man/XGraphicsExposeEvent.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 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XGraphicsExposeEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XGraphicsExposeEvent, XNoExposeEvent \- GraphicsExpose and NoExpose event structures
 145 .SH STRUCTURES
 146 The structures for
 147 .ZN GraphicsExpose
 148 and
 149 .ZN NoExpose
 150 events contain:
 151 .LP
 152 .Ds 0
 153 .TA .5i 3i
 154 .ta .5i 3i
 155 typedef struct {
 156         int type;       /\&* GraphicsExpose */
 157         unsigned long serial;   /\&* # of last request processed by server */
 158         Bool send_event;        /\&* true if this came from a SendEvent request */
 159         Display *display;       /\&* Display the event was read from */
 160         Drawable drawable;
 161         int x, y;
 162         int width, height;
 163         int count;      /\&* if nonzero, at least this many more */
 164         int major_code; /\&* core is CopyArea or CopyPlane */
 165         int minor_code; /\&* not defined in the core */
 166 } XGraphicsExposeEvent;
 167 .De
 168 .LP
 169 .Ds 0
 170 .TA .5i 3i
 171 .ta .5i 3i
 172 typedef struct {
 173         int type;       /\&* NoExpose */
 174         unsigned long serial;   /\&* # of last request processed by server */
 175         Bool send_event;        /\&* true if this came from a SendEvent request */
 176         Display *display;       /\&* Display the event was read from */
 177         Drawable drawable;
 178         int major_code; /\&* core is CopyArea or CopyPlane */
 179         int minor_code; /\&* not defined in the core */
 180 } XNoExposeEvent;
 181 .De
 182 .LP
 183 When you receive these events,
 184 their structure members are set as follows.
 185 .LP
 186 The type member is set to the event type constant name that uniquely identifies
 187 it.
 188 For example, when the X server reports a
 189 .ZN GraphicsExpose
 190 event to a client application, it sends an
 191 .ZN XGraphicsExposeEvent
 192 structure with the type member set to
 193 .ZN GraphicsExpose .
 194 The display member is set to a pointer to the display the event was read on.
 195 The send_event member is set to
 196 .ZN True
 197 if the event came from a
 198 .ZN SendEvent
 199 protocol request.
 200 The serial member is set from the serial number reported in the protocol
 201 but expanded from the 16-bit least-significant bits to a full 32-bit value.
 202 The window member is set to the window that is most useful to toolkit
 203 dispatchers.
 204 .LP
 205 Both structures have these common members: drawable, major_code, and minor_code.
 206 The drawable member is set to the drawable of the destination region on
 207 which the graphics request was to be performed.
 208 The major_code member is set to the graphics request initiated by the client
 209 and can be either
 210 .ZN X_CopyArea
 211 or
 212 .ZN X_CopyPlane .
 213 If it is
 214 .ZN X_CopyArea ,
 215 a call to
 216 .ZN XCopyArea
 217 initiated the request.
 218 If it is
 219 .ZN X_CopyPlane ,
 220 a call to
 221 .ZN XCopyPlane
 222 initiated the request.
 223 These constants are defined in
 224 .hN X11/Xproto.h .
 225 The minor_code member,
 226 like the major_code member,
 227 indicates which graphics request was initiated by
 228 the client.
 229 However, the minor_code member is not defined by the core
 230 X protocol and will be zero in these cases,
 231 although it may be used by an extension.
 232 .LP
 233 The
 234 .ZN XGraphicsExposeEvent
 235 structure has these additional members: x, y, width, height, and count.
 236 The x and y members are set to the coordinates relative to the drawable's origin
 237 and indicate the upper-left corner of the rectangle.
 238 The width and height members are set to the size (extent) of the rectangle.
 239 The count member is set to the number of
 240 .ZN GraphicsExpose
 241 events to follow.
 242 If count is zero, no more
 243 .ZN GraphicsExpose
 244 events follow for this window.
 245 However, if count is nonzero, at least that number of
 246 .ZN GraphicsExpose
 247 events (and possibly more) are to follow for this window.
 248 .SH "SEE ALSO"
 249 XAnyEvent(__libmansuffix__),
 250 XButtonEvent(__libmansuffix__),
 251 XCreateWindowEvent(__libmansuffix__),
 252 XCirculateEvent(__libmansuffix__),
 253 XCirculateRequestEvent(__libmansuffix__),
 254 XColormapEvent(__libmansuffix__),
 255 XConfigureEvent(__libmansuffix__),
 256 XConfigureRequestEvent(__libmansuffix__),
 257 XCopyArea(__libmansuffix__),
 258 XCrossingEvent(__libmansuffix__),
 259 XDestroyWindowEvent(__libmansuffix__),
 260 XErrorEvent(__libmansuffix__),
 261 XExposeEvent(__libmansuffix__),
 262 XFocusChangeEvent(__libmansuffix__),
 263 XGravityEvent(__libmansuffix__),
 264 XKeymapEvent(__libmansuffix__),
 265 XMapEvent(__libmansuffix__),
 266 XMapRequestEvent(__libmansuffix__),
 267 XPropertyEvent(__libmansuffix__),
 268 XReparentEvent(__libmansuffix__),
 269 XResizeRequestEvent(__libmansuffix__),
 270 XSelectionClearEvent(__libmansuffix__),
 271 XSelectionEvent(__libmansuffix__),
 272 XSelectionRequestEvent(__libmansuffix__),
 273 XUnmapEvent(__libmansuffix__),
 274 XVisibilityEvent(__libmansuffix__)
 275 .br
 276 \fI\*(xL\fP