← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/X11/XRaiseWin.man

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/doc/man/X11/XRaiseWin.man
 
1
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
 
2
.\"
 
3
.\" Permission is hereby granted, free of charge, to any person obtaining
 
4
.\" a copy of this software and associated documentation files (the
 
5
.\" "Software"), to deal in the Software without restriction, including
 
6
.\" without limitation the rights to use, copy, modify, merge, publish,
 
7
.\" distribute, sublicense, and/or sell copies of the Software, and to
 
8
.\" permit persons to whom the Software is furnished to do so, subject to
 
9
.\" the following conditions:
 
10
.\"
 
11
.\" The above copyright notice and this permission notice shall be included
 
12
.\" in all copies or substantial portions of the Software.
 
13
.\"
 
14
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 
15
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 
16
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 
17
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
 
18
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 
19
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 
20
.\" OTHER DEALINGS IN THE SOFTWARE.
 
21
.\"
 
22
.\" Except as contained in this notice, the name of the X Consortium shall
 
23
.\" not be used in advertising or otherwise to promote the sale, use or
 
24
.\" other dealings in this Software without prior written authorization
 
25
.\" from the X Consortium.
 
26
.\"
 
27
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
 
28
.\" Digital Equipment Corporation
 
29
.\"
 
30
.\" Portions Copyright \(co 1990, 1991 by
 
31
.\" Tektronix, Inc.
 
32
.\"
 
33
.\" Permission to use, copy, modify and distribute this documentation for
 
34
.\" any purpose and without fee is hereby granted, provided that the above
 
35
.\" copyright notice appears in all copies and that both that copyright notice
 
36
.\" and this permission notice appear in all copies, and that the names of
 
37
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
 
38
.\" to this documentation without specific, written prior permission.
 
39
.\" Digital and Tektronix makes no representations about the suitability
 
40
.\" of this documentation for any purpose.
 
41
.\" It is provided ``as is'' without express or implied warranty.
 
42
.\" 
 
43
.\" $XFree86: xc/doc/man/X11/XRaiseWin.man,v 1.2 2001/01/27 18:20:03 dawes Exp $
 
44
.\"
 
45
.ds xT X Toolkit Intrinsics \- C Language Interface
 
46
.ds xW Athena X Widgets \- C Language X Toolkit Interface
 
47
.ds xL Xlib \- C Language X Interface
 
48
.ds xC Inter-Client Communication Conventions Manual
 
49
.na
 
50
.de Ds
 
51
.nf
 
52
.\\$1D \\$2 \\$1
 
53
.ft 1
 
54
.\".ps \\n(PS
 
55
.\".if \\n(VS>=40 .vs \\n(VSu
 
56
.\".if \\n(VS<=39 .vs \\n(VSp
 
57
..
 
58
.de De
 
59
.ce 0
 
