EekElement

EekElement — Base class of a keyboard element

Functions

Properties

EekBounds * bounds Read / Write
int group Read / Write
int level Read / Write
char * name Read / Write

Signals

void symbol-index-changed Run Last

Types and Values

Object Hierarchy

    GObject
    ╰── EekElement
        ├── EekContainer
        ╰── EekKey

Description

The EekElementClass class represents a keyboard element, which shall be used to implement EekKeyboard, EekSection, or EekKey.

Functions

eek_element_get_absolute_position ()

void
eek_element_get_absolute_position (EekElement *element,
                                   gdouble *x,
                                   gdouble *y);

Compute the absolute position of element .

Parameters

element

an EekElement

 

x

pointer where the X coordinate of element will be stored

 

y

pointer where the Y coordinate of element will be stored

 

eek_element_get_bounds ()

void
eek_element_get_bounds (EekElement *element,
                        EekBounds *bounds);

Get the bounding box of element . Note that if element has parent, position of bounds are relative to the parent. To obtain the absolute position, use eek_element_get_absolute_position().

Parameters

element

an EekElement

 

bounds

pointer where bounding box of element will be stored.

[out]

eek_element_get_group ()

gint
eek_element_get_group (EekElement *element);

Return the group value of the default symbol index of element . If the value is not set, -1 will be returned.

See also: eek_element_get_symbol_index()

Parameters

element

an EekElement

 

eek_element_get_level ()

gint
eek_element_get_level (EekElement *element);

Return the level value of the default symbol index of element . If the value is not set, -1 will be returned.

See also: eek_element_get_symbol_index()

Parameters

element

an EekElement

 

eek_element_get_name ()

const gchar *
eek_element_get_name (EekElement *element);

Get the name of element .

Parameters

element

an EekElement

 

Returns

the name of element or NULL when the name is not set


eek_element_get_parent ()

EekElement *
eek_element_get_parent (EekElement *element);

Get the parent of element .

Parameters

element

an EekElement

 

Returns

an EekElement if the parent is set


eek_element_get_symbol_index ()

void
eek_element_get_symbol_index (EekElement *element,
                              gint *group,
                              gint *level);

Get the default index of the symbol matrices of element . If the index is not set, -1 will be returned.

Parameters

element

an EekElement

 

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

void
eek_element_set_bounds (EekElement *element,
                        EekBounds *bounds);

Set the bounding box of element to bounds . Note that if element has parent, X and Y positions of bounds are relative to the parent position.

Parameters

element

an EekElement

 

bounds

bounding box of element

 

eek_element_set_group ()

void
eek_element_set_group (EekElement *element,
                       gint group);

Set the group value of the default symbol index of element . To unset, pass -1 as group .

See also: eek_element_set_symbol_index()

Parameters

element

an EekElement

 

group

group index of element

 

eek_element_set_level ()

void
eek_element_set_level (EekElement *element,
                       gint level);

Set the level value of the default symbol index of element . To unset, pass -1 as level .

See also: eek_element_set_symbol_index()

Parameters

element

an EekElement

 

level

level index of element

 

eek_element_set_name ()

void
eek_element_set_name (EekElement *element,
                      const gchar *name);

Set the name of element to name .

Parameters

element

an EekElement

 

name

name of element

 

eek_element_set_parent ()

void
eek_element_set_parent (EekElement *element,
                        EekElement *parent);

Set the parent of element to parent .

Parameters

element

an EekElement

 

parent

an EekElement or NULL.

[allow-none]

eek_element_set_position ()

void
eek_element_set_position (EekElement *element,
                          gdouble x,
                          gdouble y);

Set the relative position of element .

Parameters

element

an EekElement

 

x

X coordinate of top left corner

 

y

Y coordinate of top left corner

 

eek_element_set_size ()

void
eek_element_set_size (EekElement *element,
                      gdouble width,
                      gdouble height);

Set the size of element .

Parameters

element

an EekElement

 

width

width of element

 

height

height of element

 

eek_element_set_symbol_index ()

void
eek_element_set_symbol_index (EekElement *element,
                              gint group,
                              gint level);

Set the default index of the symbol matrices of element . The setting affects the child, if child does not have the index set, as well as this element. To unset, pass -1 as group/level.

Parameters

element

an EekElement

 

group

row index of the symbol matrix

 

level

column index of the symbol matrix

 

Types and Values

EekElement

typedef struct _EekElement EekElement;

struct EekElementClass

struct EekElementClass {
};

Property Details

The “bounds” property

  “bounds”                   EekBounds *

The bounding box of EekElement.

Owner: EekElement

Flags: Read / Write


The “group” property

  “group”                    int

The group value of the symbol index of EekElement.

Owner: EekElement

Flags: Read / Write

Allowed values: >= -1

Default value: -1


The “level” property

  “level”                    int

The level value of the symbol index of EekElement.

Owner: EekElement

Flags: Read / Write

Allowed values: >= -1

Default value: -1


The “name” property

  “name”                     char *

The name of EekElement.

Owner: EekElement

Flags: Read / Write

Default value: NULL

Signal Details

The “symbol-index-changed” signal

void
user_function (EekElement *element,
               int         group,
               int         level,
               gpointer    user_data)

The ::symbol-index-changed signal is emitted each time the global configuration of group/level index changes.

Parameters

element

an EekElement

 

group

row index of the symbol matrix of keys on element

 

level

column index of the symbol matrix of keys on element

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last