1XkbOutOfRangeGroupInfo(3)        XKB FUNCTIONS       XkbOutOfRangeGroupInfo(3)
2
3
4

NAME

6       XkbOutOfRangeGroupInfo  -  Returns only the out-of-range processing in‐
7       formation from the group_info field of an XkbSymMapRec structure
8

SYNOPSIS

10       unsigned char XkbOutOfRangeGroupInfo (unsigned char grp_inf);
11

ARGUMENTS

13       - grp_inf
14              Xkb description of interest
15

DESCRIPTION

17       XkbOutOfRangeGroupInfo returns only the out-of-range processing  infor‐
18       mation from the group_info field of an XkbSymMapRec structure.
19
20       The  group_info field of an XkbSymMapRec is an encoded value containing
21       the number of groups of symbols bound to the key as well as the  speci‐
22       fication of the treatment of out-of-range groups. It is legal for a key
23       to have zero groups, in which case it also has  zero  symbols  and  all
24       events from that key yield NoSymbol.  To obtain the number of groups of
25       symbols bound to the key, use XkbKeyNumGroups.  To change the number of
26       groups  bound to a key, use XkbChangeTypesOfKey.  To obtain a mask that
27       determines the treatment of out-of-range  groups,  use  XkbKeyGroupInfo
28       and XkbOutOfRangeGroupInfo.
29
30       The  keyboard  controls contain a groups_wrap field specifying the han‐
31       dling of illegal groups on a global basis. That is, when the user  per‐
32       forms  an  action  causing  the  effective group to go out of the legal
33       range, the groups_wrap field specifies how to normalize  the  effective
34       keyboard  group  to  a group that is legal for the keyboard as a whole,
35       but there is no guarantee that the normalized group will be within  the
36       range  of  legal  groups for any individual key. The per-key group_info
37       field specifies how a key treats a legal effective  group  if  the  key
38       does  not  have a type specified for the group of concern. For example,
39       the Enter key usually has just one group defined. If the user  performs
40       an  action  causing  the global keyboard group to change to Group2, the
41       group_info field for the Enter key describes how to handle this  situa‐
42       tion.
43
44       Out-of-range groups for individual keys are mapped to a legal group us‐
45       ing the same options as are used for the overall  keyboard  group.  The
46       particular  type  of  mapping used is controlled by the bits set in the
47       group_info flag, as shown in Table 1.
48
49          Table 1 group_info Range Normalization
50       ──────────────────────────────────────────────
51       Bits set in group_info   Normalization method
52       ──────────────────────────────────────────────
53       XkbRedirectIntoRange     XkbRedirectIntoRange
54       XkbClampIntoRange        XkbClampIntoRange
55       none of the above        XkbWrapIntoRange
56

STRUCTURES

