2
.\" $XFree86: xc/doc/man/Xi/XAllDvEv.man,v 1.2 2001/01/27 18:20:20 dawes Exp $
5
.\" Copyright ([\d,\s]*) by Hewlett-Packard Company, Ardent Computer,
7
.\" Permission to use, copy, modify, distribute, and sell this documentation
8
.\" for any purpose and without fee is hereby granted, provided that the above
9
.\" copyright notice and this permission notice appear in all copies.
10
.\" Ardent, and Hewlett-Packard make no representations about the
11
.\" suitability for any purpose of the information in this document. It is
12
.\" provided \`\`as is'' without express or implied warranty.
14
.\" $Xorg: XAllDvEv.man,v 1.3 2000/08/17 19:41:55 cpqbld Exp $
15
.ds xL Programming With Xlib
16
.TH XAllowDeviceEvents __LIB_MAN_SUFFIX__ __xorgversion__ "X FUNCTIONS"
2
.\" Title: xallowdeviceevents
3
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4
.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
6
.\" Manual: [FIXME: manual]
7
.\" Source: [FIXME: source]
10
.TH "XALLOWDEVICEEVENTS" "libmansuffix" "10/02/2009" "[FIXME: source]" "[FIXME: manual]"
11
.\" -----------------------------------------------------------------
12
.\" * set default formatting
13
.\" -----------------------------------------------------------------
14
.\" disable hyphenation
16
.\" disable justification (adjust text to left margin only)
18
.\" -----------------------------------------------------------------
19
.\" * MAIN CONTENT STARTS HERE *
20
.\" -----------------------------------------------------------------
18
22
XAllowDeviceEvents \- release queued events
21
int XAllowDeviceEvents\^(\^Display *\fIdisplay\fP\^, XDevice *\fIdevice\fP\^,
22
int \fIevent_mode\fP\^, Time \fItime\fP\^);
26
Specifies the connection to the X server.
29
Specifies the device from which events are to be allowed.
32
Specifies the event mode.
34
\fIAsyncThisDevice\fP,
36
\fIReplayThisDevice\fP,
37
\fIAsyncOtherDevices\fP,
44
You can pass either a timestamp or
48
\fIXAllowDeviceEvents\fP
49
function releases some queued events if the client has caused a device
51
It has no effect if the specified time is earlier than the last-grab
52
time of the most recent active grab for the client and device,
53
or if the specified time is later than the current X server time.
55
The following describes the processing that occurs depending on what
56
constant you pass to the event_mode argument.
59
If the specified device is frozen by the client, event processing for that
60
device continues as usual. If the device is frozen multiple times by the client
61
on behalf of multiple separate grabs, \fIAsyncThisDevice\fP thaws for all.
62
\fIAsyncThisDevice\fP has no effect if the specified device is not frozen by
63
the client, but the device need not be grabbed by the client.
66
If the specified device is frozen and actively grabbed by the client, event
67
processing for that device continues normally until the next key or button
68
event is reported to the client. At this time, the specified device
69
again appears to freeze. However, if the reported event causes the grab
70
to be released, the specified device does not freeze. \fISyncThisDevice\fP
71
has no effect if the specified device is not frozen by the client or is not
72
grabbed by the client.
74
\fIReplayThisDevice\fP
75
If the specified device is actively grabbed by the client and is frozen as
76
the result of an event having been sent to the client (either from the
77
activation of a GrabDeviceButton or from a previous AllowDeviceEvents with
78
mode SyncThisDevice, but not from a GrabDevice), the grab is released and that
79
event is completely reprocessed. This time, however, the request ignores
80
any passive grabs at or above (toward the root) that the grab-window of the
81
grab just released. The request has no effect if the specified device is
82
not grabbed by the client or if it is not frozen as the result of an event.
84
\fIAsyncOtherDevices\fP
85
If the remaining devices are frozen by the client, event processing for them
86
continues as usual. If the other devices are frozen multiple times by the
87
client on behalf of multiple grabs, \fIAsyncOtherDevices\fP "thaws" for
88
all. \fIAsyncOtherDevices\fP has no effect if the devices are not frozen
92
If all devices are frozen by the client, event processing (for all devices)
93
continues normally until the next button or key event is reported to the
94
client for a grabbed device, at which time all devices again appear to freeze.
95
However, if the reported event causes the grab to be released, then the devices
96
do not freeze. If any device is still grabbed, then a subsequent event for it
97
will still cause all devices to freeze. \fISyncAll\fP has no
98
effect unless all devices are frozen by the client. If any device is
99
frozen twice by the client on behalf of two separate grabs, \fISyncAll\fP thaws
100
for both. A subsequent freeze for \fISyncAll\fP will only
101
freeze each device once.
104
If all devices are frozen by the client, event processing for all devices
105
continues normally. If any device is frozen multiple times by the client
106
on behalf of multiple separate grabs, \fIAsyncAll\fP thaws for
107
all. \fIAsyncAll\fP has no effect unless all devices are frozen by
110
\fIAsyncThisDevice\fP,
111
\fISyncThisDevice\fP,
113
\fIReplayThisDevice\fP
114
have no effect on the processing of events from the remaining devices.
115
\fIAsyncOtherDevices\fP
116
has no effect on the processing of events from the specified device. When
121
the device parameter is ignored.
123
It is possible for several grabs of different devices by the same or
124
different clients to be active simultaneously. If a device is frozen on
125
behalf of any grab, no event processing is performed for the device.
126
It is possible for a single device to be frozen because of several grabs.
127
In this case, the freeze must be released on behalf of each grab before
128
events can again be processed.
130
\fIXAllowDeviceEvents\fP
131
can generate a \fIBadDevice\fP or
137
An invalid device was specified. The specified device does not exist or has
138
not been opened by this client via \fIXOpenInputDevice\fP. This error may
139
also occur if the specified device is the X keyboard or X pointer device.
142
An invalid mode was specified on the request.
26
#include <X11/extensions/XInput\&.h>
30
int XAllowDeviceEvents( Display *display,
35
Specifies the connection to the X server\&.
40
Specifies the device from which events are to be
46
Specifies the event mode\&.You can pass AsyncThisDevice,
47
SyncThisDevice, ReplayThisDevice, AsyncOtherDevices,
48
SyncAll,or AsyncAll\&.
53
Specifies the time\&.You can pass either a timestamp or
62
The XAllowDeviceEvents function releases some queued events if
63
the client has caused a device to freeze\&. It has no effect if
64
the specified time is earlier than the last\-grab time of the
65
most recent active grab for the client and device, or if the
66
specified time is later than the current X server time\&.
76
The following describes the processing that occurs depending on
77
what constant you pass to the event_mode argument\&.
87
AsyncThisDevice If the specified device is frozen by the
88
client, event processing for that device continues as usual\&. If
89
the device is frozen multiple times by the client on behalf of
90
multiple separate grabs, AsyncThisDevice thaws for
91
all\&.AsyncThisDevice has no effect if the specified device is
92
not frozen by the client, but the device need not be grabbed by
103
SyncThisDevice If the specified device is frozen and actively
104
grabbed by the client, event processing for that device
105
continues normally until the next key or button event is
106
reported to the client\&. At this time, the specified device
107
again appears to freeze\&. However, if the reported event causes
108
the grab to be released, the specified device does not freeze\&.
109
SyncThisDevice has no effect if the specified device is not
110
frozen by the client or is not grabbed by the client\&.
120
ReplayThisDevice If the specified device is actively grabbed by
121
the client and is frozen as the result of an event having been
122
sent to the client (either from the activation of a
123
GrabDeviceButton or from a previous AllowDeviceEvents with mode
124
SyncThisDevice, but not from a GrabDevice), the grab is
125
released and that event is completely reprocessed\&. This time,
126
however, the request ignores any passive grabs at or above
127
(toward the root) that the grab\-window of the grab just
128
released\&. The request has no effect if the specified device is
129
not grabbed by the client or if it is not frozen as the result
140
AsyncOtherDevices If the remaining devices are frozen by the
141
client, event processing for them continues as usual\&. If the
142
other devices are frozen multiple times by the client on behalf
143
of multiple grabs, AsyncOtherDevices "thaws" for all\&.
144
AsyncOtherDevices has no effect if the devices are not frozen
155
SyncAll If all devices are frozen by the client, event
156
processing (for all devices) continues normally until the next
157
button or key event is reported to the client for a grabbed
158
device, at which time all devices again appear to freeze\&.
159
However, if the reported event causes the grab to be released,
160
then the devices do not freeze\&. If any device is still grabbed,
161
then a subsequent event for it will still cause all devices to
162
freeze\&. SyncAll has no effect unless all devices are frozen by
163
the client\&. If any device is frozen twice by the client on
164
behalf of two separate grabs, SyncAll thaws for both\&. A
165
subsequent freeze for SyncAll will only freeze each device
176
AsyncAll If all devices are frozen by the client, event
177
processing for all devices continues normally\&. If any device is
178
frozen multiple times by the client on behalf of multiple
179
separate grabs, AsyncAll thaws for all\&. AsyncAll has no effect
180
unless all devices are frozen by the client\&.
190
AsyncThisDevice, SyncThisDevice, and ReplayThisDevice have no
191
effect on the processing of events from the remaining
192
devices\&.AsyncOtherDevices has no effect on the processing of
193
events from the specified device\&. When the event_mode is
194
SyncAll or AsyncAll, the device parameter is ignored\&.
204
It is possible for several grabs of different devices by the
205
same or different clients to be active simultaneously\&. If a
206
device is frozen on behalf of any grab, no event processing is
207
performed for the device\&. It is possible for a single device to
208
be frozen because of several grabs\&. In this case, the freeze
209
must be released on behalf of each grab before events can again
220
XAllowDeviceEvents can generate a BadDevice or BadValue error\&.
232
An invalid device was specified\&. The specified device
233
does not exist or has not been opened by this client via
234
XOpenInputDevice\&. This error may also occur if the
235
specified device is the X keyboard or X pointer device\&.
246
An invalid mode was specified on the request\&.
257
XGrabDevice(libmansuffix)
added
removed
man/XAllowDeviceEvents.man
