man/XtAppAddTimeOut.man

   1 .\" Copyright 1993 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be
  12 .\" included in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .ds tk X Toolkit
  28 .ds xT X Toolkit Intrinsics \- C Language Interface
  29 .ds xI Intrinsics
  30 .ds xW X Toolkit Athena Widgets \- C Language Interface
  31 .ds xL Xlib \- C Language X Interface
  32 .ds xC Inter-Client Communication Conventions Manual
  33 .ds Rn 3
  34 .ds Vn 2.2
  35 .hw XtApp-Add-Time-Out XtRemove-Time-Out wid-get
  36 .na
  37 .de Ds
  38 .nf
  39 .\\$1D \\$2 \\$1
  40 .ft 1
  41 .ps \\n(PS
  42 .\".if \\n(VS>=40 .vs \\n(VSu
  43 .\".if \\n(VS<=39 .vs \\n(VSp
  44 ..
  45 .de De
  46 .ce 0
  47 .if \\n(BD .DF
  48 .nr BD 0
  49 .in \\n(OIu
  50 .if \\n(TM .ls 2
  51 .sp \\n(DDu
  52 .fi
  53 ..
  54 .de FD
  55 .LP
  56 .KS
  57 .TA .5i 3i
  58 .ta .5i 3i
  59 .nf
  60 ..
  61 .de FN
  62 .fi
  63 .KE
  64 .LP
  65 ..
  66 .de IN          \" send an index entry to the stderr
  67 ..
  68 .de C{
  69 .KS
  70 .nf
  71 .D
  72 .\"
  73 .\"     choose appropriate monospace font
  74 .\"     the imagen conditional, 480,
  75 .\"     may be changed to L if LB is too
  76 .\"     heavy for your eyes...
  77 .\"
  78 .ie "\\*(.T"480" .ft L
  79 .el .ie "\\*(.T"300" .ft L
  80 .el .ie "\\*(.T"202" .ft PO
  81 .el .ie "\\*(.T"aps" .ft CW
  82 .el .ft R
  83 .ps \\n(PS
  84 .ie \\n(VS>40 .vs \\n(VSu
  85 .el .vs \\n(VSp
  86 ..
  87 .de C}
  88 .DE
  89 .R
  90 ..
  91 .de Pn
  92 .ie t \\$1\fB\^\\$2\^\fR\\$3
  93 .el \\$1\fI\^\\$2\^\fP\\$3
  94 ..
  95 .de ZN
  96 .ie t \fB\^\\$1\^\fR\\$2
  97 .el \fI\^\\$1\^\fP\\$2
  98 ..
  99 .de NT
 100 .ne 7
 101 .ds NO Note
 102 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 103 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 104 .ie n .sp
 105 .el .sp 10p
 106 .TB
 107 .ce
 108 \\*(NO
 109 .ie n .sp
 110 .el .sp 5p
 111 .if '\\$1'C' .ce 99
 112 .if '\\$2'C' .ce 99
 113 .in +5n
 114 .ll -5n
 115 .R
 116 ..
 117 .               \" Note End -- doug kraft 3/85
 118 .de NE
 119 .ce 0
 120 .in -5n
 121 .ll +5n
 122 .ie n .sp
 123 .el .sp 10p
 124 ..
 125 .ny0
 126 .TH XtAppAddTimeOut __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
 127 .SH NAME
 128 XtAppAddTimeOut, XtRemoveTimeOut \- register and remove timeouts
 129 .SH SYNTAX
 130 .HP
 131 XtIntervalId XtAppAddTimeOut(XtAppContext \fIapp_context\fP, unsigned long
 132 \fIinterval\fP, XtTimerCallbackProc \fIproc\fP, XtPointer \fIclient_data\fP);
 133 .HP
 134 void XtRemoveTimeOut(XtIntervalId \fItimer\fP);
 135 .SH ARGUMENTS
 136 .ds Co for which the timer is to be set
 137 .IP \fIapp_context\fP 1i
 138 Specifies the application context \*(Co.
 139 .IP \fIclient_data\fP 1i
 140 Specifies the argument that is to be passed to the specified procedure
 141 when \*(Cd.
 142 .IP \fIinterval\fP 1i
 143 Specifies the time interval in milliseconds.
 144 .ds Pr \ to be called when time expires
 145 .IP \fIproc\fP 1i
 146 Specifies the procedure that is\*(Pr.
 147 .IP \fItimer\fP 1i
 148 Specifies the ID for the timeout request to be destroyed.
 149 .SH DESCRIPTION
 150 The
 151 .ZN XtAppAddTimeOut
 152 function creates a timeout and returns an identifier for it.
 153 The timeout value is set to interval.
 154 The callback procedure is called when the time interval elapses,
 155 and then the timeout is removed.
 156 .LP
 157 The
 158 .ZN XtRemoveTimeOut
 159 function removes the timeout.
 160 Note that timeouts are automatically removed once they trigger.
 161 .SH "SEE ALSO"
 162 XtAppAddInput(3Xt),XtAppAddSignal(3Xt)
 163 .br
 164 \fI\*(xT\fP
 165 .br
 166 \fI\*(xL\fP