/usr/include/girara/shortcuts.h is in libgirara-dev 0.2.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 | /* See LICENSE file for license and copyright information */
#ifndef GIRARA_SHORTCUTS_H
#define GIRARA_SHORTCUTS_H
#include "types.h"
#include <glib.h>
/**
* Adds a shortcut
*
* Note: currently argument_data accepts only a character string
*
* @param session The used girara session
* @param modifier The modifier
* @param key The key
* @param buffer Buffer command
* @param function Executed function
* @param mode Available modes
* @param argument_n Argument identifier
* @param argument_data Argument data
* @return true No error occured
* @return false An error occured
*/
bool girara_shortcut_add(girara_session_t* session, guint modifier, guint key,
const char* buffer, girara_shortcut_function_t function, girara_mode_t mode,
int argument_n, void* argument_data);
/**
* Removes a shortcut
*
* @param session The used girara session
* @param modifier The modifier
* @param key The key
* @param buffer Buffer command
* @param mode Available modes
* @return true No error occured
* @return false An error occured
*/
bool girara_shortcut_remove(girara_session_t* session, guint modifier, guint
key, const char* buffer, girara_mode_t mode);
/**
* Adds an inputbar shortcut
*
* @param session The used girara session
* @param modifier The modifier
* @param key The key
* @param function Executed function
* @param argument_n Argument identifier
* @param argument_data Argument data
* @return true No error occured
* @return false An error occured
*/
bool girara_inputbar_shortcut_add(girara_session_t* session, guint modifier,
guint key, girara_shortcut_function_t function, int argument_n, void*
argument_data);
/**
* Removes an inputbar shortcut
*
* @param session The used girara session
* @param modifier The modifier
* @param key The key
* @return true No error occured
* @return false An error occured
*/
bool girara_inputbar_shortcut_remove(girara_session_t* session, guint modifier,
guint key);
/**
* Default shortcut function to focus the inputbar
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Number of executions
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_sc_focus_inputbar(girara_session_t* session, girara_argument_t*
argument, girara_event_t* event, unsigned int t);
/**
* Default shortcut function to abort
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Number of executions
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_sc_abort(girara_session_t* session, girara_argument_t* argument,
girara_event_t* event, unsigned int t);
/**
* Default shortcut function to quit the application
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Number of executions
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_sc_quit(girara_session_t* session, girara_argument_t* argument,
girara_event_t* event, unsigned int t);
/**
* Closes the current tab
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Number of executions
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_sc_tab_close(girara_session_t* session, girara_argument_t* argument,
girara_event_t* event, unsigned int t);
/**
* Default shortcut function to navigate through tabs
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Number of execution
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_sc_tab_navigate(girara_session_t* session, girara_argument_t*
argument, girara_event_t* event, unsigned int t);
/**
* Navigate to the next tab
*
* @param session The used girara session
* @param argument The used argument
* @param event Girara event
* @param t Number of executions
* @return true if no error occured otherwise false
*/
bool girara_sc_tab_navigate_next(girara_session_t* session,
girara_argument_t* argument,
girara_event_t* event, unsigned int t);
/**
* Navigate to the previous tab
*
* @param session The used girara session
* @param argument The used argument
* @param event Girara event
* @param t Number of executions
* @return true if no error occured otherwise false
*/
bool girara_sc_tab_navigate_prev(girara_session_t* session,
girara_argument_t* argument,
girara_event_t* event, unsigned int t);
/**
* Toggles the visibility of the inputbar
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Numbr of execution
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_sc_toggle_inputbar(girara_session_t* session, girara_argument_t*
argument, girara_event_t* event, unsigned int t);
/**
* Toggles the visibility of the statusbar
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Numbr of execution
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_sc_toggle_statusbar(girara_session_t* session, girara_argument_t*
argument, girara_event_t* event, unsigned int t);
/**
* Toggles the visibility of the tabbar
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Number of execution
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_sc_toggle_tabbar(girara_session_t* session, girara_argument_t*
argument, girara_event_t* event, unsigned int t);
/**
* Passes the argument to the set command
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Number ofexecutions
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_sc_set(girara_session_t* session, girara_argument_t* argument,
girara_event_t* event, unsigned int t);
/**
* Default shortcut function to activate
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Number of executions
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_isc_activate(girara_session_t* session, girara_argument_t* argument,
girara_event_t* event, unsigned int t);
/**
* Default inputbar shortcut to abort
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Number of executions
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_isc_abort(girara_session_t* session, girara_argument_t* argument,
girara_event_t* event, unsigned int t);
/**
* Default inputbar shortcut that completes the given input
* in the statusbar
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Number of executions
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_isc_completion(girara_session_t* session, girara_argument_t*
argument, girara_event_t* event, unsigned int t);
/**
* Default inputbar shortcut to manipulate the inputbar string
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Number of executions
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_isc_string_manipulation(girara_session_t* session,
girara_argument_t* argument, girara_event_t* event, unsigned int t);
/**
* Default inputbar shortcut to navigate through the command history
*
* @param session The used girara session
* @param argument The argument
* @param event Girara event
* @param t Number of executions
* @return true No error occured
* @return false An error occured (abort execution)
*/
bool girara_isc_command_history(girara_session_t* session,
girara_argument_t* argument, girara_event_t* event, unsigned int t);
/**
* Creates a mapping between a shortcut function and an identifier and is used
* to evaluate the mapping command
*
* @param session The girara session
* @param identifier Optional identifier
* @param function The function that should be mapped
* @return true if no error occured
*/
bool girara_shortcut_mapping_add(girara_session_t* session,
const char* identifier, girara_shortcut_function_t function);
/**
* Creates a mapping between a shortcut argument and an identifier and is used
* to evalue the mapping command
*
* @param session The girara session
* @param identifier The identifier
* @param value The value that should be represented
* @return true if no error occured
*/
bool girara_argument_mapping_add(girara_session_t* session,
const char* identifier, int value);
/**
* Adds a mouse event
*
* @param session The used girara session
* @param mask The mask
* @param button Pressed button
* @param function Executed function
* @param mode Available mode
* @param event_type Event type
* @param argument_n Argument identifier
* @param argument_data Argument data
* @return true No error occured
* @return false An error occured
*/
bool girara_mouse_event_add(girara_session_t* session, guint mask, guint button,
girara_shortcut_function_t function, girara_mode_t mode,
girara_event_type_t event_type, int argument_n, void* argument_data);
/**
* Removes a mouse event
*
* @param session The used girara session
* @param mask The mask
* @param button Pressed button
* @param mode Available mode
* @return true No error occured
* @return false An error occured
*/
bool girara_mouse_event_remove(girara_session_t* session, guint mask,
guint button, girara_mode_t mode);
#endif
|