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

NAME

6       XkbGetDetectableAutoRepeat  - Determines whether or not the server sup‐
7       ports DetectableAutoRepeat
8

SYNOPSIS

10       Bool   XkbGetDetectableAutoRepeat   (Display   *display,   Bool   *sup‐
11              ported_rtrn);
12

ARGUMENTS

14       - display
15              connection to X server
16
17       - supported_rtrn
18              backfilled True if DetectableAutoRepeat supported
19

DESCRIPTION

21       Auto-repeat is the generation of multiple key events by a keyboard when
22       the user presses a key and holds it down. Keyboard hardware and device-
23       dependent  X  server software often implement auto-repeat by generating
24       multiple KeyPress events with  no  intervening  KeyRelease  event.  The
25       standard behavior of the X server is to generate a KeyRelease event for
26       every KeyPress event. If the  keyboard  hardware  and  device-dependent
27       software  of  the X server implement auto-repeat by generating multiple
28       KeyPress events, the device-independent part of the X server by default
29       synthetically  generates  a KeyRelease event after each KeyPress event.
30       This provides predictable behavior for X clients, but  does  not  allow
31       those clients to detect the fact that a key is auto-repeating.
32
33       Xkb  allows  clients  to  request  detectable auto-repeat.  If a client
34       requests and the server supports  DetectableAutoRepeat,  Xkb  generates
35       KeyRelease  events  only  when  the  key  is  physically  released.  If
36       DetectableAutoRepeat is not supported or has not  been  requested,  the
37       server synthesizes a KeyRelease event for each repeating KeyPress event
38       it generates.
39
40       DetectableAutoRepeat, unlike other controls, is not  contained  in  the
41       XkbControlsRec  structure,  nor  can  it be enabled or disabled via the
42       EnabledControls control.  Instead, query and  set  DetectableAutoRepeat
43       using XkbGetDetectableAutoRepeat and XkbSetDetectableAutoRepeat.
44
45       DetectableAutoRepeat  is  a  condition  that  applies  to  all keyboard
46       devices for a client's connection to a given X  server;  it  cannot  be
47       selectively  set  for some devices and not for others. For this reason,
48       none  of  the  Xkb  library  functions  involving  DetectableAutoRepeat
49       involve a device specifier.
50
51       XkbGetDetectableAutoRepeat  queries the server for the current state of
52       DetectableAutoRepeat and waits for a reply. If  supported_rtrn  is  not
53       NULL,  it  backfills  supported_rtrn  with  True if the server supports
54       DetectableAutoRepeat, and False otherwise.   XkbGetDetectableAutoRepeat
55       returns  the  current  state of DetectableAutoRepeat for the requesting
56       client: True if DetectableAutoRepeat is set, and False otherwise.
57

RETURN VALUES

59       True           The XkbGetDetectableAutoRepeat function returns True  if
60                      the server supports DetectableAutoRepeat.
61
62       False          The XkbGetDetectableAutoRepeat function returns False if
63                      the server does not support DetectableAutoRepeat.
64
65
66
67X Version 11                     libX11 1.6.7    XkbGetDetectableAutoRepeat(3)