| Top |
| EekLayout * | layout | Read / Write / Construct Only |
| EekModifierBehavior | modifier-behavior | Read / Write |
| void | key-cancelled | Run Last |
| void | key-locked | Run Last |
| void | key-pressed | Run Last |
| void | key-released | Run Last |
| void | key-unlocked | Run Last |
The EekKeyboardClass class represents a keyboard, which consists of one or more sections of the EekSectionClass class.
guint eek_keyboard_add_outline (EekKeyboard *keyboard,EekOutline *outline);
Register an outline of keyboard
.
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.
EekKey * eek_keyboard_find_key_by_keycode (EekKeyboard *keyboard,guint keycode);
Find an EekKey whose keycode is keycode
.
EekModifierType
eek_keyboard_get_alt_gr_mask (EekKeyboard *keyboard);
Get modifier mask used as Alt_Gr.
EekLayout *
eek_keyboard_get_layout (EekKeyboard *keyboard);
Get the layout used to create keyboard
.
GList *
eek_keyboard_get_locked_keys (EekKeyboard *keyboard);
Get locked keys.
EekModifierBehavior
eek_keyboard_get_modifier_behavior (EekKeyboard *keyboard);
Get the modifier handling mode of keyboard
.
EekModifierType
eek_keyboard_get_modifiers (EekKeyboard *keyboard);
Get the current modifier status of keyboard
.
EekModifierType
eek_keyboard_get_num_lock_mask (EekKeyboard *keyboard);
Get modifier mask used as Num_Lock.
EekOutline * eek_keyboard_get_outline (EekKeyboard *keyboard,guint oref);
Get an outline associated with oref
in keyboard
.
GList *
eek_keyboard_get_pressed_keys (EekKeyboard *keyboard);
Get pressed keys.
void eek_keyboard_get_size (EekKeyboard *keyboard,gdouble *width,gdouble *height);
Get the size of keyboard
.
EekKeyboard * eek_keyboard_new (EekLayout *layout,gdouble initial_width,gdouble initial_height);
Create a new EekKeyboard based on layout
.
layout |
an EekLayout |
|
initial_width |
initial width of the keyboard |
|
initial_height |
initial height of the keyboard |
void eek_keyboard_set_alt_gr_mask (EekKeyboard *keyboard,EekModifierType alt_gr_mask);
Set modifier mask used as Alt_Gr.
void eek_keyboard_set_modifier_behavior (EekKeyboard *keyboard,EekModifierBehavior modifier_behavior);
Set the modifier handling mode of keyboard
.
void eek_keyboard_set_modifiers (EekKeyboard *keyboard,EekModifierType modifiers);
void eek_keyboard_set_num_lock_mask (EekKeyboard *keyboard,EekModifierType num_lock_mask);
Set modifier mask used as Num_Lock.
void eek_keyboard_set_size (EekKeyboard *keyboard,gdouble width,gdouble height);
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().
“layout” property“layout” EekLayout *
The layout used to create this EekKeyboard.
Owner: EekKeyboard
Flags: Read / Write / Construct Only
“modifier-behavior” property“modifier-behavior” EekModifierBehavior
The modifier handling mode of EekKeyboard.
Owner: EekKeyboard
Flags: Read / Write
Default value: EEK_MODIFIER_BEHAVIOR_NONE
“key-cancelled” signalvoid user_function (EekKeyboard *keyboard, EekKey *key, gpointer user_data)
The ::key-cancelled signal is emitted each time a key in keyboard
is shifted to the cancelled state.
keyboard |
an EekKeyboard |
|
key |
an EekKey |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“key-locked” signalvoid user_function (EekKeyboard *keyboard, EekKey *key, gpointer user_data)
The ::key-locked signal is emitted each time a key in keyboard
is shifted to the locked state.
keyboard |
an EekKeyboard |
|
key |
an EekKey |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“key-pressed” signalvoid user_function (EekKeyboard *keyboard, EekKey *key, gpointer user_data)
The ::key-pressed signal is emitted each time a key in keyboard
is shifted to the pressed state.
keyboard |
an EekKeyboard |
|
key |
an EekKey |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“key-released” signalvoid user_function (EekKeyboard *keyboard, EekKey *key, gpointer user_data)
The ::key-released signal is emitted each time a key in keyboard
is shifted to the released state.
keyboard |
an EekKeyboard |
|
key |
an EekKey |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“key-unlocked” signalvoid user_function (EekKeyboard *keyboard, EekKey *key, gpointer user_data)
The ::key-unlocked signal is emitted each time a key in keyboard
is shifted to the unlocked state.
keyboard |
an EekKeyboard |
|
key |
an EekKey |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last