![]() |
![]() |
![]() |
libeek Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
EekKeyboard; struct EekKeyboardClass; EekModifierKey; EekKeyboard * eek_keyboard_new (EekLayout *layout
,gdouble initial_width
,gdouble initial_height
); EekLayout * eek_keyboard_get_layout (EekKeyboard *keyboard
); void eek_keyboard_get_size (EekKeyboard *keyboard
,gdouble *width
,gdouble *height
); void eek_keyboard_set_size (EekKeyboard *keyboard
,gdouble width
,gdouble height
); void eek_keyboard_set_symbol_index (EekKeyboard *keyboard
,gint group
,gint level
); void eek_keyboard_get_symbol_index (EekKeyboard *keyboard
,gint *group
,gint *level
); void eek_keyboard_set_group (EekKeyboard *keyboard
,gint group
); void eek_keyboard_set_level (EekKeyboard *keyboard
,gint level
); gint eek_keyboard_get_group (EekKeyboard *keyboard
); gint eek_keyboard_get_level (EekKeyboard *keyboard
); void eek_keyboard_set_modifier_behavior (EekKeyboard *keyboard
,EekModifierBehavior modifier_behavior
); EekModifierBehavior eek_keyboard_get_modifier_behavior (EekKeyboard *keyboard
); void eek_keyboard_set_modifiers (EekKeyboard *keyboard
,EekModifierType modifiers
); EekModifierType eek_keyboard_get_modifiers (EekKeyboard *keyboard
); EekSection * eek_keyboard_create_section (EekKeyboard *keyboard
); EekKey * eek_keyboard_find_key_by_keycode (EekKeyboard *keyboard
,guint keycode
); gulong eek_keyboard_add_outline (EekKeyboard *keyboard
,EekOutline *outline
); EekOutline * eek_keyboard_get_outline (EekKeyboard *keyboard
,gulong oref
); void eek_keyboard_set_num_lock_mask (EekKeyboard *keyboard
,EekModifierType num_lock_mask
); EekModifierType eek_keyboard_get_num_lock_mask (EekKeyboard *keyboard
); void eek_keyboard_set_alt_gr_mask (EekKeyboard *keyboard
,EekModifierType alt_gr_mask
); EekModifierType eek_keyboard_get_alt_gr_mask (EekKeyboard *keyboard
); GList * eek_keyboard_get_pressed_keys (EekKeyboard *keyboard
); GList * eek_keyboard_get_locked_keys (EekKeyboard *keyboard
); EekKeyboardPrivate;
"layout" EekLayout* : Read / Write / Construct Only "modifier-behavior" EekModifierBehavior : Read / Write
"key-cancelled" :Run Last
"key-locked" :Run Last
"key-pressed" :Run Last
"key-released" :Run Last
"key-unlocked" :Run Last
The EekKeyboardClass class represents a keyboard, which consists of one or more sections of the EekSectionClass class.
typedef struct _EekKeyboard EekKeyboard;
The EekKeyboard structure contains only private data and should only be accessed using the provided API.
struct EekKeyboardClass { EekSection *(* create_section) (EekKeyboard *self); EekKey *(* find_key_by_keycode) (EekKeyboard *self, guint keycode); /* signals */ void (* key_pressed) (EekKeyboard *self, EekKey *key); void (* key_released) (EekKeyboard *self, EekKey *key); /* signals */ void (* key_locked) (EekKeyboard *self, EekKey *key); void (* key_unlocked) (EekKeyboard *self, EekKey *key); void (* key_cancelled) (EekKeyboard *self, EekKey *key); };
virtual function for creating a section | |
virtual function for finding a key in the keyboard by keycode | |
class handler for "key-pressed" signal | |
class handler for "key-released" signal | |
class handler for "key-locked" signal | |
class handler for "key-unlocked" signal | |
class handler for "key-cancelled" signal |
typedef struct { EekModifierType modifiers; EekKey *key; } EekModifierKey;
Entry which associates modifier mask to a key. This is returned by
eek_keyboard_get_locked_keys()
.
EekModifierType |
an EekModifierType which key triggers |
EekKey * |
an EekKey |
EekKeyboard * eek_keyboard_new (EekLayout *layout
,gdouble initial_width
,gdouble initial_height
);
Create a new EekKeyboard based on layout
.
|
an EekLayout |
|
initial width of the keyboard |
|
initial height of the keyboard |
EekLayout * eek_keyboard_get_layout (EekKeyboard *keyboard
);
Get the layout used to create keyboard
.
|
an EekKeyboard |
Returns : |
an EekLayout |
void eek_keyboard_get_size (EekKeyboard *keyboard
,gdouble *width
,gdouble *height
);
Get the size of keyboard
.
|
an EekKeyboard |
|
width of keyboard
|
|
height of keyboard
|
void eek_keyboard_set_size (EekKeyboard *keyboard
,gdouble width
,gdouble height
);
void eek_keyboard_set_symbol_index (EekKeyboard *keyboard
,gint group
,gint level
);
eek_keyboard_set_symbol_index
has been deprecated since version 1.0 and should not be used in newly-written code. Use eek_element_set_symbol_index()
Set the default index of the symbol matrices of keys in keyboard
.
To unset, pass -1 as group/level.
|
an EekKeyboard |
|
row index of the symbol matrix of keys on keyboard
|
|
column index of the symbol matrix of keys on keyboard
|
void eek_keyboard_get_symbol_index (EekKeyboard *keyboard
,gint *group
,gint *level
);
eek_keyboard_get_symbol_index
has been deprecated since version 1.0 and should not be used in newly-written code. Use eek_element_get_symbol_index()
Get the default index of the symbol matrices of keys in keyboard
.
If the index is not set, -1 will be returned.
|
an EekKeyboard |
|
a pointer where the group value of the symbol index will be stored |
|
a pointer where the level value of the symbol index will be stored |
void eek_keyboard_set_group (EekKeyboard *keyboard
,gint group
);
eek_keyboard_set_group
has been deprecated since version 1.0 and should not be used in newly-written code. Use eek_element_set_group()
Set the group value of the default symbol index of keyboard
. To
unset, pass -1 as group
.
See also: eek_keyboard_set_symbol_index()
|
an EekKeyboard |
|
group index of keyboard
|
void eek_keyboard_set_level (EekKeyboard *keyboard
,gint level
);
eek_keyboard_set_level
has been deprecated since version 1.0 and should not be used in newly-written code. Use eek_element_set_level()
Set the level value of the default symbol index of keyboard
. To
unset, pass -1 as level
.
See also: eek_keyboard_set_symbol_index()
|
an EekKeyboard |
|
level index of keyboard
|
gint eek_keyboard_get_group (EekKeyboard *keyboard
);
eek_keyboard_get_group
has been deprecated since version 1.0 and should not be used in newly-written code. Use eek_element_get_group()
Return the group value of the default symbol index of keyboard
.
If the value is not set, -1 will be returned.
See also: eek_keyboard_get_symbol_index()
|
an EekKeyboard |
gint eek_keyboard_get_level (EekKeyboard *keyboard
);
eek_keyboard_get_level
has been deprecated since version 1.0 and should not be used in newly-written code. Use eek_element_get_level()
Return the level value of the default symbol index of keyboard
.
If the value is not set, -1 will be returned.
See also: eek_keyboard_get_symbol_index()
|
an EekKeyboard |
void eek_keyboard_set_modifier_behavior (EekKeyboard *keyboard
,EekModifierBehavior modifier_behavior
);
Set the modifier handling mode of keyboard
.
|
an EekKeyboard |
|
modifier behavior of keyboard
|
EekModifierBehavior eek_keyboard_get_modifier_behavior (EekKeyboard *keyboard
);
Get the modifier handling mode of keyboard
.
|
an EekKeyboard |
Returns : |
EekModifierBehavior |
void eek_keyboard_set_modifiers (EekKeyboard *keyboard
,EekModifierType modifiers
);
EekModifierType eek_keyboard_get_modifiers (EekKeyboard *keyboard
);
Get the current modifier status of keyboard
.
|
an EekKeyboard |
Returns : |
EekModifierType |
EekSection * eek_keyboard_create_section (EekKeyboard *keyboard
);
Create an EekSection instance and append it to keyboard
. This
function is rarely called by application but called by EekLayout
implementation.
|
an EekKeyboard |
EekKey * eek_keyboard_find_key_by_keycode (EekKeyboard *keyboard
,guint keycode
);
Find an EekKey whose keycode is keycode
.
|
an EekKeyboard |
|
a keycode |
Returns : |
EekKey whose keycode is keycode . [transfer none]
|
gulong eek_keyboard_add_outline (EekKeyboard *keyboard
,EekOutline *outline
);
Register an outline of keyboard
.
|
an EekKeyboard |
|
an EekOutline |
Returns : |
an unsigned long id of the registered outline, for later reference |
EekOutline * eek_keyboard_get_outline (EekKeyboard *keyboard
,gulong oref
);
Get an outline associated with oref
in keyboard
.
|
an EekKeyboard |
|
an unsigned long id |
Returns : |
an EekOutline, which should not be released |
void eek_keyboard_set_num_lock_mask (EekKeyboard *keyboard
,EekModifierType num_lock_mask
);
Set modifier mask used as Num_Lock.
|
an EekKeyboard |
|
an EekModifierType |
EekModifierType eek_keyboard_get_num_lock_mask (EekKeyboard *keyboard
);
Get modifier mask used as Num_Lock.
|
an EekKeyboard |
Returns : |
an EekModifierType |
void eek_keyboard_set_alt_gr_mask (EekKeyboard *keyboard
,EekModifierType alt_gr_mask
);
Set modifier mask used as Alt_Gr.
|
an EekKeyboard |
|
an EekModifierType |
EekModifierType eek_keyboard_get_alt_gr_mask (EekKeyboard *keyboard
);
Get modifier mask used as Alt_Gr.
|
an EekKeyboard |
Returns : |
an EekModifierType |
GList * eek_keyboard_get_pressed_keys (EekKeyboard *keyboard
);
Get pressed keys.
|
an EekKeyboard |
Returns : |
A list of pressed keys. [transfer container][element-type EekKey] |
GList * eek_keyboard_get_locked_keys (EekKeyboard *keyboard
);
Get locked keys.
|
an EekKeyboard |
Returns : |
A list of locked keys. [transfer container][element-type EekModifierKey] |
"layout"
property"layout" EekLayout* : Read / Write / Construct Only
The layout used to create this EekKeyboard.
"modifier-behavior"
property"modifier-behavior" EekModifierBehavior : Read / Write
The modifier handling mode of EekKeyboard.
Default value: EEK_MODIFIER_BEHAVIOR_NONE
"key-cancelled"
signalvoid user_function (EekKeyboard *keyboard,
EekKey *key,
gpointer user_data) : Run Last
The ::key-cancelled signal is emitted each time a key in keyboard
is shifted to the cancelled state.
|
an EekKeyboard |
|
an EekKey |
|
user data set when the signal handler was connected. |
"key-locked"
signalvoid user_function (EekKeyboard *keyboard,
EekKey *key,
gpointer user_data) : Run Last
The ::key-locked signal is emitted each time a key in keyboard
is shifted to the locked state.
|
an EekKeyboard |
|
an EekKey |
|
user data set when the signal handler was connected. |
"key-pressed"
signalvoid user_function (EekKeyboard *keyboard,
EekKey *key,
gpointer user_data) : Run Last
The ::key-pressed signal is emitted each time a key in keyboard
is shifted to the pressed state.
|
an EekKeyboard |
|
an EekKey |
|
user data set when the signal handler was connected. |
"key-released"
signalvoid user_function (EekKeyboard *keyboard,
EekKey *key,
gpointer user_data) : Run Last
The ::key-released signal is emitted each time a key in keyboard
is shifted to the released state.
|
an EekKeyboard |
|
an EekKey |
|
user data set when the signal handler was connected. |
"key-unlocked"
signalvoid user_function (EekKeyboard *keyboard,
EekKey *key,
gpointer user_data) : Run Last
The ::key-unlocked signal is emitted each time a key in keyboard
is shifted to the unlocked state.
|
an EekKeyboard |
|
an EekKey |
|
user data set when the signal handler was connected. |