[Xorg-commit] xc/doc/man/X11 XIfEvent.man,1.1.4.2,1.1.4.3

[Kaleb Keithley]

Committed by: kaleb

Update of /cvs/xorg/xc/doc/man/X11
In directory pdx:/home/kaleb/xorg/xc.XORG-CURRENT/doc/man/X11

Modified Files:
      Tag: XORG-CURRENT
	XIfEvent.man 
Log Message:
merge most of XFree86 RC3 (4.3.99.903) from vendor branch.
bug #214


Index: XIfEvent.man
===================================================================
RCS file: /cvs/xorg/xc/doc/man/X11/XIfEvent.man,v
retrieving revision 1.1.4.2
retrieving revision 1.1.4.3
diff -u -d -r1.1.4.2 -r1.1.4.3
--- a/XIfEvent.man	26 Nov 2003 22:48:16 -0000	1.1.4.2
+++ b/XIfEvent.man	23 Feb 2004 21:31:49 -0000	1.1.4.3
@@ -40,7 +40,7 @@
 .\" of this documentation for any purpose.
 .\" It is provided ``as is'' without express or implied warranty.
 .\" 
-.\" $XFree86: xc/doc/man/X11/XIfEvent.man,v 1.3 2003/04/28 22:17:55 herrb Exp $
+.\" $XFree86: xc/doc/man/X11/XIfEvent.man,v 1.4 2004/01/12 20:54:21 herrb Exp $
 .\"
 .ds xT X Toolkit Intrinsics \- C Language Interface
 .ds xW Athena X Widgets \- C Language X Toolkit Interface
@@ -207,6 +207,44 @@
 structure without removing the event from the queue.
 .ZN XPeekIfEvent
 flushes the output buffer if it blocks waiting for additional events.
+.LP
+Each of these functions requires you to pass a predicate procedure that 
+determines if an event matches what you want.
+Your predicate procedure must decide if the event is useful
+without calling any Xlib functions.
+If the predicate directly or indirectly causes the state of the event queue
+to change, the result is not defined.
+If Xlib has been initialized for threads, the predicate is called with
+the display locked and the result of a call by the predicate to any
+Xlib function that locks the display is not defined unless the caller
+has first called
+.ZN XLockDisplay .
+.LP
+The predicate procedure and its associated arguments are:
+.sM
+.HP
+Bool (\^*\fIpredicate\fP\^)\^(\^Display *\fIdisplay\fP, XEvent *\fIevent\fP, XPointer \fIarg\fP\^)
+.IP \fIdisplay\fP 1i
+Specifies the connection to the X server.
+.IP \fIevent\fP 1i
+Specifies the
+.ZN XEvent
+structure.
+.IP \fIarg\fP 1i
+Specifies the argument passed in from the 
+.ZN XIfEvent ,
+.ZN XCheckIfEvent ,
+or
+.ZN XPeekIfEvent 
+function.
+.LP
+.eM
+The predicate procedure is called once for each
+event in the queue until it finds a match. 
+After finding a match, the predicate procedure must return 
+.ZN True .
+If it did not find a match, it must return
+.ZN False .
 .SH "SEE ALSO"
 XAnyEvent(3X11),
 XNextEvent(3X11),