~ubuntu-branches/ubuntu/natty/libxi/natty-201011191114

« back to all changes in this revision

Viewing changes to man/XIGrabEnter.man

  • Committer: Bazaar Package Importer
  • Author(s): Julien Cristau
  • Date: 2009-11-21 18:39:28 UTC
  • mfrom: (1.1.10 upstream) (0.1.6 experimental)
  • Revision ID: james.westby@ubuntu.com-20091121183928-ek2jwqx3rmhv3zjz
Tags: 2:1.3-1
* Bump Standards-Version to 3.8.3.
* Add build-deps on xmlto and asciidoc to build the manpages.
* New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\" t
 
2
.\"     Title: xigrabenter
 
3
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 
4
.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
 
5
.\"      Date: 10/02/2009
 
6
.\"    Manual: [FIXME: manual]
 
7
.\"    Source: [FIXME: source]
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "XIGRABENTER" "libmansuffix" "10/02/2009" "[FIXME: source]" "[FIXME: manual]"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * set default formatting
 
13
.\" -----------------------------------------------------------------
 
14
.\" disable hyphenation
 
15
.nh
 
16
.\" disable justification (adjust text to left margin only)
 
17
.ad l
 
18
.\" -----------------------------------------------------------------
 
19
.\" * MAIN CONTENT STARTS HERE *
 
20
.\" -----------------------------------------------------------------
 
21
.SH "NAME"
 
22
XIGrabEnter, XIUngrabEnter, XIGrabFocusIn, XIUngrabFocusIn \- grab/ungrab enter or focus in events\&.
 
23
.SH "SYNOPSIS"
 
24
.sp
 
25
.nf
 
26
#include <X11/extensions/XInput\&.h>
 
27
.fi
 
28
.sp
 
29
.nf
 
30
int XIGrabEnter( Display *display,
 
31
                 int deviceid,
 
32
                 Window grab_window
 
33
                 Cursor cursor,
 
34
                 int grab_mode,
 
35
                 int paired_device_mode,
 
36
                 Bool owner_events,
 
37
                 XIEventMask *mask,
 
38
                 int num_modifiers,
 
39
                 XIGrabModifiers *modifiers_inout);
 
40
.fi
 
41
.sp
 
42
.nf
 
43
int XIUngrabEnter( Display *display,
 
44
                   int deviceid,
 
45
                   Window grab_window
 
46
                   int num_modifiers,
 
47
                   XIGrabModifiers *modifiers);
 
48
.fi
 
49
.sp
 
50
.nf
 
51
int XIGrabFocusIn ( Display *display,
 
52
                    int deviceid,
 
53
                    Window grab_window
 
54
                    int grab_mode,
 
55
                    int paired_device_mode,
 
56
                    Bool owner_events,
 
57
                    XIEventMask *mask,
 
58
                    int num_modifiers,
 
59
                    XIGrabModifiers *modifiers_inout);
 
60
.fi
 
61
.sp
 
62
.nf
 
63
int XIUngrabFocusIn( Display *display,
 
64
                     int deviceid,
 
65
                     Window grab_window
 
66
                     int num_modifiers,
 
67
                     XIGrabModifiers *modifiers);
 
68
display
 
69
       Specifies the connection to the X server\&.
 
70
.fi
 
71
.sp
 
72
.nf
 
73
device
 
74
       Specifies the device that is to be grabbed or released
 
75
.fi
 
76
.sp
 
77
.nf
 
78
num_modifiers
 
79
       Number of elements in modifiers or modifiers_return
 
80
.fi
 
81
.sp
 
82
.nf
 
83
modifiers
 
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\&.
 
88
.fi
 
89
.sp
 
90
.nf
 
91
modifiers_inout
 
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\&.
 
95
.fi
 
96
.sp
 
97
.nf
 
98
grab_window
 
99
       Specifies the grab window\&.
 
100
.fi
 
101
.sp
 
102
.nf
 
103
owner_events
 
104
       Specifies a Boolean value that indicates whether the are
 
105
       to be reported as usual or reported with respect to the
 
106
       grab window\&.
 
107
.fi
 
108
.sp
 
109
.nf
 
110
mask
 
111
       Specifies the event mask\&.
 
112
.fi
 
113
.sp
 
114
.nf
 
115
grab_mode
 
116
       Specifies further processing of events from this device\&.
 
