1XALLOWDEVICEEVENTS(3) [FIXME: manual] XALLOWDEVICEEVENTS(3)
2
6 XAllowDeviceEvents - release queued events
7
9 #include <X11/extensions/XInput.h>
10 int XAllowDeviceEvents( Display *display,
12 XDevice *device,
13 int event_mode,
14 Time time);
15 display
16 Specifies the connection to the X server.
17 device
19 Specifies the device from which events are to be
20 allowed.
21 event_mode
23 Specifies the event mode.You can pass AsyncThisDevice,
24 SyncThisDevice, ReplayThisDevice, AsyncOtherDevices,
25 SyncAll,or AsyncAll.
26 time
28 Specifies the time.You can pass either a timestamp or
29 CurrentTime.
30
32 The XAllowDeviceEvents function releases some queued events if
33 the client has caused a device to freeze. It has no effect if
34 the specified time is earlier than the last-grab time of the
35 most recent active grab for the client and device, or if the
36 specified time is later than the current X server time.
37 The following describes the processing that occurs depending on
39 what constant you pass to the event_mode argument.
40 AsyncThisDevice If the specified device is frozen by the
42 client, event processing for that device continues as usual. If
43 the device is frozen multiple times by the client on behalf of
44 multiple separate grabs, AsyncThisDevice thaws for
45 all.AsyncThisDevice has no effect if the specified device is
46 not frozen by the client, but the device need not be grabbed by
47 the client.
48 SyncThisDevice If the specified device is frozen and actively
50 grabbed by the client, event processing for that device
51 continues normally until the next key or button event is
52 reported to the client. At this time, the specified device
53 again appears to freeze. However, if the reported event causes
54 the grab to be released, the specified device does not freeze.
55 SyncThisDevice has no effect if the specified device is not
56 frozen by the client or is not grabbed by the client.
57 ReplayThisDevice If the specified device is actively grabbed by
59 the client and is frozen as the result of an event having been
60 sent to the client (either from the activation of a
61 GrabDeviceButton or from a previous AllowDeviceEvents with mode
62 SyncThisDevice, but not from a GrabDevice), the grab is
63 released and that event is completely reprocessed. This time,
64 however, the request ignores any passive grabs at or above
65 (toward the root) that the grab-window of the grab just
66 released. The request has no effect if the specified device is
67 not grabbed by the client or if it is not frozen as the result
68 of an event.
69 AsyncOtherDevices If the remaining devices are frozen by the
71 client, event processing for them continues as usual. If the
72 other devices are frozen multiple times by the client on behalf
73 of multiple grabs, AsyncOtherDevices "thaws" for all.
74 AsyncOtherDevices has no effect if the devices are not frozen
75 by the client.
76 SyncAll If all devices are frozen by the client, event
78 processing (for all devices) continues normally until the next
79 button or key event is reported to the client for a grabbed
80 device, at which time all devices again appear to freeze.
81 However, if the reported event causes the grab to be released,
82 then the devices do not freeze. If any device is still grabbed,
83 then a subsequent event for it will still cause all devices to
84 freeze. SyncAll has no effect unless all devices are frozen by
85 the client. If any device is frozen twice by the client on
86 behalf of two separate grabs, SyncAll thaws for both. A
87 subsequent freeze for SyncAll will only freeze each device
88 once.
89 AsyncAll If all devices are frozen by the client, event
91 processing for all devices continues normally. If any device is
92 frozen multiple times by the client on behalf of multiple
93 separate grabs, AsyncAll thaws for all. AsyncAll has no effect
94 unless all devices are frozen by the client.
95 AsyncThisDevice, SyncThisDevice, and ReplayThisDevice have no
97 effect on the processing of events from the remaining
98 devices.AsyncOtherDevices has no effect on the processing of
99 events from the specified device. When the event_mode is
100 SyncAll or AsyncAll, the device parameter is ignored.
101 It is possible for several grabs of different devices by the
103 same or different clients to be active simultaneously. If a
104 device is frozen on behalf of any grab, no event processing is
105 performed for the device. It is possible for a single device to
106 be frozen because of several grabs. In this case, the freeze
107 must be released on behalf of each grab before events can again
108 be processed.
109 XAllowDeviceEvents can generate a BadDevice or BadValue error.
111
113 BadDevice
114 An invalid device was specified. The specified device
115 does not exist or has not been opened by this client via
116 XOpenInputDevice. This error may also occur if the
117 specified device is the X keyboard or X pointer device.
118 BadValue
120 An invalid mode was specified on the request.
121
123 XGrabDevice(3)
124[FIXME: source] 08/04/2010 XALLOWDEVICEEVENTS(3)