1XkbGetSlowKeysDelay(3)           XKB FUNCTIONS          XkbGetSlowKeysDelay(3)
2
3
4

NAME

6       XkbGetSlowKeysDelay - Gets the SlowKeys acceptance delay for a keyboard
7       device
8

SYNOPSIS

10       Bool XkbGetSlowKeysDelay (Display *display, unsigned  int  device_spec,
11              unsigned int *delay_rtrn);
12

ARGUMENTS

14       - display
15              connection to X server
16
17       - device_spec
18              device ID, or XkbUseCoreKbd
19
20       - delay_rtrn
21              backfilled with SlowKeys delay, ms
22

DESCRIPTION

24       Some  users  may  accidentally  bump keys while moving a hand or typing
25       stick toward the key they want. Usually, the keys that are accidentally
26       bumped  are just hit for a very short period of time. The SlowKeys con‐
27       trol helps filter these accidental bumps by telling the server to  wait
28       a specified period, called the SlowKeys acceptance delay, before deliv‐
29       ering key events. If the key is released before this period elapses, no
30       key  events  are  generated.  Users can then bump any number of keys on
31       their way to the one they want without accidentally getting those char‐
32       acters.  Once  they  have reached the key they want, they can then hold
33       the desired key long enough for the computer to accept it. SlowKeys  is
34       a boolean control with one configurable attribute.
35
36       When the SlowKeys control is active, the server reports the initial key
37       press, subsequent acceptance or rejection, and release of  any  key  to
38       interested  clients  by sending an appropriate AccessXNotify event (see
39       section 10.6.4).
40
41       The server can generate XkbAccessXNotify events for some of the  global
42       keyboard  controls.  The detail field describes what AccessX event just
43       occurred and can be any of the values in Table 1.  The server can  gen‐
44       erate XkbAccessXNotify events for some of the global keyboard controls.
45       The detail field describes what AccessX event just occurred and can  be
46       any of the values in Table 1.
47
48
49                       Table 1 AccessXNotify Events
50       ─────────────────────────────────────────────────────────────
51       detail              Reason
52       ─────────────────────────────────────────────────────────────
53       XkbAXN_SKPress      A  key was pressed when SlowKeys was en‐
54                           abled.
55       XkbAXN_SKAccept     A key was accepted (held longer than the
56                           SlowKeys delay).
57       XkbAXN_SKRelease    An accepted SlowKeys key was released.
58       XkbAXN_SKReject     A  key was rejected (released before the
59                           SlowKeys delay expired).
60       XkbAXN_BKAccept     A key was accepted by BounceKeys.
61       XkbAXN_BKReject     A key was rejected (pressed  before  the
62                           BounceKeys delay expired).
63       XkbAXN_AXKWarning   AccessXKeys  is  about  to  turn  on/off
64                           StickyKeys or BounceKeys.
65
66
67       The keycode field reports the keycode of the key for  which  the  event
68       occurred. If the action is related to SlowKeys, the slowKeysDelay field
69       contains the current SlowKeys acceptance delay. If the  action  is  re‐
70       lated  to  BounceKeys,  the  debounceDelay  field  contains the current
71       BounceKeys debounce delay.
72
73       Selecting for AccessX Events
74
75       To receive XkbAccessXNotify events under all possible  conditions,  use
76       XkbSelectEvents and pass XkbAccesXNotifyMask in both bits_to_change and
77       values_for_bits.
78
79       To receive XkbStateNotify events only  under  certain  conditions,  use
80       XkbSelectEventDetails  using  XkbAccessXNotify  as  the  event_type and
81       specifying  the  desired  state  changes  in  bits_to_change  and  val‐
82       ues_for_bits using mask bits from Table 2.
83
84
85                         Table 2 AccessXNotify Event Details
86       ─────────────────────────────────────────────────────────────────────────
87       XkbAccessXNotify Event Details   Value    Circumstances
88       ─────────────────────────────────────────────────────────────────────────
89       XkbAXN_SKPressMask               (1<<0)   Slow  key  press  notification
90                                                 wanted
91       XkbAXN_SKAcceptMask              (1<<1)   Slow key  accept  notification
92                                                 wanted
93       XkbAXN_SKRejectMask              (1<<2)   Slow  key  reject notification
94                                                 wanted
95       XkbAXN_SKReleaseMask             (1<<3)   Slow key release  notification
96                                                 wanted
97       XkbAXN_BKAcceptMask              (1<<4)   Bounce key accept notification
98                                                 wanted
99       XkbAXN_BKRejectMask              (1<<5)   Bounce key reject notification
100                                                 wanted
101       XkbAXN_AXKWarningMask            (1<<6)   AccessX  warning  notification
102                                                 wanted
103       XkbAllAccessXEventsMask          (0x7f)   All AccessX features notifica‐
104                                                 tions wanted
105
106       XkbGetSlowKeysDelay  requests  the  attributes  of the SlowKeys control
107       from the server, waits for a reply and backfills  delay_rtrn  with  the
108       SlowKeys delay attribute.  XkbGetSlowKeysDelay returns True if success‐
109       ful; , XkbGetSlowKeysDelay returns False.
110

RETURN VALUES

112       True           The XkbGetSlowKeysDelay function returns True if the re‐
113                      quest  of  the Slowkeys control from the server was suc‐
114                      cessful.
115
116       False          The XkbGetSlowKeysDelay function returns False if a com‐
117                      patible version of the Xkb extension is not available in
118                      the server.
119

STRUCTURES

121       The structure for the XkbAccessXNotify event type is as follows:
122
123       typedef struct {
124           int            type;           /∗ Xkb extension base event code */
125           unsigned long  serial;         /∗ X server serial number for event */
126           Bool           send_event;     /∗ True => synthetically generated */
127           Display *      display;        /∗ server connection where event generated */
128           Time           time;           /∗ server time when event generated */
129           int            xkb_type;       /∗ XkbAccessXNotify */
130           int            device;         /∗ Xkb device ID, will not be XkbUseCoreKbd
131       */
132           int            detail;         /∗ XkbAXN_* */
133           KeyCode        keycode;        /∗ key of event */
134           int            slowKeysDelay;  /∗ current SlowKeys delay */
135           int            debounceDelay;  /∗ current debounce delay */
136       } XkbAccessXNotifyEvent;
137
138
139
140
141
142X Version 11                     libX11 1.7.0           XkbGetSlowKeysDelay(3)
Impressum