diff options
Diffstat (limited to 'libX11/man/xkb/XkbGetState.man')
-rw-r--r-- | libX11/man/xkb/XkbGetState.man | 110 |
1 files changed, 55 insertions, 55 deletions
diff --git a/libX11/man/xkb/XkbGetState.man b/libX11/man/xkb/XkbGetState.man index d591b1e0a..8e408b1ad 100644 --- a/libX11/man/xkb/XkbGetState.man +++ b/libX11/man/xkb/XkbGetState.man @@ -1,55 +1,55 @@ -.\" 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 XkbGetState __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbGetState \- Obtains the keyboard state -.SH SYNOPSIS -.HP -.B Bool XkbGetState -.BI "(\^Display *" "display" "\^," -.BI "unsigned int " "device_spec" "\^," -.BI "XkbStatePtr " "state_return" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I display -connection to the X server -.TP -.I device_spec -device ID, or XkbUseCoreKbd -.TP -.I state_return -backfilled with Xkb state -.SH DESCRIPTION -.LP -The -.I XkbGetState -function queries the server for the current keyboard state, waits -for a reply, and then backfills -.I state_return -with the results. - -All group values are expressed as group indices in the range [0..3]. Modifiers -and the compatibility modifier state values are expressed as the bitwise union -of the core X11 modifier masks. The pointer button state is reported as in the -core X11 protocol. +.\" 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 XkbGetState __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
+.SH NAME
+XkbGetState \- Obtains the keyboard state
+.SH SYNOPSIS
+.HP
+.B Status XkbGetState
+.BI "(\^Display *" "display" "\^,"
+.BI "unsigned int " "device_spec" "\^,"
+.BI "XkbStatePtr " "state_return" "\^);"
+.if n .ti +5n
+.if t .ti +.5i
+.SH ARGUMENTS
+.TP
+.I display
+connection to the X server
+.TP
+.I device_spec
+device ID, or XkbUseCoreKbd
+.TP
+.I state_return
+backfilled with Xkb state
+.SH DESCRIPTION
+.LP
+The
+.I XkbGetState
+function queries the server for the current keyboard state, waits
+for a reply, and then backfills
+.I state_return
+with the results.
+
+All group values are expressed as group indices in the range [0..3]. Modifiers
+and the compatibility modifier state values are expressed as the bitwise union
+of the core X11 modifier masks. The pointer button state is reported as in the
+core X11 protocol.
|