NAME
XkbGetDeviceInfo - Determine whether the X server allows Xkb access to particular capabilities of input devices other than the core X key‐ board, or to determine the status of indicator maps, indicator names or
button actions on a non-KeyClass extension device SYNOPSIS XkbDeviceInfoPtr XkbGetDeviceInfo (Display *dpy, unsigned int which, unsigned int devicespec, unsigned int indclass, unsigned int indid); ARGUMENTS
- dpy connection to X server
- which mask indicating information to return
- devicespec device ID, or XkbUseCoreKbd
- indclass feedback class for indicator requests
- indid feedback ID for indicator requests DESCRIPTION To determine whether the X server allows Xkb access to particular capa‐ bilities of input devices other than the core X keyboard, or to deter‐ mine the status of indicator maps, indicator names or button actions on
a non-KeyClass extension device, use XkbGetDeviceInfo. XkbGetDeviceInfo returns information about the input device specified by devicespec. Unlike the devicespec parameter of most Xkb func‐ tions, devicespec does not need to be a keyboard device. It must, how‐ ever, indicate either the core keyboard or a valid X Input Extension device. The which parameter is a mask specifying optional information to be returned. It is an inclusive OR of one or more of the values from Table 1 and causes the returned XkbDeviceInfoRec to contain values for the corresponding fields specified in the table. Table 1 XkbDeviceInfoRec Mask Bits Name XkbDeviceInfoRec Value Capability If Set Fields Effected XkbXIKeyboardsMask (1L <<0) Clients can use all Xkb requests and events with KeyClass devices supported by the input device extension. XkbXIButtonActionsMask numbtns (1L <<1) Clients can assign key btnacts actions to buttons
non-KeyClass input extension devices.
XkbXIIndicatorNamesMask leds->names (1L <<2) Clients can assign names to indicators on
non-KeyClass input extension devices.
XkbXIIndicatorMapsMask leds->maps (1L <<3) Clients can assign indicator maps to indicators on
non-KeyClass input extension devices.
XkbXIIndicatorStateMask leds->state (1L <<4) Clients can request the status of indicators
on non-KeyClass input extension devices. XkbXIIndicatorsMask szleds (0x1c) XkbXIIndicatorNamesMask | numleds XkbXIIndicatorMapsMask |
leds->* XkbXIIndicatorStateMask XkbXIUnsupportedFeaturesMask unsupported (1L <<15) XkbXIAllDeviceFeaturesMask Those selected (0x1e) XkbXIIndicatorsMask | by Value Column XkbSIButtonActionsMask masks XkbXIAllFeaturesMask Those selected (0x1f) XkbSIAllDeviceFeaturesMask | by Value Column XkbSIKeyboardsMask masks XkbXIAllDetailsMask Those selected (0x801f) XkbXIAllFeaturesMask | by Value column XkbXIUnsupportedFeaturesMask masks The XkbDeviceInfoRec returned by XkbGetDeviceInfo always has values for name (may be a null string, ""), type, supported, unsupported, hasownstate, dfltkbdfd, and dfltkbdfb. Other fields are filled in as specified by which. Upon return, the supported field will be set to the inclusive OR of zero or more bits from Table 1; each bit set indicates an optional Xkb extension device feature supported by the server implementation, and a client may modify the associated behavior. If the XkbButtonActionsMask bit is set in which, the XkbDeviceInfoRec returned will have the button actions (btnacts field) filled in for all buttons. If which includes one of the bits in XkbXIIndicatorsMask, the feedback class of the indicators must be specified in indclass, and the feed‐ back ID of the indicators must be specified in indid. If the request does not include any of the bits in XkbXIIndicatorsMask, the indclass and indid parameters are ignored. The class and ID can be obtained via the input device extension XListInputDevices request. If any of the XkbXIIndicatorsMask bits are set in which, the XkbDevi‐ ceInfoRec returned will have filled in the portions of the leds struc‐ ture corresponding to the indicator feedback identified by indclass and indid. The leds vector of the XkbDeviceInfoRec is allocated if necessary and szleds and numleds filled in. The ledclass, ledid and physindicators fields of the leds entry corresponding to indclass and indid are always filled in. If which contains XkbXIIndicatorNames‐ Mask, the namespresent and names fields of the leds structure corre‐ sponding to indclass and indid are returned. If which contains XkbXIIndicatorStateMask, the corresponding state field is updated. If which contains XkbXIIndicatorMapsMask, the mapspresent and maps fields are updated. Xkb provides convenience functions to request subsets of the informa‐ tion available via XkbGetDeviceInfo. These convenience functions mir‐ ror some of the mask bits. The functions all take an XkbDeviceInfoPtr as an input argument and operate on the X Input Extension device speci‐ fied by the devicespec field of the structure. Only the parts of the structure indicated in the function description are updated. The XkbDe‐ viceInfoRec structure used in the function call can be obtained by calling XkbGetDeviceInfo or can be allocated by calling XkbAllocDevice‐ 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; SEE ALSO XkbAllocDeviceInfo(3), XListInputDevices(3) X Version 11 libX11 1.6.5 XkbGetDeviceInfo(3)