| libeek Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | ||||
EekSymbol; enum EekSymbolCategory; struct EekSymbolClass; EekSymbolCategory eek_symbol_category_from_name (const gchar *name); const gchar * eek_symbol_category_get_name (EekSymbolCategory category); EekSymbolCategory eek_symbol_get_category (EekSymbol *symbol); const gchar * eek_symbol_get_icon_name (EekSymbol *symbol); const gchar * eek_symbol_get_label (EekSymbol *symbol); EekModifierType eek_symbol_get_modifier_mask (EekSymbol *symbol); const gchar * eek_symbol_get_name (EekSymbol *symbol); gboolean eek_symbol_is_modifier (EekSymbol *symbol); EekSymbol * eek_symbol_new (const gchar *name); void eek_symbol_set_category (EekSymbol *symbol,EekSymbolCategory category); void eek_symbol_set_icon_name (EekSymbol *symbol,const gchar *icon_name); void eek_symbol_set_label (EekSymbol *symbol,const gchar *label); void eek_symbol_set_modifier_mask (EekSymbol *symbol,EekModifierType mask); void eek_symbol_set_name (EekSymbol *symbol,const gchar *name);
"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
typedef struct _EekSymbol EekSymbol;
The EekSymbol structure contains only private data and should only be accessed using the provided API.
typedef enum {
EEK_SYMBOL_CATEGORY_LETTER,
EEK_SYMBOL_CATEGORY_FUNCTION,
EEK_SYMBOL_CATEGORY_KEYNAME,
EEK_SYMBOL_CATEGORY_USER0,
EEK_SYMBOL_CATEGORY_USER1,
EEK_SYMBOL_CATEGORY_USER2,
EEK_SYMBOL_CATEGORY_USER3,
EEK_SYMBOL_CATEGORY_USER4,
EEK_SYMBOL_CATEGORY_UNKNOWN,
EEK_SYMBOL_CATEGORY_LAST = EEK_SYMBOL_CATEGORY_UNKNOWN
} EekSymbolCategory;
Category of the key symbols.
| the symbol represents an alphabet letter | |
| the symbol represents a function | |
| the symbol does not have meaning but have a name | |
| reserved for future use | |
| reserved for future use | |
| reserved for future use | |
| reserved for future use | |
| reserved for future use | |
| used for error reporting | |
| the last symbol category |
EekSymbolCategory eek_symbol_category_from_name (const gchar *name);
const gchar * eek_symbol_category_get_name (EekSymbolCategory category);
EekSymbolCategory eek_symbol_get_category (EekSymbol *symbol);
Get symbol category of symbol.
|
an EekSymbol |
const gchar * eek_symbol_get_icon_name (EekSymbol *symbol);
Get the icon name of symbol.
|
an EekSymbol |
const gchar * eek_symbol_get_label (EekSymbol *symbol);
Get the label text of symbol.
|
an EekSymbol |
EekModifierType eek_symbol_get_modifier_mask (EekSymbol *symbol);
Get modifier mask that symbol can trigger.
|
an EekSymbol |
const gchar * eek_symbol_get_name (EekSymbol *symbol);
Get the name of symbol.
|
an EekSymbol |
gboolean eek_symbol_is_modifier (EekSymbol *symbol);
Check if symbol is a modifier.
EekSymbol * eek_symbol_new (const gchar *name);
Create a new EekSymbol with name.
|
name of the symbol |
void eek_symbol_set_category (EekSymbol *symbol,EekSymbolCategory category);
Set symbol category of symbol to category.
|
an EekSymbol |
|
an EekSymbolCategory |
void eek_symbol_set_icon_name (EekSymbol *symbol,const gchar *icon_name);
Set the icon name of symbol to icon_name.
|
an EekSymbol |
|
icon name of symbol
|
void eek_symbol_set_label (EekSymbol *symbol,const gchar *label);
Set the label text of symbol to label.
|
an EekSymbol |
|
label text of symbol
|
void eek_symbol_set_modifier_mask (EekSymbol *symbol,EekModifierType mask);
Set modifier mask that symbol can trigger.
|
an EekSymbol |
|
an EekModifierType |
"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