NAME
XkbGetSlowKeysDelay - Gets the SlowKeys acceptance delay for a keyboard device SYNOPSIS Bool XkbGetSlowKeysDelay (Display *display, unsigned int devicespec, unsigned int *delayrtrn); ARGUMENTS
- display connection to X server
- devicespec device ID, or XkbUseCoreKbd
- delayrtrn backfilled with SlowKeys delay, ms DESCRIPTION Some users may accidentally bump keys while moving a hand or typing stick toward the key they want. Usually, the keys that are accidentally bumped are just hit for a very short period of time. The SlowKeys con‐ trol helps filter these accidental bumps by telling the server to wait a specified period, called the SlowKeys acceptance delay, before deliv‐ ering key events. If the key is released before this period elapses, no key events are generated. Users can then bump any number of keys on their way to the one they want without accidentally getting those char‐ acters. Once they have reached the key they want, they can then hold the desired key long enough for the computer to accept it. SlowKeys is a boolean control with one configurable attribute. When the SlowKeys control is active, the server reports the initial key press, subsequent acceptance or rejection, and release of any key to interested clients by sending an appropriate AccessXNotify event (see section 10.6.4). The server can generate XkbAccessXNotify events for some of the global keyboard controls. The detail field describes what AccessX event just occurred and can be any of the values in Table 1. The server can gen‐ erate XkbAccessXNotify events for some of the global keyboard controls. The detail field describes what AccessX event just occurred and can be any of the values in Table 1. Table 1 AccessXNotify Events ───────────────────────────────────────────────────────────── detail Reason ───────────────────────────────────────────────────────────── XkbAXNSKPress A key was pressed when SlowKeys was enabled. XkbAXNSKAccept A key was accepted (held longer than the SlowKeys delay). XkbAXNSKRelease An accepted SlowKeys key was released. XkbAXNSKReject A key was rejected (released before the SlowKeys delay expired). XkbAXNBKAccept A key was accepted by BounceKeys. XkbAXNBKReject A key was rejected (pressed before the BounceKeys delay expired). XkbAXNAXKWarning AccessXKeys is about to turn on/off StickyKeys or BounceKeys. The keycode field reports the keycode of the key for which the event occurred. If the action is related to SlowKeys, the slowKeysDelay field contains the current SlowKeys acceptance delay. If the action is related to BounceKeys, the debounceDelay field contains the current BounceKeys debounce delay. Selecting for AccessX Events To receive XkbAccessXNotify events under all possible conditions, use XkbSelectEvents and pass XkbAccesXNotifyMask in both bitstochange and valuesforbits. To receive XkbStateNotify events only under certain conditions, use XkbSelectEventDetails using XkbAccessXNotify as the eventtype and specifying the desired state changes in bitstochange and val‐ uesforbits using mask bits from Table 2. Table 2 AccessXNotify Event Details ───────────────────────────────────────────────────────────────────────── XkbAccessXNotify Event Details Value Circumstances ───────────────────────────────────────────────────────────────────────── XkbAXNSKPressMask (1<<0) Slow key press notification wanted XkbAXNSKAcceptMask (1<<1) Slow key accept notification wanted XkbAXNSKRejectMask (1<<2) Slow key reject notification wanted XkbAXNSKReleaseMask (1<<3) Slow key release notification wanted XkbAXNBKAcceptMask (1<<4) Bounce key accept notification wanted XkbAXNBKRejectMask (1<<5) Bounce key reject notification wanted XkbAXNAXKWarningMask (1<<6) AccessX warning notification wanted XkbAllAccessXEventsMask (0x7f) All AccessX features notifica‐ tions wanted XkbGetSlowKeysDelay requests the attributes of the SlowKeys control from the server, waits for a reply and backfills delayrtrn with the SlowKeys delay attribute. XkbGetSlowKeysDelay returns True if success‐ ful; , XkbGetSlowKeysDelay returns False. RETURN VALUES True The XkbGetSlowKeysDelay function returns True if the request of the Slowkeys control from the server was suc‐ cessful. False The XkbGetSlowKeysDelay function returns False if a com‐ patible version of the Xkb extension is not available in the server. STRUCTURES The structure for the XkbAccessXNotify event type is as follows: typedef struct { int type; /∗ Xkb extension base event code */ unsigned long serial; /∗ X server serial number for event */ Bool sendevent; /∗ True => synthetically generated */ Display * display; /∗ server connection where event generated */ Time time; /∗ server time when event generated */ int xkbtype; /∗ XkbAccessXNotify */ int device; /∗ Xkb device ID, will not be XkbUseCoreKbd */ int detail; /∗ XkbAXN* */ KeyCode keycode; /∗ key of event */ int slowKeysDelay; /∗ current SlowKeys delay */ int debounceDelay; /∗ current debounce delay */ } XkbAccessXNotifyEvent; X Version 11 libX11 1.6.5 XkbGetSlowKeysDelay(3)