tk/doc/tkwait.n

   1 '\"
   2 '\" Copyright (c) 1992 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 '\" RCS: @(#) $Id$
   9 '\"
  10 .so man.macros
  11 .TH tkwait n "" Tk "Tk Built-In Commands"
  12 .BS
  13 '\" Note:  do not modify the .SH NAME line immediately below!
  14 .SH NAME
  15 tkwait \- Wait for variable to change or window to be destroyed
  16 .SH SYNOPSIS
  17 \fBtkwait variable \fIname\fR
  18 .sp
  19 \fBtkwait visibility \fIname\fR
  20 .sp
  21 \fBtkwait window \fIname\fR
  22 .BE
  23
  24 .SH DESCRIPTION
  25 .PP
  26 The \fBtkwait\fR command waits for one of several things to happen,
  27 then it returns without taking any other actions.
  28 The return value is always an empty string.
  29 If the first argument is \fBvariable\fR (or any abbreviation of
  30 it) then the second argument is the name of a global variable and the
  31 command waits for that variable to be modified.
  32 If the first argument is \fBvisibility\fR (or any abbreviation
  33 of it) then the second argument is the name of a window and the
  34 \fBtkwait\fR command waits for a change in its
  35 visibility state (as indicated by the arrival of a VisibilityNotify
  36 event).  This form is typically used to wait for a newly-created
  37 window to appear on the screen before taking some action.
  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 If an event handler invokes \fBtkwait\fR again, the nested call
  48 to \fBtkwait\fR must complete before the outer call can complete.
  49
  50 .SH KEYWORDS
  51 variable, visibility, wait, window
  52