1XkbChangeIndicators(3) XKB FUNCTIONS XkbChangeIndicators(3)
2
6 XkbChangeIndicators - Changes indicator maps or state without passing
7 the entire keyboard description
8
10 Bool XkbChangeIndicators (Display *dpy, XkbDescPtr xkb, XkbIndicator‐
11 ChangesPtr changes, unsigned int state);
12
14 - dpy connection to the X server
15 - xkb keyboard description from which names are to be taken.
17 - changes
19 indicators to be updated on the server
20 - state
22 new state of indicators listed in changes->state_changes
23
25 The XkbIndicatorChangesRec identifies small modifications to the indi‐
26 cator map. Use it with the function XkbChangeIndicators to reduce the
27 amount of traffic sent to the server (see STRUCTURES).
28 The state_changes field is a mask that specifies the indicators that
30 have changed state, and map_changes is a mask that specifies the indi‐
31 cators whose maps have changed.
32 XkbChangeIndicators copies any maps specified by changes from the key‐
34 board description, xkb, to the server specified by dpy. If any bits
35 are set in the state_changes field of changes, XkbChangeIndicators also
36 sets the state of those indicators to the values specified in the state
37 mask. A 1 bit in state turns the corresponding indicator on, a 0 bit
38 turns it off.
39 In addition, it can also generate XkbIndicatorStateNotify and XkbIndi‐
41 catorMapNotify events.
42 Whenever an indicator changes state, the server sends XkbIndica‐
44 torStateNotify events to all interested clients. Similarly, whenever an
45 indicator's map changes, the server sends XkbIndicatorMapNotify events
46 to all interested clients.
47 To receive XkbIndicatorStateNotify events, use XkbSelectEvents with
49 both the bits_to_change and values_for_bits parameters containing
50 XkbIndicatorStateNotifyMask. To receive XkbIndicatorMapNotify events,
51 use XkbSelectEvents with XkbIndicatorMapNotifyMask.
52 To receive events for only specific indicators, use XkbSelectEventDe‐
54 tails. Set the event_type parameter to XkbIndicatorStateNotify or
55 XkbIndicatorMapNotify, and set both the bits_to_change and val‐
56 ues_for_bits detail parameters to a mask where each bit specifies one
57 indicator, turning on those bits that specify the indicators for which
58 you want to receive events.
59 xkb_type is either XkbIndicatorStateNotify or XkbIndicatorMapNotify,
61 depending on whether the event is a kbIndicatorStateNotify event or
62 kbIndicatorMapNotify event.
63 The changed parameter is a mask that is the bitwise inclusive OR of the
65 indicators that have changed. If the event is of type XkbIndicatorMap‐
66 Notify, changed reports the maps that changed. If the event is of type
67 XkbIndicatorStateNotify, changed reports the indicators that have
68 changed state. state is a mask that specifies the current state of all
69 indicators, whether they have changed or not, for both XkbIndica‐
70 torStateNotify and IndicatorMapNotify events.
71
73 typedef struct _XkbIndicatorChanges {
74 unsigned int state_changes;
75 unsigned int map_changes;
76 }XkbIndicatorChangesRec,*XkbIndicatorChangesPtr;
77 Both types of indicator events use the same structure:
79 typedef struct _XkbIndicatorNotify {
81 int type; /∗ Xkb extension base event code */
82 unsigned long serial; /∗ X server serial number for event */
83 Bool send_event; /∗ True => synthetically generated */
84 Display * display; /∗ server connection where event generated */
85 Time time; /∗ server time when event generated */
86 int xkb_type; /∗ specifies state or map notify */
87 int device; /∗ Xkb device ID, will not be XkbUseCoreKbd*/
88 unsigned int changed; /∗ mask of indicators with new state or map */
89 unsigned int state; /∗ current state of all indicators */
90 } XkbIndicatorNotifyEvent;
91
94 BadAtom A name is neither a valid Atom or None
95 BadImplementation
97 Invalid reply from server
98
100 XkbIndicatorMapNotify(3), XkbIndicatorStateNotify(3)
101X Version 11 libX11 1.6.7 XkbChangeIndicators(3)