diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2008-06-30 22:57:00 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2008-06-30 22:57:00 (GMT) |
commit | d6e7f6b3743e98803d7e8c7debc709c072c6e6a5 (patch) | |
tree | d6714c53bb2368a4c8befd4c7dc0085d88b31a15 /doc/tkwait.n | |
parent | 8ab3b0fffbe37701d924b4da873e6f231a843e5f (diff) | |
download | tk-d6e7f6b3743e98803d7e8c7debc709c072c6e6a5.zip tk-d6e7f6b3743e98803d7e8c7debc709c072c6e6a5.tar.gz tk-d6e7f6b3743e98803d7e8c7debc709c072c6e6a5.tar.bz2 |
Minor doc updates (removing out of date changebars, improving typedef formatting,
etc.)
Diffstat (limited to 'doc/tkwait.n')
-rw-r--r-- | doc/tkwait.n | 101 |
1 files changed, 50 insertions, 51 deletions
diff --git a/doc/tkwait.n b/doc/tkwait.n index b3282c2..33d6426 100644 --- a/doc/tkwait.n +++ b/doc/tkwait.n @@ -1,51 +1,50 @@ -'\" -'\" Copyright (c) 1992 The Regents of the University of California. -'\" Copyright (c) 1994-1996 Sun Microsystems, Inc. -'\" -'\" See the file "license.terms" for information on usage and redistribution -'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: tkwait.n,v 1.2 1998/09/14 18:23:00 stanton Exp $ -'\" -.so man.macros -.TH tkwait n "" Tk "Tk Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -tkwait \- Wait for variable to change or window to be destroyed -.SH SYNOPSIS -\fBtkwait variable \fIname\fR -.sp -\fBtkwait visibility \fIname\fR -.sp -\fBtkwait window \fIname\fR -.BE - -.SH DESCRIPTION -.PP -The \fBtkwait\fR command waits for one of several things to happen, -then it returns without taking any other actions. -The return value is always an empty string. -If the first argument is \fBvariable\fR (or any abbreviation of -it) then the second argument is the name of a global variable and the -command waits for that variable to be modified. -If the first argument is \fBvisibility\fR (or any abbreviation -of it) then the second argument is the name of a window and the -\fBtkwait\fR command waits for a change in its -visibility state (as indicated by the arrival of a VisibilityNotify -event). This form is typically used to wait for a newly-created -window to appear on the screen before taking some action. -If the first argument is \fBwindow\fR (or any abbreviation -of it) then the second argument is the name of a window and the -\fBtkwait\fR command waits for that window to be destroyed. -This form is typically used to wait for a user to finish interacting -with a dialog box before using the result of that interaction. -.PP -While the \fBtkwait\fR command is waiting it processes events in -the normal fashion, so the application will continue to respond -to user interactions. -If an event handler invokes \fBtkwait\fR again, the nested call -to \fBtkwait\fR must complete before the outer call can complete. - -.SH KEYWORDS -variable, visibility, wait, window +'\" -*- nroff -*-
+'\"
+'\" Copyright (c) 1992 The Regents of the University of California.
+'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" RCS: @(#) $Id: tkwait.n,v 1.3 2008/06/30 22:57:03 dkf Exp $
+'\"
+.so man.macros
+.TH tkwait n "" Tk "Tk Built-In Commands"
+.BS
+'\" Note: do not modify the .SH NAME line immediately below!
+.SH NAME
+tkwait \- Wait for variable to change or window to be destroyed
+.SH SYNOPSIS
+\fBtkwait variable \fIname\fR
+.sp
+\fBtkwait visibility \fIname\fR
+.sp
+\fBtkwait window \fIname\fR
+.BE
+.SH DESCRIPTION
+.PP
+The \fBtkwait\fR command waits for one of several things to happen,
+then it returns without taking any other actions.
+The return value is always an empty string.
+If the first argument is \fBvariable\fR (or any abbreviation of
+it) then the second argument is the name of a global variable and the
+command waits for that variable to be modified.
+If the first argument is \fBvisibility\fR (or any abbreviation
+of it) then the second argument is the name of a window and the
+\fBtkwait\fR command waits for a change in its
+visibility state (as indicated by the arrival of a VisibilityNotify
+event). This form is typically used to wait for a newly-created
+window to appear on the screen before taking some action.
+If the first argument is \fBwindow\fR (or any abbreviation
+of it) then the second argument is the name of a window and the
+\fBtkwait\fR command waits for that window to be destroyed.
+This form is typically used to wait for a user to finish interacting
+with a dialog box before using the result of that interaction.
+.PP
+While the \fBtkwait\fR command is waiting it processes events in
+the normal fashion, so the application will continue to respond
+to user interactions.
+If an event handler invokes \fBtkwait\fR again, the nested call
+to \fBtkwait\fR must complete before the outer call can complete.
+.SH KEYWORDS
+variable, visibility, wait, window
|