diff options
author | Steve Bennett <steveb@workware.net.au> | 2024-09-10 08:22:55 +1000 |
---|---|---|
committer | Steve Bennett <steveb@workware.net.au> | 2025-07-16 09:34:08 +1000 |
commit | 7c8c9ca1cfe8197f0410353e8b147d8cdef3791b (patch) | |
tree | b50b2d55e48b04607dddb276dd97b1869ac00afc | |
parent | b9f8342bfef0912734fb57c8dc4cbaf288a525e5 (diff) | |
download | jimtcl-7c8c9ca1cfe8197f0410353e8b147d8cdef3791b.zip jimtcl-7c8c9ca1cfe8197f0410353e8b147d8cdef3791b.tar.gz jimtcl-7c8c9ca1cfe8197f0410353e8b147d8cdef3791b.tar.bz2 |
document vwait script
Signed-off-by: Steve Bennett <steveb@workware.net.au>
-rw-r--r-- | jim_tcl.txt | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/jim_tcl.txt b/jim_tcl.txt index 71dc35a..097cd84 100644 --- a/jim_tcl.txt +++ b/jim_tcl.txt @@ -5465,14 +5465,16 @@ Time-based execution is also available via the eventloop API. the type of the event. An error occurs if +'id'+ does not match an event. -+*vwait ?-signal?* 'variable'+:: ++*vwait ?-signal?* 'variable' ?script?+:: A call to `vwait` enters the eventloop. `vwait` processes events until the named (global) variable changes or all event handlers are removed. The variable need not exist beforehand. If there are no event handlers defined, `vwait` - returns immediately. If +'-signal'+ is specified, `vwait` will + returns immediately. If +*-signal*+ is specified, `vwait` will also quit if a handled signal occurs. In this case, `signal check -clear` - can be used to check for the signal that occurred. + can be used to check for the signal that occurred. If +'script'+ is given + it is evaluated after each event. If it returns break, `vwait` returns. + `vwait` also returns with an error if the script returns an error. +*update ?idletasks?*+:: A call to `update` enters the eventloop to process expired events, but |