EekLayout

EekLayout — Base interface of a layout engine

Synopsis

                    EekLayoutIface;
                    EekLayout;
void                eek_layout_apply                    (EekLayout *layout,
                                                         EekKeyboard *keyboard);
gint                eek_layout_get_group                (EekLayout *layout);

Description

The EekLayout class is a base interface of layout engine which arranges keyboard elements.

Details

EekLayoutIface

typedef struct {
    void (* apply)         (EekLayout   *self,
                            EekKeyboard *keyboard);
    gint (* get_group)     (EekLayout   *self);

    /* signals */
    void (* group_changed) (EekLayout   *self,
                            gint         group);
    void (* changed)       (EekLayout   *self);
} EekLayoutIface;

`apply` ()	virtual function for applying the layout to a keyboard
`get_group` ()	virtual function for getting the current group setting of the layout
`group_changed` ()	class handler for "group-changed" signal
`changed` ()	class handler for "changed" signal

EekLayout

typedef struct _EekLayout EekLayout;

eek_layout_apply ()

void                eek_layout_apply                    (EekLayout *layout,
                                                         EekKeyboard *keyboard);

Apply layout to keyboard. This function is rarely called by user programs but called by the subclasses of EekKeyboard.

`layout` :	an EekLayout
`keyboard` :	an EekKeyboard

eek_layout_get_group ()

gint                eek_layout_get_group                (EekLayout *layout);

Get the group index from the layout. This function normally called after "group-changed" signal to change group index of all the keys in EekKeyboard at a time.

layout :

an EekLayout

			libeek Reference Manual
Top \| Description