1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
.\" Copyright (c) 1999 - Sun Microsystems, Inc.
.\" All rights reserved.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, and/or sell copies of the Software, and to permit persons
.\" to whom the Software is furnished to do so, provided that the above
.\" copyright notice(s) and this permission notice appear in all copies of
.\" the Software and that both the above copyright notice(s) and this
.\" permission notice appear in supporting documentation.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.\" Except as contained in this notice, the name of a copyright holder
.\" shall not be used in advertising or otherwise to promote the sale, use
.\" or other dealings in this Software without prior written authorization
.\" of the copyright holder.
.\"
.TH XkbNoteIndicatorChanges __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
XkbNoteIndicatorChanges \- Notes the changes in a changes structure
.SH SYNOPSIS
.B void XkbNoteIndicatorChanges
(
.I old,
.I new,
.I wanted
)
.br
XkbIndicatorChangesPtr \fIold\fP\^;
.br
XkbIndicatorNotifyEvent *\fInew\fP\^;
.br
unsigned int \fIwanted\fP\^;
.if n .ti +5n
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- old
XkbIndicatorChanges structure to be updated
.TP
.I \- new
event from which changes are to be copied
.TP
.I \- wanted
which changes are to be noted
.SH DESCRIPTION
.LP
Whenever an indicator changes state, the server sends XkbIndicatorStateNotify events to all
interested clients. Similarly, whenever an indicator's map changes, the server sends
XkbIndicatorMapNotify events to all interested clients.
To receive XkbIndicatorStateNotify events, use
.I XkbSelectEvents
with both the
.I bits_to_change
and
.I values_for_bits
parameters containing XkbIndicatorStateNotifyMask. To receive XkbIndicatorMapNotify events,
use
.I XkbSelectEvents
with XkbIndicatorMapNotifyMask.
To receive events for only specific indicators, use
.I XkbSelectEventDetails.
Set the
.I event_type
parameter to XkbIndicatorStateNotify or XkbIndicatorMapNotify, and set both the
.I bits_to_change
and
.I values_for_bits
detail parameters to a mask where each bit specifies one indicator, turning on those bits that
specify the indicators for which you want to receive events.
The
.I changed
parameter is a mask that is the bitwise inclusive OR of the indicators that have changed. If
the event is of type XkbIndicatorMapNotify,
.I changed
reports the maps that changed. If the event is of type XkbIndicatorStateNotify,
.I changed
reports the indicators that have changed state.
.I state
is a mask that specifies the current state of all indicators, whether they have changed or
not, for both XkbIndicatorStateNotify and IndicatorMapNotify events.
When your client application receives either a XkbIndicatorStateNotify event or
XkbIndicatorMapNotify event, you can note the changes in a changes structure by calling
.I XkbNoteIndicatorChanges.
The
.I wanted
parameter is the bitwise inclusive OR of XkbIndicatorMapMask and
XkbIndicatorStateMask.
.I XkbNoteIndicatorChanges
copies any changes reported in
.I new
and specified in
.I wanted
into the changes record specified by
.I old.
.SH STRUCTURES
Both types of indicator events use the same structure:
.nf
typedef struct _XkbIndicatorNotify {
int type; /\(** Xkb extension base event code */
unsigned long serial; /\(** X server serial number for event */
Bool send_event; /\(** True => synthetically generated */
Display * display; /\(** server connection where event generated */
Time time; /\(** server time when event generated */
int xkb_type; /\(** specifies state or map notify */
int device; /\(** Xkb device ID, will not be XkbUseCoreKbd */
unsigned int changed; /\(** mask of indicators with new state or map */
unsigned int state; /\(** current state of all indicators */
} XkbIndicatorNotifyEvent;
.fi
.I xkb_type
is either XkbIndicatorStateNotify or XkbIndicatorMapNotify, depending on whether the event is
a kbIndicatorStateNotify event or kbIndicatorMapNotify event.
.SH "SEE ALSO"
.BR XkbIndicatorMapMask (__libmansuffix__),
.BR XkbIndicatorStateMask (__libmansuffix__),
.BR XkbSelectEventDetails (__libmansuffix__),
.BR XkbSelectEvents (__libmansuffix__)
|
