home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / tkwait.n < prev    next >
Encoding:
Text File  |  1993-04-01  |  2.6 KB  |  67 lines
  1. '\"
  2. '\" Copyright (c) 1992 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/tkwait.n,v 1.4 93/04/01 09:53:00 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .so man.macros
  24. .HS tkwait tk
  25. .BS
  26. '\" Note:  do not modify the .SH NAME line immediately below!
  27. .SH NAME
  28. tkwait \- Wait for variable to change or window to be destroyed
  29. .SH SYNOPSIS
  30. \fBtkwait variable \fIname\fR
  31. .br
  32. \fBtkwait visibility \fIname\fR
  33. .VS
  34. .VE
  35. .br
  36. \fBtkwait window \fIname\fR
  37. .BE
  38.  
  39. .SH DESCRIPTION
  40. .PP
  41. The \fBtkwait\fR command waits for one of several things to happen,
  42. then it returns without taking any other actions.
  43. The return value is always an empty string.
  44. If the first argument is \fBvariable\fR (or any abbreviation of
  45. it) then the second argument is the name of a variable and the
  46. command waits for that variable to be modified.
  47. If the first argument is \fBvisibility\fR (or any abbreviation
  48. .VS
  49. of it) then the second argument is the name of a window and the
  50. \fBtkwait\fR command waits for a change in its
  51. visibility state (as indicated by the arrival of a VisibilityNotify
  52. event).  This form is typically used to wait for a newly-created
  53. window to appear on the screen before taking some action.
  54. .VE
  55. If the first argument is \fBwindow\fR (or any abbreviation
  56. of it) then the second argument is the name of a window and the
  57. \fBtkwait\fR command waits for that window to be destroyed.
  58. This form is typically used to wait for a user to finish interacting
  59. with a dialog box before using the result of that interaction.
  60. .PP
  61. While the \fBtkwait\fR command is waiting it processes events in
  62. the normal fashion, so the application will continue to respond
  63. to user interactions.
  64.  
  65. .SH KEYWORDS
  66. variable, visibility, wait, window
  67.