NAME
XkbSetDeviceInfo - Modify some or all of the characteristics of an X Input Extension device SYNOPSIS Bool XkbSetDeviceInfo (Display *dpy, unsigned int which, XkbDeviceIn‐ foPtr deviceinfo); ARGUMENTS
- dpy connection to X server
- which mask indicating characteristics to modify
- deviceinfo structure defining the device and modifications DESCRIPTION To change characteristics of an X Input Extension device in the server, first modify a local copy of the device structure and then use either XkbSetDeviceInfo, or, to save network traffic, use an XkbDeviceChanges‐ Rec structure and call XkbChangeDeviceInfo to download the changes to the server. XkbSetDeviceInfo sends a request to the server to modify the character‐ istics of the device specified in the deviceinfo structure. The par‐ ticular characteristics modified are identified by the bits set in which and take their values from the relevant fields in deviceinfo (see Table 1). XkbSetDeviceInfo returns True if the request was suc‐ cessfully sent to the server. If the X server implementation does not allow interaction between the X input extension and the Xkb Extension, the function does nothing and returns False. 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 which parameter specifies which aspects of the device should be changed and is a bitmask composed of an inclusive OR or one or more of the following bits: XkbXIButtonActionsMask, XkbXIIndicatorNamesMask, XkbXIIndicatorMapsMask. If the features requested to be manipulated in which are valid for the device, but the server does not support assign‐ ment of one or more of them, that particular portion of the request is ignored.
If the device specified in deviceinfo->devicespec does not contain buttons and a request affecting buttons is made, or the device does not contain indicators and a request affecting indicators is made, a Bad‐ Match protocol error results. If the XkbXIButtonActionsMask bit is set in the supported mask returned by XkbGetDeviceInfo, the Xkb extension allows applications to assign key actions to buttons on input extension devices other than the core keyboard device. If the XkbXIButtonActionsMask is set in which, the actions for all buttons specified in deviceinfo are set to the
XkbActions specified in deviceinfo->btnacts. If the number of but‐ tons requested to be updated is not valid for the device, XkbSetDevice‐ Info returns False and a BadValue protocol error results. If the XkbXIIndicatorMaps and / or XkbXIIndicatorNamesMask bit is set in the supported mask returned by XkbGetDeviceInfo, the Xkb extension allows applications to assign maps and / or names to the indicators of nonkeyboard extension devices. If supported, maps and / or names can be assigned to all extension device indicators, whether they are part of a keyboard feedback or part of an indicator feedback. If the XkbXIIndicatorMapsMask and / or XkbXIIndicatorNamesMask flag is set in which, the indicator maps and / or names for all
deviceinfo->numleds indicator devices specified in deviceinfo->leds
are set to the maps and / or names specified in deviceinfo->leds.
deviceinfo->leds->ledclass and ledid specify the input extension class and device ID for each indicator device to modify; if they have invalid values, a BadValue protocol error results and XkbSetDeviceInfo returns False. If they have legal values but do not specify a keyboard or indicator class feedback for the device in question, a BadMatch
error results. If any of the values in deviceinfo->leds->names are not a valid Atom or None, a BadAtom protocol error results. RETURN VALUES True The XkbSetDeviceInfo function returns True if the request was successfully sent to the server. False The XkbSetDeviceInfo function returns False if the X server implementation does not allow interaction between the X input extension and the Xkb Extension. STRUCTURES Changes to an Xkb extension device may be tracked by listening to Xkb‐ DeviceExtensionNotify events and accumulating the changes in an XkbDe‐ viceChangesRec structure. The changes noted in the structure may then be used in subsequent operations to update either a server configura‐ tion or a local copy of an Xkb extension device configuration. The changes structure is defined as follows: typedef struct XkbDeviceChanges { unsigned int changed; /∗ bits indicating what has changed */ unsigned short firstbtn; /∗ number of first button which changed, if any */ unsigned short numbtns; /∗ number of buttons that have changed */ XkbDeviceLedChangesRec leds; } XkbDeviceChangesRec,*XkbDeviceChangesPtr; DIAGNOSTICS BadAtom A name is neither a valid Atom or None BadMatch A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid BadValue An argument is out of range SEE ALSO XkbChangeDeviceInfo(3), XkbGetDeviceInfo(3) X Version 11 libX11 1.6.5 XkbSetDeviceInfo(3)