NAME
XkbKeyNumGroups - Returns the number of groups of symbols bound to the key corresponding to keycode SYNOPSIS int XkbKeyNumGroups (XkbDescPtr xkb, KeyCode keycode); ARGUMENTS
- xkb Xkb description of interest
- keycode keycode of interest DESCRIPTION The groupinfo field of an XkbSymMapRec is an encoded value containing the number of groups of symbols bound to the key as well as the speci‐
fication 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 XkbKeyNumGroups. To change the number of groups bound to a key, use XkbChangeTypesOfKey. To obtain a mask that
determines the treatment of out-of-range groups, use XkbKeyGroupInfo and XkbOutOfRangeGroupInfo. The keyboard controls contain a groupswrap field specifying the han‐ dling of illegal groups on a global basis. That is, when the user per‐ forms an action causing the effective group to go out of the legal range, the groupswrap 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 groupinfo 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 groupinfo field for the Enter key describes how to handle this situa‐ tion.
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 groupinfo flag, as shown in Table 1. Table 1 groupinfo Range Normalization ────────────────────────────────────────────── Bits set in groupinfo Normalization method ────────────────────────────────────────────── XkbRedirectIntoRange XkbRedirectIntoRange XkbClampIntoRange XkbClampIntoRange none of the above XkbWrapIntoRange 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 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 pro‐
gram exits. The remaining controls, known as the 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 describ‐ ing whether the behavior as a whole is enabled or disabled. The attributes and state for most of these controls are held in the XkbCon‐ trolsRec structure. You can manipulate the Xkb controls individually, via convenience func‐ tions, or as a whole. To treat them as a group, modify an XkbControl‐ sRec 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 conve‐ nience function to manipulate one control individually, you do not use an XkbControlsRec structure directly. The Xkb controls are grouped as shown in Table 2. Table 2 Xkb Keyboard Controls ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Type of Control Control Name Boolean Control? ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Controls for enabling and disabling other controls EnabledControls No AutoReset No Control for bell behavior AudibleBell Boolean Controls for repeat key behavior PerKeyRepeat No RepeatKeys Boolean DetectableAutorepeat Boolean Controls for keyboard overlays Overlay1 Boolean Overlay2 Boolean Controls for using the mouse from the keyboard MouseKeys Boolean MouseKeysAccel Boolean Controls for better keyboard access by AccessXFeedback Boolean physically impaired persons AccessXKeys Boolean AccessXTimeout Boolean BounceKeys Boolean SlowKeys Boolean StickyKeys Boolean Controls for general keyboard mapping GroupsWrap No IgnoreGroupLock Boolean IgnoreLockMods No InternalMods No The individual categories and controls are described first, together with functions for manipulating them. STRUCTURES The KeySymMapRec structure is defined as follows:
#define XkbNumKbdGroups 4
#define XkbMaxKbdGroup (XkbNumKbdGroups-1) typedef struct { /∗ map to keysyms for a single keycode */ unsigned char ktindex[XkbNumKbdGroups]; /∗ key type index for each group */
unsigned char groupinfo; /∗ # 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; The XkbControlsRec structure is defined as follows:
#define XkbMaxLegalKeyCode 255
#define XkbPerKeyBitArraySize ((XkbMaxLegalKeyCode+1)/8) typedef struct { unsigned char mkdfltbtn; /∗ default button for keyboard driven mouse */ unsigned char numgroups; /∗ number of keyboard groups */
unsigned char groupswrap; /∗ how to wrap out-of-bounds groups */ XkbModsRec internal; /∗ defines server internal modifiers */ XkbModsRec ignorelock; /∗ modifiers to ignore when checking for grab */ unsigned int enabledctrls; /∗ 1 bit => corresponding boolean control enabled */ unsigned short repeatdelay; /∗ ms delay until first repeat */ unsigned short repeatinterval; /∗ ms delay between repeats */ unsigned short slowkeysdelay; /∗ ms minimum time key must be down to be ok */ unsigned short debouncedelay; /∗ ms delay before key reactivated */ unsigned short mkdelay; /∗ ms delay to second mouse motion event */ unsigned short mkinterval; /∗ ms delay between repeat mouse events */
unsigned short mktimetomax; /∗ # intervals until constant mouse move */ unsigned short mkmaxspeed; /∗ multiplier for maximum mouse speed */ short mkcurve; /∗ determines mouse move curve type */ unsigned short axoptions; /∗ 1 bit => Access X option enabled */ unsigned short axtimeout; /∗ seconds until Access X disabled */ unsigned short axtoptsmask; /∗ 1 bit => options to reset on Access X timeout */ unsigned short axtoptsvalues; /∗ 1 bit => turn option on, 0=> off */ unsigned int axtctrlsmask; /∗ which bits in enabledctrls to modify */ unsigned int axtctrlsvalues; /∗ values for new bits in enabledctrls */ unsigned char perkeyrepeat[XkbPerKeyBitArraySize]; /∗ per key auto repeat */ } XkbControlsRec, *XkbControlsPtr; The XkbControlsRec structure is defined as follows:
#define XkbMaxLegalKeyCode 255
#define XkbPerKeyBitArraySize ((XkbMaxLegalKeyCode+1)/8) typedef struct { unsigned char mkdfltbtn; /∗ default button for keyboard driven mouse */ unsigned char numgroups; /∗ number of keyboard groups */
unsigned char groupswrap; /∗ how to wrap out-of-bounds groups */ XkbModsRec internal; /∗ defines server internal modifiers */ XkbModsRec ignorelock; /∗ modifiers to ignore when checking for grab */ unsigned int enabledctrls; /∗ 1 bit => corresponding boolean control enabled */ unsigned short repeatdelay; /∗ ms delay until first repeat */ unsigned short repeatinterval; /∗ ms delay between repeats */ unsigned short slowkeysdelay; /∗ ms minimum time key must be down to be ok */ unsigned short debouncedelay; /∗ ms delay before key reactivated */ unsigned short mkdelay; /∗ ms delay to second mouse motion event */ unsigned short mkinterval; /∗ ms delay between repeat mouse events */
unsigned short mktimetomax; /∗ # intervals until constant mouse move */ unsigned short mkmaxspeed; /∗ multiplier for maximum mouse speed */ short mkcurve; /∗ determines mouse move curve type */ unsigned short axoptions; /∗ 1 bit => Access X option enabled */ unsigned short axtimeout; /∗ seconds until Access X disabled */ unsigned short axtoptsmask; /∗ 1 bit => options to reset on Access X timeout */ unsigned short axtoptsvalues; /∗ 1 bit => turn option on, 0=> off */ unsigned int axtctrlsmask; /∗ which bits in enabledctrls to modify */ unsigned int axtctrlsvalues; /∗ values for new bits in enabledctrls */ unsigned char perkeyrepeat[XkbPerKeyBitArraySize]; /∗ per key auto repeat */ XkbChangeTypesOfKey(3), XkbKeyGroupInfo(3), XkbOutOfRangeGroupInfo.(3) } XkbControlsRec, *XkbControlsPtr; SEE ALSO X Version 11 libX11 1.6.5 XkbKeyNumGroups(3)