xklavier_config.h File Reference

#include <libxklavier/xklavier.h>

Go to the source code of this file.

Classes
struct	_XklConfigItem
struct	_XklConfigRec
Defines
#define	XKL_MAX_CI_NAME_LENGTH   32
#define	XKL_MAX_CI_SHORT_DESC_LENGTH   10
#define	XKL_MAX_CI_DESC_LENGTH   192
Typedefs
typedef _XklConfigItem	XklConfigItem
typedef _XklConfigItem *	XklConfigItemPtr
typedef _XklConfigRec	XklConfigRec
typedef _XklConfigRec *	XklConfigRecPtr
typedef void(*	ConfigItemProcessFunc )(const XklConfigItemPtr configItem, void *userData)
typedef void(*	GroupProcessFunc )(const XklConfigItemPtr configItem, Bool allowMultipleSelection, void *userData)
Functions
void	XklConfigInit (void)
void	XklConfigTerm (void)
Bool	XklConfigLoadRegistryFromFile (const char *fileName)
Bool	XklConfigLoadRegistry (void)
void	XklConfigFreeRegistry (void)
void	XklConfigEnumModels (ConfigItemProcessFunc func, void *userData)
void	XklConfigEnumLayouts (ConfigItemProcessFunc func, void *userData)
void	XklConfigEnumLayoutVariants (const char *layoutName, ConfigItemProcessFunc func, void *userData)
void	XklConfigEnumOptionGroups (GroupProcessFunc func, void *userData)
void	XklConfigEnumOptions (const char *optionGroupName, ConfigItemProcessFunc func, void *userData)
Bool	XklConfigFindModel (XklConfigItemPtr ptr)
Bool	XklConfigFindLayout (XklConfigItemPtr ptr)
Bool	XklConfigFindVariant (const char *layoutName, XklConfigItemPtr ptr)
Bool	XklConfigFindOptionGroup (XklConfigItemPtr ptr, Bool *allowMultipleSelection)
Bool	XklConfigFindOption (const char *optionGroupName, XklConfigItemPtr ptr)
Bool	XklConfigActivate (const XklConfigRecPtr data)
Bool	XklConfigGetFromServer (XklConfigRecPtr data)
Bool	XklConfigGetFromBackup (XklConfigRecPtr data)
Bool	XklConfigWriteFile (const char *fileName, const XklConfigRecPtr data, const Bool binary)
Bool	XklGetNamesProp (Atom rulesAtomName, char **rulesFileOut, XklConfigRecPtr configOut)
Bool	XklSetNamesProp (Atom rulesAtomName, char *rulesFile, XklConfigRecPtr config)
Bool	XklBackupNamesProp ()
Bool	XklRestoreNamesProp ()
void	XklConfigRecInit (XklConfigRecPtr data)
void	XklConfigRecReset (XklConfigRecPtr data)
void	XklConfigRecDestroy (XklConfigRecPtr data)
Bool	XklConfigRecEquals (XklConfigRecPtr data1, XklConfigRecPtr data2)

---

Detailed Description

---

Define Documentation

#define XKL_MAX_CI_DESC_LENGTH   192

Maximum description length, including '\0' character. Important: this length is in bytes, so for unicode (UTF-8 encoding in XML file) the actual maximum length can be smaller.

#define XKL_MAX_CI_NAME_LENGTH   32

Maximum name length, including '\'0' character

#define XKL_MAX_CI_SHORT_DESC_LENGTH   10

Maximum short description length, including '\0' character. Important: this length is in bytes, so for unicode (UTF-8 encoding in XML file) the actual maximum length can be smaller.

---

Typedef Documentation

typedef struct _XklConfigItem XklConfigItem

The configuration item. Corresponds to XML element "configItem".

typedef struct _XklConfigItem * XklConfigItemPtr

The configuration item. Corresponds to XML element "configItem".

typedef struct _XklConfigRec XklConfigRec

Basic configuration params

typedef struct _XklConfigRec * XklConfigRecPtr

Basic configuration params

---