XklConfigRegistry: Libxklavier Reference Manual

XklConfigRegistry

Functions

gboolean	xkl_config_registry_load ()
void	(*XklConfigItemProcessFunc) ()
void	(*XklTwoConfigItemsProcessFunc) ()
void	xkl_config_registry_foreach_model ()
void	xkl_config_registry_foreach_layout ()
void	xkl_config_registry_foreach_layout_variant ()
void	xkl_config_registry_foreach_option_group ()
void	xkl_config_registry_foreach_option ()
gboolean	xkl_config_registry_find_model ()
gboolean	xkl_config_registry_find_layout ()
gboolean	xkl_config_registry_find_variant ()
gboolean	xkl_config_registry_find_option_group ()
gboolean	xkl_config_registry_find_option ()
void	xkl_config_registry_foreach_country ()
void	xkl_config_registry_foreach_country_variant ()
void	xkl_config_registry_foreach_language ()
void	xkl_config_registry_foreach_language_variant ()
void	xkl_config_registry_search_by_pattern ()

Properties

XklEngine *

engine

Read / Write / Construct Only

Types and Values

	XklConfigRegistryPrivate
struct	XklConfigRegistry

Object Hierarchy

    GObject
    ╰── XklConfigRegistry

Description

Functions

xkl_config_registry_load ()

gboolean
xkl_config_registry_load (XklConfigRegistry *config,
                          gboolean if_extras_needed);

Loads XML configuration registry. The name is taken from X server (for XKB/libxkbfile, from the root window property)

Parameters

config	the config registry
if_extras_needed	whether exotic materials (layouts, options) should be loaded as well

Returns

TRUE on success

XklConfigItemProcessFunc ()

void
(*XklConfigItemProcessFunc) (XklConfigRegistry *config,
                             const XklConfigItem *item,
                             gpointer data);

Callback type used for enumerating keyboard models, layouts, variants, options

Parameters

config	the config registry
item	the item from registry
data	anything which can be stored into the pointer

XklTwoConfigItemsProcessFunc ()

void
(*XklTwoConfigItemsProcessFunc) (XklConfigRegistry *config,
                                 const XklConfigItem *item,
                                 const XklConfigItem *subitem,
                                 gpointer data);

Callback type used for enumerating layouts/variants for countries/languages

Parameters

config	the config registry
item	the item from registry
subitem	the item from registry
data	anything which can be stored into the pointer

xkl_config_registry_foreach_model ()

void
xkl_config_registry_foreach_model (XklConfigRegistry *config,
                                   XklConfigItemProcessFunc func,
                                   gpointer data);

Enumerates keyboard models from the XML configuration registry

Parameters

config	the config registry
func	callback to call for every model.	[scope call]
data	anything which can be stored into the pointer

xkl_config_registry_foreach_layout ()

void
xkl_config_registry_foreach_layout (XklConfigRegistry *config,
                                    XklConfigItemProcessFunc func,
                                    gpointer data);

Enumerates keyboard layouts from the XML configuration registry

Parameters

config	the config registry
func	callback to call for every layout.	[scope call]
data	anything which can be stored into the pointer

xkl_config_registry_foreach_layout_variant ()

void
xkl_config_registry_foreach_layout_variant
                               (XklConfigRegistry *config,
                                const gchar *layout_name,
                                XklConfigItemProcessFunc func,
                                gpointer data);

Enumerates keyboard layout variants from the XML configuration registry

Parameters

config	the config registry
layout_name	layout name for which variants will be listed
func	callback to call for every layout variant.	[scope call]
data	anything which can be stored into the pointer

xkl_config_registry_foreach_option_group ()

void
xkl_config_registry_foreach_option_group
                               (XklConfigRegistry *config,
                                XklConfigItemProcessFunc func,
                                gpointer data);

Enumerates keyboard option groups from the XML configuration registry

Parameters

config	the config registry
func	callback to call for every option group.	[scope call]
data	anything which can be stored into the pointer

xkl_config_registry_foreach_option ()

void
xkl_config_registry_foreach_option (XklConfigRegistry *config,
                                    const gchar *option_group_name,
                                    XklConfigItemProcessFunc func,
                                    gpointer data);

Enumerates keyboard options from the XML configuration registry

Parameters

config	the config registry
option_group_name	option group name for which variants will be listed
func	callback to call for every option.	[scope call]
data	anything which can be stored into the pointer

xkl_config_registry_find_model ()

gboolean
xkl_config_registry_find_model (XklConfigRegistry *config,
                                XklConfigItem *item);

Loads a keyboard model information from the XML configuration registry.

Parameters

