NAME
XkbGetAccessXTimeout - Queries the current AccessXTimeout options for a keyboard device SYNOPSIS Bool XkbGetAccessXTimeout (Display *display, unsigned int devicespec, unsigned short *timeoutrtrn, unsigned int *ctrlsmaskrtrn, unsigned int *ctrlsvaluesrtrn, unsigned short *optionsmaskrtrn, unsigned short *optionsvaluesrtrn); ARGUMENTS
- display unsigned short
- devicespec device to query, or XkbUseCoreKbd
- timeoutrtrn delay until AccessXTimeout, seconds
- ctrlsmaskrtrn backfilled with controls to modify
- ctrlsvaluesrtrn backfilled with on/off status for controls
- optionsmaskrtrn backfilled with axoptions to modify
- optionsvaluesrtrn backfilled with values for axoptions DESCRIPTION In environments where computers are shared, features such as SlowKeys present a problem: if SlowKeys is on, the keyboard can appear to be unresponsive because keys are not accepted until they are held for a certain period of time. To help solve this problem, Xkb provides an AccessXTimeout control to automatically change the enabled/disabled state of any boolean controls and to change the value of the AccessXKeys and AccessXFeedback control attributes if the keyboard is idle for a specified period of time. When a timeout as specified by AccessXTimeout occurs and a control is consequently modified, Xkb generates an XkbControlsNotify event. XkbGetAccessXTimeout sends a request to the X server to obtain the cur‐ rent values for the AccessXTimeout attributes, waits for a reply, and backfills the values into the appropriate arguments. The parameters optionsmaskrtrn and optionsvaluesrtrn are backfilled with the options to modify and the values for axoptions, which is a field in the XkbControlsRec structure. XkbGetAccessXTimeout returns True if successful; if a compatible version of the Xkb extension is not avail‐ able in the server, XkbGetAccessXTimeout returns False. RETURN VALUES True The XkbGetAccessXTimeout returns True when it success‐ fully sends a request to the X server to obtain the cur‐ rent values for the AccessXTimeout attributes, waits for a reply, and backfills the values into the appropriate arguments. False The XkbGetAccessXTimeout funtion returns False if a com‐ patible 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 XkbGetAccessXTimeout(3)