XklConfigRegistry

XklConfigRegistry —

Synopsis




            XklConfigRegistryPrivate;
            XklConfigRegistry;
gboolean    xkl_config_registry_load        (XklConfigRegistry *config);
void        xkl_config_registry_foreach_model
                                            (XklConfigRegistry *config,
                                             ConfigItemProcessFuncfunc,
                                             gpointer data);
void        xkl_config_registry_foreach_layout
                                            (XklConfigRegistry *config,
                                             ConfigItemProcessFuncfunc,
                                             gpointer data);
void        xkl_config_registry_foreach_layout_variant
                                            (XklConfigRegistry *config,
                                             const gchar *layout_name,
                                             ConfigItemProcessFuncfunc,
                                             gpointer data);
void        xkl_config_registry_foreach_option_group
                                            (XklConfigRegistry *config,
                                             ConfigItemProcessFuncfunc,
                                             gpointer data);
void        xkl_config_registry_foreach_option
                                            (XklConfigRegistry *config,
                                             const gchar *option_group_name,
                                             ConfigItemProcessFuncfunc,
                                             gpointer data);
gboolean    xkl_config_registry_find_model  (XklConfigRegistry *config,
                                             XklConfigItem *item);
gboolean    xkl_config_registry_find_layout (XklConfigRegistry *config,
                                             XklConfigItem *item);
gboolean    xkl_config_registry_find_variant
                                            (XklConfigRegistry *config,
                                             const char *layout_name,
                                             XklConfigItem *item);
gboolean    xkl_config_registry_find_option_group
                                            (XklConfigRegistry *config,
                                             XklConfigItem *item);
gboolean    xkl_config_registry_find_option (XklConfigRegistry *config,
                                             const gchar *option_group_name,
                                             XklConfigItem *item);

Description

Details

XklConfigRegistryPrivate

typedef struct _XklConfigRegistryPrivate XklConfigRegistryPrivate;


XklConfigRegistry

typedef struct {
/**
 * The superclass object
 */
		GObject parent;

		XklConfigRegistryPrivate *priv;
} XklConfigRegistry;


xkl_config_registry_load ()

gboolean    xkl_config_registry_load        (XklConfigRegistry *config);

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

config : the config registry
Returns : TRUE on success

xkl_config_registry_foreach_model ()

void        xkl_config_registry_foreach_model
                                            (XklConfigRegistry *config,
                                             ConfigItemProcessFuncfunc,
                                             gpointer data);

Enumerates keyboard models from the XML configuration registry

config : the config registry
Param2 :
data : anything which can be stored into the pointer

xkl_config_registry_foreach_layout ()

void        xkl_config_registry_foreach_layout
                                            (XklConfigRegistry *config,
                                             ConfigItemProcessFuncfunc,
                                             gpointer data);

Enumerates keyboard layouts from the XML configuration registry

config : the config registry
Param2 :
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,
                                             ConfigItemProcessFuncfunc,
                                             gpointer data);

Enumerates keyboard layout variants from the XML configuration registry

config : the config registry
layout_name : layout name for which variants will be listed
Param3 :
data : anything which can be stored into the pointer

xkl_config_registry_foreach_option_group ()

void        xkl_config_registry_foreach_option_group
                                            (XklConfigRegistry *config,
                                             ConfigItemProcessFuncfunc,
                                             gpointer data);

Enumerates keyboard option groups from the XML configuration registry

config : the config registry
Param2 :
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,
                                             ConfigItemProcessFuncfunc,
                                             gpointer data);

Enumerates keyboard options from the XML configuration registry

config : the config registry
option_group_name : option group name for which variants will be listed
Param3 :
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.

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.

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.

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.

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.

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