diff options
Diffstat (limited to 'libX11/man/xkb/XkbKeyNumGroups.man')
| -rw-r--r-- | libX11/man/xkb/XkbKeyNumGroups.man | 620 |
1 files changed, 310 insertions, 310 deletions
diff --git a/libX11/man/xkb/XkbKeyNumGroups.man b/libX11/man/xkb/XkbKeyNumGroups.man index 06c8274e2..684af07ba 100644 --- a/libX11/man/xkb/XkbKeyNumGroups.man +++ b/libX11/man/xkb/XkbKeyNumGroups.man @@ -1,310 +1,310 @@ -'\" t -.\" 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 XkbKeyNumGroups __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbKeyNumGroups \- Returns the number of groups of symbols bound to the key -corresponding to keycode -.SH SYNOPSIS -.HP -.B int XkbKeyNumGroups -.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 -The -.I group_info -field of an XkbSymMapRec is an encoded value containing the number of groups of -symbols bound to the -key as well as the specification of the treatment of out-of-range groups. It is -legal for a key to -have zero groups, in which case it also has zero symbols and all events from -that key yield NoSymbol. -To obtain the number of groups of symbols bound to the key, use -.I XkbKeyNumGroups. -To change the number of groups bound to a key, use -.I XkbChangeTypesOfKey. -To obtain a mask that determines the treatment of out-of-range groups, use -.I XkbKeyGroupInfo -and -.I XkbOutOfRangeGroupInfo. - -The keyboard controls contain a -.I groups_wrap -field specifying the handling of illegal groups on a global basis. That is, when -the user performs an -action causing the effective group to go out of the legal range, the -.I groups_wrap -field specifies how to normalize the effective keyboard group to a group that is -legal for the -keyboard as a whole, but there is no guarantee that the normalized group will be -within the range of -legal groups for any individual key. The per-key -.I group_info -field specifies how a key treats a legal effective group if the key does not -have a type specified for -the group of concern. For example, the Enter key usually has just one group -defined. If the user -performs an action causing the global keyboard group to change to Group2, the -.I group_info -field for the Enter key describes how to handle this situation. - -Out-of-range groups for individual keys are mapped to a legal group using the -same options as are used -for the overall keyboard group. The particular type of mapping used is -controlled by the bits set in -the -.I group_info -flag, as shown in Table 1. -.bp -.TS -c s -l l -l l. -Table 1 group_info Range Normalization -_ -Bits set in group_info Normalization method -_ -XkbRedirectIntoRange XkbRedirectIntoRange -XkbClampIntoRange XkbClampIntoRange -none of the above XkbWrapIntoRange -.TE - -.\"--- Chapter 10 -The Xkb extension is composed of two parts: a server extension, and a -client-side X library extension. -This chapter discusses functions used to modify controls effecting the behavior -of the server portion -of the Xkb extension. X Library Controls discusses functions used to modify -controls that affect only -the behavior of the client portion of the extension; those controls are known as -Library Controls. - -Xkb contains control features that affect the entire keyboard, known as global -keyboard controls. Some -of the controls may be selectively enabled and disabled; these controls are -known as the -.I Boolean Controls. -Boolean Controls can be turned on or off under program control and can also be -automatically set to an -on or off condition when a client program exits. The remaining controls, known -as the -.I Non-Boolean Controls, -are always active. The XkbControlsRec structure describes the current state of -most of the global -controls and the attributes effecting the behavior of each of these Xkb -features. This chapter -describes the Xkb controls and how to manipulate them. - -There are two possible components for each of the Boolean Controls: attributes -describing how the -control should work, and a state describing whether the behavior as a whole is -enabled or disabled. -The attributes and state for most of these controls are held in the -XkbControlsRec structure. - -You can manipulate the Xkb controls individually, via convenience functions, or -as a whole. To treat -them as a group, modify an XkbControlsRec structure to describe all of the -changes to be made, and -then pass that structure and appropriate flags to an Xkb library function, or -use a -XkbControlsChangesRec to reduce network traffic. When using a convenience -function to manipulate one -control individually, you do not use an XkbControlsRec structure directly. - -The Xkb controls are grouped as shown in Table 2. - -.TS -c s s -l l l -lw(2i) l l. -Table 2 Xkb Keyboard Controls -_ -Type of Control Control Name Boolean Control? -_ -T{ -Controls for enabling and disabling other controls -T} EnabledControls No - AutoReset No -T{ -Control for bell behavior -T} AudibleBell Boolean -T{ -Controls for repeat key behavior -T} PerKeyRepeat No - RepeatKeys Boolean - DetectableAutorepeat Boolean -T{ -Controls for keyboard overlays -T} Overlay1 Boolean - Overlay2 Boolean -T{ -Controls for using the mouse from the keyboard -T} MouseKeys Boolean - MouseKeysAccel Boolean -T{ -Controls for better keyboard access by -T} AccessXFeedback Boolean -T{ -physically impaired persons -T} AccessXKeys Boolean - AccessXTimeout Boolean - BounceKeys Boolean - SlowKeys Boolean - StickyKeys Boolean -T{ -Controls for general keyboard mapping -T} GroupsWrap No - IgnoreGroupLock Boolean - IgnoreLockMods No - InternalMods No -.TE - -The individual categories and controls are described first, together with -functions for manipulating -them. -.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 - -.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 - -.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 -.SH "SEE ALSO" -.BR XkbChangeTypesOfKey (__libmansuffix__), -.BR XkbKeyGroupInfo (__libmansuffix__), -.BR XkbOutOfRangeGroupInfo. (__libmansuffix__) +'\" t
+.\" 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 XkbKeyNumGroups __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
+.SH NAME
+XkbKeyNumGroups \- Returns the number of groups of symbols bound to the key
+corresponding to keycode
+.SH SYNOPSIS
+.HP
+.B int XkbKeyNumGroups
+.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
+The
+.I group_info
+field of an XkbSymMapRec is an encoded value containing the number of groups of
+symbols bound to the
+key as well as the specification of the treatment of out-of-range groups. It is
+legal for a key to
+have zero groups, in which case it also has zero symbols and all events from
+that key yield NoSymbol.
+To obtain the number of groups of symbols bound to the key, use
+.I XkbKeyNumGroups.
+To change the number of groups bound to a key, use
+.I XkbChangeTypesOfKey.
+To obtain a mask that determines the treatment of out-of-range groups, use
+.I XkbKeyGroupInfo
+and
+.I XkbOutOfRangeGroupInfo.
+
+The keyboard controls contain a
+.I groups_wrap
+field specifying the handling of illegal groups on a global basis. That is, when
+the user performs an
+action causing the effective group to go out of the legal range, the
+.I groups_wrap
+field specifies how to normalize the effective keyboard group to a group that is
+legal for the
+keyboard as a whole, but there is no guarantee that the normalized group will be
+within the range of
+legal groups for any individual key. The per-key
+.I group_info
+field specifies how a key treats a legal effective group if the key does not
+have a type specified for
+the group of concern. For example, the Enter key usually has just one group
+defined. If the user
+performs an action causing the global keyboard group to change to Group2, the
+.I group_info
+field for the Enter key describes how to handle this situation.
+
+Out-of-range groups for individual keys are mapped to a legal group using the
+same options as are used
+for the overall keyboard group. The particular type of mapping used is
+controlled by the bits set in
+the
+.I group_info
+flag, as shown in Table 1.
+.bp
+.TS
+c s
+l l
+l l.
+Table 1 group_info Range Normalization
+_
+Bits set in group_info Normalization method
+_
+XkbRedirectIntoRange XkbRedirectIntoRange
+XkbClampIntoRange XkbClampIntoRange
+none of the above XkbWrapIntoRange
+.TE
+
+.\"--- Chapter 10
+The Xkb extension is composed of two parts: a server extension, and a
+client-side X library extension.
+This chapter discusses functions used to modify controls effecting the behavior
+of the server portion
+of the Xkb extension. X Library Controls discusses functions used to modify
+controls that affect only
+the behavior of the client portion of the extension; those controls are known as
+Library Controls.
+
+Xkb contains control features that affect the entire keyboard, known as global
+keyboard controls. Some
+of the controls may be selectively enabled and disabled; these controls are
+known as the
+.I Boolean Controls.
+Boolean Controls can be turned on or off under program control and can also be
+automatically set to an
+on or off condition when a client program exits. The remaining controls, known
+as the
+.I Non-Boolean Controls,
+are always active. The XkbControlsRec structure describes the current state of
+most of the global
+controls and the attributes effecting the behavior of each of these Xkb
+features. This chapter
+describes the Xkb controls and how to manipulate them.
+
+There are two possible components for each of the Boolean Controls: attributes
+describing how the
+control should work, and a state describing whether the behavior as a whole is
+enabled or disabled.
+The attributes and state for most of these controls are held in the
+XkbControlsRec structure.
+
+You can manipulate the Xkb controls individually, via convenience functions, or
+as a whole. To treat
+them as a group, modify an XkbControlsRec structure to describe all of the
+changes to be made, and
+then pass that structure and appropriate flags to an Xkb library function, or
+use a
+XkbControlsChangesRec to reduce network traffic. When using a convenience
+function to manipulate one
+control individually, you do not use an XkbControlsRec structure directly.
+
+The Xkb controls are grouped as shown in Table 2.
+
+.TS
+c s s
+l l l
+lw(2i) l l.
+Table 2 Xkb Keyboard Controls
+_
+Type of Control Control Name Boolean Control?
+_
+T{
+Controls for enabling and disabling other controls
+T} EnabledControls No
+ AutoReset No
+T{
+Control for bell behavior
+T} AudibleBell Boolean
+T{
+Controls for repeat key behavior
+T} PerKeyRepeat No
+ RepeatKeys Boolean
+ DetectableAutorepeat Boolean
+T{
+Controls for keyboard overlays
+T} Overlay1 Boolean
+ Overlay2 Boolean
+T{
+Controls for using the mouse from the keyboard
+T} MouseKeys Boolean
+ MouseKeysAccel Boolean
+T{
+Controls for better keyboard access by
+T} AccessXFeedback Boolean
+T{
+physically impaired persons
+T} AccessXKeys Boolean
+ AccessXTimeout Boolean
+ BounceKeys Boolean
+ SlowKeys Boolean
+ StickyKeys Boolean
+T{
+Controls for general keyboard mapping
+T} GroupsWrap No
+ IgnoreGroupLock Boolean
+ IgnoreLockMods No
+ InternalMods No
+.TE
+
+The individual categories and controls are described first, together with
+functions for manipulating
+them.
+.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
+
+.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
+
+.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
+.SH "SEE ALSO"
+.BR XkbChangeTypesOfKey (__libmansuffix__),
+.BR XkbKeyGroupInfo (__libmansuffix__),
+.BR XkbOutOfRangeGroupInfo. (__libmansuffix__)
|