xenocara/lib/libXt/man/XtNextEvent.man

184 lines
4.2 KiB
Groff
Raw Normal View History

2006-11-25 11:01:46 -07:00
.\" Copyright (c) 1993, 1994 X Consortium
2012-03-10 09:45:48 -07:00
.\"
2006-11-25 11:01:46 -07:00
.\" 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 furnished to do so, subject to
.\" the following conditions:
2012-03-10 09:45:48 -07:00
.\"
2006-11-25 11:01:46 -07:00
.\" The above copyright notice and this permission notice shall be included
.\" in all copies or substantial portions of the Software.
2012-03-10 09:45:48 -07:00
.\"
2006-11-25 11:01:46 -07:00
.\" 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.
2012-03-10 09:45:48 -07:00
.\"
2006-11-25 11:01:46 -07:00
.\" 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 dealing in this Software without prior written authorization
.\" from the X Consortium.
.\"
.ds tk X Toolkit
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xI Intrinsics
.ds xW X Toolkit Athena Widgets \- C Language Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
.ds Rn 3
.ds Vn 2.2
.hw XtNext-Event XtPeek-Event XtProcess-Event XtMain-Loop wid-get
.na
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.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 FD
.LP
.KS
.TA .5i 3i
.ta .5i 3i
.nf
..
.de FN
.fi
.KE
.LP
..
.de IN \" send an index entry to the stderr
..
.de C{
.KS
.nf
.D
.\"
.\" choose appropriate monospace font
.\" the imagen conditional, 480,
.\" may be changed to L if LB is too
.\" heavy for your eyes...
.\"
.ie "\\*(.T"480" .ft L
.el .ie "\\*(.T"300" .ft L
.el .ie "\\*(.T"202" .ft PO
.el .ie "\\*(.T"aps" .ft CW
.el .ft R
.ps \\n(PS
.ie \\n(VS>40 .vs \\n(VSu
.el .vs \\n(VSp
..
.de C}
.DE
.R
..
.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 NT
.ne 7
.ds NO Note
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
.ie n .sp
.el .sp 10p
.TB
.ce
\\*(NO
.ie n .sp
.el .sp 5p
.if '\\$1'C' .ce 99
.if '\\$2'C' .ce 99
.in +5n
.ll -5n
.R
..
. \" Note End -- doug kraft 3/85
.de NE
.ce 0
.in -5n
.ll +5n
.ie n .sp
.el .sp 10p
..
.ny0
.TH XtNextEvent __libmansuffix__ __xorgversion__ "XT COMPATIBILITY FUNCTIONS"
.SH NAME
XtNextEvent, XtPending, XtPeekEvent, XtProcessEvent, XtMainLoop \- query and process events and input
.SH SYNTAX
.HP
2012-03-10 09:45:48 -07:00
void XtNextEvent(XEvent *\fIevent_return\fP);
2006-11-25 11:01:46 -07:00
.HP
2012-03-10 09:45:48 -07:00
Boolean XtPeekEvent(XEvent *\fIevent_return\fP);
2006-11-25 11:01:46 -07:00
.HP
2012-03-10 09:45:48 -07:00
Boolean XtPending(void);
2006-11-25 11:01:46 -07:00
.HP
2012-03-10 09:45:48 -07:00
void XtProcessEvent(XtInputMask \fImask\fP);
2006-11-25 11:01:46 -07:00
.HP
2012-03-10 09:45:48 -07:00
void XtMainLoop(void);
2006-11-25 11:01:46 -07:00
.SH ARGUMENTS
.IP \fIevent\fP 1i
Specifies a pointer to the event structure that is to be dispatched
to the appropriate event handler.
.IP \fIevent_return\fP 1i
Returns the event information to the specified event structure.
.IP \fImask\fP 1i
Specifies what types of events to process.
The mask is the bitwise inclusive OR of any combination of
.ZN XtIMXEvent ,
.ZN XtIMTimer ,
.ZN XtIMAlternateInput ,
and
.ZN XtIMSignal .
As a convenience, the \*(tk defines the symbolic name
.ZN XtIMAll
to be the bitwise inclusive OR of all event types.
.SH DESCRIPTION
.ZN XtNextEvent
has been replaced by
.ZN XtAppNextEvent .
.LP
.ZN XtPeekEvent
has been replaced by
.ZN XtAppPeekEvent .
.LP
.ZN XtPending
has been replaced by
.ZN XtAppPending .
.LP
.ZN XtProcessEvent
has been replaced by
.ZN XtAppProcessEvent .
.LP
.ZN XtMainLoop
has been replaced by
.ZN XtAppMainLoop .
.SH "SEE ALSO"
2012-03-10 09:45:48 -07:00
XtAppNextEvent(3xt), XtAppPending(__libmansuffix__), XtAppPeekEvent(__libmansuffix__),
2011-09-10 03:36:19 -06:00
XtAppProcessEvent(__libmansuffix__), XtAppMainLoop(__libmansuffix__)
2006-11-25 11:01:46 -07:00
.br
\fI\*(xT\fP
.br
\fI\*(xL\fP