117
       You can pass GrabModeSync or GrabModeAsync\&.
 
118
.fi
 
119
.sp
 
120
.nf
 
121
paired_device_mode
 
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\&.
 
126
.fi
 
127
.SH "DESCRIPTION"
 
128
.sp
 
129
.if n \{\
 
130
.RS 4
 
131
.\}
 
132
.nf
 
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\&.
 
137
.fi
 
138
.if n \{\
 
139
.RE
 
140
.\}
 
141
.sp
 
142
.if n \{\
 
143
.RS 4
 
144
.\}
 
145
.nf
 
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
 
153
down\&.
 
154
.fi
 
155
.if n \{\
 
156
.RE
 
157
.\}
 
158
.sp
 
159
.if n \{\
 
160
.RS 4
 
161
.\}
 
162
.nf
 
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
 
167
modifier keys)\&.
 
168
.fi
 
169
.if n \{\
 
170
.RE
 
171
.\}
 
172
.sp
 
173
.if n \{\
 
174
.RS 4
 
175
.\}
 
176
.nf
 
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\&.
 
183
.fi
 
184
.if n \{\
 
185
.RE
 
186
.\}
 
187
.sp
 
188
.if n \{\
 
189
.RS 4
 
190
.\}
 
191
.nf
 
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\&.
 
195
.fi
 
196
.if n \{\
 
197
.RE
 
198
.\}
 
199
.sp
 
200
.if n \{\
 
201
.RS 4
 
202
.\}
 
203
.nf
 
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\&.
 
210
.fi
 
211
.if n \{\
 
212
.RE
 
213
.\}
 
214
.sp
 
215
.if n \{\
 
216
.RS 4
 
217
.\}
 
218
.nf
 
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\&.
 
225
.fi
 
226
.if n \{\
 
227
.RE
 
228
.\}
 
229
.sp
 
230
.if n \{\
 
231
.RS 4
 
232
.\}
 
233
.nf
 
234
XIGrabEnter and XIGrabFocusIn can generate BadDevice,
 
235
BadMatch, BadValue, and BadWindow errors\&.
 
236
.fi
 
237
.if n \{\
 
238
.RE
 
239
.\}
 
240
.sp
 
241
.if n \{\
 
242
.RS 4
 
243
.\}
 
244
.nf
 
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\&.
 
251
.fi
 
252
.if n \{\
 
253
.RE
 
254
.\}
 
255
.sp
 
256
.if n \{\
 
257
.RS 4
 
258
.\}
 
259
.nf
 
260
XIUngrabEnter and XIUngrabFocusIn can generate BadDevice,
 
261
BadMatch, BadValue and BadWindow errors\&.
 
262
.fi
 
263
.if n \{\
 
264
.RE
 
265
.\}
 
266
.SH "DIAGNOSTICS"
 
267
.sp
 
268
.if n \{\
 
269
.RS 4
 
270
.\}
 
271
.nf
 
272
BadDevice
 
273
       An invalid deviceid was specified\&.
 
274
.fi
 
275
.if n \{\
 
276
.RE
 
277
.\}
 
278
.sp
 
279
.if n \{\
 
280
.RS 4
 
281
.\}
 
282
.nf
 
283
BadMatch
 
284
       This error may occur if XIGrabEnter specified a device
 
285
       that has no valuators, or XIGrabFocusIn specified a device
 
286
       that has no keys\&.
 
287
.fi
 
288
.if n \{\
 
289
.RE
 
290
.\}
 
291
.sp
 
292
.if n \{\
 
293
.RS 4
 
294
.\}
 
295
.nf
 
296
BadValue
 
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\&.
 
302
.fi
 
303
.if n \{\
 
304
.RE
 
305
.\}
 
306
.sp
 
307
.if n \{\
 
308
.RS 4
 
309
.\}
 
310
.nf
 
311
BadWindow
 
312
       A value for a Window argument does not name a defined
 
313
       Window\&.
 
314
.fi
 
315
.if n \{\
 
316
.RE
 
317
.\}
 
318
.SH "SEE ALSO"
 
319
.sp
 
320
.if n \{\
 
321
.RS 4
 
322
.\}
 
323
.nf
 
324
XIAllowEvents(libmansuffix)
 
325
.fi
 
326
.if n \{\
 
327
.RE
 
328
.\}