diff options
author | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2020-01-04 17:55:18 +0000 |
---|---|---|
committer | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2020-01-04 17:55:18 +0000 |
commit | 1128148d76d7952d7aacfa2b083f5b5a96b4b4d5 (patch) | |
tree | 9291b9dfdfb4da1828705353be85e340f302e651 /lib/libX11/man/XNextEvent.man | |
parent | 7b7fd95cb6ee85ebe6d6d08b126b770770e86688 (diff) |
Uppdate to libX11 1.6.9. Tested by krw@ and naddy@
Diffstat (limited to 'lib/libX11/man/XNextEvent.man')
-rw-r--r-- | lib/libX11/man/XNextEvent.man | 141 |
1 files changed, 53 insertions, 88 deletions
diff --git a/lib/libX11/man/XNextEvent.man b/lib/libX11/man/XNextEvent.man index 2435789e5..f1bfac935 100644 --- a/lib/libX11/man/XNextEvent.man +++ b/lib/libX11/man/XNextEvent.man @@ -38,72 +38,39 @@ .\" 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. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XNextEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XNextEvent, XPeekEvent, XWindowEvent, XCheckWindowEvent, XMaskEvent, XCheckMaskEvent, XCheckTypedEvent, XCheckTypedWindowEvent \- select events by type .SH SYNTAX .HP -int XNextEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^); +int XNextEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^); .HP -int XPeekEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^); +int XPeekEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^); .HP int XWindowEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, long -\fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^); +\fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^); .HP Bool XCheckWindowEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, long -\fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^); +\fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^); .HP int XMaskEvent\^(\^Display *\fIdisplay\fP\^, long \fIevent_mask\fP\^, XEvent -*\fIevent_return\fP\^); +*\fIevent_return\fP\^); .HP Bool XCheckMaskEvent\^(\^Display *\fIdisplay\fP\^, long \fIevent_mask\fP\^, -XEvent *\fIevent_return\fP\^); +XEvent *\fIevent_return\fP\^); .HP Bool XCheckTypedEvent\^(\^Display *\fIdisplay\fP\^, int \fIevent_type\fP\^, -XEvent *\fIevent_return\fP\^); +XEvent *\fIevent_return\fP\^); .HP Bool XCheckTypedWindowEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -int \fIevent_type\fP\^, XEvent *\fIevent_return\fP\^); +int \fIevent_type\fP\^, XEvent *\fIevent_return\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -117,127 +84,125 @@ Returns the next event in the queue. Returns a copy of the matched event's associated structure. .IP \fIevent_type\fP 1i Specifies the event type to be compared. - -.ds Wi \ whose event uou are interested in .IP \fIw\fP 1i -Specifies the window \*(Wi. +Specifies the window whose event you are interested in. .SH DESCRIPTION The -.ZN XNextEvent +.B XNextEvent function copies the first event from the event queue into the specified -.ZN XEvent +.B XEvent structure and then removes it from the queue. If the event queue is empty, -.ZN XNextEvent +.B XNextEvent flushes the output buffer and blocks until an event is received. .LP The -.ZN XPeekEvent +.B XPeekEvent function returns the first event from the event queue, but it does not remove the event from the queue. If the queue is empty, -.ZN XPeekEvent +.B XPeekEvent flushes the output buffer and blocks until an event is received. It then copies the event into the client-supplied -.ZN XEvent +.B XEvent structure without removing it from the event queue. .LP The -.ZN XWindowEvent +.B XWindowEvent function searches the event queue for an event that matches both the specified window and event mask. When it finds a match, -.ZN XWindowEvent +.B XWindowEvent removes that event from the queue and copies it into the specified -.ZN XEvent +.B XEvent structure. The other events stored in the queue are not discarded. If a matching event is not in the queue, -.ZN XWindowEvent +.B XWindowEvent flushes the output buffer and blocks until one is received. .LP The -.ZN XCheckWindowEvent -function searches the event queue and then the events available +.B XCheckWindowEvent +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, -.ZN XCheckWindowEvent +.B XCheckWindowEvent removes that event, copies it into the specified -.ZN XEvent +.B XEvent structure, and returns -.ZN True . +.BR True . The other events stored in the queue are not discarded. If the event you requested is not available, -.ZN XCheckWindowEvent +.B XCheckWindowEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. .LP The -.ZN XMaskEvent -function searches the event queue for the events associated with the +.B XMaskEvent +function searches the event queue for the events associated with the specified mask. When it finds a match, -.ZN XMaskEvent +.B XMaskEvent removes that event and copies it into the specified -.ZN XEvent +.B XEvent structure. The other events stored in the queue are not discarded. If the event you requested is not in the queue, -.ZN XMaskEvent +.B XMaskEvent flushes the output buffer and blocks until one is received. .LP The -.ZN XCheckMaskEvent +.B XCheckMaskEvent 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, -.ZN XCheckMaskEvent +.B XCheckMaskEvent removes that event, copies it into the specified -.ZN XEvent +.B XEvent structure, and returns -.ZN True . +.BR True . The other events stored in the queue are not discarded. If the event you requested is not available, -.ZN XCheckMaskEvent +.B XCheckMaskEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. .LP The -.ZN XCheckTypedEvent -function searches the event queue and then any events available +.B XCheckTypedEvent +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, -.ZN XCheckTypedEvent +.B XCheckTypedEvent removes that event, copies it into the specified -.ZN XEvent +.B XEvent structure, and returns -.ZN True . +.BR True . The other events in the queue are not discarded. If the event is not available, -.ZN XCheckTypedEvent +.B XCheckTypedEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. .LP The -.ZN XCheckTypedWindowEvent -function searches the event queue and then any events available +.B XCheckTypedWindowEvent +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, -.ZN XCheckTypedWindowEvent +.B XCheckTypedWindowEvent removes the event from the queue, copies it into the specified -.ZN XEvent +.B XEvent structure, and returns -.ZN True . +.BR True . The other events in the queue are not discarded. If the event is not available, -.ZN XCheckTypedWindowEvent +.B XCheckTypedWindowEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), |