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_tab_navigate_next (girara_session_t *session, girara_argument_t *argument, girara_event_t *event, unsigned int t)
bool	girara_sc_tab_navigate_prev (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_isc_command_history (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

session	The girara session
identifier	The identifier
value	The value that should be represented

Returns

true if no error occured

Definition at line 647 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

session	The used girara session
modifier	The modifier
key	The key
function	Executed function
argument_n	Argument identifier
argument_data	Argument data

Returns

true No error occured

false An error occured

Definition at line 97 of file shortcuts.c.

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

Removes an inputbar shortcut

Parameters

session	The used girara session
modifier	The modifier
key	The key

Returns

true No error occured

false An error occured

Definition at line 128 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

session	The used girara session
argument	The argument
event	Girara event
t	Number of executions

Returns

true No error occured

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
	)

Default inputbar shortcut to navigate through the command history

Parameters

session	The used girara session
argument	The argument
event	Girara event
t	Number 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

session	The used girara session
argument	The argument
event	Girara event
t	Number 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

session	The used girara session
argument	The argument
event	Girara event
t	Number 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

session	The used girara session
mask	The mask
button	Pressed button
function	Executed function
mode	Available mode
event_type	Event type
argument_n	Argument identifier
argument_data	Argument data

Returns

true No error occured

false An error occured

Definition at line 685 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

session	The used girara session
mask	The mask
button	Pressed button
mode	Available mode

Returns

true No error occured

false An error occured

Definition at line 721 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

session	The used girara session
argument	The argument
event	Girara event
t	Number 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

session	The used girara session
argument	The argument
event	Girara event
t	Number 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

session	The used girara session
argument	The argument
event	Girara event
t	Number 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

session	The used girara session
argument	The argument
event	Girara event
t	Number 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

session	The used girara session
argument	The argument
event	Girara event
t	Number 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

session	The used girara session
argument	The argument
event	Girara event
t	Number of execution

Returns

true No error occured

false An error occured (abort execution)

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

Navigate to the next tab

Parameters

session	The used girara session
argument	The used argument
event	Girara event
t	Number of executions

Returns

true if no error occured otherwise false

Definition at line 388 of file shortcuts.c.

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

Navigate to the previous tab

Parameters

session	The used girara session
argument	The used argument
event	Girara event
t	Number of executions

Returns

true if no error occured otherwise false

Definition at line 397 of file shortcuts.c.

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

session	The used girara session
argument	The argument
event	Girara event
t	Numbr 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

session	The used girara session
argument	The argument
event	Girara event
t	Numbr 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

session	The used girara session
argument	The argument
event	Girara event
t	Number 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

session	The used girara session
modifier	The modifier
key	The key
buffer	Buffer command
function	Executed function
mode	Available modes
argument_n	Argument identifier
argument_data	Argument data

Returns

true No error occured

false An error occured

Definition at line 18 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

session	The girara session
identifier	Optional identifier
function	The function that should be mapped

Returns

true if no error occured

Definition at line 609 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

session	The used girara session
modifier	The modifier
key	The key
buffer	Buffer command
mode	Available modes

Returns

true No error occured

false An error occured

Definition at line 68 of file shortcuts.c.