girara
Functions
shortcuts.h File Reference
#include "types.h"
#include "macros.h"
#include <glib.h>
Include dependency graph for shortcuts.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

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) GIRARA_VISIBLE
 
bool girara_shortcut_remove (girara_session_t *session, guint modifier, guint key, const char *buffer, girara_mode_t mode) GIRARA_VISIBLE
 
bool girara_inputbar_shortcut_add (girara_session_t *session, guint modifier, guint key, girara_shortcut_function_t function, int argument_n, void *argument_data) GIRARA_VISIBLE
 
bool girara_inputbar_shortcut_remove (girara_session_t *session, guint modifier, guint key) GIRARA_VISIBLE
 
bool girara_sc_focus_inputbar (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t) GIRARA_VISIBLE
 
bool girara_sc_abort (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t) GIRARA_VISIBLE
 
bool girara_sc_quit (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t) GIRARA_VISIBLE
 
bool girara_sc_toggle_inputbar (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t) GIRARA_VISIBLE
 
bool girara_sc_toggle_statusbar (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t) GIRARA_VISIBLE
 
bool girara_sc_set (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t) GIRARA_VISIBLE
 
bool girara_sc_exec (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t) GIRARA_VISIBLE
 
bool girara_isc_activate (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t) GIRARA_VISIBLE
 
bool girara_isc_abort (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t) GIRARA_VISIBLE
 
bool girara_isc_completion (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t) GIRARA_VISIBLE
 
bool girara_isc_string_manipulation (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t) GIRARA_VISIBLE
 
bool girara_isc_command_history (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t) GIRARA_VISIBLE
 
bool girara_shortcut_mapping_add (girara_session_t *session, const char *identifier, girara_shortcut_function_t function) GIRARA_VISIBLE
 
bool girara_argument_mapping_add (girara_session_t *session, const char *identifier, int value) GIRARA_VISIBLE
 
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) GIRARA_VISIBLE
 
bool girara_mouse_event_remove (girara_session_t *session, guint mask, guint button, girara_mode_t mode) GIRARA_VISIBLE
 

Function Documentation

◆ girara_argument_mapping_add()

bool girara_argument_mapping_add ( girara_session_t *  session,
const char *  identifier,
int  value 
)

Creates a mapping between a shortcut argument and an identifier and is used to evalue the mapping command

Parameters
sessionThe girara session
identifierThe identifier
valueThe value that should be represented
Returns
true if no error occurred

◆ girara_inputbar_shortcut_add()

bool girara_inputbar_shortcut_add ( girara_session_t *  session,
guint  modifier,
guint  key,
girara_shortcut_function_t  function,
int  argument_n,
void *  argument_data 
)

Adds an inputbar shortcut

Parameters
sessionThe used girara session
modifierThe modifier
keyThe key
functionExecuted function
argument_nArgument identifier
argument_dataArgument data
Returns
true No error occurred
false An error occurred

◆ girara_inputbar_shortcut_remove()

bool girara_inputbar_shortcut_remove ( girara_session_t *  session,
guint  modifier,
guint  key 
)

Removes an inputbar shortcut

Parameters
sessionThe used girara session
modifierThe modifier
keyThe key
Returns
true No error occurred
false An error occurred

◆ girara_isc_abort()

bool girara_isc_abort ( girara_session_t *  session,
girara_argument_t *  argument,
girara_event_t *  event,
unsigned int  t 
)

Default inputbar shortcut to abort

Parameters
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns
true No error occurred
false An error occurred (abort execution)

◆ girara_isc_activate()

bool girara_isc_activate ( girara_session_t *  session,
girara_argument_t *  argument,
girara_event_t *  event,
unsigned int  t 
)

Default shortcut function to activate

Parameters
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns
true No error occurred
false An error occurred (abort execution)

◆ girara_isc_command_history()

bool girara_isc_command_history ( girara_session_t *  session,
girara_argument_t *  argument,
girara_event_t *  event,
unsigned int  t 
)

Default inputbar shortcut to navigate through the command history

Parameters
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns
true No error occurred
false An error occurred (abort execution)

◆ girara_isc_completion()

