![]() |
![]() |
![]() |
libeek Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
#define EEK_INVALID_KEYCODE struct EekBounds; struct EekColor; EekContainer; EekElement; enum EekGradientType; EekKey; EekKeyboard; EekKeysym; enum EekModifierBehavior; enum EekModifierType; enum EekOrientation; struct EekOutline; struct EekPoint; EekSection; EekSymbol; EekSymbolMatrix; EekText; EekTheme; EekThemeContext; EekThemeNode; #define I_ (string) EekBounds * eek_bounds_copy (const EekBounds *bounds
); void eek_bounds_free (EekBounds *bounds
); gdouble eek_bounds_long_side (EekBounds *bounds
); EekColor * eek_color_copy (const EekColor *color
); void eek_color_free (EekColor *color
); EekColor * eek_color_new (gdouble red
,gdouble green
,gdouble blue
,gdouble alpha
); EekOutline * eek_outline_copy (const EekOutline *outline
); void eek_outline_free (EekOutline *outline
); EekPoint * eek_point_copy (const EekPoint *point
); void eek_point_free (EekPoint *point
); void eek_point_rotate (EekPoint *point
,gint angle
);
GBoxed +----EekBounds
GBoxed +----EekColor
GObject +----EekElement +----EekContainer +----EekKeyboard +----EekSection
GObject +----EekElement +----EekContainer +----EekKey
GObject +----EekElement +----EekKey
GObject +----EekElement +----EekContainer +----EekKeyboard
GObject +----EekSymbol +----EekKeysym
GBoxed +----EekOutline
GBoxed +----EekPoint
GObject +----EekElement +----EekContainer +----EekSection
GObject +----EekSymbol +----EekKeysym +----EekText
GBoxed +----EekSymbolMatrix
GObject +----EekSymbol +----EekText
GObject +----EekThemeContext
EekKeysym implements EekSerializable.
EekSymbol implements EekSerializable.
EekText implements EekSerializable.
"bounds" EekBounds* : Read / Write "group" gint : Read / Write "level" gint : Read / Write "name" gchar* : Read / Write "column" gint : Read / Write "keycode" guint : Read / Write "oref" gulong : Read / Write "row" gint : Read / Write "symbol-matrix" EekSymbolMatrix* : Read / Write "layout" EekLayout* : Read / Write / Construct Only "modifier-behavior" EekModifierBehavior : Read / Write "angle" gint : Read / Write "category" EekSymbolCategory : Read / Write / Construct "icon-name" gchar* : Read / Write / Construct "label" gchar* : Read / Write / Construct "modifier-mask" EekModifierType : Read / Write / Construct "name" gchar* : Read / Write / Construct "tooltip" gchar* : Read / Write / Construct "text" gchar* : Read / Write / Construct Only
"child-added" :Run First
"child-removed" :Run First
"symbol-index-changed" :Run Last
"cancelled" :Run Last
"locked" :Run First
"pressed" :Run First
"released" :Run Last
"unlocked" :Run Last
"key-cancelled" :Run Last
"key-locked" :Run Last
"key-pressed" :Run Last
"key-released" :Run Last
"key-unlocked" :Run Last
"key-cancelled" :Run Last
"key-locked" :Run Last
"key-pressed" :Run Last
"key-released" :Run Last
"key-unlocked" :Run Last
"changed" :Run Last
struct EekBounds { gdouble x; gdouble y; gdouble width; gdouble height; };
The rectangle containing an element's bounding box.
struct EekColor { gdouble red; gdouble green; gdouble blue; gdouble alpha; };
Color used for drawing.
typedef enum { EEK_GRADIENT_NONE, EEK_GRADIENT_VERTICAL, EEK_GRADIENT_HORIZONTAL, EEK_GRADIENT_RADIAL } EekGradientType;
typedef struct _EekKey EekKey;
The EekKey structure contains only private data and should only be accessed using the provided API.
typedef struct _EekKeyboard EekKeyboard;
The EekKeyboard structure contains only private data and should only be accessed using the provided API.
typedef struct _EekKeysym EekKeysym;
The EekKeysym structure contains only private data and should only be accessed using the provided API.
typedef enum { EEK_MODIFIER_BEHAVIOR_NONE, EEK_MODIFIER_BEHAVIOR_LOCK, EEK_MODIFIER_BEHAVIOR_LATCH } EekModifierBehavior;
Modifier handling mode.
typedef enum { EEK_SHIFT_MASK = 1 << 0, EEK_LOCK_MASK = 1 << 1, EEK_CONTROL_MASK = 1 << 2, EEK_MOD1_MASK = 1 << 3, EEK_MOD2_MASK = 1 << 4, EEK_MOD3_MASK = 1 << 5, EEK_MOD4_MASK = 1 << 6, EEK_MOD5_MASK = 1 << 7, EEK_BUTTON1_MASK = 1 << 8, EEK_BUTTON2_MASK = 1 << 9, EEK_BUTTON3_MASK = 1 << 10, EEK_BUTTON4_MASK = 1 << 11, EEK_BUTTON5_MASK = 1 << 12, /* The next few modifiers are used by XKB, so we skip to the end. * Bits 15 - 25 are currently unused. Bit 29 is used internally. */ EEK_SUPER_MASK = 1 << 26, EEK_HYPER_MASK = 1 << 27, EEK_META_MASK = 1 << 28, EEK_RELEASE_MASK = 1 << 30, EEK_MODIFIER_MASK = 0x5c001fff } EekModifierType;
the Shift key. | |
a Lock key (depending on the modifier mapping of the X server this may either be CapsLock or ShiftLock). | |
the Control key. | |
the fourth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier, but normally it is the Alt key). | |
the fifth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier). | |
the sixth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier). | |
the seventh modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier). | |
the eighth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier). | |
the first mouse button. | |
the second mouse button. | |
the third mouse button. | |
the fourth mouse button. | |
the fifth mouse button. | |
the Super modifier. Since 2.10 | |
the Hyper modifier. Since 2.10 | |
the Meta modifier. Since 2.10 | |
not used in EEK itself. GTK+ uses it to differentiate between (keyval, modifiers) pairs from key press and release events. | |
a mask covering all modifier types. |
typedef enum { EEK_ORIENTATION_VERTICAL, EEK_ORIENTATION_HORIZONTAL, EEK_ORIENTATION_INVALID = -1 } EekOrientation;
Orientation of rows in sections. Elements in a row will be arranged with the specified orientation.
struct EekOutline { gdouble corner_radius; EekPoint *points; gint num_points; };
2D rounded polygon used to draw key shape
typedef struct _EekSection EekSection;
The EekSection structure contains only private data and should only be accessed using the provided API.
typedef struct _EekSymbol EekSymbol;
The EekSymbol structure contains only private data and should only be accessed using the provided API.
typedef struct { gint num_groups; gint num_levels; EekSymbol **data; } EekSymbolMatrix;
Symbol matrix of a key.
typedef struct _EekText EekText;
The EekText structure contains only private data and should only be accessed using the provided API.
EekColor * eek_color_new (gdouble red
,gdouble green
,gdouble blue
,gdouble alpha
);
"group"
property"group" gint : Read / Write
The group value of the symbol index of EekElement.
Allowed values: >= G_MAXULONG
Default value: -1
"level"
property"level" gint : Read / Write
The level value of the symbol index of EekElement.
Allowed values: >= G_MAXULONG
Default value: -1
"column"
property"column" gint : Read / Write
The column index of EekKey in the parent EekSection.
Allowed values: >= G_MAXULONG
Default value: -1
"row"
property"row" gint : Read / Write
The row index of EekKey in the parent EekSection.
Allowed values: >= G_MAXULONG
Default value: -1
"symbol-matrix"
property"symbol-matrix" EekSymbolMatrix* : Read / Write
The symbol matrix of EekKey.
"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
"angle"
property"angle" gint : Read / Write
The rotation angle of EekSection.
Allowed values: [-360,360]
Default value: 0
"category"
property"category" EekSymbolCategory : Read / Write / Construct
Category of the symbol.
Default value: EEK_SYMBOL_CATEGORY_UNKNOWN
"icon-name"
property"icon-name" gchar* : Read / Write / Construct
Icon name used to render the symbol.
Default value: NULL
"label"
property"label" gchar* : Read / Write / Construct
Text used to display the symbol.
Default value: NULL
"modifier-mask"
property"modifier-mask" EekModifierType : Read / Write / Construct
Modifier mask of the symbol.
"name"
property"name" gchar* : Read / Write / Construct
Canonical name of the symbol.
Default value: NULL
"tooltip"
property"tooltip" gchar* : Read / Write / Construct
Tooltip text.
Default value: NULL
"child-added"
signalvoid user_function (EekContainer *container,
EekElement *element,
gpointer user_data) : Run First
The ::child-added signal is emitted each time an element is
added to container
.
|
an EekContainer |
|
an EekElement |
|
user data set when the signal handler was connected. |
"child-removed"
signalvoid user_function (EekContainer *container,
EekElement *element,
gpointer user_data) : Run First
The ::child-removed signal is emitted each time an element is
removed from container
.
|
an EekContainer |
|
an EekElement |
|
user data set when the signal handler was connected. |
"symbol-index-changed"
signalvoid user_function (EekElement *element,
gint group,
gint level,
gpointer user_data) : Run Last
The ::symbol-index-changed signal is emitted each time the global configuration of group/level index changes.
|
an EekElement |
|
row index of the symbol matrix of keys on element
|
|
column index of the symbol matrix of keys on element
|
|
user data set when the signal handler was connected. |
"cancelled"
signalvoid user_function (EekKey *key,
gpointer user_data) : Run Last
The ::cancelled signal is emitted each time key
is shifted to
the cancelled state.
|
an EekKey |
|
user data set when the signal handler was connected. |
"locked"
signalvoid user_function (EekKey *key,
gpointer user_data) : Run First
The ::locked signal is emitted each time key
is shifted to
the locked state. The class handler runs before signal
handlers to allow signal handlers to read the status of key
with eek_key_is_locked()
.
|
an EekKey |
|
user data set when the signal handler was connected. |
"pressed"
signalvoid user_function (EekKey *key,
gpointer user_data) : Run First
The ::pressed signal is emitted each time key
is shifted to
the pressed state. The class handler runs before signal
handlers to allow signal handlers to read the status of key
with eek_key_is_pressed()
.
|
an EekKey |
|
user data set when the signal handler was connected. |
"released"
signalvoid user_function (EekKey *key,
gpointer user_data) : Run Last
The ::released signal is emitted each time key
is shifted to
the released state.
|
an EekKey |
|
user data set when the signal handler was connected. |
"unlocked"
signalvoid user_function (EekKey *key,
gpointer user_data) : Run Last
The ::unlocked signal is emitted each time key
is shifted to
the unlocked state.
|
an EekKey |
|
user data set when the signal handler was connected. |
"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. |
"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. |
"changed"
signalvoid user_function (EekThemeContext *eekthemecontext,
gpointer user_data) : Run Last