config	the config registry
item	pointer to a XklConfigItem containing the name of the keyboard model. On successfull return, the descriptions are filled.

Returns

TRUE if appropriate element was found and loaded

xkl_config_registry_find_layout ()

gboolean
xkl_config_registry_find_layout (XklConfigRegistry *config,
                                 XklConfigItem *item);

Loads a keyboard layout information from the XML configuration registry.

Parameters

config	the config registry
item	pointer to a XklConfigItem containing the name of the keyboard layout. On successfull return, the descriptions are filled.

Returns

TRUE if appropriate element was found and loaded

xkl_config_registry_find_variant ()

gboolean
xkl_config_registry_find_variant (XklConfigRegistry *config,
                                  const char *layout_name,
                                  XklConfigItem *item);

Loads a keyboard layout variant information from the XML configuration registry.

Parameters

config	the config registry
layout_name	name of the parent layout
item	pointer to a XklConfigItem containing the name of the keyboard layout variant. On successfull return, the descriptions are filled.

Returns

TRUE if appropriate element was found and loaded

xkl_config_registry_find_option_group ()

gboolean
xkl_config_registry_find_option_group (XklConfigRegistry *config,
                                       XklConfigItem *item);

Loads a keyboard option group information from the XML configuration registry.

Parameters

config	the config registry
item	pointer to a XklConfigItem containing the name of the keyboard option group. On successfull return, the descriptions are filled.

Returns

TRUE if appropriate element was found and loaded

xkl_config_registry_find_option ()

gboolean
xkl_config_registry_find_option (XklConfigRegistry *config,
                                 const gchar *option_group_name,
                                 XklConfigItem *item);

Loads a keyboard option information from the XML configuration registry.

Parameters

config	the config registry
option_group_name	name of the option group
item	pointer to a XklConfigItem containing the name of the keyboard option. On successfull return, the descriptions are filled.

Returns

TRUE if appropriate element was found and loaded

xkl_config_registry_foreach_country ()

void
xkl_config_registry_foreach_country (XklConfigRegistry *config,
                                     XklConfigItemProcessFunc func,
                                     gpointer data);

Enumerates countries for which layouts are available, from the XML configuration registry

Parameters

config	the config registry
func	callback to call for every ISO 3166 country code.	[scope call]
data	anything which can be stored into the pointer

xkl_config_registry_foreach_country_variant ()

void
xkl_config_registry_foreach_country_variant
                               (XklConfigRegistry *config,
                                const gchar *country_code,
                                XklTwoConfigItemsProcessFunc func,
                                gpointer data);

Enumerates keyboard layout variants for the country, from the XML configuration registry

Parameters

config	the config registry
country_code	country ISO code for which variants will be listed
func	callback to call for every country variant.	[scope call]
data	anything which can be stored into the pointer

xkl_config_registry_foreach_language ()

void
xkl_config_registry_foreach_language (XklConfigRegistry *config,
                                      XklConfigItemProcessFunc func,
                                      gpointer data);

Enumerates languages for which layouts are available, from the XML configuration registry

Parameters

config	the config registry
func	callback to call for every ISO 639-2 country code.	[scope call]
data	anything which can be stored into the pointer

xkl_config_registry_foreach_language_variant ()

void
xkl_config_registry_foreach_language_variant
                               (XklConfigRegistry *config,
                                const gchar *language_code,
                                XklTwoConfigItemsProcessFunc func,
                                gpointer data);

Enumerates keyboard layout variants for the language, from the XML configuration registry

Parameters

config	the config registry
language_code	language ISO code for which variants will be listed
func	callback to call for every country variant.	[scope call]
data	anything which can be stored into the pointer

xkl_config_registry_search_by_pattern ()

void
xkl_config_registry_search_by_pattern (XklConfigRegistry *config,
                                       const gchar *pattern,
                                       XklTwoConfigItemsProcessFunc func,
                                       gpointer data);

Enumerates keyboard layout/variants that match the pattern. The layout/variant is considered as matching if one of the following is true:

Country description (from the country list or name) contains pattern as substring
Language description (from the language list or name) contains pattern as substring

Parameters

config	the config registry
pattern	pattern to search for (NULL means "all")
func	callback to call for every matching layout/variant.	[scope call]
data	anything which can be stored into the pointer

Types and Values

XklConfigRegistryPrivate

typedef struct _XklConfigRegistryPrivate XklConfigRegistryPrivate;

struct XklConfigRegistry

struct XklConfigRegistry;

Property Details

The `“engine”` property

  “engine”                   XklEngine *

XklEngine.

Owner: XklConfigRegistry

Flags: Read / Write / Construct Only