2006-11-25 11:01:46 -07:00
|
|
|
.\" Copyright 1993 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.
|
|
|
|
|
.\"
|
|
|
|
|
.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 XtApp-Add-Time-Out XtRemove-Time-Out wid-get
|
|
|
|
|
.na
|
|
|
|
|
.TH XtAppAddTimeOut __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
|
|
|
|
|
.SH NAME
|
|
|
|
|
XtAppAddTimeOut, XtRemoveTimeOut \- register and remove timeouts
|
|
|
|
|
.SH SYNTAX
|
2020-01-14 13:48:59 -07:00
|
|
|
#include <X11/Intrinsic.h>
|
2006-11-25 11:01:46 -07:00
|
|
|
.HP
|
|
|
|
|
XtIntervalId XtAppAddTimeOut(XtAppContext \fIapp_context\fP, unsigned long
|
2012-03-10 09:45:48 -07:00
|
|
|
\fIinterval\fP, XtTimerCallbackProc \fIproc\fP, XtPointer \fIclient_data\fP);
|
2006-11-25 11:01:46 -07:00
|
|
|
.HP
|
2012-03-10 09:45:48 -07:00
|
|
|
void XtRemoveTimeOut(XtIntervalId \fItimer\fP);
|
2006-11-25 11:01:46 -07:00
|
|
|
.SH ARGUMENTS
|
|
|
|
|
.IP \fIapp_context\fP 1i
|
2020-01-14 13:48:59 -07:00
|
|
|
Specifies the application context for which the timer is to be set.
|
2006-11-25 11:01:46 -07:00
|
|
|
.IP \fIclient_data\fP 1i
|
|
|
|
|
Specifies the argument that is to be passed to the specified procedure
|
2020-01-14 13:48:59 -07:00
|
|
|
when handling the callback.
|
2006-11-25 11:01:46 -07:00
|
|
|
.IP \fIinterval\fP 1i
|
|
|
|
|
Specifies the time interval in milliseconds.
|
|
|
|
|
.IP \fIproc\fP 1i
|
2020-01-14 13:48:59 -07:00
|
|
|
Specifies the procedure that is to be called when time expires.
|
2006-11-25 11:01:46 -07:00
|
|
|
.IP \fItimer\fP 1i
|
|
|
|
|
Specifies the ID for the timeout request to be destroyed.
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The
|
2020-01-14 13:48:59 -07:00
|
|
|
.B XtAppAddTimeOut
|
2006-11-25 11:01:46 -07:00
|
|
|
function creates a timeout and returns an identifier for it.
|
|
|
|
|
The timeout value is set to interval.
|
|
|
|
|
The callback procedure is called when the time interval elapses,
|
|
|
|
|
and then the timeout is removed.
|
|
|
|
|
.LP
|
|
|
|
|
The
|
2020-01-14 13:48:59 -07:00
|
|
|
.B XtRemoveTimeOut
|
2006-11-25 11:01:46 -07:00
|
|
|
function removes the timeout.
|
|
|
|
|
Note that timeouts are automatically removed once they trigger.
|
|
|
|
|
.SH "SEE ALSO"
|
2011-09-10 03:36:19 -06:00
|
|
|
XtAppAddInput(__libmansuffix__),XtAppAddSignal(__libmansuffix__)
|
2006-11-25 11:01:46 -07:00
|
|
|
.br
|
|
|
|
|
\fI\*(xT\fP
|
|
|
|
|
.br
|
|
|
|
|
\fI\*(xL\fP
|
