doc/tkwait.n

   1 '\"
   2 '\" Copyright (c) 1992 The Regents of the University of California.
   3 '\" Copyright (c) 1994 Sun Microsystems, Inc.
   4 '\" Copyright (c) 1996-1999 Christian Werner
   5 '\"
   6 '\" See the file "license.terms" for information on usage and redistribution
   7 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   8 '\"
   9 .so man.macros
  10 .TH tkwait n 8.0 Ck "Ck Built-In Commands"
  11 .BS
  12 '\" Note:  do not modify the .SH NAME line immediately below!
  13 .SH NAME
  14 tkwait \- Wait for variable to change or window to be destroyed
  15 .SH SYNOPSIS
  16 \fBtkwait variable \fIname\fR
  17 .br
  18 \fBtkwait visibility \fIname\fR
  19 .br
  20 \fBtkwait window \fIname\fR
  21 .BE
  22
  23 .SH DESCRIPTION
  24 .PP
  25 The \fBtkwait\fR command waits for one of several things to happen,
  26 then it returns without taking any other actions.
  27 The return value is always an empty string.
  28 If the first argument is \fBvariable\fR (or any abbreviation of
  29 it) then the second argument is the name of a global variable and the
  30 command waits for that variable to be modified.
  31 If the first argument is \fBvisibility\fR (or any abbreviation
  32 of it) then the second argument is the name of a window and the
  33 \fBtkwait\fR command waits for a change in its
  34 visibility state. This form is typically used to wait for a newly-created
  35 window to appear on the screen before taking some action.
  36 At the time of this writing, visibility state changes are unreliable.
  37 Thus this form of the \fBtkwait\fR command is strongly discouraged.
  38 If the first argument is \fBwindow\fR (or any abbreviation
  39 of it) then the second argument is the name of a window and the
  40 \fBtkwait\fR command waits for that window to be destroyed.
  41 This form is typically used to wait for a user to finish interacting
  42 with a dialog box before using the result of that interaction.
  43 .PP
  44 While the \fBtkwait\fR command is waiting it processes events in
  45 the normal fashion, so the application will continue to respond
  46 to user interactions.
  47
  48 .SH KEYWORDS
  49 variable, visibility, wait, window