File: XAllowDeviceEvents.man

package info (click to toggle)
libxi 2:1.3-8
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 2,476 kB
  • ctags: 906
  • sloc: sh: 10,500; ansic: 6,600; makefile: 454
file content (261 lines) | stat: -rw-r--r-- 6,602 bytes parent folder | download | duplicates (2)
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
'\" t
.\"     Title: xallowdeviceevents
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
.\"      Date: 10/02/2009
.\"    Manual: [FIXME: manual]
.\"    Source: [FIXME: source]
.\"  Language: English
.\"
.TH "XALLOWDEVICEEVENTS" "libmansuffix" "10/02/2009" "[FIXME: source]" "[FIXME: manual]"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
XAllowDeviceEvents \- release queued events
.SH "SYNOPSIS"
.sp
.nf
#include <X11/extensions/XInput\&.h>
.fi
.sp
.nf
int XAllowDeviceEvents( Display *display,
                        XDevice *device,
                        int event_mode,
                        Time time);
display
       Specifies the connection to the X server\&.
.fi
.sp
.nf
device
       Specifies the device from which events are to be
       allowed\&.
.fi
.sp
.nf
event_mode
       Specifies the event mode\&.You can pass AsyncThisDevice,
       SyncThisDevice, ReplayThisDevice, AsyncOtherDevices,
       SyncAll,or AsyncAll\&.
.fi
.sp
.nf
time
       Specifies the time\&.You can pass either a timestamp or
       CurrentTime\&.
.fi
.SH "DESCRIPTION"
.sp
.if n \{\
.RS 4
.\}
.nf
The XAllowDeviceEvents function releases some queued events if
the client has caused a device to freeze\&. It has no effect if
the specified time is earlier than the last\-grab time of the
most recent active grab for the client and device, or if the
specified time is later than the current X server time\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
The following describes the processing that occurs depending on
what constant you pass to the event_mode argument\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
AsyncThisDevice If the specified device is frozen by the
client, event processing for that device continues as usual\&. If
the device is frozen multiple times by the client on behalf of
multiple separate grabs, AsyncThisDevice thaws for
all\&.AsyncThisDevice has no effect if the specified device is
not frozen by the client, but the device need not be grabbed by
the client\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
SyncThisDevice If the specified device is frozen and actively
grabbed by the client, event processing for that device
continues normally until the next key or button event is
reported to the client\&. At this time, the specified device
again appears to freeze\&. However, if the reported event causes
the grab to be released, the specified device does not freeze\&.
SyncThisDevice has no effect if the specified device is not
frozen by the client or is not grabbed by the client\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
ReplayThisDevice If the specified device is actively grabbed by
the client and is frozen as the result of an event having been
sent to the client (either from the activation of a
GrabDeviceButton or from a previous AllowDeviceEvents with mode
SyncThisDevice, but not from a GrabDevice), the grab is
released and that event is completely reprocessed\&. This time,
however, the request ignores any passive grabs at or above
(toward the root) that the grab\-window of the grab just
released\&. The request has no effect if the specified device is
not grabbed by the client or if it is not frozen as the result
of an event\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
AsyncOtherDevices If the remaining devices are frozen by the
client, event processing for them continues as usual\&. If the
other devices are frozen multiple times by the client on behalf
of multiple grabs, AsyncOtherDevices "thaws" for all\&.
AsyncOtherDevices has no effect if the devices are not frozen
by the client\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
SyncAll If all devices are frozen by the client, event
processing (for all devices) continues normally until the next
button or key event is reported to the client for a grabbed
device, at which time all devices again appear to freeze\&.
However, if the reported event causes the grab to be released,
then the devices do not freeze\&. If any device is still grabbed,
then a subsequent event for it will still cause all devices to
freeze\&. SyncAll has no effect unless all devices are frozen by
the client\&. If any device is frozen twice by the client on
behalf of two separate grabs, SyncAll thaws for both\&. A
subsequent freeze for SyncAll will only freeze each device
once\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
AsyncAll If all devices are frozen by the client, event
processing for all devices continues normally\&. If any device is
frozen multiple times by the client on behalf of multiple
separate grabs, AsyncAll thaws for all\&. AsyncAll has no effect
unless all devices are frozen by the client\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
AsyncThisDevice, SyncThisDevice, and ReplayThisDevice have no
effect on the processing of events from the remaining
devices\&.AsyncOtherDevices has no effect on the processing of
events from the specified device\&. When the event_mode is
SyncAll or AsyncAll, the device parameter is ignored\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
It is possible for several grabs of different devices by the
same or different clients to be active simultaneously\&. If a
device is frozen on behalf of any grab, no event processing is
performed for the device\&. It is possible for a single device to
be frozen because of several grabs\&. In this case, the freeze
must be released on behalf of each grab before events can again
be processed\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
XAllowDeviceEvents can generate a BadDevice or BadValue error\&.
.fi
.if n \{\
.RE
.\}
.SH "DIAGNOSTICS"
.sp
.if n \{\
.RS 4
.\}
.nf
BadDevice
       An invalid device was specified\&. The specified device
       does not exist or has not been opened by this client via
       XOpenInputDevice\&. This error may also occur if the
       specified device is the X keyboard or X pointer device\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
BadValue
       An invalid mode was specified on the request\&.
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.sp
.if n \{\
.RS 4
.\}
.nf
XGrabDevice(libmansuffix)
.fi
.if n \{\
.RE
.\}