EekKeyboard

EekKeyboard — Base class of a keyboard

Synopsis

                    EekKeyboardClass;
                    EekKeyboardPrivate;
                    EekKeyboard;
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);
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);

Object Hierarchy

  GObject
   +----EekElement
         +----EekContainer
               +----EekKeyboard

Implemented Interfaces

EekKeyboard implements EekSerializable.

Properties

  "layout"                   EekLayout*            : Read / Write / Construct Only
  "modifier-behavior"        gint                  : Read / Write

Signals

  "key-pressed"                                    : Run Last
  "key-released"                                   : Run Last

Description

The EekKeyboardClass class represents a keyboard, which consists of one or more sections of the EekSectionClass class.

Details

EekKeyboardClass

typedef struct {
    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);
} EekKeyboardClass;

create_section ()

 virtual function for creating a section

find_key_by_keycode ()

 virtual function for finding a key in the keyboard by keycode

key_pressed ()

 class handler for "key-pressed" signal

key_released ()

 class handler for "key-released" signal

EekKeyboardPrivate

typedef struct _EekKeyboardPrivate EekKeyboardPrivate;

EekKeyboard

typedef struct _EekKeyboard EekKeyboard;

The EekKeyboard structure contains only private data and should only be accessed using the provided API.

eek_keyboard_new ()

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

eek_keyboard_get_layout ()

EekLayout *         eek_keyboard_get_layout             (EekKeyboard *keyboard);

Get the layout used to create keyboard.

keyboard :

 an EekKeyboard

Returns :

 an EekLayout

eek_keyboard_get_size ()

void                eek_keyboard_get_size               (EekKeyboard *keyboard,
                                                         gdouble *width,
                                                         gdouble *height);

Get the size of keyboard.

keyboard :

 an EekKeyboard

width :

 width of keyboard

height :

 height of keyboard

eek_keyboard_set_size ()

void                eek_keyboard_set_size               (EekKeyboard *keyboard,
                                                         gdouble width,
                                                         gdouble height);

eek_keyboard_set_symbol_index ()

void                eek_keyboard_set_symbol_index       (EekKeyboard *keyboard,
                                                         gint group,
                                                         gint level);

Warning

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.

keyboard :

 an EekKeyboard

group :

 row index of the symbol matrix of keys on keyboard

level :

 column index of the symbol matrix of keys on keyboard

eek_keyboard_get_symbol_index ()

void                eek_keyboard_get_symbol_index       (EekKeyboard *keyboard,
                                                         gint *group,
                                                         gint *level);

Warning

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.

keyboard :

 an EekKeyboard

group :

 a pointer where the group value of the symbol index will be stored

level :

 a pointer where the level value of the symbol index will be stored

eek_keyboard_set_group ()

void                eek_keyboard_set_group              (EekKeyboard *keyboard,
                                                         gint group);

Warning

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()

keyboard :

 an EekKeyboard

group :

 group index of keyboard

eek_keyboard_set_level ()

void                eek_keyboard_set_level              (EekKeyboard *keyboard,
                                                         gint level);

Warning

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()

keyboard :

 an EekKeyboard

level :

 level index of keyboard

eek_keyboard_get_group ()

gint                eek_keyboard_get_group              (EekKeyboard *keyboard);

Warning

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()

keyboard :

 an EekKeyboard

eek_keyboard_get_level ()

gint                eek_keyboard_get_level              (EekKeyboard *keyboard);

Warning

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()

keyboard :

 an EekKeyboard

eek_keyboard_set_modifier_behavior ()

void                eek_keyboard_set_modifier_behavior  (EekKeyboard *keyboard,
                                                         EekModifierBehavior modifier_behavior);

Set the modifier handling mode of keyboard.

keyboard :

 an EekKeyboard

modifier_behavior :

 modifier behavior of keyboard

eek_keyboard_get_modifier_behavior ()

EekModifierBehavior  eek_keyboard_get_modifier_behavior (EekKeyboard *keyboard);

Get the modifier handling mode of keyboard.

keyboard :

 an EekKeyboard

Returns :

 EekModifierBehavior

eek_keyboard_get_modifiers ()

EekModifierType     eek_keyboard_get_modifiers          (EekKeyboard *keyboard);

Get the current modifier status of keyboard.

keyboard :

 an EekKeyboard

Returns :

 EekModifierType

eek_keyboard_create_section ()

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.

keyboard :

 an EekKeyboard

eek_keyboard_find_key_by_keycode ()

EekKey *            eek_keyboard_find_key_by_keycode    (EekKeyboard *keyboard,
                                                         guint keycode);

Find an EekKey whose keycode is keycode.

keyboard :

 an EekKeyboard

keycode :

 a keycode

returns :

 EekKey whose keycode is keycode. [transfer none]

eek_keyboard_add_outline ()

gulong              eek_keyboard_add_outline            (EekKeyboard *keyboard,
                                                         EekOutline *outline);

Register an outline of keyboard.

keyboard :

 an EekKeyboard

outline :

 an EekOutline

Returns :

 an unsigned long id of the registered outline, for later reference

eek_keyboard_get_outline ()

EekOutline *        eek_keyboard_get_outline            (EekKeyboard *keyboard,
                                                         gulong oref);

Get an outline associated with oref in keyboard.

keyboard :

 an EekKeyboard

oref :

 an unsigned long id

Returns :

 an EekOutline, which should not be released

Property Details

The "layout" property

  "layout"                   EekLayout*            : Read / Write / Construct Only

The layout used to create this EekKeyboard.

The "modifier-behavior" property

  "modifier-behavior"        gint                  : Read / Write

The modifier handling mode of EekKeyboard.

Allowed values: >= 0

Default value: 0

Signal Details

The "key-pressed" signal

void                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.

keyboard :

 an EekKeyboard

key :

 an EekKey

user_data :

 user data set when the signal handler was connected.

The "key-released" signal

void                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.

keyboard :

 an EekKeyboard

key :

 an EekKey

user_data :

 user data set when the signal handler was connected.

See Also

EekSection
Generated by GTK-Doc V1.15