1XkbNoteIndicatorChanges(3)       XKB FUNCTIONS      XkbNoteIndicatorChanges(3)
2
3
4

NAME

6       XkbNoteIndicatorChanges - Notes the changes in a changes structure
7

SYNOPSIS

9       void  XkbNoteIndicatorChanges  (XkbIndicatorChangesPtr  old, XkbIndica‐
10              torNotifyEvent *new, unsigned int wanted);
11

ARGUMENTS

13       - old  XkbIndicatorChanges structure to be updated
14
15       - new  event from which changes are to be copied
16
17       - wanted
18              which changes are to be noted
19

DESCRIPTION

21       Whenever an  indicator  changes  state,  the  server  sends  XkbIndica‐
22       torStateNotify events to all interested clients. Similarly, whenever an
23       indicator's map changes, the server sends XkbIndicatorMapNotify  events
24       to all interested clients.
25
26       To  receive  XkbIndicatorStateNotify  events,  use XkbSelectEvents with
27       both  the  bits_to_change  and  values_for_bits  parameters  containing
28       XkbIndicatorStateNotifyMask.  To  receive XkbIndicatorMapNotify events,
29       use XkbSelectEvents with XkbIndicatorMapNotifyMask.
30
31       To receive events for only specific indicators,  use  XkbSelectEventDe‐
32       tails.   Set  the  event_type  parameter  to XkbIndicatorStateNotify or
33       XkbIndicatorMapNotify,  and  set  both  the  bits_to_change  and   val‐
34       ues_for_bits  detail  parameters to a mask where each bit specifies one
35       indicator, turning on those bits that specify the indicators for  which
36       you want to receive events.
37
38       The changed parameter is a mask that is the bitwise inclusive OR of the
39       indicators that have changed. If the event is of type  XkbIndicatorMap‐
40       Notify,  changed reports the maps that changed. If the event is of type
41       XkbIndicatorStateNotify,  changed  reports  the  indicators  that  have
42       changed state.  state is a mask that specifies the current state of all
43       indicators, whether they have  changed  or  not,  for  both  XkbIndica‐
44       torStateNotify and IndicatorMapNotify events.
45
46       When  your client application receives either a XkbIndicatorStateNotify
47       event or XkbIndicatorMapNotify event, you can note  the  changes  in  a
48       changes structure by calling XkbNoteIndicatorChanges.
49
50
51       The wanted parameter is the bitwise inclusive OR of XkbIndicatorMapMask
52       and XkbIndicatorStateMask.  XkbNoteIndicatorChanges copies any  changes
53       reported  in new and specified in wanted into the changes record speci‐
54       fied by old.
55

STRUCTURES

57       Both types of indicator events use the same structure:
58
59       typedef struct _XkbIndicatorNotify {
60         int            type;       /∗ Xkb extension base event code */
61         unsigned long  serial;     /∗ X server serial number for event */
62         Bool           send_event; /∗ True => synthetically generated */
63         Display *      display;    /∗ server connection where event generated */
64         Time           time;       /∗ server time when event generated */
65         int            xkb_type;   /∗ specifies state or map notify */
66         int            device;     /∗ Xkb device ID, will not be XkbUseCoreKbd */
67         unsigned int   changed;    /∗ mask of indicators with new state or map */
68         unsigned int   state;      /∗ current state of all indicators */
69       } XkbIndicatorNotifyEvent;
70
71       xkb_type is either  XkbIndicatorStateNotify  or  XkbIndicatorMapNotify,
72       depending  on  whether  the  event is a kbIndicatorStateNotify event or
73       kbIndicatorMapNotify event.
74

SEE ALSO

76       XkbIndicatorMapMask(3),   XkbIndicatorStateMask(3),   XkbSelectEventDe‐
77       tails(3), XkbSelectEvents(3)
78
79
80
81X Version 11                     libX11 1.6.4       XkbNoteIndicatorChanges(3)
Impressum