58       The KeySymMapRec structure is defined as follows:
59
60           #define XkbNumKbdGroups             4
61           #define XkbMaxKbdGroup              (XkbNumKbdGroups-1)
62
63           typedef struct {                    /∗ map to keysyms for a single keycode */
64               unsigned char       kt_index[XkbNumKbdGroups];  /∗ key type index for each group */
65               unsigned char       group_info; /∗ # of groups and out of range group handling */
66               unsigned char       width;      /∗ max # of shift levels for key */
67               unsigned short      offset;     /∗ index to keysym table in syms array */
68       } XkbSymMapRec, *XkbSymMapPtr;
69
70
71       The XkbControlsRec structure is defined as follows:
72
73           #define XkbMaxLegalKeyCode     255
74           #define XkbPerKeyBitArraySize  ((XkbMaxLegalKeyCode+1)/8)
75
76
77           typedef struct {
78               unsigned char   mk_dflt_btn;      /∗ default button for keyboard driven mouse */
79               unsigned char   num_groups;       /∗ number of keyboard groups */
80               unsigned char   groups_wrap;      /∗ how to wrap out-of-bounds groups */
81               XkbModsRec      internal;         /∗ defines server internal modifiers */
82               XkbModsRec      ignore_lock;      /∗ modifiers to ignore when checking for grab */
83               unsigned int    enabled_ctrls;    /∗ 1 bit => corresponding boolean control enabled */
84               unsigned short  repeat_delay;     /∗ ms delay until first repeat */
85               unsigned short  repeat_interval;  /∗ ms delay between repeats */
86               unsigned short  slow_keys_delay;  /∗ ms minimum time key must be down to be ok */
87               unsigned short  debounce_delay;   /∗ ms delay before key reactivated */
88               unsigned short  mk_delay;         /∗ ms delay to second mouse motion event */
89               unsigned short  mk_interval;      /∗ ms delay between repeat mouse events */
90               unsigned short  mk_time_to_max;   /∗ # intervals until constant mouse move */
91               unsigned short  mk_max_speed;     /∗ multiplier for maximum mouse speed */
92               short           mk_curve;         /∗ determines mouse move curve type */
93               unsigned short  ax_options;       /∗ 1 bit => Access X option enabled */
94               unsigned short  ax_timeout;       /∗ seconds until Access X disabled */
95               unsigned short  axt_opts_mask;    /∗ 1 bit => options to reset on Access X timeout */
96               unsigned short  axt_opts_values;  /∗ 1 bit => turn option on, 0=> off */
97               unsigned int    axt_ctrls_mask;   /∗ which bits in enabled_ctrls to modify */
98               unsigned int    axt_ctrls_values; /∗ values for new bits in enabled_ctrls */
99               unsigned char   per_key_repeat[XkbPerKeyBitArraySize];  /∗ per key auto repeat */
100            } XkbControlsRec, *XkbControlsPtr;
101
102       The XkbControlsRec structure is defined as follows:
103
104           #define XkbMaxLegalKeyCode     255
105           #define XkbPerKeyBitArraySize  ((XkbMaxLegalKeyCode+1)/8)
106
107
108           typedef struct {
109               unsigned char   mk_dflt_btn;      /∗ default button for keyboard driven mouse */
110               unsigned char   num_groups;       /∗ number of keyboard groups */
111               unsigned char   groups_wrap;      /∗ how to wrap out-of-bounds groups */
112               XkbModsRec      internal;         /∗ defines server internal modifiers */
113               XkbModsRec      ignore_lock;      /∗ modifiers to ignore when checking for grab */
114               unsigned int    enabled_ctrls;    /∗ 1 bit => corresponding boolean control enabled */
115               unsigned short  repeat_delay;     /∗ ms delay until first repeat */
116               unsigned short  repeat_interval;  /∗ ms delay between repeats */
117               unsigned short  slow_keys_delay;  /∗ ms minimum time key must be down to be ok */
118               unsigned short  debounce_delay;   /∗ ms delay before key reactivated */
119               unsigned short  mk_delay;         /∗ ms delay to second mouse motion event */
120               unsigned short  mk_interval;      /∗ ms delay between repeat mouse events */
121               unsigned short  mk_time_to_max;   /∗ # intervals until constant mouse move */
122               unsigned short  mk_max_speed;     /∗ multiplier for maximum mouse speed */
123               short           mk_curve;         /∗ determines mouse move curve type */
124               unsigned short  ax_options;       /∗ 1 bit => Access X option enabled */
125               unsigned short  ax_timeout;       /∗ seconds until Access X disabled */
126               unsigned short  axt_opts_mask;    /∗ 1 bit => options to reset on Access X timeout */
127               unsigned short  axt_opts_values;  /∗ 1 bit => turn option on, 0=> off */
128               unsigned int    axt_ctrls_mask;   /∗ which bits in enabled_ctrls to modify */
129               unsigned int    axt_ctrls_values; /∗ values for new bits in enabled_ctrls */
130               unsigned char   per_key_repeat[XkbPerKeyBitArraySize];  /∗ per key auto repeat */
131            } XkbControlsRec, *XkbControlsPtr;
132

SEE ALSO

134       XkbChangeTypesOfKey(3), XkbKeyGroupInfo(3), XkbOutOfRangeGroupInfo.(3)
135
136
137
138X Version 11                     libX11 1.7.0        XkbOutOfRangeGroupInfo(3)
Impressum