NAME
XkbGetStickyKeysOptions - Queries the current StickyKeys attributes for a keyboard device SYNOPSIS Bool XkbGetStickyKeysOptions (Display *display, unsigned int devicespec, unsigned int *optionsrtrn); ARGUMENTS
- display connection to X server
- devicespec device ID, or XkbUseCoreKbd
- optionsrtrn backfilled with StickyKeys option mask DESCRIPTION The StickyKeys control has two options that can be accessed via the axoptions of an XkbControlsRec structure. The first option, TwoKeys, specifies whether StickyKeys should automatically turn off when two keys are pressed at the same time. This feature is useful for shared computers so people who do not want them do not need to turn StickyKeys off if a previous user left StickyKeys on. The second option, Latch‐ ToLock, specifies whether or not StickyKeys locks a modifier when pressed twice in a row. XkbGetStickyKeysOptions requests the attributes of the StickyKeys con‐ trol from the server, waits for a reply, and backfills optionsrtrn with a mask indicating whether the individual StickyKeys options are on or off. Valid bits in optionsrtrn are: XkbAXTwoKeysMask XkbAXLatchToLockMask XkbGetStickyKeysOptions returns True if successful; if a compatible version of the Xkb extension is not available in the server XkbGet‐ StickyKeysOptions returns False. RETURN VALUES True The XkbGetStickyKeysOptions function returns True if the request for the attributes of the StickyKeys control from the server was successful. False The XkbGetStickyKeysOptions function returns False if a compatible version of the Xkb extension is not available in the server. STRUCTURES The XkbControlsRec structure is defined as follows:
#define XkbMaxLegalKeyCode 255
#define XkbPerKeyBitArraySize ((XkbMaxLegalKeyCode+1)/8) typedef struct { unsigned char mkdfltbtn; /∗ default button for keyboard driven mouse */ unsigned char numgroups; /∗ number of keyboard groups */
unsigned char groupswrap; /∗ how to wrap out-of-bounds groups */ XkbModsRec internal; /∗ defines server internal modifiers */ XkbModsRec ignorelock; /∗ modifiers to ignore when checking for grab */ unsigned int enabledctrls; /∗ 1 bit => corresponding boolean control enabled */ unsigned short repeatdelay; /∗ ms delay until first repeat */ unsigned short repeatinterval; /∗ ms delay between repeats */ unsigned short slowkeysdelay; /∗ ms minimum time key must be down to be ok */ unsigned short debouncedelay; /∗ ms delay before key reactivated */ unsigned short mkdelay; /∗ ms delay to second mouse motion event */ unsigned short mkinterval; /∗ ms delay between repeat mouse events */
unsigned short mktimetomax; /∗ # intervals until constant mouse move */ unsigned short mkmaxspeed; /∗ multiplier for maximum mouse speed */ short mkcurve; /∗ determines mouse move curve type */ unsigned short axoptions; /∗ 1 bit => Access X option enabled */ unsigned short axtimeout; /∗ seconds until Access X disabled */ unsigned short axtoptsmask; /∗ 1 bit => options to reset on Access X timeout */ unsigned short axtoptsvalues; /∗ 1 bit => turn option on, 0=> off */ unsigned int axtctrlsmask; /∗ which bits in enabledctrls to modify */ unsigned int axtctrlsvalues; /∗ values for new bits in enabledctrls */ unsigned char perkeyrepeat[XkbPerKeyBitArraySize]; /∗ per key auto repeat */ } XkbControlsRec, *XkbControlsPtr; X Version 11 libX11 1.6.5 XkbGetStickyKeysOptions(3)