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

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/X11/XGEEvent.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:
 
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/XGEEvent.man,v 1.2 2001/01/27 18:19:59 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 XGraphicsExposeEvent 3X11 __xorgversion__ "XLIB FUNCTIONS"
 
144
.SH NAME
 
145
XGraphicsExposeEvent, XNoExposeEvent \- GraphicsExpose and NoExpose event structures
 
146
.SH STRUCTURES
 
147
The structures for
 
148
.ZN GraphicsExpose
 
149
and
 
150
.ZN NoExpose
 
151
events contain:
 
152
.LP
 
153
.Ds 0
 
154
.TA .5i 3i
 
155
.ta .5i 3i
 
156
typedef struct {
 
157
        int type;       /* GraphicsExpose */
 
158
        unsigned long serial;   /* # of last request processed by server */
 
159
        Bool send_event;        /* true if this came from a SendEvent request */
 
160
        Display *display;       /* Display the event was read from */
 
161
        Drawable drawable;
 
162
        int x, y;
 
163
        int width, height;
 
164
        int count;      /* if nonzero, at least this many more */
 
165
        int major_code; /* core is CopyArea or CopyPlane */
 
166
        int minor_code; /* not defined in the core */
 
167
} XGraphicsExposeEvent;
 
168
.De
 
169
.LP
 
170
.Ds 0
 
171
.TA .5i 3i
 
172
.ta .5i 3i
 
173
typedef struct {
 
174
        int type;       /* NoExpose */
 
175
        unsigned long serial;   /* # of last request processed by server */
 
176
        Bool send_event;        /* true if this came from a SendEvent request */
 
177
        Display *display;       /* Display the event was read from */
 
178
        Drawable drawable;
 
179
        int major_code; /* core is CopyArea or CopyPlane */
 
180
        int minor_code; /* not defined in the core */
 
181
} XNoExposeEvent;
 
182
.De
 
183
.LP
 
184
When you receive these events,
 
185
their structure members are set as follows.
 
186
.LP
 
187
The type member is set to the event type constant name that uniquely identifies
 
188
it.
 
189
For example, when the X server reports a
 
190
.ZN GraphicsExpose
 
191
event to a client application, it sends an
 
192
.ZN XGraphicsExposeEvent
 
193
structure with the type member set to
 
194
.ZN GraphicsExpose .
 
195
The display member is set to a pointer to the display the event was read on.
 
196
The send_event member is set to
 
197
.ZN True
 
198
if the event came from a
 
199
.ZN SendEvent
 
200
protocol request.
 
201
The serial member is set from the serial number reported in the protocol
 
202
but expanded from the 16-bit least-significant bits to a full 32-bit value.
 
203
The window member is set to the window that is most useful to toolkit
 
204
dispatchers.
 
205
.LP
 
206
Both structures have these common members: drawable, major_code, and minor_code.
 
207
The drawable member is set to the drawable of the destination region on 
 
208
which the graphics request was to be performed.
 
209
The major_code member is set to the graphics request initiated by the client
 
210
and can be either
 
211
.ZN X_CopyArea
 
212
or
 
213
.ZN X_CopyPlane .
 
214
If it is
 
215
.ZN X_CopyArea ,
 
216
a call to
 
217
.ZN XCopyArea
 
218
initiated the request.
 
219
If it is
 
220
.ZN X_CopyPlane ,
 
221
a call to
 
222
.ZN XCopyPlane
 
223
initiated the request.
 
224
These constants are defined in 
 
225
.hN X11/Xproto.h .
 
226
The minor_code member,
 
227
like the major_code member, 
 
228
indicates which graphics request was initiated by
 
229
the client. 
 
230
However, the minor_code member is not defined by the core
 
231
X protocol and will be zero in these cases, 
 
232
although it may be used by an extension.
 
233
.LP
 
234
The 
 
235
.ZN XGraphicsExposeEvent
 
236
structure has these additional members: x, y, width, height, and count. 
 
237
The x and y members are set to the coordinates relative to the drawable's origin
 
238
and indicate the upper-left corner of the rectangle.
 
239
The width and height members are set to the size (extent) of the rectangle.
 
240
The count member is set to the number of
 
241
.ZN GraphicsExpose
 
242
events to follow.
 
243
If count is zero, no more
 
244
.ZN GraphicsExpose
 
245
events follow for this window.
 
246
However, if count is nonzero, at least that number of
 
247
.ZN GraphicsExpose
 
248
events (and possibly more) are to follow for this window.
 
249
.SH "SEE ALSO"
 
250
XAnyEvent(3X11),
 
251
XButtonEvent(3X11),
 
252
XCreateWindowEvent(3X11),
 
253
XCirculateEvent(3X11),
 
254
XCirculateRequestEvent(3X11),
 
255
XColormapEvent(3X11),
 
256
XConfigureEvent(3X11),
 
257
XConfigureRequestEvent(3X11),
 
258
XCopyArea(3X11),
 
259
XCrossingEvent(3X11),
 
260
XDestroyWindowEvent(3X11),
 
261
XErrorEvent(3X11),
 
262
XExposeEvent(3X11),
 
263
XFocusChangeEvent(3X11),
 
264
XGravityEvent(3X11),
 
265
XKeymapEvent(3X11),
 
266
XMapEvent(3X11),
 
267
XMapRequestEvent(3X11),
 
268
XPropertyEvent(3X11),
 
269
XReparentEvent(3X11),
 
270
XResizeRequestEvent(3X11),
 
271
XSelectionClearEvent(3X11),
 
272
XSelectionEvent(3X11),
 
273
XSelectionRequestEvent(3X11),
 
274
XUnmapEvent(3X11),
 
275
XVisibilityEvent(3X11)
 
276
.br
 
277
\fI\*(xL\fP