1XkbGetControls(3) XKB FUNCTIONS XkbGetControls(3)
2
6 XkbGetControls - Finds the current state of Xkb server controls
7
9 Status XkbGetControls (Display *display, unsigned long which, XkbDe‐
10 scPtr xkb);
11
13 - display
14 connection to X server
15 - which
17 mask of controls requested
18 - xkb keyboard description for controls information
20
22 XkbGetControls queries the server for the requested control informa‐
23 tion, waits for a reply, and then copies the server's values for the
24 requested information into the ctrls structure of the xkb argument.
25 Only those components specified by the which parameter are copied.
26 Valid values for which are any combination of the masks listed in Table
27 1 that have "ok" in the which column.
28 Table 1 shows the actual values for the individual mask bits used to
30 select controls for modification and to enable and disable the control.
31 Note that the same mask bit is used to specify general modifications to
32 the parameters used to configure the control (which), and to enable and
33 disable the control (enabled_ctrls). The anomalies in Table 1 (no "ok"
34 in column) are for controls that have no configurable attributes; and
35 for controls that are not boolean controls and therefore cannot be en‐
36 abled or disabled.
37 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 If xkb->ctrls is NULL, XkbGetControls allocates and initializes it be‐
69 fore obtaining the values specified by which. If xkb->ctrls is not
70 NULL, XkbGetControls modifies only those portions of xkb->ctrls corre‐
71 sponding to the values specified by which.
72 XkbGetControls returns Success if successful; otherwise, it returns
74 BadAlloc if it cannot obtain sufficient storage, BadMatch if xkb is
75 NULL or which is empty, or BadImplementation.
76 To free the ctrls member of a keyboard description, use XkbFreeCon‐
78 trols.
79 The num_groups field in the ctrls structure is always filled in by Xk‐
81 bGetControls, regardless of which bits are selected by which.
82
84 Success The XkbGetControls function returns Success if success‐
85 ful.
86
88 BadAlloc Unable to allocate storage
89 BadImplementation
91 Invalid reply from server
92 BadMatch A compatible version of Xkb was not available in the
94 server or an argument has correct type and range, but is
95 otherwise invalid
96
99 XkbFreeControls(3)
100X Version 11 libX11 1.8.1 XkbGetControls(3)