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
44 using 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
61 extension; 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
65 enabled 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:
75 attributes describing how the control should work, and a state describ‐
76 ing whether the behavior as a whole is enabled or disabled. The
77 attributes and state for most of these controls are held in the XkbCon‐
78 trolsRec 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
94 ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
95 Type of Control Control Name Boolean Control?
96 ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
97 Controls for enabling and disabling other controls EnabledControls No
98 AutoReset No
99 Control for bell behavior AudibleBell Boolean
100 Controls for repeat key behavior PerKeyRepeat No
101 RepeatKeys Boolean
102 DetectableAutorepeat Boolean
103 Controls for keyboard overlays Overlay1 Boolean
104 Overlay2 Boolean
105 Controls for using the mouse from the keyboard MouseKeys Boolean
106 MouseKeysAccel Boolean
107 Controls for better keyboard access by AccessXFeedback Boolean
108 physically impaired persons AccessXKeys Boolean
109 AccessXTimeout Boolean
110 BounceKeys Boolean
111 SlowKeys Boolean
112 StickyKeys Boolean
113 Controls for general keyboard mapping GroupsWrap No
114 IgnoreGroupLock Boolean
115 IgnoreLockMods No
116 InternalMods No
117 The individual categories and controls are described first, together with
119 functions for manipulating
120 them.
121 STRUCTURES
123 The KeySymMapRec structure is defined as follows:
124 #define XkbNumKbdGroups 4
125 #define XkbMaxKbdGroup (XkbNumKbdGroups-1)
126 typedef struct { /∗ map to keysyms for a single keycode
128 */
129 unsigned char kt_index[XkbNumKbdGroups]; /∗ key type index for
130 each group */
131 unsigned char group_info; /∗ # of groups and out of range group
132 handling */
133 unsigned char width; /∗ max # of shift levels for key */
134 unsigned short offset; /∗ index to keysym table in syms array
135 */
136 } XkbSymMapRec, *XkbSymMapPtr;
137 The XkbControlsRec structure is defined as follows:
140 #define XkbMaxLegalKeyCode 255
142 #define XkbPerKeyBitArraySize ((XkbMaxLegalKeyCode+1)/8)
143 typedef struct {
146 unsigned char mk_dflt_btn; /∗ default button for keyboard driven
147 mouse */
148 unsigned char num_groups; /∗ number of keyboard groups */
149 unsigned char groups_wrap; /∗ how to wrap out-of-bounds groups */
150 XkbModsRec internal; /∗ defines server internal modifiers
151 */
152 XkbModsRec ignore_lock; /∗ modifiers to ignore when checking
153 for grab */
154 unsigned int enabled_ctrls; /∗ 1 bit => corresponding boolean
155 control enabled */
156 unsigned short repeat_delay; /∗ ms delay until first repeat */
157 unsigned short repeat_interval; /∗ ms delay between repeats */
158 unsigned short slow_keys_delay; /∗ ms minimum time key must be down to
159 be ok */
160 unsigned short debounce_delay; /∗ ms delay before key reactivated */
161 unsigned short mk_delay; /∗ ms delay to second mouse motion
162 event */
163 unsigned short mk_interval; /∗ ms delay between repeat mouse
164 events */
165 unsigned short mk_time_to_max; /∗ # intervals until constant mouse
166 move */
167 unsigned short mk_max_speed; /∗ multiplier for maximum mouse speed
168 */
169 short mk_curve; /∗ determines mouse move curve type */
170 unsigned short ax_options; /∗ 1 bit => Access X option enabled */
171 unsigned short ax_timeout; /∗ seconds until Access X disabled */
172 unsigned short axt_opts_mask; /∗ 1 bit => options to reset on Access
173 X timeout */
174 unsigned short axt_opts_values; /∗ 1 bit => turn option on, 0=> off */
175 unsigned int axt_ctrls_mask; /∗ which bits in enabled_ctrls to
176 modify */
177 unsigned int axt_ctrls_values; /∗ values for new bits in
178 enabled_ctrls */
179 unsigned char per_key_repeat[XkbPerKeyBitArraySize]; /∗ per key auto
180 repeat */
181 } XkbControlsRec, *XkbControlsPtr;
182 The XkbControlsRec structure is defined as follows:
183 #define XkbMaxLegalKeyCode 255
186 #define XkbPerKeyBitArraySize ((XkbMaxLegalKeyCode+1)/8)
187 typedef struct {
190 unsigned char mk_dflt_btn; /∗ default button for keyboard driven
191 mouse */
192 unsigned char num_groups; /∗ number of keyboard groups */
193 unsigned char groups_wrap; /∗ how to wrap out-of-bounds groups */
194 XkbModsRec internal; /∗ defines server internal modifiers
195 */
196 XkbModsRec ignore_lock; /∗ modifiers to ignore when checking
197 for grab */
198 unsigned int enabled_ctrls; /∗ 1 bit => corresponding boolean
199 control enabled */
200 unsigned short repeat_delay; /∗ ms delay until first repeat */
201 unsigned short repeat_interval; /∗ ms delay between repeats */
202 unsigned short slow_keys_delay; /∗ ms minimum time key must be down to
203 be ok */
204 unsigned short debounce_delay; /∗ ms delay before key reactivated */
205 unsigned short mk_delay; /∗ ms delay to second mouse motion
206 event */
207 unsigned short mk_interval; /∗ ms delay between repeat mouse
208 events */
209 unsigned short mk_time_to_max; /∗ # intervals until constant mouse
210 move */
211 unsigned short mk_max_speed; /∗ multiplier for maximum mouse speed
212 */
213 short mk_curve; /∗ determines mouse move curve type */
214 unsigned short ax_options; /∗ 1 bit => Access X option enabled */
215 unsigned short ax_timeout; /∗ seconds until Access X disabled */
216 unsigned short axt_opts_mask; /∗ 1 bit => options to reset on Access
217 X timeout */
218 unsigned short axt_opts_values; /∗ 1 bit => turn option on, 0=> off */
219 unsigned int axt_ctrls_mask; /∗ which bits in enabled_ctrls to
220 modify */
221 unsigned int axt_ctrls_values; /∗ values for new bits in
222 enabled_ctrls */
223 unsigned char per_key_repeat[XkbPerKeyBitArraySize]; /∗ per key auto
224 repeat */
225 XkbChangeTypesOfKey(3), XkbKeyGroupInfo(3), XkbOutOfRangeGroupInfo.(3)
226 } XkbControlsRec, *XkbControlsPtr;
227 SEE ALSO
229X Version 11 libX11 1.3.4 XkbKeyNumGroups(3)