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 "XIGRABENTER" "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
.\" -----------------------------------------------------------------
22
XIGrabEnter, XIUngrabEnter, XIGrabFocusIn, XIUngrabFocusIn \- grab/ungrab enter or focus in events\&.
26
#include <X11/extensions/XInput\&.h>
30
int XIGrabEnter( Display *display,
35
int paired_device_mode,
39
XIGrabModifiers *modifiers_inout);
43
int XIUngrabEnter( Display *display,
47
XIGrabModifiers *modifiers);
51
int XIGrabFocusIn ( Display *display,
55
int paired_device_mode,
59
XIGrabModifiers *modifiers_inout);
63
int XIUngrabFocusIn( Display *display,
67
XIGrabModifiers *modifiers);
69
Specifies the connection to the X server\&.
74
Specifies the device that is to be grabbed or released
79
Number of elements in modifiers or modifiers_return
84
Specifies the set of latched and base modifiers or
85
XIAnyModifier to ungrab\&. The data type is for
86
consistency with the respective grab request and the
87
status code of the XIGrabModifiers struct is ignored\&.
92
Specifies the set of latched and base modifiers or
93
XIAnyModifier to grab\&. Returns the modifiers that could
94
not be grabbed and their status code\&.
99
Specifies the grab window\&.
104
Specifies a Boolean value that indicates whether the are
105
to be reported as usual or reported with respect to the
111
Specifies the event mask\&.
116
Specifies further processing of events from this device\&.
117
You can pass GrabModeSync or GrabModeAsync\&.
122
Specifies further processing of events from the paired
123
master device\&. You can pass GrabModeSync or
124
GrabModeAsync\&. If deviceid specifies a floating slave
125
device, this parameter is ignored\&.
133
XIGrabEnter and XIGrabFocusIn establish a passive grab\&. The
134
modifier device for a enter grab is the paired master device if
135
deviceid specifies a master pointer\&. Otherwise, the modifier
136
device is the device specified with deviceid\&.
146
For XIGrabEnter and XIGrabFocusIn, in the future, the device is
147
actively grabbed (as for XIGrabDevice, the last\-grab time is
148
set to the time at which the pointer/focus entered window) if
149
the device is not grabbed and the pointer has entered the
150
grab_window or the focus has been set to the grab_window when
151
the specified modifier keys are logically down on the modifier
152
device and no other buttons or modifier keys are logically
163
The interpretation of the remaining arguments is as for
164
XIGrabDevice\&. The active grab is terminated automatically when
165
the pointer leaves the window or the focus is set to a
166
different window (independent of the logical state of the
177
If the device is an attached slave device, the device is
178
automatically detached from the master device when the grab
179
activates and reattached to the same master device when the
180
grab deactivates\&. If the master device is removed while the
181
device is floating as a result of a grab, the device remains
182
floating once the grab deactivates\&.
192
Note that the logical state of a device (as seen by client
193
applications) may lag the physical state if device event
194
processing is frozen\&.
204
This request overrides all previous grabs by the same client of
205
the same type and modifier combinations on the same window\&. A
206
modifiers of XIAnyModifier is equivalent to issuing the grab
207
request for all possible modifier combinations (including the
208
combination of no modifiers)\&. It is not required that all
209
modifiers specified have currently assigned KeyCodes\&.
219
If some other client has already issued a XIGrabEnter or
220
XIGrabFocusIn on the same window, a BadAccess error results\&.
221
When using XIAnyModifier, the request fails completely, and a
222
XIBadAccess error results (no grabs are established) if there
223
is a conflicting grab for any combination\&. XIGrabEnter and
224
XIGrabFocusin have no effect on an active grab\&.
234
XIGrabEnter and XIGrabFocusIn can generate BadDevice,
235
BadMatch, BadValue, and BadWindow errors\&.
245
XIUngrabEnter and XIUngrabFocusIn releases the passive grab on
246
the specified window if it was grabbed by this client\&. A
247
modifier of XIAnyModifier is equivalent to issuing the ungrab
248
request for all possible modifier combinations, including the
249
combination of no modifiers\&. XIUngrabEnter and XIUngrabFocusIn
250
have no effect on an active grab\&.
260
XIUngrabEnter and XIUngrabFocusIn can generate BadDevice,
261
BadMatch, BadValue and BadWindow errors\&.
273
An invalid deviceid was specified\&.
284
This error may occur if XIGrabEnter specified a device
285
that has no valuators, or XIGrabFocusIn specified a device
297
Some numeric value falls outside the range of values
298
accepted by the request\&. Unless a specific range is
299
specified for an argument, the full range defined by the
300
argument\'s type is accepted\&. Any argument defined as a
301
set of alternatives can generate this error\&.
312
A value for a Window argument does not name a defined
324
XIAllowEvents(libmansuffix)