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

NAME

6       XkbSetDetectableAutoRepeat - Sets DetectableAutoRepeat
7

SYNOPSIS

9       Bool  XkbSetDetectableAutoRepeat  (Display  *display,  Bool detectable,
10              Bool *supported_rtrn);
11

ARGUMENTS

13       - display
14              connection to X server
15
16       - detectable
17              True => set DetectableAutoRepeat
18
19       - supported_rtrn
20              backfilled True if DetectableAutoRepeat supported
21

DESCRIPTION

23       Auto-repeat is the generation of multiple key events by a keyboard when
24       the user presses a key and holds it down. Keyboard hardware and device-
25       dependent X server software often implement auto-repeat  by  generating
26       multiple  KeyPress  events  with  no  intervening KeyRelease event. The
27       standard behavior of the X server is to generate a KeyRelease event for
28       every  KeyPress  event.  If  the keyboard hardware and device-dependent
29       software of the X server implement auto-repeat by  generating  multiple
30       KeyPress events, the device-independent part of the X server by default
31       synthetically generates a KeyRelease event after each  KeyPress  event.
32       This  provides  predictable  behavior for X clients, but does not allow
33       those clients to detect the fact that a key is auto-repeating.
34
35       Xkb allows clients to request detectable auto-repeat.  If a client  re‐
36       quests  and  the  server  supports  DetectableAutoRepeat, Xkb generates
37       KeyRelease events only when the key  is  physically  released.  If  De‐
38       tectableAutoRepeat  is  not  supported  or  has not been requested, the
39       server synthesizes a KeyRelease event for each repeating KeyPress event
40       it generates.
41
42       DetectableAutoRepeat,  unlike  other  controls, is not contained in the
43       XkbControlsRec structure, nor can it be enabled or disabled via the En‐
44       abledControls  control. Instead, query and set DetectableAutoRepeat us‐
45       ing XkbGetDetectableAutoRepeat and XkbSetDetectableAutoRepeat.
46
47       DetectableAutoRepeat is a condition that applies to  all  keyboard  de‐
48       vices  for  a client's connection to a given X server; it cannot be se‐
49       lectively set for some devices and not for  others.  For  this  reason,
50       none  of  the  Xkb library functions involving DetectableAutoRepeat in‐
51       volve a device specifier.
52
53       This request affects all keyboard activity for  the  requesting  client
54       only;  other  clients  still see the expected nondetectable auto-repeat
55       behavior, unless they have requested otherwise.
56
57       XkbSetDetectableAutoRepeat sends a request to the  server  to  set  De‐
58       tectableAutoRepeat on for the current client if detectable is True, and
59       off if detectable is  False;  it  then  waits  for  a  reply.  If  sup‐
60       ported_rtrn  is  not  NULL,  XkbSetDetectableAutoRepeat  backfills sup‐
61       ported_rtrn with True if the server supports DetectableAutoRepeat,  and
62       False  if  it does not.  XkbSetDetectableAutoRepeat returns the current
63       state of DetectableAutoRepeat for the requesting client:  True  if  De‐
64       tectableAutoRepeat is set, and False otherwise.
65

RETURN VALUES

67       True           The  XkbSetDetectableAutoRepeat function returns True if
68                      DetectableAutoRepeat is set.
69
70       False          The XkbSetDetectableAutoRepeat function returns False if
71                      DetectableAutoRepeat is not set.
72
73
74
75X Version 11                     libX11 1.7.0    XkbSetDetectableAutoRepeat(3)