1XkbChangeEnabledControls(3) XKB FUNCTIONS XkbChangeEnabledControls(3)
2
6 XkbChangeEnabledControls - Manipulates the EnabledControls control
7
9 Bool XkbChangeEnabledControls (Display *dpy, unsigned int device_spec,
10 unsigned int mask, unsigned int values);
11
13 - dpy connection to X server
14 - device_spec
16 keyboard device to modify
17 - mask 1 bit -> controls to enable / disable
19 - values
21 1 bit => enable, 0 bit => disable
22
24 The EnabledControls control is a bit mask where each bit that is turned
25 on means the corresponding control is enabled, and when turned off,
26 disabled. It corresponds to the enabled_ctrls field of an XkbControl‐
27 sRec structure (see STRUCTURES). The bits describing which controls are
28 turned on or off are defined in Table 1.
29 Table 1 shows the actual values for the individual mask bits used to
31 select controls for modification and to enable and disable the control.
32 Note that the same mask bit is used to specify general modifications to
33 the parameters used to configure the control (which), and to enable and
34 disable the control (enabled_ctrls). The anomalies in the table (no
35 "ok" in column) are for controls that have no configurable attributes;
36 and for controls that are not boolean controls and therefore cannot be
37 enabled or disabled.
38 Table 1 Controls Mask Bits
40 ───────────────────────────────────────────────────────────────────────────
41 Mask Bit which or enabled Value
42 changed_ctrls _ctrls
43 ───────────────────────────────────────────────────────────────────────────
44 XkbRepeatKeysMask ok ok (1L<<0)
45 XkbSlowKeysMask ok ok (1L<<1)
46 XkbBounceKeysMask ok ok (1L<<2)
47 XkbStickyKeysMask ok ok (1L<<3)
48 XkbMouseKeysMask ok ok (1L<<4)
49 XkbMouseKeysAccelMask ok ok (1L<<5)
50 XkbAccessXKeysMask ok ok (1L<<6)
51 XkbAccessXTimeoutMask ok ok (1L<<7)
52 XkbAccessXFeedbackMask ok ok (1L<<8)
53 XkbAudibleBellMask ok (1L<<9)
54 XkbOverlay1Mask ok (1L<<10)
55 XkbOverlay2Mask ok (1L<<11)
56 XkbIgnoreGroupLockMask ok (1L<<12)
57 XkbGroupsWrapMask ok (1L<<27)
58 XkbInternalModsMask ok (1L<<28)
59 XkbIgnoreLockModsMask ok (1L<<29)
60 XkbPerKeyRepeatMask ok (1L<<30)
61 XkbControlsEnabledMask ok (1L<<31)
62 XkbAccessXOptionsMask ok ok (XkbStickyKeysMask |
63 XkbAccessXFeedbackMask)
64 XkbAllBooleanCtrlsMask ok (0x00001FFF)
65 XkbAllControlsMask ok (0xF8001FFF)
66 The mask parameter specifies the boolean controls to be enabled or dis‐
68 abled, and the values mask specifies the new state for those controls.
69 Valid values for both of these masks are composed of a bitwise inclu‐
70 sive OR of bits taken from the set of mask bits in Table 1, using only
71 those masks with "ok" in the enabled_ctrls column.
72 If the X server does not support a compatible version of Xkb or the Xkb
74 extension has not been properly initialized, XkbChangeEnabledControls
75 returns False; otherwise, it sends the request to the X server and
76 returns True.
77 Note that the EnabledControls control only enables and disables con‐
79 trols; it does not configure them. Some controls, such as the Audible‐
80 Bell control, have no configuration attributes and are therefore manip‐
81 ulated solely by enabling and disabling them. Others, however, have
82 additional attributes to configure their behavior. For example, the
83 RepeatControl control uses repeat_delay and repeat_interval fields to
84 describe the timing behavior of keys that repeat. The RepeatControl
85 behavior is turned on or off depending on the value of the XkbRe‐
86 peatKeysMask bit, but you must use other means, as described in this
87 chapter, to configure its behavior in detail.
88
90 True The X server supports a compatible version of Xkb.
91 False The X server does not support a compatible version of
93 Xkb or the Xkb extension has not been properly initial‐
94 ized.
95
97 The XkbControlsRec structure is defined as follows:
98 #define XkbMaxLegalKeyCode 255
100 #define XkbPerKeyBitArraySize ((XkbMaxLegalKeyCode+1)/8)
101 typedef struct {
104 unsigned char mk_dflt_btn; /∗ default button for keyboard driven mouse */
105 unsigned char num_groups; /∗ number of keyboard groups */
106 unsigned char groups_wrap; /∗ how to wrap out-of-bounds groups */
107 XkbModsRec internal; /∗ defines server internal modifiers */
108 XkbModsRec ignore_lock; /∗ modifiers to ignore when checking for grab */
109 unsigned int enabled_ctrls; /∗ 1 bit => corresponding boolean control enabled */
110 unsigned short repeat_delay; /∗ ms delay until first repeat */
111 unsigned short repeat_interval; /∗ ms delay between repeats */
112 unsigned short slow_keys_delay; /∗ ms minimum time key must be down to be ok */
113 unsigned short debounce_delay; /∗ ms delay before key reactivated */
114 unsigned short mk_delay; /∗ ms delay to second mouse motion event */
115 unsigned short mk_interval; /∗ ms delay between repeat mouse events */
116 unsigned short mk_time_to_max; /∗ # intervals until constant mouse move */
117 unsigned short mk_max_speed; /∗ multiplier for maximum mouse speed */
118 short mk_curve; /∗ determines mouse move curve type */
119 unsigned short ax_options; /∗ 1 bit => Access X option enabled */
120 unsigned short ax_timeout; /∗ seconds until Access X disabled */
121 unsigned short axt_opts_mask; /∗ 1 bit => options to reset on Access X timeout */
122 unsigned short axt_opts_values; /∗ 1 bit => turn option on, 0=> off */
123 unsigned int axt_ctrls_mask; /∗ which bits in enabled_ctrls to modify */
124 unsigned int axt_ctrls_values; /∗ values for new bits in enabled_ctrls */
125 unsigned char per_key_repeat[XkbPerKeyBitArraySize]; /∗ per key auto repeat */
126 } XkbControlsRec, *XkbControlsPtr;
127X Version 11 libX11 1.6.5 XkbChangeEnabledControls(3)