<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='xneventman'>
<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium -->

<!--  Permission is hereby granted, free of charge, to any person obtaining -->
<!--  a copy of this software and associated documentation files (the -->
<!--  "Software"), to deal in the Software without restriction, including -->
<!--  without limitation the rights to use, copy, modify, merge, publish, -->
<!--  distribute, sublicense, and/or sell copies of the Software, and to -->
<!--  permit persons to whom the Software is furnished to do so, subject to -->
<!--  the following conditions: -->

<!--  The above copyright notice and this permission notice shall be included -->
<!--  in all copies or substantial portions of the Software. -->

<!--  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -->
<!--  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -->
<!--  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -->
<!--  IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR -->
<!--  OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -->
<!--  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -->
<!--  OTHER DEALINGS IN THE SOFTWARE. -->

<!--  Except as contained in this notice, the name of the X Consortium shall -->
<!--  not be used in advertising or otherwise to promote the sale, use or -->
<!--  other dealings in this Software without prior written authorization -->
<!--  from the X Consortium. -->

<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by -->
<!--  Digital Equipment Corporation -->

<!--  Portions Copyright \(co 1990, 1991 by -->
<!--  Tektronix, Inc. -->

<!--  Permission to use, copy, modify and distribute this documentation for -->
<!--  any purpose and without fee is hereby granted, provided that the above -->
<!--  copyright notice appears in all copies and that both that copyright notice -->
<!--  and this permission notice appear in all copies, and that the names of -->
<!--  Digital and Tektronix not be used in in advertising or publicity pertaining -->
<!--  to this documentation without specific, written prior permission. -->
<!--  Digital and Tektronix makes no representations about the suitability -->
<!--  of this documentation for any purpose. -->
<!--  It is provided ``as is'' without express or implied warranty. -->
<!--   -->
<!--  $XFree86: xc/doc/man/X11/XNEvent.man,v 1.3 2003/04/28 22:17:55 herrb Exp $ -->

<!-- .na -->
<!-- Ds listing suppressed (not used) -->
<!-- De listing suppressed (not used) -->
<!-- FD listing suppressed (not used) -->
<!-- FN listing suppressed (not used) -->
<!-- IN listing suppressed (not used) -->
<!-- C{ listing suppressed (not used) -->
<!-- C} listing suppressed (not used) -->
<!-- Pn listing suppressed (not used) -->
<!-- hN listing suppressed (not used) -->
<!-- NT listing suppressed (not used) -->
<!-- .		\" Note End \-\- doug kraft 3/85 -->
<!-- NE listing suppressed (not used) -->
<!-- .ny0 -->
<refmeta>
<refentrytitle>XNextEvent</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XNextEvent</refname>
<refname>XPeekEvent</refname>
<refname>XWindowEvent</refname>
<refname>XCheckWindowEvent</refname>
<refname>XMaskEvent</refname>
<refname>XCheckMaskEvent</refname>
<refname>XCheckTypedEvent</refname>
<refname>XCheckTypedWindowEvent</refname>
<refpurpose>select events by type</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>

<para>int XNextEvent&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, XEvent *<emphasis remap='I'>event_return</emphasis>&hairsp;);</para> 

<para>int XPeekEvent&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, XEvent *<emphasis remap='I'>event_return</emphasis>&hairsp;);</para> 

<para>int XWindowEvent&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Window <emphasis remap='I'>w</emphasis>&hairsp;, long
<emphasis remap='I'>event_mask</emphasis>&hairsp;, XEvent *<emphasis remap='I'>event_return</emphasis>&hairsp;);</para> 

<para>Bool XCheckWindowEvent&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Window <emphasis remap='I'>w</emphasis>&hairsp;, long
<emphasis remap='I'>event_mask</emphasis>&hairsp;, XEvent *<emphasis remap='I'>event_return</emphasis>&hairsp;);</para> 

<para>int XMaskEvent&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, long <emphasis remap='I'>event_mask</emphasis>&hairsp;, XEvent
*<emphasis remap='I'>event_return</emphasis>&hairsp;);</para> 

<para>Bool XCheckMaskEvent&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, long <emphasis remap='I'>event_mask</emphasis>&hairsp;,
XEvent *<emphasis remap='I'>event_return</emphasis>&hairsp;);</para> 

<para>Bool XCheckTypedEvent&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, int <emphasis remap='I'>event_type</emphasis>&hairsp;,
XEvent *<emphasis remap='I'>event_return</emphasis>&hairsp;);</para> 

<para>Bool XCheckTypedWindowEvent&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Window <emphasis remap='I'>w</emphasis>&hairsp;,
int <emphasis remap='I'>event_type</emphasis>&hairsp;, XEvent *<emphasis remap='I'>event_return</emphasis>&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>display</emphasis></term>
  <listitem>
<para>Specifies the connection to the X server.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>event_mask</emphasis></term>
  <listitem>
<para>Specifies the event mask.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>event_return</emphasis></term>
  <listitem>
<para>Returns the matched event's associated structure.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>event_return</emphasis></term>
  <listitem>
<para>Returns the next event in the queue.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>event_return</emphasis></term>
  <listitem>
<para>Returns a copy of the matched event's associated structure.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>event_type</emphasis></term>
  <listitem>
<para>Specifies the event type to be compared.</para>

  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>w</emphasis></term>
  <listitem>
