gok-modifier

Functions

gboolean	gok_modifier_add ()
gboolean	gok_modifier_set_pre ()
gboolean	gok_modifier_set_post ()
void	gok_modifier_set_type ()
void	gok_modifier_output_pre ()
void	gok_modifier_output_post ()
void	gok_modifier_all_off ()
int	gok_modifier_get_state ()
int	gok_modifier_get_type ()
gboolean	gok_modifier_get_normal ()
void	gok_modifier_update_modifier_keys ()

Types and Values

#define	MODIFIER_NORMAL
enum	ModifierStates
enum	ModifierTypes

Description

Functions

gok_modifier_add ()

gboolean
gok_modifier_add (gchar *Name);

Adds a modifier to the list of modifiers.

Parameters

Name

Name of the modifier.

Returns

TRUE if the modifier was created, FALSE if not.

gok_modifier_set_pre ()

gboolean
gok_modifier_set_pre (gchar *Name,
                      GokOutput *pOutput);

Sets the wrapper 'pre' output for the given modifier.

Parameters

Name	Name of the modifier.
pOutput	Pointer to the output that will be set as the modifier wrapper 'pre'.

Returns

TRUE if the modifier 'pre' was set, FALSE if not.

gok_modifier_set_post ()

gboolean
gok_modifier_set_post (gchar *Name,
                       GokOutput *pOutput);

Sets the 'post' output for the given modifier.

Parameters

Name	Name of the modifier.
pOutput	Pointer to the output that will be set as the modifier wrapper 'post'.

Returns

TRUE if the modifier 'pre' was set, FALSE if not.

gok_modifier_set_type ()

void
gok_modifier_set_type (gchar *Name,
                       gint Type);

Sets the 'Type' attribute for the given modifier.

Parameters

Name	Name of the modifier.
Type	The type of the modifier.

gok_modifier_output_pre ()

void
gok_modifier_output_pre (void);

Sends all the wrapper 'pre' outputs to the system.

gok_modifier_output_post ()

void
gok_modifier_output_post (void);

Sends all the wrapper 'post' outputs to the system.

gok_modifier_all_off ()

void
gok_modifier_all_off (void);

Changes the state of modifier keys to OFF, unless they are locked on.

gok_modifier_get_state ()

int
gok_modifier_get_state (gchar *pNameModifier);

Parameters

NameModifier

Name of the modifier you want the state for.

Returns

The state of the modifier

gok_modifier_get_type ()

int
gok_modifier_get_type (gchar *pNameModifier);

Parameters

NameModifier

Name of the modifier you want the type for.

Returns

The type of the modifier

gok_modifier_get_normal ()

gboolean
gok_modifier_get_normal (void);

Returns

TRUE if there are no modifiers on (or locked on). Returns FALSE if one or more modifiers are on (or locked on).

gok_modifier_update_modifier_keys ()

void
gok_modifier_update_modifier_keys (GokKeyboard *pKeyboard);

Updates the indicator on all the modifier keys for the current keyboard.

Types and Values

MODIFIER_NORMAL

#define MODIFIER_NORMAL ""

enum ModifierStates

Members

MODIFIER_STATE_OFF
MODIFIER_STATE_ON
MODIFIER_STATE_LOCKED

enum ModifierTypes

Members

MODIFIER_TYPE_NORMAL
MODIFIER_TYPE_TOGGLE