girara
Functions
shortcuts.h File Reference
#include "types.h"
#include <glib.h>

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

Function Documentation

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 occured

Definition at line 456 of file shortcuts.c.

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 occured
false An error occured

Definition at line 95 of file shortcuts.c.

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 occured
false An error occured

Definition at line 126 of file shortcuts.c.

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 occured
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 that completes the given input in the statusbar

Parameters:
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns:
true No error occured
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 manipulate the inputbar string

Parameters:
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns:
true No error occured
false An error occured (abort execution)
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 occured
false An error occured

Definition at line 494 of file shortcuts.c.

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 occured
false An error occured

Definition at line 530 of file shortcuts.c.

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 occured
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 focus the inputbar

Parameters:
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns:
true No error occured
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 
)

Default shortcut function to quit the application

Parameters:
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns:
true No error occured
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 
)

Passes the argument to the set command

Parameters:
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber ofexecutions
Returns:
true No error occured
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 
)

Closes the current tab

Parameters:
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of executions
Returns:
true No error occured
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 
)

Default shortcut function to navigate through tabs

Parameters:
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of execution
Returns:
true No error occured
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 inputbar

Parameters:
sessionThe used girara session
argumentThe argument
eventGirara event
tNumbr of execution
Returns:
true No error occured
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 statusbar

Parameters:
sessionThe used girara session
argumentThe argument
eventGirara event
tNumbr of execution
Returns:
true No error occured
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 
)

Toggles the visibility of the tabbar

Parameters:
sessionThe used girara session
argumentThe argument
eventGirara event
tNumber of execution
Returns:
true No error occured
false An error occured (abort execution)
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 occured
false An error occured

Definition at line 16 of file shortcuts.c.

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 occured

Definition at line 419 of file shortcuts.c.

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 occured
false An error occured

Definition at line 66 of file shortcuts.c.

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines