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

NAME

6       XkbKeyGroupInfo  - Returns the number of groups of symbols bound to the
7       key corresponding to keycode
8

SYNOPSIS

10       unsigned char XkbKeyGroupInfo (XkbDescPtr xkb, KeyCode keycode);
11

ARGUMENTS

13       xkb    Xkb description of interest
14
15       keycode
16              keycode of interest
17

DESCRIPTION

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
29       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
43       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
48          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
56       XkbKeyGroupInfo  returns  the  group_info  field  from the XkbSymMapRec
57       structure associated with the key corresponding to keycode.
58

STRUCTURES

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