home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / update.n < prev    next >
Encoding:
Text File  |  1993-04-01  |  2.7 KB  |  66 lines
  1. '\"
  2. '\" Copyright (c) 1990-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/update.n,v 1.5 93/04/01 09:53:02 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .so man.macros
  24. .HS update tk
  25. .BS
  26. '\" Note:  do not modify the .SH NAME line immediately below!
  27. .SH NAME
  28. .VS
  29. update \- Process pending events and/or when-idle handlers
  30. .SH SYNOPSIS
  31. \fBupdate\fR ?\fBidletasks\fR?
  32. .VE
  33. .BE
  34.  
  35. .SH DESCRIPTION
  36. .PP
  37. This command is used to bring the entire application world
  38. ``up to date.''
  39. It flushes all pending output to the display,  waits for the
  40. server to process that output and return errors or events,
  41. handles all pending events of any sort (including when-idle handlers),
  42. and repeats this set of operations until there are no pending
  43. events, no pending when-idle handlers, no pending output to the server,
  44. and no operations still outstanding at the server.  
  45. .PP
  46. If the \fBidletasks\fR keyword is specified as an argument to the
  47. .VS
  48. command, then no new events or errors are processed;  only when-idle
  49. idlers are invoked.
  50. This causes operations that are normally deferred, such as display
  51. updates and window layout calculations, to be performed immediately.
  52. .PP
  53. The \fBupdate idletasks\fR command is useful in scripts where
  54. changes have been made to the application's state and you want those
  55. changes to appear on the display immediately, rather than waiting
  56. for the script to complete.
  57. The \fBupdate\fR command with no options is useful in scripts where
  58. you are performing a long-running computation but you still want
  59. the application to respond to user interactions;  if you occasionally
  60. call \fBupdate\fR then user input will be processed during the
  61. next call to \fBupdate\fR.
  62. .VE
  63.  
  64. .SH KEYWORDS
  65. event, flush, handler, idle, update
  66.