1XkbAllocControls(3) XKB FUNCTIONS XkbAllocControls(3)
2
6 XkbAllocControls - Allocates an XkbControlsRec structure in the XkbDe‐
7 scRec
8
10 Status XkbAllocControls (XkbDescPtr xkb, unsigned int which);
11
13 xkb Xkb description in which to allocate ctrls rec
14 which mask of components of ctrls to allocate
16
18 The need to allocate an XkbControlsRec structure seldom arises; Xkb
19 creates one when an application calls XkbGetControls or a related func‐
20 tion. For those situations where there is not an XkbControlsRec struc‐
21 ture allocated in the XkbDescRec, allocate one by calling XkbAllocCon‐
22 trols.
23 XkbAllocControls allocates the ctrls field of the xkb parameter, ini‐
25 tializes all fields to zero, and returns Success. If the ctrls field is
26 not NULL, XkbAllocControls simply returns Success. If xkb is NULL, Xk‐
27 bAllocControls reports a BadMatch error. If the ctrls field could not
28 be allocated, it reports a BadAlloc error.
29 The which mask specifies the individual fields of the ctrls structure
31 to be allocated and can contain any of the valid masks defined in Table
32 1. (SHOULD THIS COMMENT BE LEFT IN????) Because none of the currently
33 existing controls have any structures associated with them, which is
34 currently of little practical value in this call.
35 Table 1 shows the actual values for the individual mask bits used to
37 select controls for modification and to enable and disable the control.
38 Note that the same mask bit is used to specify general modifications to
39 the parameters used to configure the control (which), and to enable and
40 disable the control (enabled_ctrls). The anomalies in the table (no
41 "ok" in column) are for controls that have no configurable attributes;
42 and for controls that are not boolean controls and therefore cannot be
43 enabled or disabled.
44 Table 1 Controls Mask Bits
47 ───────────────────────────────────────────────────────────────────────────
48 Mask Bit which or enabled Value
49 changed_ctrls _ctrls
50 ───────────────────────────────────────────────────────────────────────────
51 XkbRepeatKeysMask ok ok (1L<<0)
52 XkbSlowKeysMask ok ok (1L<<1)
53 XkbBounceKeysMask ok ok (1L<<2)
54 XkbStickyKeysMask ok ok (1L<<3)
55 XkbMouseKeysMask ok ok (1L<<4)
56 XkbMouseKeysAccelMask ok ok (1L<<5)
57 XkbAccessXKeysMask ok ok (1L<<6)
58 XkbAccessXTimeoutMask ok ok (1L<<7)
59 XkbAccessXFeedbackMask ok ok (1L<<8)
60 XkbAudibleBellMask ok (1L<<9)
61 XkbOverlay1Mask ok (1L<<10)
62 XkbOverlay2Mask ok (1L<<11)
63 XkbIgnoreGroupLockMask ok (1L<<12)
64 XkbGroupsWrapMask ok (1L<<27)
65 XkbInternalModsMask ok (1L<<28)
66 XkbIgnoreLockModsMask ok (1L<<29)
68 XkbPerKeyRepeatMask ok (1L<<30)
69 XkbControlsEnabledMask ok (1L<<31)
70 XkbAccessXOptionsMask ok ok (XkbStickyKeysMask |
71 XkbAccessXFeedbackMask)
72 XkbAllBooleanCtrlsMask ok (0x00001FFF)
73 XkbAllControlsMask ok (0xF8001FFF)
74
76 SUCCESS allocates the ctrls field of the xkb parameter,
77 initializes all fields to zero
78 the ctrls field is not NULL
80
82 BadAlloc Unable to allocate storage
83 BadMatch A compatible version of Xkb was not available in the
85 server or an argument has correct type and range, but is
86 otherwise invalid
87
89 XkbGetControls(3)
90X Version 11 libX11 1.8.7 XkbAllocControls(3)