NAME
XkbAllocDeviceLedInfo - Obtain an XkbDeviceLedInfoRec structure SYNOPSIS Status XkbAllocDeviceLedInfo (XkbDeviceInfoPtr deviceinfo, int numneeded); ARGUMENTS
- deviceinfo structure in which to allocate LED space
- numneeded number of indicators to allocate space for DESCRIPTION XkbAllocDeviceLedInfo allocates space for an XkbDeviceLedInfoRec and places it in deviceinfo. If numneeded is nonzero, numneeded XkbIndicatorMapRec structures are also allocated and linked into the XkbDeviceLedInfoRec structure. If you request XkbIndicatorMapRec struc‐ tures be allocated using this request, you must initialize them explic‐ itly. All other fields are initialized to zero. To initialize an XkbDeviceLedInfoRec structure, use XkbAddDeviceLed‐ Info. STRUCTURES Information about X Input Extension devices is transferred between a client program and the Xkb extension in an XkbDeviceInfoRec structure: typedef struct { char * name; /∗ name for device */ Atom type; /∗ name for class of devices */ unsigned short devicespec; /∗ device of interest */ Bool hasownstate; /∗ True=>this device has its own state */ unsigned short supported; /∗ bits indicating supported capabilities */ unsigned short unsupported; /∗ bits indicating unsupported capabilities */ unsigned short numbtns; /∗ number of entries in btnacts */ XkbAction * btnacts; /∗ button actions */ unsigned short szleds; /∗ total number of entries in LEDs vector */ unsigned short numleds; /∗ number of valid entries in LEDs vector */ unsigned short dfltkbdfb; /∗ input extension ID of default (core kbd) indicator */ unsigned short dfltledfb; /∗ input extension ID of default indicator feedback */ XkbDeviceLedInfoPtr leds; /∗ LED descriptions */ } XkbDeviceInfoRec, *XkbDeviceInfoPtr; typedef struct { unsigned short ledclass; /∗ class for this LED device*/ unsigned short ledid; /∗ ID for this LED device */ unsigned int physindicators; /∗ bits for which LEDs physically present */ unsigned int mapspresent; /∗ bits for which LEDs have maps in maps */ unsigned int namespresent; /∗ bits for which LEDs are in names */ unsigned int state; /∗ 1 bit => corresponding LED is on */ Atom names[XkbNumIndicators]; /∗ names for LEDs */ XkbIndicatorMapRec maps; /∗ indicator maps for each LED */ } XkbDeviceLedInfoRec, *XkbDeviceLedInfoPtr; Each indicator has its own set of attributes that specify whether clients can explicitly set its state and whether it tracks the keyboard state. The attributes of each indicator are held in the maps array, which is an array of XkbIndicatorRec structures: typedef struct { unsigned char flags; /∗ how the indicator can be changed */ unsigned char whichgroups; /∗ match criteria for groups */ unsigned char groups; /∗ which keyboard groups the indicator watches */ unsigned char whichmods; /∗ match criteria for modifiers */ XkbModsRec mods; /∗ which modifiers the indicator watches */ unsigned int ctrls; /∗ which controls the indicator watches */ } XkbIndicatorMapRec, *XkbIndicatorMapPtr; This indicator map specifies for each indicator: · The conditions under which the keyboard modifier state affects the indicator · The conditions under which the keyboard group state affects the indicator · The conditions under which the state of the boolean controls affects the indicator · The effect (if any) of attempts to explicitly change the state of the indicator using the functions XkbSetControls or XChangeKey‐ boardControl SEE ALSO XkbAddDeviceLedInfo(3), XkbSetControls(3) X Version 11 libX11 1.6.5 XkbAllocDeviceLedInfo(3)