1XkbNoteControlsChanges(3) XKB FUNCTIONS XkbNoteControlsChanges(3)
2
6 XkbNoteControlsChanges - Notes the changes in a changes structure when
7 a client receives an XkbControlsNotify event
8
10 void XkbNoteControlsChanges (XkbControlsChangesPtr changes, XkbControl‐
11 sNotifyEvent *new, unsigned int wanted);
12
14 - changes
15 records changes indicated by new
16 - new tells which things have changed
18 - wanted
20 tells which parts of new to record in changes
21
23 Whenever a field in the controls structure changes in the server's key‐
24 board description, the server sends an XkbControlsNotify event to all
25 interested clients.To receive XkbControlsNotify events under all possi‐
26 ble conditions, use XkbSelectEvents and pass XkbControlsNotifyMask in
27 both bits_to_change and values_for_bits.
28 To receive XkbControlsNotify events only under certain conditions, use
30 XkbSelectEventDetails using XkbControlsNotify as the event_type and
31 specifying the desired state changes in bits_to_change and val‐
32 ues_for_bits using mask bits from Table 1.
33 Table 1 shows the actual values for the individual mask bits used to
35 select controls for modification and to enable and disable the control.
36 Note that the same mask bit is used to specify general modifications to
37 the parameters used to configure the control (which), and to enable and
38 disable the control (enabled_ctrls). The anomalies in the table (no
39 "ok" in column) are for controls that have no configurable attributes;
40 and for controls that are not boolean controls and therefore cannot be
41 enabled or disabled.
42 Table 1 Controls Mask Bits
45 ──────────────────────────────────────────────────────────────────────────
46 Mask Bit which or enabled Value
47 changed_ctrls _ctrls
48 ──────────────────────────────────────────────────────────────────────────
49 XkbRepeatKeysMask ok ok (1L<<0)
50 XkbSlowKeysMask ok ok (1L<<1)
51 XkbBounceKeysMask ok ok (1L<<2)
52 XkbStickyKeysMask ok ok (1L<<3)
53 XkbMouseKeysMask ok ok (1L<<4)
54 XkbMouseKeysAccelMask ok ok (1L<<5)
55 XkbAccessXKeysMask ok ok (1L<<6)
56 XkbAccessXTimeoutMask ok ok (1L<<7)
57 XkbAccessXFeedbackMask ok ok (1L<<8)
58 XkbAudibleBellMask ok (1L<<9)
59 XkbOverlay1Mask ok (1L<<10)
60 XkbOverlay2Mask ok (1L<<11)
61 XkbIgnoreGroupLockMask ok (1L<<12)
62 XkbGroupsWrapMask ok (1L<<27)
63 XkbInternalModsMask ok (1L<<28)
64 XkbIgnoreLockModsMask ok (1L<<29)
65 XkbPerKeyRepeatMask ok (1L<<30)
66 XkbControlsEnabledMask ok (1L<<31)
68 XkbAccessXOptionsMask ok ok (XkbStickyKeysMask |
69 XkbAccessXFeedbackMask)
70 XkbAllBooleanCtrlsMask ok (0x00001FFF)
71 XkbAllControlsMask ok (0xF8001FFF)
72 The changed_ctrls field specifies the controls components that have
74 changed and consists of bits taken from the masks defined in Table 1
75 with "ok" in the changed_ctrls column.
76 The controls currently enabled in the server are reported in the
78 enabled_ctrls field. If any controls were just enabled or disabled
79 (that is, the contents of the enabled_ctrls field changed), they are
80 flagged in the enabled_ctrl_changes field. The valid bits for these
81 fields are the masks listed in Table 1 with "ok" in the enabled_ctrls
82 column. The num_groups field reports the number of groups bound to the
83 key belonging to the most number of groups and is automatically updated
84 when the keyboard mapping changes.
85 If the change was caused by a request from a client, the keycode and
87 event_type fields are set to zero and the req_major and req_minor
88 fields identify the request. The req_major value is the same as the
89 major extension opcode. Otherwise, event_type is set to the type of
90 event that caused the change (one of KeyPress, KeyRelease, DeviceKey‐
91 Press, DeviceKeyRelease, ButtonPress or ButtonRelease), and req_major
92 and req_minor are undefined. If event_type is KeyPress, KeyRelease,
93 DeviceKeyPress, or DeviceKeyRelease, the keycode field is set to the
94 key that caused the change. If event_type is ButtonPress or ButtonRe‐
95 lease, keycode contains the button number.
96 When a client receives an XkbControlsNotify event, it can note the
98 changes in a changes structure using XkbNoteControlsChanges.
99 The wanted parameter is a bitwise inclusive OR of bits taken from the
101 set of masks specified in Table 1 with "ok" in the changed_ctrls col‐
102 umn. XkbNoteControlsChanges copies any changes reported in new and
103 specified in wanted into the changes record specified by old.
104
106 The structure for the XkbControlsNotify event is defined as follows:
107 typedef struct {
109 int type; /∗ Xkb extension base event code */
110 unsigned long serial; /∗ X server serial number for event */
111 Bool send_event; /∗ True => synthetically generated */
112 Display * display; /∗ server connection where event generated */
113 Time time; /∗ server time when event generated */
114 int xkb_type; /∗ XkbCompatMapNotify */
115 int device; /∗ Xkb device ID, will not be XkbUseCoreKbd */
116 unsigned int changed_ctrls; /∗ bits indicating which controls data have changed*/
117 unsigned int enabled_ctrls; /∗ controls currently enabled in server */
118 unsigned int enabled_ctrl_changes; /∗ bits indicating enabled/disabled controls */
119 int num_groups; /∗ current number of keyboard groups */
120 KeyCode keycode; /∗ != 0 => keycode of key causing change */
121 char event_type; /∗ Type of event causing change */
122 char req_major; /∗ major event code of event causing change */
123 char req_minor; /∗ minor event code of event causing change */
124 } XkbControlsNotifyEvent;
125
127 XkbSelectEventDetails(3), XkbSelectEvents(3)
128X Version 11 libX11 1.6.7 XkbNoteControlsChanges(3)