← 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/XMapWin.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/XMapWin.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/XMapWin.man,v 1.2 2001/01/27 18:20:01 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 XMapWindow 3X11 __xorgversion__ "XLIB FUNCTIONS"
 
144
.SH NAME
 
145
XMapWindow, XMapRaised, XMapSubwindows \- map windows
 
146
.SH SYNTAX
 
147
XMapWindow\^(\^\fIdisplay\fP, \fIw\fP\^)
 
148
.br
 
149
      Display *\fIdisplay\fP\^;
 
150
.br
 
151
      Window \fIw\fP\^;
 
152
.LP
 
153
XMapRaised\^(\^\fIdisplay\fP, \fIw\fP\^)
 
154
.br
 
155
      Display *\fIdisplay\fP\^;
 
156
.br
 
157
      Window \fIw\fP\^;
 
158
.LP
 
159
XMapSubwindows\^(\^\fIdisplay\fP, \fIw\fP\^)
 
160
.br
 
161
      Display *\fIdisplay\fP\^;
 
162
.br
 
163
      Window \fIw\fP\^;
 
164
.SH ARGUMENTS
 
165
.IP \fIdisplay\fP 1i
 
166
Specifies the connection to the X server.
 
167
.IP \fIw\fP 1i
 
168
Specifies the window.
 
169
.SH DESCRIPTION
 
170
The
 
171
.ZN XMapWindow
 
172
function
 
173
maps the window and all of its
 
174
subwindows that have had map requests.
 
175
Mapping a window that has an unmapped ancestor does not display the
 
176
window but marks it as eligible for display when the ancestor becomes
 
177
mapped.
 
178
Such a window is called unviewable.
 
179
When all its ancestors are mapped,
 
180
the window becomes viewable
 
181
and will be visible on the screen if it is not obscured by another window.
 
182
This function has no effect if the window is already mapped.
 
183
.LP
 
184
If the override-redirect of the window is
 
185
.ZN False 
 
186
and if some other client has selected
 
187
.ZN SubstructureRedirectMask
 
188
on the parent window, then the X server generates a
 
189
.ZN MapRequest
 
190
event, and the
 
191
.ZN XMapWindow
 
192
function does not map the window.
 
193
Otherwise, the window is mapped, and the X server generates a
 
194
.ZN MapNotify
 
195
event.
 
196
.LP
 
197
If the window becomes viewable and no earlier contents for it are remembered,
 
198
the X server tiles the window with its background.
 
199
If the window's background is undefined,
 
200
the existing screen contents are not
 
201
altered, and the X server generates zero or more 
 
202
.ZN Expose
 
203
events.
 
204
If backing-store was maintained while the window was unmapped, no 
 
205
.ZN Expose
 
206
events
 
207
are generated.
 
208
If backing-store will now be maintained, 
 
209
a full-window exposure is always generated.
 
210
Otherwise, only visible regions may be reported.
 
211
Similar tiling and exposure take place for any newly viewable inferiors.
 
212
.LP
 
213
.IN "XMapWindow"
 
214
If the window is an
 
215
.ZN InputOutput 
 
216
window,
 
217
.ZN XMapWindow
 
218
generates 
 
219
.ZN Expose 
 
220
events on each 
 
221
.ZN InputOutput
 
222
window that it causes to be displayed.
 
223
If the client maps and paints the window 
 
224
and if the client begins processing events, 
 
225
the window is painted twice.
 
226
To avoid this,
 
227
first ask for 
 
228
.ZN Expose 
 
229
events and then map the window,
 
230
so the client processes input events as usual.
 
231
The event list will include 
 
232
.ZN Expose 
 
233
for each
 
234
window that has appeared on the screen. 
 
235
The client's normal response to
 
236
an 
 
237
.ZN Expose 
 
238
event should be to repaint the window.
 
239
This method usually leads to simpler programs and to proper interaction
 
240
with window managers.
 
241
.LP
 
242
.ZN XMapWindow
 
243
can generate a
 
244
.ZN BadWindow 
 
245
error.
 
246
.LP
 
247
The
 
248
.ZN XMapRaised
 
249
function
 
250
essentially is similar to
 
251
.ZN XMapWindow
 
252
in that it maps the window and all of its
 
253
subwindows that have had map requests.
 
254
However, it also raises the specified window to the top of the stack.
 
255
.LP
 
256
.ZN XMapRaised
 
257
can generate a
 
258
.ZN BadWindow 
 
259
error.
 
260
.LP
 
261
The
 
262
.ZN XMapSubwindows
 
263
.IN "XMapSubwindows"
 
264
function maps all subwindows for a specified window in top-to-bottom stacking 
 
265
order.
 
266
The X server generates
 
267
.ZN Expose
 
268
events on each newly displayed window.
 
269
This may be much more efficient than mapping many windows
 
270
one at a time because the server needs to perform much of the work
 
271
only once, for all of the windows, rather than for each window.
 
272
.LP
 
273
.ZN XMapSubwindows
 
274
can generate a
 
275
.ZN BadWindow 
 
276
error.
 
277
.SH DIAGNOSTICS
 
278
.TP 1i
 
279
.ZN BadWindow
 
280
A value for a Window argument does not name a defined Window.
 
281
.SH "SEE ALSO"
 
282
XChangeWindowAttributes(3X11),
 
283
XConfigureWindow(3X11),
 
284
XCreateWindow(3X11),
 
285
XDestroyWindow(3X11),
 
286
XRaiseWindow(3X11),
 
287
XUnmapWindow(3X11)
 
288
.br
 
289
\fI\*(xL\fP