summaryrefslogtreecommitdiffstats
path: root/doc/after.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/after.n')
-rw-r--r--doc/after.n17
1 files changed, 13 insertions, 4 deletions
diff --git a/doc/after.n b/doc/after.n
index 4e5dfdd..e6d2dd0 100644
--- a/doc/after.n
+++ b/doc/after.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: after.n,v 1.11 2008/06/13 05:45:07 mistachkin Exp $
+'\" RCS: @(#) $Id: after.n,v 1.12 2008/10/15 10:43:37 dkf Exp $
'\"
.so man.macros
.TH after n 7.5 Tcl "Tcl Built-In Commands"
@@ -26,7 +26,6 @@ after \- Execute a command after a time delay
.sp
\fBafter info \fR?\fIid\fR?
.BE
-
.SH DESCRIPTION
.PP
This command is used to delay execution of the program or to execute
@@ -34,12 +33,14 @@ a command in background sometime in the future. It has several forms,
depending on the first argument to the command:
.TP
\fBafter \fIms\fR
+.
\fIMs\fR must be an integer giving a time in milliseconds.
The command sleeps for \fIms\fR milliseconds and then returns.
While the command is sleeping the application does not respond to
events.
.TP
\fBafter \fIms \fR?\fIscript script script ...\fR?
+.
In this form the command returns immediately, but it arranges
for a Tcl command to be executed \fIms\fR milliseconds later as an
event handler.
@@ -55,6 +56,7 @@ The \fBafter\fR command returns an identifier that can be used
to cancel the delayed command using \fBafter cancel\fR.
.TP
\fBafter cancel \fIid\fR
+.
Cancels the execution of a delayed command that
was previously scheduled.
\fIId\fR indicates which command should be canceled; it must have
@@ -63,6 +65,7 @@ If the command given by \fIid\fR has already been executed then
the \fBafter cancel\fR command has no effect.
.TP
\fBafter cancel \fIscript script ...\fR
+.
This command also cancels the execution of a delayed command.
The \fIscript\fR arguments are concatenated together with space
separators (just as in the \fBconcat\fR command).
@@ -71,6 +74,7 @@ canceled and will never be executed; if no such command is
currently pending then the \fBafter cancel\fR command has no effect.
.TP
\fBafter idle \fIscript \fR?\fIscript script ...\fR?
+.
Concatenates the \fIscript\fR arguments together with space
separators (just as in the \fBconcat\fR command), and arranges
for the resulting script to be evaluated later as an idle callback.
@@ -83,6 +87,7 @@ background error will be reported by the command
registered with \fB interp bgerror\fR.
.TP
\fBafter info \fR?\fIid\fR?
+.
This command returns information about existing event handlers.
If no \fIid\fR argument is supplied, the command returns
a list of the identifiers for all existing
@@ -106,6 +111,7 @@ and \fBupdate\fR commands.
.SH "EXAMPLES"
This defines a command to make Tcl do nothing at all for \fIN\fR
seconds:
+.PP
.CS
proc sleep {N} {
\fBafter\fR [expr {int($N * 1000)}]
@@ -114,6 +120,7 @@ proc sleep {N} {
.PP
This arranges for the command \fIwake_up\fR to be run in eight hours
(providing the event loop is active at that time):
+.PP
.CS
\fBafter\fR [expr {1000 * 60 * 60 * 8}] wake_up
.CE
@@ -128,6 +135,7 @@ processing steps (arranging for the next step to be done using an
already-triggered timer event only when the event queue has been
drained) and is useful when you want to ensure that a Tk GUI remains
responsive during a slow task.
+.PP
.CS
proc doOneStep {} {
if {[::my_calc::one_step]} {
@@ -136,9 +144,10 @@ proc doOneStep {} {
}
doOneStep
.CE
-
.SH "SEE ALSO"
concat(n), interp(n), update(n), vwait(n)
-
.SH KEYWORDS
cancel, delay, idle callback, sleep, time
+'\" Local Variables:
+'\" mode: nroff
+'\" End: