| libeek Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | Signals | ||||
EekSection; struct EekSectionClass; void eek_section_add_row (EekSection *section,gint num_columns,EekOrientation orientation); EekKey * eek_section_create_key (EekSection *section,guint keycode,gint column,gint row); EekKey * eek_section_find_key_by_keycode (EekSection *section,guint keycode); gint eek_section_get_angle (EekSection *section); gint eek_section_get_n_rows (EekSection *section); void eek_section_get_row (EekSection *section,gint index,gint *num_columns,EekOrientation *orientation); void eek_section_set_angle (EekSection *section,gint angle);
"key-cancelled" :Run Last"key-locked" :Run Last"key-pressed" :Run Last"key-released" :Run Last"key-unlocked" :Run Last
The EekSectionClass class represents a section, which consists of one or more keys of the EekKeyClass class.
typedef struct _EekSection EekSection;
The EekSection structure contains only private data and should only be accessed using the provided API.
struct EekSectionClass {
gint (* get_n_rows) (EekSection *self);
void (* add_row) (EekSection *self,
gint num_columns,
EekOrientation orientation);
void (* get_row) (EekSection *self,
gint index,
gint *num_columns,
EekOrientation *orientation);
EekKey *(* create_key) (EekSection *self,
guint keycode,
gint row,
gint column);
/* signals */
void (* key_pressed) (EekSection *self,
EekKey *key);
void (* key_released) (EekSection *self,
EekKey *key);
void (* key_locked) (EekSection *self,
EekKey *key);
void (* key_unlocked) (EekSection *self,
EekKey *key);
void (* key_cancelled) (EekSection *self,
EekKey *key);
};
| virtual function for getting the number of rows in the section | |
| virtual function for adding a new row to the section | |
| virtual function for accessing a row in the section | |
| virtual function for creating key in the section | |
| 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 |
void eek_section_add_row (EekSection *section,gint num_columns,EekOrientation orientation);
Add a row which has num_columns columns and whose orientation is
orientation to section.
|
an EekSection |
|
the number of column in the row |
|
EekOrientation of the row |
EekKey * eek_section_create_key (EekSection *section,guint keycode,gint column,gint row);
Create an EekKey instance and append it to section. This
function is rarely called by application but called by EekLayout
implementation.
|
an EekSection |
|
a keycode |
|
the column index of the key |
|
the row index of the key |
EekKey * eek_section_find_key_by_keycode (EekSection *section,guint keycode);
gint eek_section_get_angle (EekSection *section);
Get rotation angle of section.
|
an EekSection |
gint eek_section_get_n_rows (EekSection *section);
Get the number of rows in section.
|
an EekSection |
void eek_section_get_row (EekSection *section,gint index,gint *num_columns,EekOrientation *orientation);
Get the information about the index-th row in section.
|
an EekSection |
|
the index of row |
|
pointer where the number of column in the row will be stored |
|
pointer where EekOrientation of the row will be stored |
void eek_section_set_angle (EekSection *section,gint angle);
Set rotation angle of section to angle.
|
an EekSection |
|
rotation angle |
"angle" property"angle" gint : Read / Write
The rotation angle of EekSection.
Allowed values: [-360,360]
Default value: 0
"key-cancelled" signalvoid user_function (EekSection *section,
EekKey *key,
gpointer user_data) : Run Last
The ::key-cancelled signal is emitted each time a key in section
is shifted to the cancelled state.
|
an EekSection |
|
an EekKey |
|
user data set when the signal handler was connected. |
"key-locked" signalvoid user_function (EekSection *section,
EekKey *key,
gpointer user_data) : Run Last
The ::key-locked signal is emitted each time a key in section
is shifted to the locked state.
|
an EekSection |
|
an EekKey |
|
user data set when the signal handler was connected. |
"key-pressed" signalvoid user_function (EekSection *section,
EekKey *key,
gpointer user_data) : Run Last
The ::key-pressed signal is emitted each time a key in section
is shifted to the pressed state.
|
an EekSection |
|
an EekKey |
|
user data set when the signal handler was connected. |
"key-released" signalvoid user_function (EekSection *section,
EekKey *key,
gpointer user_data) : Run Last
The ::key-released signal is emitted each time a key in section
is shifted to the released state.
|
an EekSection |
|
an EekKey |
|
user data set when the signal handler was connected. |
"key-unlocked" signalvoid user_function (EekSection *section,
EekKey *key,
gpointer user_data) : Run Last
The ::key-unlocked signal is emitted each time a key in section
is shifted to the unlocked state.
|
an EekSection |
|
an EekKey |
|
user data set when the signal handler was connected. |