man/xkb/XkbSetDetectableAutorepeat.man

   1 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software is furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice (including the next
  11 .\" paragraph) shall be included in all copies or substantial portions of the
  12 .\" Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20 .\" DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .TH XkbSetDetectableAutoRepeat __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbSetDetectableAutoRepeat \- Sets DetectableAutoRepeat
  25 .SH SYNTAX
  26 .HP
  27 .B Bool XkbSetDetectableAutoRepeat
  28 .BI "(\^Display *" "display" "\^,"
  29 .BI "Bool " "detectable" "\^,"
  30 .BI "Bool *" "supported_rtrn" "\^);"
  31 .if n .ti +5n
  32 .if t .ti +.5i
  33 .SH ARGUMENTS
  34 .TP
  35 .I \- display
  36 connection to X server
  37 .TP
  38 .I \- detectable
  39 True => set DetectableAutoRepeat
  40 .TP
  41 .I \- supported_rtrn
  42 backfilled True if DetectableAutoRepeat supported
  43 .SH DESCRIPTION
  44 .LP
  45 Auto-repeat is the generation of multiple key events by a keyboard when the user
  46 presses a key and holds it down. Keyboard hardware and device-dependent X server
  47 software often implement auto-repeat by generating multiple KeyPress events with
  48 no intervening KeyRelease event. The standard behavior of the X server is to
  49 generate a KeyRelease event for every KeyPress event. If the keyboard hardware
  50 and device-dependent software of the X server implement auto-repeat by
  51 generating multiple KeyPress events, the device-independent part of the X server
  52 by default synthetically generates a KeyRelease event after each KeyPress event.
  53 This provides predictable behavior for X clients, but does not allow those
  54 clients to detect the fact that a key is auto-repeating.
  55
  56 Xkb allows clients to request
  57 .I detectable auto-repeat.
  58 If a client requests and the server supports DetectableAutoRepeat, Xkb generates
  59 KeyRelease events only when the key is physically released. If
  60 DetectableAutoRepeat is not supported or has not been requested, the server
  61 synthesizes a KeyRelease event for each repeating KeyPress event it generates.
  62
  63 DetectableAutoRepeat, unlike other controls, is not contained in the
  64 XkbControlsRec structure, nor can it be enabled or disabled via the
  65 EnabledControls control. Instead, query and set DetectableAutoRepeat using
  66 .I XkbGetDetectableAutoRepeat
  67 and
  68 .I XkbSetDetectableAutoRepeat.
  69
  70 DetectableAutoRepeat is a condition that applies to all keyboard devices for a
  71 client's connection to a given X server; it cannot be selectively set for some
  72 devices and not for others. For this reason, none of the Xkb library functions
  73 involving DetectableAutoRepeat involve a device specifier.
  74
  75 This request affects all keyboard activity for the requesting client only; other
  76 clients still see the expected nondetectable auto-repeat behavior, unless they
  77 have requested otherwise.
  78
  79 .I XkbSetDetectableAutoRepeat
  80 sends a request to the server to set DetectableAutoRepeat on for the current
  81 client if
  82 .I detectable
  83 is True, and off if
  84 .I detectable
  85 is False; it then waits for a reply. If
  86 .I supported_rtrn
  87 is not NULL,
  88 .I XkbSetDetectableAutoRepeat
  89 backfills
  90 .I supported_rtrn
  91 with True if the server supports DetectableAutoRepeat, and False if it does not.
  92 .I XkbSetDetectableAutoRepeat
  93 returns the current state of DetectableAutoRepeat for the requesting client:
  94 True if DetectableAutoRepeat is set, and False otherwise.
  95 .SH "RETURN VALUES"
  96 .TP 15
  97 True
  98 The
  99 .I XkbSetDetectableAutoRepeat
 100 function returns True if DetectableAutoRepeat is set.
 101 .TP 15
 102 False
 103 The
 104 .I XkbSetDetectableAutoRepeat
 105 function returns False if DetectableAutoRepeat is not set.