From a0fa440dee24b4b39d30c1b04579691d42efba65 Mon Sep 17 00:00:00 2001 From: marha Date: Sat, 4 Sep 2010 16:22:11 +0000 Subject: libx11 git update 4/9/2010 --- libX11/man/xkb/XkbGetAutoRepeatRate.man | 168 ++++++++++++++++---------------- 1 file changed, 84 insertions(+), 84 deletions(-) (limited to 'libX11/man/xkb/XkbGetAutoRepeatRate.man') diff --git a/libX11/man/xkb/XkbGetAutoRepeatRate.man b/libX11/man/xkb/XkbGetAutoRepeatRate.man index 69c834dad..d9e6af7ac 100644 --- a/libX11/man/xkb/XkbGetAutoRepeatRate.man +++ b/libX11/man/xkb/XkbGetAutoRepeatRate.man @@ -1,84 +1,84 @@ -.\" Copyright 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, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" 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. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbGetAutoRepeatRate __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbGetAutoRepeatRate \- Gets the current attributes of the RepeatKeys control -for a keyboard device -.SH SYNOPSIS -.HP -.B Bool XkbGetAutoRepeatRate -.BI "(\^Display *" "display" "\^," -.BI "unsigned int " "device_spec" "\^," -.BI "unsigned int *" "timeout_rtrn" "\^," -.BI "unsigned int *" "interval_rtrn" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- display -connection to X server -.TP -.I \- device_spec -desired device ID, or XkbUseCoreKbd -.TP -.I \- timeout_rtrn -backfilled with initial repeat delay, ms -.TP -.I \- interval_rtrn -backfilled with subsequent repeat delay, ms -.SH DESCRIPTION -.LP -The core protocol allows only control over whether or not the entire keyboard or -individual keys should auto-repeat when held down. RepeatKeys is a boolean -control that extends this capability by adding control over the delay until a -key begins to repeat and the rate at which it repeats. RepeatKeys is coupled -with the core auto-repeat control: when RepeatKeys is enabled or disabled, the -core auto-repeat is enabled or disabled and vice versa. - -Auto-repeating keys are controlled by two attributes. The first, -.I timeout, -is the delay after the initial press of an auto-repeating key and the first -generated repeat event. The second, -.I interval, -is the delay between all subsequent generated repeat events. As with all boolean -controls, configuring the attributes that determine how the control operates -does not automatically enable the control as a whole. - -.I XkbGetAutoRepeatRate -queries the server for the current values of the RepeatControls control -attributes, backfills -.I timeout_rtrn -and -.I interval_rtrn -with them, and returns True. If a compatible version of the Xkb extension is not -available in the server -.I XkbGetAutoRepeatRate -returns False. -.SH "RETURN VALUES" -.TP 15 -True -The XkbGetAutoRepeatRate function returns True if a compatible version of the -Xkb extension is available in the server. -.TP 15 -False -The XkbGetAutoRepeatRate function returns False if a compatible version of the -Xkb extension is not available in the server. +.\" Copyright 1999 Oracle and/or its affiliates. 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, sublicense, +.\" and/or sell copies of the Software, and to permit persons to whom the +.\" Software is furnished to do so, subject to the following conditions: +.\" +.\" The above copyright notice and this permission notice (including the next +.\" paragraph) shall be included in all copies or substantial portions of the +.\" Software. +.\" +.\" 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. IN NO EVENT SHALL +.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +.\" DEALINGS IN THE SOFTWARE. +.\" +.TH XkbGetAutoRepeatRate __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbGetAutoRepeatRate \- Gets the current attributes of the RepeatKeys control +for a keyboard device +.SH SYNOPSIS +.HP +.B Bool XkbGetAutoRepeatRate +.BI "(\^Display *" "display" "\^," +.BI "unsigned int " "device_spec" "\^," +.BI "unsigned int *" "timeout_rtrn" "\^," +.BI "unsigned int *" "interval_rtrn" "\^);" +.if n .ti +5n +.if t .ti +.5i +.SH ARGUMENTS +.TP +.I \- display +connection to X server +.TP +.I \- device_spec +desired device ID, or XkbUseCoreKbd +.TP +.I \- timeout_rtrn +backfilled with initial repeat delay, ms +.TP +.I \- interval_rtrn +backfilled with subsequent repeat delay, ms +.SH DESCRIPTION +.LP +The core protocol allows only control over whether or not the entire keyboard or +individual keys should auto-repeat when held down. RepeatKeys is a boolean +control that extends this capability by adding control over the delay until a +key begins to repeat and the rate at which it repeats. RepeatKeys is coupled +with the core auto-repeat control: when RepeatKeys is enabled or disabled, the +core auto-repeat is enabled or disabled and vice versa. + +Auto-repeating keys are controlled by two attributes. The first, +.I timeout, +is the delay after the initial press of an auto-repeating key and the first +generated repeat event. The second, +.I interval, +is the delay between all subsequent generated repeat events. As with all boolean +controls, configuring the attributes that determine how the control operates +does not automatically enable the control as a whole. + +.I XkbGetAutoRepeatRate +queries the server for the current values of the RepeatControls control +attributes, backfills +.I timeout_rtrn +and +.I interval_rtrn +with them, and returns True. If a compatible version of the Xkb extension is not +available in the server +.I XkbGetAutoRepeatRate +returns False. +.SH "RETURN VALUES" +.TP 15 +True +The XkbGetAutoRepeatRate function returns True if a compatible version of the +Xkb extension is available in the server. +.TP 15 +False +The XkbGetAutoRepeatRate function returns False if a compatible version of the +Xkb extension is not available in the server. -- cgit v1.2.3