60
.if \\n(BD .DF
 
61
.nr BD 0
 
62
.in \\n(OIu
 
63
.if \\n(TM .ls 2
 
64
.sp \\n(DDu
 
65
.fi
 
66
..
 
67
.de FD
 
68
.LP
 
69
.KS
 
70
.TA .5i 3i
 
71
.ta .5i 3i
 
72
.nf
 
73
..
 
74
.de FN
 
75
.fi
 
76
.KE
 
77
.LP
 
78
..
 
79
.de IN          \" send an index entry to the stderr
 
80
..
 
81
.de C{
 
82
.KS
 
83
.nf
 
84
.D
 
85
.\"
 
86
.\"     choose appropriate monospace font
 
87
.\"     the imagen conditional, 480,
 
88
.\"     may be changed to L if LB is too
 
89
.\"     heavy for your eyes...
 
90
.\"
 
91
.ie "\\*(.T"480" .ft L
 
92
.el .ie "\\*(.T"300" .ft L
 
93
.el .ie "\\*(.T"202" .ft PO
 
94
.el .ie "\\*(.T"aps" .ft CW
 
95
.el .ft R
 
96
.ps \\n(PS
 
97
.ie \\n(VS>40 .vs \\n(VSu
 
98
.el .vs \\n(VSp
 
99
..
 
100
.de C}
 
101
.DE
 
102
.R
 
103
..
 
104
.de Pn
 
105
.ie t \\$1\fB\^\\$2\^\fR\\$3
 
106
.el \\$1\fI\^\\$2\^\fP\\$3
 
107
..
 
108
.de ZN
 
109
.ie t \fB\^\\$1\^\fR\\$2
 
110
.el \fI\^\\$1\^\fP\\$2
 
111
..
 
112
.de hN
 
113
.ie t <\fB\\$1\fR>\\$2
 
114
.el <\fI\\$1\fP>\\$2
 
115
..
 
116
.de NT
 
117
.ne 7
 
118
.ds NO Note
 
119
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 
120
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 
121
.ie n .sp
 
122
.el .sp 10p
 
123
.TB
 
124
.ce
 
125
\\*(NO
 
126
.ie n .sp
 
127
.el .sp 5p
 
128
.if '\\$1'C' .ce 99
 
129
.if '\\$2'C' .ce 99
 
130
.in +5n
 
131
.ll -5n
 
132
.R
 
133
..
 
134
.               \" Note End -- doug kraft 3/85
 
135
.de NE
 
136
.ce 0
 
137
.in -5n
 
138
.ll +5n
 
139
.ie n .sp
 
140
.el .sp 10p
 
141
..
 
142
.ny0
 
143
.TH XRaiseWindow 3X11 __xorgversion__ "XLIB FUNCTIONS"
 
144
.SH NAME
 
145
XRaiseWindow, XLowerWindow, XCirculateSubwindows, XCirculateSubwindowsUp, XCirculateSubwindowsDown, XRestackWindows \- change window stacking order
 
146
.SH SYNTAX
 
147
XRaiseWindow\^(\^\fIdisplay\fP, \fIw\fP\^)
 
148
.br
 
149
      Display *\fIdisplay\fP\^;
 
150
.br
 
151
      Window \fIw\fP\^;
 
152
.LP
 
153
XLowerWindow\^(\^\fIdisplay\fP, \fIw\fP\^)
 
154
.br
 
155
      Display *\fIdisplay\fP\^;
 
156
.br
 
157
      Window \fIw\fP\^;
 
158
.LP
 
159
XCirculateSubwindows\^(\^\fIdisplay\fP, \fIw\fP\^, \fIdirection\fP\^)
 
160
.br
 
161
      Display *\fIdisplay\fP\^;
 
162
.br
 
163
      Window \fIw\fP\^;
 
164
.br
 
165
      int \fIdirection\fP\^;
 
166
.LP
 
167
XCirculateSubwindowsUp\^(\^\fIdisplay\fP, \fIw\fP\^)
 
168
.br
 
169
      Display *\fIdisplay\fP\^;
 
170
.br
 
171
      Window \fIw\fP\^;
 
172
.LP
 
173
XCirculateSubwindowsDown\^(\^\fIdisplay\fP, \fIw\fP\^)
 
174
.br
 
175
      Display *\fIdisplay\fP\^;
 
176
.br
 
177
      Window \fIw\fP\^;
 
178
.LP
 
179
XRestackWindows\^(\^\fIdisplay\fP, \fIwindows\fP\^, \^\fInwindows\fP\^);
 
180
.br
 
181
      Display *\fIdisplay\fP\^;
 
182
.br
 
183
      Window \fIwindows\fP\^[];
 
184
.br
 
185
      int \fInwindows\fP\^;
 
186
.SH ARGUMENTS
 
187
.IP \fIdirection\fP 1i
 
188
Specifies the direction (up or down) that you want to circulate
 
189
the window. 
 
190
You can pass 
 
191
.ZN RaiseLowest
 
192
or
 
193
.ZN LowerHighest .
 
194
.IP \fIdisplay\fP 1i
 
195
Specifies the connection to the X server.
 
196
.IP \fInwindows\fP 1i
 
197
Specifies the number of windows to be restacked.
 
198
.IP \fIw\fP 1i
 
199
Specifies the window.
 
200
.IP \fIwindows\fP 1i
 
201
Specifies an array containing the windows to be restacked.
 
202
.SH DESCRIPTION
 
203
The
 
204
.ZN XRaiseWindow
 
205
function
 
206
raises the specified window to the top of the stack so that no sibling window
 
207
obscures it.
 
208
If the windows are regarded as overlapping sheets of paper stacked 
 
209
on a desk,
 
210
then raising a window is analogous to moving the sheet to the top of
 
211
the stack but leaving its x and y location on the desk constant.
 
212
Raising a mapped window may generate 
 
213
.ZN Expose
 
214
events for the window and any mapped subwindows that were formerly obscured.  
 
215
.LP
 
216
If the override-redirect attribute of the window is 
 
217
.ZN False 
 
218
and some
 
219
other client has selected 
 
220
.ZN SubstructureRedirectMask 
 
221
on the parent, the X server generates a
 
222
.ZN ConfigureRequest 
 
223
event, and no processing is performed.
 
224
Otherwise, the window is raised.
 
225
.LP
 
226
.ZN XRaiseWindow
 
227
can generate a
 
228
.ZN BadWindow 
 
229
error.
 
230
.LP
 
231
The
 
232
.ZN XLowerWindow
 
233
function lowers the specified window to the bottom of the stack
 
234
so that it does not obscure any sibling
 
235
windows.
 
236
If the windows are regarded as overlapping sheets of paper
 
237
stacked on a desk, then lowering a window is analogous to moving the
 
238
sheet to the bottom of the stack but leaving its x and y location on
 
239
the desk constant.
 
240
Lowering a mapped window will generate 
 
241
.ZN Expose 
 
242
events on any windows it formerly obscured.
 
243
.LP
 
244
If the override-redirect attribute of the window is 
 
245
.ZN False 
 
246
and some
 
247
other client has selected 
 
248
.ZN SubstructureRedirectMask 
 
249
on the parent, the X server generates a
 
250
.ZN ConfigureRequest 
 
251
event, and no processing is performed.  
 
252
Otherwise, the window is lowered to the bottom of the
 
253
stack.
 
254
.LP
 
255
.ZN XLowerWindow
 
256
can generate a
 
257
.ZN BadWindow 
 
258
error.
 
259
.LP
 
260
The
 
261
.ZN XCirculateSubwindows
 
262
function circulates children of the specified window in the specified 
 
263
direction.
 
264
If you specify
 
265
.ZN RaiseLowest ,
 
266
.ZN XCirculateSubwindows
 
267
raises the lowest mapped child (if any) that is occluded 
 
268
by another child to the top of the stack.
 
269
If you specify
 
270
.ZN LowerHighest ,
 
271
.ZN XCirculateSubwindows
 
272
lowers the highest mapped child (if any) that occludes another child
 
273
to the bottom of the stack.
 
274
Exposure processing is then performed on formerly obscured windows.
 
275
If some other client has selected 
 
276
.ZN SubstructureRedirectMask 
 
277
on the window, the X server generates a 
 
278
.ZN CirculateRequest 
 
279
event, and no further processing is performed.
 
280
If a child is actually restacked,
 
281
the X server generates a
 
282
.ZN CirculateNotify
 
283
event. 
 
284
.LP
 
285
.ZN XCirculateSubwindows
 
286
can generate
 
287
.ZN BadValue
 
288
and
 
289
.ZN BadWindow 
 
290
errors.
 
291
.LP
 
292
The
 
293
.ZN XCirculateSubwindowsUp
 
294
function raises the lowest mapped child of the specified window that
 
295
is partially
 
296
or completely
 
297
occluded by another child.
 
298
Completely unobscured children are not affected.
 
299
This is a convenience function equivalent to
 
300
.ZN XCirculateSubwindows
 
301
with
 
302
.ZN RaiseLowest
 
303
specified.
 
304
.LP
 
305
.ZN XCirculateSubwindowsUp
 
306
can generate a
 
307
.ZN BadWindow 
 
308
error.
 
309
.LP
 
310
The
 
311
.ZN XCirculateSubwindowsDown
 
312
function lowers the highest mapped child of the specified window that partially
 
313
or completely occludes another child.
 
314
Completely unobscured children are not affected.
 
315
This is a convenience function equivalent to
 
316
.ZN XCirculateSubwindows
 
317
with
 
318
.ZN LowerHighest
 
319
specified.
 
320
.LP
 
321
.ZN XCirculateSubwindowsDown
 
322
can generate a
 
323
.ZN BadWindow 
 
324
error.
 
325
.LP
 
326
The
 
327
.ZN XRestackWindows
 
328
function restacks the windows in the order specified,
 
329
from top to bottom.
 
330
The stacking order of the first window in the windows array is unaffected,
 
331
but the other windows in the array are stacked underneath the first window,
 
332
in the order of the array.
 
333
The stacking order of the other windows is not affected.
 
334
For each window in the window array that is not a child of the specified window,
 
335
a
 
336
.ZN BadMatch
 
337
error results.
 
338
.LP
 
339
If the override-redirect attribute of a window is 
 
340
.ZN False 
 
341
and some
 
342
other client has selected 
 
343
.ZN SubstructureRedirectMask 
 
344
on the parent, the X server generates 
 
345
.ZN ConfigureRequest 
 
346
events for each window whose override-redirect flag is not set, 
 
347
and no further processing is performed.
 
348
Otherwise, the windows will be restacked in top-to-bottom order.
 
349
.LP
 
350
.ZN XRestackWindows
 
351
can generate
 
352
.ZN BadWindow 
 
353
error.
 
354
.SH DIAGNOSTICS
 
355
.TP 1i
 
356
.ZN BadValue
 
357
Some numeric value falls outside the range of values accepted by the request.
 
358
Unless a specific range is specified for an argument, the full range defined
 
359
by the argument's type is accepted.  Any argument defined as a set of
 
360
alternatives can generate this error.
 
361
.TP 1i
 
362
.ZN BadWindow
 
363
A value for a Window argument does not name a defined Window.
 
364
.SH "SEE ALSO"
 
365
XChangeWindowAttributes(3X11),
 
366
XConfigureWindow(3X11),
 
367
XCreateWindow(3X11),
 
368
XDestroyWindow(3X11),
 
369
XMapWindow(3X11),
 
370
XUnmapWindow(3X11)
 
371
.br
 
372
\fI\*(xL\fP