![]() | ![]() | ![]() | [Insert name here] Reference Manual | ![]() |
---|
#define MODIFIER_NORMAL enum ModifierStates; enum ModifierTypes; gboolean gok_modifier_add (gchar *Name); gboolean gok_modifier_set_pre (gchar *Name, GokOutput *pOutput); gboolean gok_modifier_set_post (gchar *Name, GokOutput *pOutput); void gok_modifier_set_type (gchar *Name, gint Type); void gok_modifier_press (GokKey *pKey, gchar *NameModifier); void gok_modifier_output_pre (void); void gok_modifier_output_post (void); void gok_modifier_all_off (void); int gok_modifier_get_state (gchar *pNameModifier); int gok_modifier_get_type (gchar *pNameModifier); gboolean gok_modifier_get_normal (void); void gok_modifier_update_modifier_keys (GokKeyboard *pKeyboard);
typedef enum { MODIFIER_STATE_OFF, MODIFIER_STATE_ON, MODIFIER_STATE_LOCKED } ModifierStates;
typedef enum { /* a normal modifier like shift or CTRL */ MODIFIER_TYPE_NORMAL, /* a toggle type of modifier like Capslock */ MODIFIER_TYPE_TOGGLE } ModifierTypes;
gboolean gok_modifier_add (gchar *Name);
Adds a modifier to the list of modifiers.
Name : | Name of the modifier. |
Returns : | TRUE if the modifier was created, FALSE if not. |
gboolean gok_modifier_set_pre (gchar *Name, GokOutput *pOutput);
Sets the wrapper 'pre' output for the given modifier.
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. |
gboolean gok_modifier_set_post (gchar *Name, GokOutput *pOutput);
Sets the 'post' output for the given modifier.
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. |
void gok_modifier_set_type (gchar *Name, gint Type);
Sets the 'Type' attribute for the given modifier.
Name : | Name of the modifier. |
Type : | The type of the modifier. |
void gok_modifier_press (GokKey *pKey, gchar *NameModifier);
This must be called when a modifier key has been pressed. Changes the state of the modifier.
pKey : | |
NameModifier : | Name of the modifier key that has been pressed. |
void gok_modifier_output_pre (void);
Sends all the wrapper 'pre' outputs to the system.
void gok_modifier_output_post (void);
Sends all the wrapper 'post' outputs to the system.
void gok_modifier_all_off (void);
Changes the state of modifier keys to OFF, unless they are locked on.
int gok_modifier_get_state (gchar *pNameModifier);
pNameModifier : | |
Returns : | The state of the modifier |
int gok_modifier_get_type (gchar *pNameModifier);
pNameModifier : | |
Returns : | The type of the modifier |
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). |
void gok_modifier_update_modifier_keys (GokKeyboard *pKeyboard);
Updates the indicator on all the modifier keys for the current keyboard.
pKeyboard : |
|
<<< gok-log | gok-output >>> |