aboutsummaryrefslogtreecommitdiff
path: root/libX11/man/xkb/XkbSetDetectableAutorepeat.man
diff options
context:
space:
mode:
authormarha <marha@users.sourceforge.net>2009-06-28 22:07:26 +0000
committermarha <marha@users.sourceforge.net>2009-06-28 22:07:26 +0000
commit3562e78743202e43aec8727005182a2558117eca (patch)
tree8f9113a77d12470c5c851a2a8e4cb02e89df7d43 /libX11/man/xkb/XkbSetDetectableAutorepeat.man
downloadvcxsrv-3562e78743202e43aec8727005182a2558117eca.tar.gz
vcxsrv-3562e78743202e43aec8727005182a2558117eca.tar.bz2
vcxsrv-3562e78743202e43aec8727005182a2558117eca.zip
Checked in the following released items:
xkeyboard-config-1.4.tar.gz ttf-bitstream-vera-1.10.tar.gz font-alias-1.0.1.tar.gz font-sun-misc-1.0.0.tar.gz font-sun-misc-1.0.0.tar.gz font-sony-misc-1.0.0.tar.gz font-schumacher-misc-1.0.0.tar.gz font-mutt-misc-1.0.0.tar.gz font-misc-misc-1.0.0.tar.gz font-misc-meltho-1.0.0.tar.gz font-micro-misc-1.0.0.tar.gz font-jis-misc-1.0.0.tar.gz font-isas-misc-1.0.0.tar.gz font-dec-misc-1.0.0.tar.gz font-daewoo-misc-1.0.0.tar.gz font-cursor-misc-1.0.0.tar.gz font-arabic-misc-1.0.0.tar.gz font-winitzki-cyrillic-1.0.0.tar.gz font-misc-cyrillic-1.0.0.tar.gz font-cronyx-cyrillic-1.0.0.tar.gz font-screen-cyrillic-1.0.1.tar.gz font-xfree86-type1-1.0.1.tar.gz font-adobe-utopia-type1-1.0.1.tar.gz font-ibm-type1-1.0.0.tar.gz font-bitstream-type1-1.0.0.tar.gz font-bitstream-speedo-1.0.0.tar.gz font-bh-ttf-1.0.0.tar.gz font-bh-type1-1.0.0.tar.gz font-bitstream-100dpi-1.0.0.tar.gz font-bh-lucidatypewriter-100dpi-1.0.0.tar.gz font-bh-100dpi-1.0.0.tar.gz font-adobe-utopia-100dpi-1.0.1.tar.gz font-adobe-100dpi-1.0.0.tar.gz font-util-1.0.1.tar.gz font-bitstream-75dpi-1.0.0.tar.gz font-bh-lucidatypewriter-75dpi-1.0.0.tar.gz font-adobe-utopia-75dpi-1.0.1.tar.gz font-bh-75dpi-1.0.0.tar.gz bdftopcf-1.0.1.tar.gz font-adobe-75dpi-1.0.0.tar.gz mkfontscale-1.0.6.tar.gz openssl-0.9.8k.tar.gz bigreqsproto-1.0.2.tar.gz xtrans-1.2.2.tar.gz resourceproto-1.0.2.tar.gz inputproto-1.4.4.tar.gz compositeproto-0.4.tar.gz damageproto-1.1.0.tar.gz zlib-1.2.3.tar.gz xkbcomp-1.0.5.tar.gz freetype-2.3.9.tar.gz pthreads-w32-2-8-0-release.tar.gz pixman-0.12.0.tar.gz kbproto-1.0.3.tar.gz evieext-1.0.2.tar.gz fixesproto-4.0.tar.gz recordproto-1.13.2.tar.gz randrproto-1.2.2.tar.gz scrnsaverproto-1.1.0.tar.gz renderproto-0.9.3.tar.gz xcmiscproto-1.1.2.tar.gz fontsproto-2.0.2.tar.gz xextproto-7.0.3.tar.gz xproto-7.0.14.tar.gz libXdmcp-1.0.2.tar.gz libxkbfile-1.0.5.tar.gz libfontenc-1.0.4.tar.gz libXfont-1.3.4.tar.gz libX11-1.1.5.tar.gz libXau-1.0.4.tar.gz libxcb-1.1.tar.gz xorg-server-1.5.3.tar.gz
Diffstat (limited to 'libX11/man/xkb/XkbSetDetectableAutorepeat.man')
-rw-r--r--libX11/man/xkb/XkbSetDetectableAutorepeat.man119
1 files changed, 119 insertions, 0 deletions
diff --git a/libX11/man/xkb/XkbSetDetectableAutorepeat.man b/libX11/man/xkb/XkbSetDetectableAutorepeat.man
new file mode 100644
index 000000000..9ba780bd9
--- /dev/null
+++ b/libX11/man/xkb/XkbSetDetectableAutorepeat.man
@@ -0,0 +1,119 @@
+.\" Copyright (c) 1999 - Sun Microsystems, Inc.
+.\" All rights reserved.
+.\"
+.\" Permission is hereby granted, free of charge, to any person obtaining a
+.\" copy of this software and associated documentation files (the
+.\" "Software"), to deal in the Software without restriction, including
+.\" without limitation the rights to use, copy, modify, merge, publish,
+.\" distribute, and/or sell copies of the Software, and to permit persons
+.\" to whom the Software is furnished to do so, provided that the above
+.\" copyright notice(s) and this permission notice appear in all copies of
+.\" the Software and that both the above copyright notice(s) and this
+.\" permission notice appear in supporting documentation.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
+.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
+.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
+.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.\" Except as contained in this notice, the name of a copyright holder
+.\" shall not be used in advertising or otherwise to promote the sale, use
+.\" or other dealings in this Software without prior written authorization
+.\" of the copyright holder.
+.\"
+.TH XkbSetDetectableAutorepeat __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
+.SH NAME
+XkbSetDetectableAutorepeat \- Sets DetectableAutorepeat
+.SH SYNTAX
+.B Bool XkbSetDetectableAutorepeat
+(
+.I display,
+.I detectable,
+.I supported_rtrn
+)
+.br
+ Display *\fI display \fP\^;
+.br
+ Bool \fI detectable \fP\^;
+.br
+ Bool *\fI supported_rtrn \fP\^;
+.if n .ti +5n
+.if t .ti +.5i
+.SH ARGUMENTS
+.TP
+.I \- display
+connection to X server
+.TP
+.I \- detectable
+True => set DetectableAutorepeat
+.TP
+.I \- supported_rtrn
+backfilled True if DetectableAutorepeat supported
+.SH DESCRIPTION
+.LP
+Auto-repeat is the generation of multiple key events by a keyboard when the user
+presses a key and holds it down. Keyboard hardware and device-dependent X server
+software often implement auto-repeat by generating multiple KeyPress events with
+no intervening KeyRelease event. The standard behavior of the X server is to
+generate a KeyRelease event for every KeyPress event. If the keyboard hardware
+and device-dependent software of the X server implement auto-repeat by
+generating multiple KeyPress events, the device-independent part of the X server
+by default synthetically generates a KeyRelease event after each KeyPress event.
+This provides predictable behavior for X clients, but does not allow those
+clients to detect the fact that a key is auto-repeating.
+
+Xkb allows clients to request
+.I detectable auto-repeat.
+If a client requests and the server supports DetectableAutorepeat, Xkb generates
+KeyRelease events only when the key is physically released. If
+DetectableAutorepeat is not supported or has not been requested, the server
+synthesizes a KeyRelease event for each repeating KeyPress event it generates.
+
+DetectableAutorepeat, unlike other controls, is not contained in the
+XkbControlsRec structure, nor can it be enabled or disabled via the
+EnabledControls control. Instead, query and set DetectableAutorepeat using
+.I XkbGetDetectableAutorepeat
+and
+.I XkbSetDetectableAutorepeat.
+
+DetectableAutorepeat is a condition that applies to all keyboard devices for a
+client's connection to a given X server; it cannot be selectively set for some
+devices and not for others. For this reason, none of the Xkb library functions
+involving DetectableAutorepeat involve a device specifier.
+
+This request affects all keyboard activity for the requesting client only; other
+clients still see the expected nondetectable auto-repeat behavior, unless they
+have requested otherwise.
+
+.I XkbSetDetectableAutorepeat
+sends a request to the server to set DetectableAutorepeat on for the current
+client if
+.I detectable
+is True, and off if
+.I detectable
+is False; it then waits for a reply. If
+.I supported_rtrn
+is not NULL,
+.I XkbSetDetectableAutorepeat
+backfills
+.I supported_rtrn
+with True if the server supports DetectableAutorepeat, and False if it does not.
+.I XkbSetDetectableAutorepeat
+returns the current state of DetectableAutorepeat for the requesting client:
+True if DetectableAutorepeat is set, and False otherwise.
+.SH "RETURN VALUES"
+.TP 15
+True
+The
+.I XkbSetDetectableAutorepeat
+function returns True if DetectableAutorepeat is set.
+.TP 15
+False
+The
+.I XkbSetDetectableAutorepeat
+function returns False if DetectableAutorepeat is not set.