xklavier.h File Reference

#include <stdarg.h>
#include <X11/Xlib.h>

Go to the source code of this file.

Classes
struct	XklState
Defines
#define	XKLF_CAN_TOGGLE_INDICATORS   0x01
#define	XKLF_CAN_OUTPUT_CONFIG_AS_ASCII   0x02
#define	XKLF_CAN_OUTPUT_CONFIG_AS_BINARY   0x04
#define	XKLF_MULTIPLE_LAYOUTS_SUPPORTED   0x08
#define	XKLF_REQUIRES_MANUAL_LAYOUT_MANAGEMENT   0x10
#define	XKLL_MANAGE_WINDOW_STATES   0x01
#define	XKLL_TRACK_KEYBOARD_STATE   0x02
#define	XKLL_MANAGE_LAYOUTS   0x04
#define	XklDebug(level,)   _XklDebug( __FILE__, __func__, level, __VA_ARGS__ )
Typedefs
typedef void(*	XklConfigCallback )(void *userData)
typedef int(*	XklWinCallback )(Window win, Window parent, void *userData)
typedef void(*	XklStateCallback )(XklStateChange changeType, int group, Bool restore, void *userData)
typedef void(*	XklLogAppender )(const char file[], const char function[], int level, const char format[], va_list args)
Enumerations
enum	XklStateChange { GROUP_CHANGED, INDICATORS_CHANGED }
Functions
int	XklInit (Display *dpy)
int	XklTerm (void)
const char *	XklGetBackendName (void)
int	XklGetBackendFeatures (void)
unsigned	XklGetMaxNumGroups (void)
int	XklStartListen (int what)
int	XklStopListen (void)
int	XklPauseListen (void)
int	XklResumeListen (void)
Bool	XklGrabKey (int keycode, unsigned modifiers)
Bool	XklUngrabKey (int keycode, unsigned modifiers)
int	XklFilterEvents (XEvent *evt)
void	XklAllowOneSwitchToSecondaryGroup (void)
Window	XklGetCurrentWindow (void)
XklState *	XklGetCurrentState (void)
char *	XklGetWindowTitle (Window w)
Bool	XklGetState (Window win, XklState *state_return)
void	XklDelState (Window win)
void	XklSaveState (Window win, XklState *state)
void	XklSetTransparent (Window win, Bool transparent)
Bool	XklIsTransparent (Window win)
Bool	XklIsSameApp (Window win1, Window win2)
unsigned	XklGetNumGroups (void)
const char **	XklGetGroupNames (void)
const char **	XklGetIndicatorNames (void)
int	XklGetNextGroup (void)
int	XklGetPrevGroup (void)
int	XklGetRestoreGroup (void)
void	XklLockGroup (int group)
int	XklRegisterConfigCallback (XklConfigCallback fun, void *userData)
int	XklRegisterWindowCallback (XklWinCallback fun, void *userData)
int	XklRegisterStateCallback (XklStateCallback fun, void *userData)
void	XklSetGroupPerApp (Bool isGlobal)
Bool	XklIsGroupPerApp (void)
void	XklSetIndicatorsHandling (Bool whetherHandle)
Bool	XklGetIndicatorsHandling (void)
void	XklSetSecondaryGroupsMask (int mask)
int	XklGetSecondaryGroupsMask (void)
void	XklSetDefaultGroup (int group)
int	XklGetDefaultGroup (void)
const char *	XklGetLastError (void)
void	_XklDebug (const char file[], const char function[], int level, const char format[],...)
void	XklDefaultLogAppender (const char file[], const char function[], int level, const char format[], va_list args)
void	XklSetLogAppender (XklLogAppender fun)
void	XklSetDebugLevel (int level)

---

Detailed Description

---

Define Documentation

#define XKLF_CAN_OUTPUT_CONFIG_AS_ASCII   0x02

Backend allows to write ascii representation of the configuration

#define XKLF_CAN_OUTPUT_CONFIG_AS_BINARY   0x04

Backend allows to write binary representation of the configuration

#define XKLF_CAN_TOGGLE_INDICATORS   0x01

Backend allows to toggls indicators on/off

#define XKLF_MULTIPLE_LAYOUTS_SUPPORTED   0x08

Backend supports multiple layouts

#define XKLF_REQUIRES_MANUAL_LAYOUT_MANAGEMENT   0x10

Backend requires manual configuration, some daemon should do XklStartListen( XKLL_MANAGE_LAYOUTS );

---

Enumeration Type Documentation

enum XklStateChange

Enumeration values: GROUP_CHANGED  Group was changed INDICATORS_CHANGED  Indicators were changed

---