man/XNextEvent.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 XNextEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XNextEvent, XPeekEvent, XWindowEvent, XCheckWindowEvent, XMaskEvent, XCheckMaskEvent, XCheckTypedEvent, XCheckTypedWindowEvent \- select events by type
 145 .SH SYNTAX
 146 .HP
 147 int XNextEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^);
 148 .HP
 149 int XPeekEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^);
 150 .HP
 151 int XWindowEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, long
 152 \fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^);
 153 .HP
 154 Bool XCheckWindowEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, long
 155 \fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^);
 156 .HP
 157 int XMaskEvent\^(\^Display *\fIdisplay\fP\^, long \fIevent_mask\fP\^, XEvent
 158 *\fIevent_return\fP\^);
 159 .HP
 160 Bool XCheckMaskEvent\^(\^Display *\fIdisplay\fP\^, long \fIevent_mask\fP\^,
 161 XEvent *\fIevent_return\fP\^);
 162 .HP
 163 Bool XCheckTypedEvent\^(\^Display *\fIdisplay\fP\^, int \fIevent_type\fP\^,
 164 XEvent *\fIevent_return\fP\^);
 165 .HP
 166 Bool XCheckTypedWindowEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
 167 int \fIevent_type\fP\^, XEvent *\fIevent_return\fP\^);
 168 .SH ARGUMENTS
 169 .IP \fIdisplay\fP 1i
 170 Specifies the connection to the X server.
 171 .IP \fIevent_mask\fP 1i
 172 Specifies the event mask.
 173 .IP \fIevent_return\fP 1i
 174 Returns the matched event's associated structure.
 175 .IP \fIevent_return\fP 1i
 176 Returns the next event in the queue.
 177 .IP \fIevent_return\fP 1i
 178 Returns a copy of the matched event's associated structure.
 179 .IP \fIevent_type\fP 1i
 180 Specifies the event type to be compared.
 181
 182 .ds Wi \ whose event uou are interested in
 183 .IP \fIw\fP 1i
 184 Specifies the window \*(Wi.
 185 .SH DESCRIPTION
 186 The
 187 .ZN XNextEvent
 188 function copies the first event from the event queue into the specified
 189 .ZN XEvent
 190 structure and then removes it from the queue.
 191 If the event queue is empty,
 192 .ZN XNextEvent
 193 flushes the output buffer and blocks until an event is received.
 194 .LP
 195 The
 196 .ZN XPeekEvent
 197 function returns the first event from the event queue,
 198 but it does not remove the event from the queue.
 199 If the queue is empty,
 200 .ZN XPeekEvent
 201 flushes the output buffer and blocks until an event is received.
 202 It then copies the event into the client-supplied
 203 .ZN XEvent
 204 structure without removing it from the event queue.
 205 .LP
 206 The
 207 .ZN XWindowEvent
 208 function searches the event queue for an event that matches both the specified
 209 window and event mask.
 210 When it finds a match,
 211 .ZN XWindowEvent
 212 removes that event from the queue and copies it into the specified
 213 .ZN XEvent
 214 structure.
 215 The other events stored in the queue are not discarded.
 216 If a matching event is not in the queue,
 217 .ZN XWindowEvent
 218 flushes the output buffer and blocks until one is received.
 219 .LP
 220 The
 221 .ZN XCheckWindowEvent
 222 function searches the event queue and then the events available
 223 on the server connection for the first event that matches the specified window
 224 and event mask.
 225 If it finds a match,
 226 .ZN XCheckWindowEvent
 227 removes that event, copies it into the specified
 228 .ZN XEvent
 229 structure, and returns
 230 .ZN True .
 231 The other events stored in the queue are not discarded.
 232 If the event you requested is not available,
 233 .ZN XCheckWindowEvent
 234 returns
 235 .ZN False ,
 236 and the output buffer will have been flushed.
 237 .LP
 238 The
 239 .ZN XMaskEvent
 240 function searches the event queue for the events associated with the
 241 specified mask.
 242 When it finds a match,
 243 .ZN XMaskEvent
 244 removes that event and copies it into the specified
 245 .ZN XEvent
 246 structure.
 247 The other events stored in the queue are not discarded.
 248 If the event you requested is not in the queue,
 249 .ZN XMaskEvent
 250 flushes the output buffer and blocks until one is received.
 251 .LP
 252 The
 253 .ZN XCheckMaskEvent
 254 function searches the event queue and then any events available on the
 255 server connection for the first event that matches the specified mask.
 256 If it finds a match,
 257 .ZN XCheckMaskEvent
 258 removes that event, copies it into the specified
 259 .ZN XEvent
 260 structure, and returns
 261 .ZN True .
 262 The other events stored in the queue are not discarded.
 263 If the event you requested is not available,
 264 .ZN XCheckMaskEvent
 265 returns
 266 .ZN False ,
 267 and the output buffer will have been flushed.
 268 .LP
 269 The
 270 .ZN XCheckTypedEvent
 271 function searches the event queue and then any events available
 272 on the server connection for the first event that matches the specified type.
 273 If it finds a match,
 274 .ZN XCheckTypedEvent
 275 removes that event, copies it into the specified
 276 .ZN XEvent
 277 structure, and returns
 278 .ZN True .
 279 The other events in the queue are not discarded.
 280 If the event is not available,
 281 .ZN XCheckTypedEvent
 282 returns
 283 .ZN False ,
 284 and the output buffer will have been flushed.
 285 .LP
 286 The
 287 .ZN XCheckTypedWindowEvent
 288 function searches the event queue and then any events available
 289 on the server connection for the first event that matches the specified
 290 type and window.
 291 If it finds a match,
 292 .ZN XCheckTypedWindowEvent
 293 removes the event from the queue, copies it into the specified
 294 .ZN XEvent
 295 structure, and returns
 296 .ZN True .
 297 The other events in the queue are not discarded.
 298 If the event is not available,
 299 .ZN XCheckTypedWindowEvent
 300 returns
 301 .ZN False ,
 302 and the output buffer will have been flushed.
 303 .SH "SEE ALSO"
 304 XAnyEvent(__libmansuffix__),
 305 XIfEvent(__libmansuffix__),
 306 XPutBackEvent(__libmansuffix__),
 307 XSendEvent(__libmansuffix__)
 308 .br
 309 \fI\*(xL\fP