aboutsummaryrefslogtreecommitdiff
path: root/libX11/man/xkb/XkbKeyHasActions.man
diff options
context:
space:
mode:
authormarha <marha@users.sourceforge.net>2010-09-04 16:22:11 +0000
committermarha <marha@users.sourceforge.net>2010-09-04 16:22:11 +0000
commita0fa440dee24b4b39d30c1b04579691d42efba65 (patch)
tree871ba76fa2620c406a09c0529312691d40f37495 /libX11/man/xkb/XkbKeyHasActions.man
parent28d9e16b745a3127287215888b0b5f12acb255af (diff)
downloadvcxsrv-a0fa440dee24b4b39d30c1b04579691d42efba65.tar.gz
vcxsrv-a0fa440dee24b4b39d30c1b04579691d42efba65.tar.bz2
vcxsrv-a0fa440dee24b4b39d30c1b04579691d42efba65.zip
libx11 git update 4/9/2010
Diffstat (limited to 'libX11/man/xkb/XkbKeyHasActions.man')
-rw-r--r--libX11/man/xkb/XkbKeyHasActions.man250
1 files changed, 125 insertions, 125 deletions
diff --git a/libX11/man/xkb/XkbKeyHasActions.man b/libX11/man/xkb/XkbKeyHasActions.man
index 4f97143d0..a7fbc1780 100644
--- a/libX11/man/xkb/XkbKeyHasActions.man
+++ b/libX11/man/xkb/XkbKeyHasActions.man
@@ -1,125 +1,125 @@
-.\" 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 XkbKeyHasActions __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
-.SH NAME
-XkbKeyHasActions \- Determines if the key corresponding to
-.I keycode
-has any actions associated with it
-.SH SYNOPSIS
-.HP
-.B int XkbKeyHasActions
-.BI "(\^XkbDescPtr " "xkb" "\^,"
-.BI "KeyCode " "keycode" "\^);"
-.if n .ti +5n
-.if t .ti +.5i
-.SH ARGUMENTS
-.TP
-.I \- xkb
-Xkb description of interest
-.TP
-.I \- keycode
-keycode of interest
-.SH DESCRIPTION
-.LP
-A key action defines the effect key presses and releases have on the internal state of the
-server. For example, the expected key action associated with pressing the Shift key is to set
-the Shift modifier. There is zero or one key action associated with each keysym bound to each
-key.
-
-Just as the entire list of key symbols for the keyboard mapping is held in the
-.I syms
-field of the client map, the entire list of key actions for the keyboard mapping is held in the
-.I acts
-array of the server map. The total size of
-.I acts
-is specified by
-.I size_acts,
-and the number of entries is specified by
-.I num_acts.
-
-The
-.I key_acts
-array, indexed by keycode, describes the actions associated with a key. The
-.I key_acts
-array has
-.I min_key_code
-unused entries at the start to allow direct indexing using a keycode. If a
-.I key_acts
-entry is zero, it means the key does not have any actions associated with it. If an entry is not
-zero, the entry represents an index into the
-.I acts
-field of the server map, much as the
-.I offset
-field of a KeySymMapRec structure is an index into the
-.I syms
-field of the client map.
-
-The reason the
-.I acts
-field is a linear list of XkbActions is to reduce the memory consumption associated with a
-keymap. Because Xkb allows individual keys to have multiple shift levels and a different number
-of groups per key, a single two-dimensional array of KeySyms would potentially be very large and
-sparse. Instead, Xkb provides a small two-dimensional array of XkbActions for each key. To store
-all of these individual arrays, Xkb concatenates each array together in the
-.I acts
-field of the server map.
-
-The key action structures consist only of fields of type char or unsigned char. This is done to
-optimize data transfer when the server sends bytes over the wire. If the fields are anything but
-bytes, the server has to sift through all of the actions and swap any nonbyte fields. Because
-they consist of nothing but bytes, it can just copy them out.
-
-.I XkbKeyHasActions
-returns True if the key corresponding to
-.I keycode
-has any actions associated with it; otherwise, it returns False.
-.SH "RETURN VALUES"
-.TP 15
-True
-The
-.I XkbKeyHasActions
-function will return True if the key corresponding to
-.I keycode
-has any actions associated with it.
-.TP 15
-False
-The
-.I XkbKeyHasActions
-function will return False if the key corresponding to
-.I keycode
-does not have any actions associated with it.
-.SH STRUCTURES
-.LP
-The KeySymMapRec structure is defined as follows:
-.nf
-
- #define XkbNumKbdGroups 4
- #define XkbMaxKbdGroup (XkbNumKbdGroups-1)
-
- typedef struct { /\(** map to keysyms for a single keycode */
- unsigned char kt_index[XkbNumKbdGroups]; /\(** key type index for each group */
- unsigned char group_info; /\(** # of groups and out of range group handling */
- unsigned char width; /\(** max # of shift levels for key */
- unsigned short offset; /\(** index to keysym table in syms array */
-} XkbSymMapRec, *XkbSymMapPtr;
-
-.fi
+.\" 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 XkbKeyHasActions __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
+.SH NAME
+XkbKeyHasActions \- Determines if the key corresponding to
+.I keycode
+has any actions associated with it
+.SH SYNOPSIS
+.HP
+.B int XkbKeyHasActions
+.BI "(\^XkbDescPtr " "xkb" "\^,"
+.BI "KeyCode " "keycode" "\^);"
+.if n .ti +5n
+.if t .ti +.5i
+.SH ARGUMENTS
+.TP
+.I \- xkb
+Xkb description of interest
+.TP
+.I \- keycode
+keycode of interest
+.SH DESCRIPTION
+.LP
+A key action defines the effect key presses and releases have on the internal state of the
+server. For example, the expected key action associated with pressing the Shift key is to set
+the Shift modifier. There is zero or one key action associated with each keysym bound to each
+key.
+
+Just as the entire list of key symbols for the keyboard mapping is held in the
+.I syms
+field of the client map, the entire list of key actions for the keyboard mapping is held in the
+.I acts
+array of the server map. The total size of
+.I acts
+is specified by
+.I size_acts,
+and the number of entries is specified by
+.I num_acts.
+
+The
+.I key_acts
+array, indexed by keycode, describes the actions associated with a key. The
+.I key_acts
+array has
+.I min_key_code
+unused entries at the start to allow direct indexing using a keycode. If a
+.I key_acts
+entry is zero, it means the key does not have any actions associated with it. If an entry is not
+zero, the entry represents an index into the
+.I acts
+field of the server map, much as the
+.I offset
+field of a KeySymMapRec structure is an index into the
+.I syms
+field of the client map.
+
+The reason the
+.I acts
+field is a linear list of XkbActions is to reduce the memory consumption associated with a
+keymap. Because Xkb allows individual keys to have multiple shift levels and a different number
+of groups per key, a single two-dimensional array of KeySyms would potentially be very large and
+sparse. Instead, Xkb provides a small two-dimensional array of XkbActions for each key. To store
+all of these individual arrays, Xkb concatenates each array together in the
+.I acts
+field of the server map.
+
+The key action structures consist only of fields of type char or unsigned char. This is done to
+optimize data transfer when the server sends bytes over the wire. If the fields are anything but
+bytes, the server has to sift through all of the actions and swap any nonbyte fields. Because
+they consist of nothing but bytes, it can just copy them out.
+
+.I XkbKeyHasActions
+returns True if the key corresponding to
+.I keycode
+has any actions associated with it; otherwise, it returns False.
+.SH "RETURN VALUES"
+.TP 15
+True
+The
+.I XkbKeyHasActions
+function will return True if the key corresponding to
+.I keycode
+has any actions associated with it.
+.TP 15
+False
+The
+.I XkbKeyHasActions
+function will return False if the key corresponding to
+.I keycode
+does not have any actions associated with it.
+.SH STRUCTURES
+.LP
+The KeySymMapRec structure is defined as follows:
+.nf
+
+ #define XkbNumKbdGroups 4
+ #define XkbMaxKbdGroup (XkbNumKbdGroups-1)
+
+ typedef struct { /\(** map to keysyms for a single keycode */
+ unsigned char kt_index[XkbNumKbdGroups]; /\(** key type index for each group */
+ unsigned char group_info; /\(** # of groups and out of range group handling */
+ unsigned char width; /\(** max # of shift levels for key */
+ unsigned short offset; /\(** index to keysym table in syms array */
+} XkbSymMapRec, *XkbSymMapPtr;
+
+.fi