![]() |
![]() |
![]() |
Libxklavier Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
XklConfigRegistryPrivate; XklConfigRegistry; gboolean xkl_config_registry_load (XklConfigRegistry *config
,gboolean if_extras_needed
); void (*ConfigItemProcessFunc) (XklConfigRegistry *config
,const XklConfigItem *item
,gpointer data
); void (*TwoConfigItemsProcessFunc) (XklConfigRegistry *config
,const XklConfigItem *item
,const XklConfigItem *subitem
,gpointer data
); void xkl_config_registry_foreach_model (XklConfigRegistry *config
,ConfigItemProcessFunc func
,gpointer data
); void xkl_config_registry_foreach_layout (XklConfigRegistry *config
,ConfigItemProcessFunc func
,gpointer data
); void xkl_config_registry_foreach_layout_variant (XklConfigRegistry *config
,const gchar *layout_name
,ConfigItemProcessFunc func
,gpointer data
); void xkl_config_registry_foreach_option_group (XklConfigRegistry *config
,ConfigItemProcessFunc func
,gpointer data
); void xkl_config_registry_foreach_option (XklConfigRegistry *config
,const gchar *option_group_name
,ConfigItemProcessFunc func
,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
); void xkl_config_registry_foreach_country (XklConfigRegistry *config
,ConfigItemProcessFunc func
,gpointer data
); void xkl_config_registry_foreach_country_variant (XklConfigRegistry *config
,const gchar *country_code
,TwoConfigItemsProcessFunc func
,gpointer data
); void xkl_config_registry_foreach_language (XklConfigRegistry *config
,ConfigItemProcessFunc func
,gpointer data
); void xkl_config_registry_foreach_language_variant (XklConfigRegistry *config
,const gchar *language_code
,TwoConfigItemsProcessFunc func
,gpointer data
); void xkl_config_registry_search_by_pattern (XklConfigRegistry *config
,const gchar *pattern
,TwoConfigItemsProcessFunc func
,gpointer data
);
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)
|
the config registry |
|
whether exotic materials (layouts, options) should be loaded as well |
Returns : |
TRUE on success |
void (*ConfigItemProcessFunc) (XklConfigRegistry *config
,const XklConfigItem *item
,gpointer data
);
Callback type used for enumerating keyboard models, layouts, variants, options
|
the config registry |
|
the item from registry |
|
anything which can be stored into the pointer |
void (*TwoConfigItemsProcessFunc) (XklConfigRegistry *config
,const XklConfigItem *item
,const XklConfigItem *subitem
,gpointer data
);
Callback type used for enumerating layouts/variants for countries/languages
|
the config registry |
|
the item from registry |
|
the item from registry |
|
anything which can be stored into the pointer |
void xkl_config_registry_foreach_model (XklConfigRegistry *config
,ConfigItemProcessFunc func
,gpointer data
);
Enumerates keyboard models from the XML configuration registry
|
the config registry |
|
callback to call for every model |
|
anything which can be stored into the pointer |
void xkl_config_registry_foreach_layout (XklConfigRegistry *config
,ConfigItemProcessFunc func
,gpointer data
);
Enumerates keyboard layouts from the XML configuration registry
|
the config registry |
|
callback to call for every layout |
|
anything which can be stored into the pointer |
void xkl_config_registry_foreach_layout_variant (XklConfigRegistry *config
,const gchar *layout_name
,ConfigItemProcessFunc func
,gpointer data
);
Enumerates keyboard layout variants from the XML configuration registry
|
the config registry |
|
layout name for which variants will be listed |
|
callback to call for every layout variant |
|
anything which can be stored into the pointer |
void xkl_config_registry_foreach_option_group (XklConfigRegistry *config
,ConfigItemProcessFunc func
,gpointer data
);
Enumerates keyboard option groups from the XML configuration registry
|
the config registry |
|
callback to call for every option group |
|
anything which can be stored into the pointer |
void xkl_config_registry_foreach_option (XklConfigRegistry *config
,const gchar *option_group_name
,ConfigItemProcessFunc func
,gpointer data
);
Enumerates keyboard options from the XML configuration registry
|
the config registry |
|
option group name for which variants will be listed |
|
callback to call for every option |
|
anything which can be stored into the pointer |
gboolean xkl_config_registry_find_model (XklConfigRegistry *config
,XklConfigItem *item
);
Loads a keyboard model information from the XML configuration registry.
|
the config registry |
|
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 |
gboolean xkl_config_registry_find_layout (XklConfigRegistry *config
,XklConfigItem *item
);
Loads a keyboard layout information from the XML configuration registry.
|
the config registry |
|
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 |
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.
|
the config registry |
|
name of the parent layout |
|
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 |
gboolean xkl_config_registry_find_option_group (XklConfigRegistry *config
,XklConfigItem *item
);
Loads a keyboard option group information from the XML configuration registry.
|
the config registry |
|
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 |
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.
|
the config registry |
|
name of the option group |
|
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 |
void xkl_config_registry_foreach_country (XklConfigRegistry *config
,ConfigItemProcessFunc func
,gpointer data
);
Enumerates countries for which layouts are available, from the XML configuration registry
|
the config registry |
|
callback to call for every ISO 3166 country code |
|
anything which can be stored into the pointer |
void xkl_config_registry_foreach_country_variant (XklConfigRegistry *config
,const gchar *country_code
,TwoConfigItemsProcessFunc func
,gpointer data
);
Enumerates keyboard layout variants for the country, from the XML configuration registry
|
the config registry |
|
country ISO code for which variants will be listed |
|
callback to call for every country variant |
|
anything which can be stored into the pointer |
void xkl_config_registry_foreach_language (XklConfigRegistry *config
,ConfigItemProcessFunc func
,gpointer data
);
Enumerates languages for which layouts are available, from the XML configuration registry
|
the config registry |
|
callback to call for every ISO 639-2 country code |
|
anything which can be stored into the pointer |
void xkl_config_registry_foreach_language_variant (XklConfigRegistry *config
,const gchar *language_code
,TwoConfigItemsProcessFunc func
,gpointer data
);
Enumerates keyboard layout variants for the language, from the XML configuration registry
|
the config registry |
|
language ISO code for which variants will be listed |
|
callback to call for every country variant |
|
anything which can be stored into the pointer |
void xkl_config_registry_search_by_pattern (XklConfigRegistry *config
,const gchar *pattern
,TwoConfigItemsProcessFunc 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: 1. Country description (from the country list or name) contains pattern as substring 2. Language description (from the language list or name) contains pattern as substring
|
the config registry |
|
pattern to search for (NULL means "all") |
|
callback to call for every matching layout/variant |
|
anything which can be stored into the pointer |