diff options
author | marha <marha@users.sourceforge.net> | 2009-06-28 22:07:26 +0000 |
---|---|---|
committer | marha <marha@users.sourceforge.net> | 2009-06-28 22:07:26 +0000 |
commit | 3562e78743202e43aec8727005182a2558117eca (patch) | |
tree | 8f9113a77d12470c5c851a2a8e4cb02e89df7d43 /libX11/man/xkb/XkbGetAccessXTimeout.man | |
download | vcxsrv-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/XkbGetAccessXTimeout.man')
-rw-r--r-- | libX11/man/xkb/XkbGetAccessXTimeout.man | 162 |
1 files changed, 162 insertions, 0 deletions
diff --git a/libX11/man/xkb/XkbGetAccessXTimeout.man b/libX11/man/xkb/XkbGetAccessXTimeout.man new file mode 100644 index 000000000..7a53cc995 --- /dev/null +++ b/libX11/man/xkb/XkbGetAccessXTimeout.man @@ -0,0 +1,162 @@ +.\" 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 XkbGetAccessXTimeout __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbGetAccessXTimeout \- Queries the current AccessXTimeout options for a +keyboard device +.SH SYNOPSIS +.B Bool XkbGetAccessXTimeout +( +.I display, +.I device_spec, +.I timeout_rtrn, +.I ctrls_mask_rtrn, +.I ctrls_values_rtrn, +.I options_mask_rtrn, +.I options_values_rtrn +) +.br + Display *\fI display \fP\^; +.br + unsigned int \fI device_spec \fP\^; +.br + unsigned short *\fI timeout_rtrn \fP\^; +.br + unsigned int *\fI ctrls_mask_rtrn \fP\^; +.br + unsigned int *\fI ctrls_values_rtrn \fP\^; +.br + unsigned short *\fI options_mask_rtrn \fP\^; +.br + unsigned short *\fI options_values_rtrn \fP\^; +.if n .ti +5n +.if t .ti +.5i +.SH ARGUMENTS +.TP +.I \- display +unsigned short +.TP +.I \- device_spec +device to query, or XkbUseCoreKbd +.TP +.I \- timeout_rtrn +delay until AccessXTimeout, seconds +.TP +.I \- ctrls_mask_rtrn +backfilled with controls to modify +.TP +.I \- ctrls_values_rtrn +backfilled with on/off status for controls +.TP +.I \- options_mask_rtrn +backfilled with ax_options to modify +.TP +.I \- options_values_rtrn +backfilled with values for ax_options +.SH DESCRIPTION +.LP +In environments where computers are shared, features such as SlowKeys present a +problem: if +SlowKeys is on, the keyboard can appear to be unresponsive because keys are not +accepted +until they are held for a certain period of time. To help solve this problem, +Xkb provides +an AccessXTimeout control to automatically change the enabled/disabled state of +any boolean +controls and to change the value of the AccessXKeys and AccessXFeedback control +attributes +if the keyboard is idle for a specified period of time. + +When a timeout as specified by AccessXTimeout occurs and a control is +consequently modified, +Xkb generates an XkbControlsNotify event. + +.I XkbGetAccessXTimeout +sends a request to the X server to obtain the current values for the +AccessXTimeout attributes, waits for a reply, and backfills the values into the +appropriate arguments. The parameters +.I options_mask_rtrn +and +.I options_values_rtrn +are backfilled with the options to modify and the values for +.I ax_options, +which is a field in the XkbControlsRec structure. +.I XkbGetAccessXTimeout +returns True if successful; if a compatible version of the Xkb extension is not +available in the server, +.I XkbGetAccessXTimeout +returns False. +.SH "RETURN VALUES" +.TP 15 +True +The +.I XkbGetAccessXTimeout +returns True when it successfully sends a request to the X server to obtain the +current values for the AccessXTimeout attributes, waits for a reply, and +backfills the values into the appropriate arguments. +.TP 15 +False +The +.I XkbGetAccessXTimeout +funtion returns False if a compatible version of the Xkb extension is not +available in the +server. +.SH STRUCTURES +.LP +.nf +The XkbControlsRec structure is defined as follows: + +\&#define XkbMaxLegalKeyCode 255 +\&#define XkbPerKeyBitArraySize ((XkbMaxLegalKeyCode+1)/8) + +typedef struct { + unsigned char mk_dflt_btn; /\(** default button for keyboard driven mouse */ + unsigned char num_groups; /\(** number of keyboard groups */ + unsigned char groups_wrap; /\(** how to wrap out-of-bounds groups */ + XkbModsRec internal; /\(** defines server internal modifiers */ + XkbModsRec ignore_lock; /\(** modifiers to ignore when checking for grab */ + unsigned int enabled_ctrls; /\(** 1 bit => corresponding boolean control enabled */ + unsigned short repeat_delay; /\(** ms delay until first repeat */ + unsigned short repeat_interval; /\(** ms delay between repeats */ + unsigned short slow_keys_delay; /\(** ms minimum time key must be down to be ok */ + unsigned short debounce_delay; /\(** ms delay before key reactivated */ + unsigned short mk_delay; /\(** ms delay to second mouse motion event */ + unsigned short mk_interval; /\(** ms delay between repeat mouse events */ + unsigned short mk_time_to_max; /\(** # intervals until constant mouse move */ + unsigned short mk_max_speed; /\(** multiplier for maximum mouse speed */ + short mk_curve; /\(** determines mouse move curve type */ + unsigned short ax_options; /\(** 1 bit => Access X option enabled */ + unsigned short ax_timeout; /\(** seconds until Access X disabled */ + unsigned short axt_opts_mask; /\(** 1 bit => options to reset on Access X timeout */ + unsigned short axt_opts_values; /\(** 1 bit => turn option on, 0=> off */ + unsigned int axt_ctrls_mask; /\(** which bits in enabled_ctrls to modify */ + unsigned int axt_ctrls_values; /\(** values for new bits in enabled_ctrls */ + unsigned char per_key_repeat[XkbPerKeyBitArraySize]; /\(** per key auto repeat */ +} XkbControlsRec, *XkbControlsPtr; +.fi |