EekSymbol: libeek Reference Manual

Functions

EekSymbolCategory	eek_symbol_category_from_name ()
const gchar *	eek_symbol_category_get_name ()
EekSymbolCategory	eek_symbol_get_category ()
const gchar *	eek_symbol_get_icon_name ()
const gchar *	eek_symbol_get_label ()
EekModifierType	eek_symbol_get_modifier_mask ()
const gchar *	eek_symbol_get_name ()
gboolean	eek_symbol_is_modifier ()
EekSymbol *	eek_symbol_new ()
void	eek_symbol_set_category ()
void	eek_symbol_set_icon_name ()
void	eek_symbol_set_label ()
void	eek_symbol_set_modifier_mask ()
void	eek_symbol_set_name ()

Properties

EekSymbolCategory	category	Read / Write / Construct
char *	icon-name	Read / Write / Construct
char *	label	Read / Write / Construct
EekModifierType	modifier-mask	Read / Write / Construct
char *	name	Read / Write / Construct
char *	tooltip	Read / Write / Construct

Types and Values

	EekSymbol
enum	EekSymbolCategory
struct	EekSymbolClass

Object Hierarchy

    GObject
    ╰── EekSymbol
        ├── EekKeysym
        ╰── EekText

Implemented Interfaces

EekSymbol implements EekSerializable.

Description

The EekSymbolClass class represents a symbol assigned to a key.

Functions

eek_symbol_category_from_name ()

EekSymbolCategory
eek_symbol_category_from_name (const gchar *name);

eek_symbol_category_get_name ()

const gchar *
eek_symbol_category_get_name (EekSymbolCategory category);

eek_symbol_get_category ()

EekSymbolCategory
eek_symbol_get_category (EekSymbol *symbol);

Get symbol category of symbol .

Parameters

symbol

an EekSymbol

eek_symbol_get_icon_name ()

const gchar *
eek_symbol_get_icon_name (EekSymbol *symbol);

Get the icon name of symbol .

Parameters

symbol

an EekSymbol

eek_symbol_get_label ()

const gchar *
eek_symbol_get_label (EekSymbol *symbol);

Get the label text of symbol .

Parameters

symbol

an EekSymbol

eek_symbol_get_modifier_mask ()

EekModifierType
eek_symbol_get_modifier_mask (EekSymbol *symbol);

Get modifier mask that symbol can trigger.

Parameters

symbol

an EekSymbol

eek_symbol_get_name ()

const gchar *
eek_symbol_get_name (EekSymbol *symbol);

Get the name of symbol .

Parameters

symbol

an EekSymbol

eek_symbol_is_modifier ()

gboolean
eek_symbol_is_modifier (EekSymbol *symbol);

Check if symbol is a modifier.

Parameters

symbol

an EekSymbol

Returns

TRUE if symbol is a modifier.

eek_symbol_new ()

EekSymbol *
eek_symbol_new (const gchar *name);

Create a new EekSymbol with name .

Parameters

name

name of the symbol

eek_symbol_set_category ()

void
eek_symbol_set_category (EekSymbol *symbol,
                         EekSymbolCategory category);

Set symbol category of symbol to category .

Parameters

symbol	an EekSymbol
category	an EekSymbolCategory

eek_symbol_set_icon_name ()

void
eek_symbol_set_icon_name (EekSymbol *symbol,
                          const gchar *icon_name);

Set the icon name of symbol to icon_name .

Parameters

symbol	an EekSymbol
icon_name	icon name of `symbol`

eek_symbol_set_label ()

void
eek_symbol_set_label (EekSymbol *symbol,
                      const gchar *label);

Set the label text of symbol to label .

Parameters

symbol	an EekSymbol
label	label text of `symbol`

eek_symbol_set_modifier_mask ()

void
eek_symbol_set_modifier_mask (EekSymbol *symbol,
                              EekModifierType mask);

Set modifier mask that symbol can trigger.

Parameters

symbol	an EekSymbol
mask	an EekModifierType

eek_symbol_set_name ()

void
eek_symbol_set_name (EekSymbol *symbol,
                     const gchar *name);

Set the name of symbol to name .

Parameters

symbol	an EekSymbol
name	name of the symbol

Types and Values

EekSymbol

typedef struct _EekSymbol EekSymbol;

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

enum EekSymbolCategory

Category of the key symbols.

Members

EEK_SYMBOL_CATEGORY_LETTER	the symbol represents an alphabet letter
EEK_SYMBOL_CATEGORY_FUNCTION	the symbol represents a function
EEK_SYMBOL_CATEGORY_KEYNAME	the symbol does not have meaning but have a name
EEK_SYMBOL_CATEGORY_USER0	reserved for future use
EEK_SYMBOL_CATEGORY_USER1	reserved for future use
EEK_SYMBOL_CATEGORY_USER2	reserved for future use
EEK_SYMBOL_CATEGORY_USER3	reserved for future use
EEK_SYMBOL_CATEGORY_USER4	reserved for future use
EEK_SYMBOL_CATEGORY_UNKNOWN	used for error reporting
EEK_SYMBOL_CATEGORY_LAST	the last symbol category

struct EekSymbolClass

struct EekSymbolClass {
};

Property Details