bool girara_isc_completion ( 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

Parameters
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns
true No error occurred
false An error occurred (abort execution)

◆ girara_isc_string_manipulation()

bool girara_isc_string_manipulation ( girara_session_t *  session,
girara_argument_t *  argument,
girara_event_t *  event,
unsigned int  t 
)

Default inputbar shortcut to manipulate the inputbar string

Parameters
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns
true No error occurred
false An error occurred (abort execution)

◆ girara_mouse_event_add()

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 
)

Adds a mouse event

Parameters
sessionThe used girara session
maskThe mask
buttonPressed button
functionExecuted function
modeAvailable mode
event_typeEvent type
argument_nArgument identifier
argument_dataArgument data
Returns
true No error occurred
false An error occurred

◆ girara_mouse_event_remove()

bool girara_mouse_event_remove ( girara_session_t *  session,
guint  mask,
guint  button,
girara_mode_t  mode 
)

Removes a mouse event

Parameters
sessionThe used girara session
maskThe mask
buttonPressed button
modeAvailable mode
Returns
true No error occurred
false An error occurred

◆ girara_sc_abort()

bool girara_sc_abort ( girara_session_t *  session,
girara_argument_t *  argument,
girara_event_t *  event,
unsigned int  t 
)

Default shortcut function to abort

Parameters
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns
true No error occurred
false An error occurred (abort execution)

◆ girara_sc_exec()

bool girara_sc_exec ( girara_session_t *  session,
girara_argument_t *  argument,
girara_event_t *  event,
unsigned int  t 
)

Executes a command.

Parameters
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber ofexecutions
Returns
true No error occurred
false An error occurred (abort execution)

◆ girara_sc_focus_inputbar()

bool girara_sc_focus_inputbar ( girara_session_t *  session,
girara_argument_t *  argument,
girara_event_t *  event,
unsigned int  t 
)

Default shortcut function to focus the inputbar

Parameters
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns
true No error occurred
false An error occurred (abort execution)

◆ girara_sc_quit()

bool girara_sc_quit ( girara_session_t *  session,
girara_argument_t *  argument,
girara_event_t *  event,
unsigned int  t 
)

Default shortcut function to quit the application

Parameters
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns
true No error occurred
false An error occurred (abort execution)

◆ girara_sc_set()

bool girara_sc_set ( girara_session_t *  session,
girara_argument_t *  argument,
girara_event_t *  event,
unsigned int  t 
)

Passes the argument to the set command

Parameters
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber ofexecutions
Returns
true No error occurred
false An error occurred (abort execution)

◆ girara_sc_toggle_inputbar()

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 inputbar

Parameters
sessionThe used girara session
argumentThe argument
eventGirara event
tNumbr of execution
Returns
true No error occurred
false An error occurred (abort execution)

◆ girara_sc_toggle_statusbar()

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 statusbar

Parameters
sessionThe used girara session
argumentThe argument
eventGirara event
tNumbr of execution
Returns
true No error occurred
false An error occurred (abort execution)

◆ girara_shortcut_add()

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 
)

Adds a shortcut

Note: currently argument_data accepts only a character string

Parameters
sessionThe used girara session
modifierThe modifier
keyThe key
bufferBuffer command
functionExecuted function
modeAvailable modes
argument_nArgument identifier
argument_dataArgument data
Returns
true No error occurred
false An error occurred

◆ girara_shortcut_mapping_add()

bool girara_shortcut_mapping_add ( girara_session_t *  session,
const char *  identifier,
girara_shortcut_function_t  function 
)

Creates a mapping between a shortcut function and an identifier and is used to evaluate the mapping command

Parameters
sessionThe girara session
identifierOptional identifier
functionThe function that should be mapped
Returns
true if no error occurred

◆ girara_shortcut_remove()

bool girara_shortcut_remove ( girara_session_t *  session,
guint  modifier,
guint  key,
const char *  buffer,
girara_mode_t  mode 
)

Removes a shortcut

Parameters
sessionThe used girara session
modifierThe modifier
keyThe key
bufferBuffer command
modeAvailable modes
Returns
true No error occurred
false An error occurred