1XkbKeyNumGroups(3) XKB FUNCTIONS XkbKeyNumGroups(3)
2
6 XkbKeyNumGroups - Returns the number of groups of symbols bound to the
7 key corresponding to keycode
8
10 int XkbKeyNumGroups (XkbDescPtr xkb, KeyCode keycode);
11
13 xkb Xkb description of interest
14 keycode
16 keycode of interest
17
19 The group_info field of an XkbSymMapRec is an encoded value containing
20 the number of groups of symbols bound to the key as well as the speci‐
21 fication of the treatment of out-of-range groups. It is legal for a key
22 to have zero groups, in which case it also has zero symbols and all
23 events from that key yield NoSymbol. To obtain the number of groups of
24 symbols bound to the key, use XkbKeyNumGroups. To change the number of
25 groups bound to a key, use XkbChangeTypesOfKey. To obtain a mask that
26 determines the treatment of out-of-range groups, use XkbKeyGroupInfo
27 and XkbOutOfRangeGroupInfo.
28 The keyboard controls contain a groups_wrap field specifying the han‐
30 dling of illegal groups on a global basis. That is, when the user per‐
31 forms an action causing the effective group to go out of the legal
32 range, the groups_wrap field specifies how to normalize the effective
33 keyboard group to a group that is legal for the keyboard as a whole,
34 but there is no guarantee that the normalized group will be within the
35 range of legal groups for any individual key. The per-key group_info
36 field specifies how a key treats a legal effective group if the key
37 does not have a type specified for the group of concern. For example,
38 the Enter key usually has just one group defined. If the user performs
39 an action causing the global keyboard group to change to Group2, the
40 group_info field for the Enter key describes how to handle this situa‐
41 tion.
42 Out-of-range groups for individual keys are mapped to a legal group us‐
44 ing the same options as are used for the overall keyboard group. The
45 particular type of mapping used is controlled by the bits set in the
46 group_info flag, as shown in Table 1.
47 Table 1 group_info Range Normalization
49 ──────────────────────────────────────────────
50 Bits set in group_info Normalization method
51 ──────────────────────────────────────────────
52 XkbRedirectIntoRange XkbRedirectIntoRange
53 XkbClampIntoRange XkbClampIntoRange
54 none of the above XkbWrapIntoRange
55 The Xkb extension is composed of two parts: a server extension, and a
57 client-side X library extension. This chapter discusses functions used
58 to modify controls effecting the behavior of the server portion of the
59 Xkb extension. X Library Controls discusses functions used to modify
60 controls that affect only the behavior of the client portion of the ex‐
61 tension; those controls are known as Library Controls.
62 Xkb contains control features that affect the entire keyboard, known as
64 global keyboard controls. Some of the controls may be selectively en‐
65 abled and disabled; these controls are known as the Boolean Controls.
66 Boolean Controls can be turned on or off under program control and can
67 also be automatically set to an on or off condition when a client pro‐
68 gram exits. The remaining controls, known as the Non-Boolean Controls,
69 are always active. The XkbControlsRec structure describes the current
70 state of most of the global controls and the attributes effecting the
71 behavior of each of these Xkb features. This chapter describes the Xkb
72 controls and how to manipulate them.
73 There are two possible components for each of the Boolean Controls: at‐
75 tributes describing how the control should work, and a state describing
76 whether the behavior as a whole is enabled or disabled. The attributes
77 and state for most of these controls are held in the XkbControlsRec
78 structure.
79 You can manipulate the Xkb controls individually, via convenience func‐
81 tions, or as a whole. To treat them as a group, modify an XkbControl‐
82 sRec structure to describe all of the changes to be made, and then pass
83 that structure and appropriate flags to an Xkb library function, or use
84 a XkbControlsChangesRec to reduce network traffic. When using a conve‐
85 nience function to manipulate one control individually, you do not use
86 an XkbControlsRec structure directly.
87 The Xkb controls are grouped as shown in Table 2.
89 Table 2 Xkb Keyboard Controls
91 ───────────────────────────────────────────────────────────────
92 Type of Control Control Name Boolean Control?
94 ───────────────────────────────────────────────────────────────
95 Controls for en‐ EnabledControls No
96 abling and disabling AutoReset No
97 other controls
98 ───────────────────────────────────────────────────────────────
99 Control for bell be‐ AudibleBell Boolean
100 havior
101 ───────────────────────────────────────────────────────────────
102 Controls for repeat PerKeyRepeat No
103 key behavior RepeatKeys Boolean
104 DetectableAutorepeat Boolean
105 ───────────────────────────────────────────────────────────────
106 Controls for Overlay1 Boolean
107 keyboard overlays Overlay2 Boolean
108 ───────────────────────────────────────────────────────────────
109 Controls for using MouseKeys Boolean
110 the mouse from the MouseKeysAccel Boolean
111 keyboard
112 ───────────────────────────────────────────────────────────────
113 AccessXFeedback Boolean
114 Controls for better AccessXKeys Boolean
115 keyboard access by AccessXTimeout Boolean
116 physically impaired BounceKeys Boolean
117 persons SlowKeys Boolean
118 StickyKeys Boolean
119 ───────────────────────────────────────────────────────────────
120 GroupsWrap No
121 Controls for general IgnoreGroupLock Boolean
122 keyboard mapping IgnoreLockMods No
123 InternalMods No
124 ───────────────────────────────────────────────────────────────
125 The individual categories and controls are described first, together
128 with functions for manipulating them.
129
131 The KeySymMapRec structure is defined as follows:
132 #define XkbNumKbdGroups 4
134 #define XkbMaxKbdGroup (XkbNumKbdGroups-1)
135 typedef struct { /* map to keysyms for a single keycode */
137 unsigned char kt_index[XkbNumKbdGroups]; /* key type index for each group */
138 unsigned char group_info; /* # of groups and out of range group handling */
139 unsigned char width; /* max # of shift levels for key */
140 unsigned short offset; /* index to keysym table in syms array */
141 } XkbSymMapRec, *XkbSymMapPtr;
142 The XkbControlsRec structure is defined as follows:
145 #define XkbMaxLegalKeyCode 255
147 #define XkbPerKeyBitArraySize ((XkbMaxLegalKeyCode+1)/8)
148 typedef struct {
151 unsigned char mk_dflt_btn; /* default button for keyboard driven mouse */
152 unsigned char num_groups; /* number of keyboard groups */
153 unsigned char groups_wrap; /* how to wrap out-of-bounds groups */
154 XkbModsRec internal; /* defines server internal modifiers */
155 XkbModsRec ignore_lock; /* modifiers to ignore when checking for grab */
156 unsigned int enabled_ctrls; /* 1 bit => corresponding boolean control enabled */
157 unsigned short repeat_delay; /* ms delay until first repeat */
158 unsigned short repeat_interval; /* ms delay between repeats */
159 unsigned short slow_keys_delay; /* ms minimum time key must be down to be ok */
160 unsigned short debounce_delay; /* ms delay before key reactivated */
161 unsigned short mk_delay; /* ms delay to second mouse motion event */
162 unsigned short mk_interval; /* ms delay between repeat mouse events */
163 unsigned short mk_time_to_max; /* # intervals until constant mouse move */
164 unsigned short mk_max_speed; /* multiplier for maximum mouse speed */
165 short mk_curve; /* determines mouse move curve type */
166 unsigned short ax_options; /* 1 bit => Access X option enabled */
167 unsigned short ax_timeout; /* seconds until Access X disabled */
168 unsigned short axt_opts_mask; /* 1 bit => options to reset on Access X timeout */
169 unsigned short axt_opts_values; /* 1 bit => turn option on, 0=> off */
170 unsigned int axt_ctrls_mask; /* which bits in enabled_ctrls to modify */
171 unsigned int axt_ctrls_values; /* values for new bits in enabled_ctrls */
172 unsigned char per_key_repeat[XkbPerKeyBitArraySize]; /* per key auto repeat */
173 } XkbControlsRec, *XkbControlsPtr;
174 The XkbControlsRec structure is defined as follows:
176 #define XkbMaxLegalKeyCode 255
178 #define XkbPerKeyBitArraySize ((XkbMaxLegalKeyCode+1)/8)
179 typedef struct {
181 unsigned char mk_dflt_btn; /* default button for keyboard driven mouse */
182 unsigned char num_groups; /* number of keyboard groups */
183 unsigned char groups_wrap; /* how to wrap out-of-bounds groups */
184 XkbModsRec internal; /* defines server internal modifiers */
185 XkbModsRec ignore_lock; /* modifiers to ignore when checking for grab */
186 unsigned int enabled_ctrls; /* 1 bit => corresponding booleancontrol enabled */
187 unsigned short repeat_delay; /* ms delay until first repeat */
188 unsigned short repeat_interval; /* ms delay between repeats */
189 unsigned short slow_keys_delay; /* ms minimum time key must be down to be ok */
190 unsigned short debounce_delay; /* ms delay before key reactivated */
191 unsigned short mk_delay; /* ms delay to second mouse motion event */
192 unsigned short mk_interval; /* ms delay between repeat mouse events */
193 unsigned short mk_time_to_max; /* # intervals until constant mouse move */
194 unsigned short mk_max_speed; /* multiplier for maximum mouse speed */
195 short mk_curve; /* determines mouse move curve type */
196 unsigned short ax_options; /* 1 bit => Access X option enabled */
197 unsigned short ax_timeout; /* seconds until Access X disabled */
198 unsigned short axt_opts_mask; /* 1 bit => options to reset on Access X timeout */
199 unsigned short axt_opts_values; /* 1 bit => turn option on, 0=> off */
200 unsigned int axt_ctrls_mask; /* which bits in enabled_ctrls to modify */
201 unsigned int axt_ctrls_values; /* values for new bits in enabled_ctrls */
202 unsigned char per_key_repeat[XkbPerKeyBitArraySize]; /* per key auto repeat */
203 } XkbControlsRec, *XkbControlsPtr;
204
206 XkbChangeTypesOfKey(3), XkbKeyGroupInfo(3), XkbOutOfRangeGroupInfo.(3)
207X Version 11 libX11 1.8.7 XkbKeyNumGroups(3)