2 '\" Copyright (c) 1990 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8 '\" RCS: @(#) $Id: CrtTimerHdlr.3,v 1.2 1998/09/14 18:39:47 stanton Exp $
10 '\" The definitions below are for supplemental macros used in Tcl/Tk
13 '\" .AP type name in/out ?indent?
14 '\" Start paragraph describing an argument to a library procedure.
15 '\" type is type of argument (int, etc.), in/out is either "in", "out",
16 '\" or "in/out" to describe whether procedure reads or modifies arg,
17 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
18 '\" needed; use .AS below instead)
21 '\" Give maximum sizes of arguments for setting tab stops. Type and
22 '\" name are examples of largest possible arguments that will be passed
23 '\" to .AP later. If args are omitted, default tab stops are used.
26 '\" Start box enclosure. From here until next .BE, everything will be
27 '\" enclosed in one large box.
30 '\" End of box enclosure.
33 '\" Begin code excerpt.
38 '\" .VS ?version? ?br?
39 '\" Begin vertical sidebar, for use in marking newly-changed parts
40 '\" of man pages. The first argument is ignored and used for recording
41 '\" the version when the .VS was added, so that the sidebars can be
42 '\" found and removed when they reach a certain age. If another argument
43 '\" is present, then a line break is forced before starting the sidebar.
46 '\" End of vertical sidebar.
49 '\" Begin an indented unfilled display.
52 '\" End of indented unfilled display.
55 '\" Start of list of standard options for a Tk widget. The
56 '\" options follow on successive lines, in four columns separated
60 '\" End of list of standard options for a Tk widget.
62 '\" .OP cmdName dbName dbClass
63 '\" Start of description of a specific option. cmdName gives the
64 '\" option's name as specified in the class command, dbName gives
65 '\" the option's name in the option database, and dbClass gives
66 '\" the option's class in the option database.
69 '\" Print arg1 underlined, then print arg2 normally.
71 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
73 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
77 '\" # Start an argument description
81 . ie !"\\$2"" .TP \\n()Cu
86 \&\\$1 \\fI\\$2\\fP (\\$3)
99 '\" # define tabbing values for .AP
102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
108 .AS Tcl_Interp Tcl_CreateInterp in/out
109 '\" # BS - start boxed text
110 '\" # ^y = starting y location
118 .if n \l'\\n(.lu\(ul'
121 '\" # BE - end boxed text (draw box now)
126 .ie n \l'\\n(^lu\(ul'
128 .\" Draw four-sided box normally, but don't draw top of
129 .\" box if the box started on an earlier page.
131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
141 '\" # VS - start vertical sidebar
142 '\" # ^Y = starting y location
143 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
147 .ie n 'mc \s12\(br\s0
150 '\" # VE - end of vertical sidebar
158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
165 '\" # Special macro to handle page bottom: finish off current
166 '\" # box/sidebar if in box/sidebar mode, then invoked standard
167 '\" # page bottom macro.
174 .\" Draw three-sided box if this is the box's first page,
175 .\" draw two sides but no top otherwise.
176 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
180 .nr ^x \\n(^tu+1v-\\n(^Yu
181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
194 '\" # DS - begin display
200 '\" # DE - end display
206 '\" # SO - start of list of standard options
208 .SH "STANDARD OPTIONS"
214 '\" # SE - end of list of standard options
219 See the \\fBoptions\\fR manual entry for details on the standard options.
221 '\" # OP - start of full description for a single option
226 Command-Line Name: \\fB\\$1\\fR
227 Database Name: \\fB\\$2\\fR
228 Database Class: \\fB\\$3\\fR
232 '\" # CS - begin code excerpt
238 '\" # CE - end code excerpt
246 .TH Tcl_CreateTimerHandler 3 7.5 Tcl "Tcl Library Procedures"
249 Tcl_CreateTimerHandler, Tcl_DeleteTimerHandler \- call a procedure at a
253 \fB#include <tcl.h>\fR
256 \fBTcl_CreateTimerHandler\fR(\fImilliseconds, proc, clientData\fR)
258 \fBTcl_DeleteTimerHandler\fR(\fItoken\fR)
260 .AS Tcl_TimerToken milliseconds
261 .AP int milliseconds in
262 How many milliseconds to wait before invoking \fIproc\fR.
263 .AP Tcl_TimerProc *proc in
264 Procedure to invoke after \fImilliseconds\fR have elapsed.
265 .AP ClientData clientData in
266 Arbitrary one-word value to pass to \fIproc\fR.
267 .AP Tcl_TimerToken token in
268 Token for previously-created timer handler (the return value
269 from some previous call to \fBTcl_CreateTimerHandler\fR).
274 \fBTcl_CreateTimerHandler\fR arranges for \fIproc\fR to be
275 invoked at a time \fImilliseconds\fR milliseconds in the
277 The callback to \fIproc\fR will be made by \fBTcl_DoOneEvent\fR,
278 so \fBTcl_CreateTimerHandler\fR is only useful in programs that
279 dispatch events through \fBTcl_DoOneEvent\fR or through Tcl commands
281 The call to \fIproc\fR may not be made at the exact time given by
282 \fImilliseconds\fR: it will be made at the next opportunity
283 after that time. For example, if \fBTcl_DoOneEvent\fR isn't
284 called until long after the time has elapsed, or if there
285 are other pending events to process before the call to
286 \fIproc\fR, then the call to \fIproc\fR will be delayed.
288 \fIProc\fR should have arguments and return value that match
289 the type \fBTcl_TimerProc\fR:
291 typedef void Tcl_TimerProc(ClientData \fIclientData\fR);
293 The \fIclientData\fR parameter to \fIproc\fR is a
294 copy of the \fIclientData\fR argument given to
295 \fBTcl_CreateTimerHandler\fR when the callback
296 was created. Typically, \fIclientData\fR points to a data
297 structure containing application-specific information about
298 what to do in \fIproc\fR.
300 \fBTcl_DeleteTimerHandler\fR may be called to delete a
301 previously-created timer handler. It deletes the handler
302 indicated by \fItoken\fR so that no call to \fIproc\fR
303 will be made; if that handler no longer exists
304 (e.g. because the time period has already elapsed and \fIproc\fR
305 has been invoked then \fBTcl_DeleteTimerHandler\fR does nothing.
306 The tokens returned by \fBTcl_CreateTimerHandler\fR never have
307 a value of NULL, so if NULL is passed to \fBTcl_DeleteTimerHandler\fR
308 then the procedure does nothing.
311 callback, clock, handler, timer