<para>Specifies the window &nbsp;whose event uou are interested in.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;XNextEvent&hairsp;</emphasis>
function copies the first event from the event queue into the specified
<emphasis remap='I'>&hairsp;XEvent&hairsp;</emphasis>
structure and then removes it from the queue.
If the event queue is empty,
<emphasis remap='I'>&hairsp;XNextEvent&hairsp;</emphasis>
flushes the output buffer and blocks until an event is received.</para>

<para>The
<emphasis remap='I'>&hairsp;XPeekEvent&hairsp;</emphasis>
function returns the first event from the event queue,
but it does not remove the event from the queue.
If the queue is empty,
<emphasis remap='I'>&hairsp;XPeekEvent&hairsp;</emphasis>
flushes the output buffer and blocks until an event is received.
It then copies the event into the client-supplied
<emphasis remap='I'>&hairsp;XEvent&hairsp;</emphasis>
structure without removing it from the event queue.</para>

<para>The
<emphasis remap='I'>&hairsp;XWindowEvent&hairsp;</emphasis>
function searches the event queue for an event that matches both the specified
window and event mask.
When it finds a match,
<emphasis remap='I'>&hairsp;XWindowEvent&hairsp;</emphasis>
removes that event from the queue and copies it into the specified
<emphasis remap='I'>&hairsp;XEvent&hairsp;</emphasis>
structure.
The other events stored in the queue are not discarded.
If a matching event is not in the queue,
<emphasis remap='I'>&hairsp;XWindowEvent&hairsp;</emphasis>
flushes the output buffer and blocks until one is received.</para>

<para>The
<emphasis remap='I'>&hairsp;XCheckWindowEvent&hairsp;</emphasis>
function searches the event queue and then the events available 
on the server connection for the first event that matches the specified window
and event mask.
If it finds a match,
<emphasis remap='I'>&hairsp;XCheckWindowEvent&hairsp;</emphasis>
removes that event, copies it into the specified
<emphasis remap='I'>&hairsp;XEvent&hairsp;</emphasis>
structure, and returns
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>.
The other events stored in the queue are not discarded.
If the event you requested is not available,
<emphasis remap='I'>&hairsp;XCheckWindowEvent&hairsp;</emphasis>
returns
<emphasis remap='I'>&hairsp;False&hairsp;</emphasis>,
and the output buffer will have been flushed.</para>

<para>The
<emphasis remap='I'>&hairsp;XMaskEvent&hairsp;</emphasis>
function searches the event queue for the events associated with the 
specified mask.
When it finds a match,
<emphasis remap='I'>&hairsp;XMaskEvent&hairsp;</emphasis>
removes that event and copies it into the specified
<emphasis remap='I'>&hairsp;XEvent&hairsp;</emphasis>
structure.
The other events stored in the queue are not discarded.
If the event you requested is not in the queue,
<emphasis remap='I'>&hairsp;XMaskEvent&hairsp;</emphasis>
flushes the output buffer and blocks until one is received.</para>

<para>The
<emphasis remap='I'>&hairsp;XCheckMaskEvent&hairsp;</emphasis>
function searches the event queue and then any events available on the
server connection for the first event that matches the specified mask.
If it finds a match,
<emphasis remap='I'>&hairsp;XCheckMaskEvent&hairsp;</emphasis>
removes that event, copies it into the specified
<emphasis remap='I'>&hairsp;XEvent&hairsp;</emphasis>
structure, and returns
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>.
The other events stored in the queue are not discarded.
If the event you requested is not available,
<emphasis remap='I'>&hairsp;XCheckMaskEvent&hairsp;</emphasis>
returns
<emphasis remap='I'>&hairsp;False&hairsp;</emphasis>,
and the output buffer will have been flushed.</para>

<para>The
<emphasis remap='I'>&hairsp;XCheckTypedEvent&hairsp;</emphasis>
function searches the event queue and then any events available  
on the server connection for the first event that matches the specified type.
If it finds a match,
<emphasis remap='I'>&hairsp;XCheckTypedEvent&hairsp;</emphasis>
removes that event, copies it into the specified
<emphasis remap='I'>&hairsp;XEvent&hairsp;</emphasis>
structure, and returns
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>.
The other events in the queue are not discarded.
If the event is not available,
<emphasis remap='I'>&hairsp;XCheckTypedEvent&hairsp;</emphasis>
returns
<emphasis remap='I'>&hairsp;False&hairsp;</emphasis>,
and the output buffer will have been flushed.</para>

<para>The
<emphasis remap='I'>&hairsp;XCheckTypedWindowEvent&hairsp;</emphasis>
function searches the event queue and then any events available  
on the server connection for the first event that matches the specified
type and window.
If it finds a match,
<emphasis remap='I'>&hairsp;XCheckTypedWindowEvent&hairsp;</emphasis>
removes the event from the queue, copies it into the specified
<emphasis remap='I'>&hairsp;XEvent&hairsp;</emphasis>
structure, and returns
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>.
The other events in the queue are not discarded.
If the event is not available,
<emphasis remap='I'>&hairsp;XCheckTypedWindowEvent&hairsp;</emphasis>
returns
<emphasis remap='I'>&hairsp;False&hairsp;</emphasis>,
and the output buffer will have been flushed.</para>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>XAnyEvent(3X11),
XIfEvent(3X11),
XPutBackEvent(3X11),
XSendEvent(3X11)
<!-- .br -->
<userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

