Skip to content

Commit 7c8c9ca

Browse files
committed
document vwait script
Signed-off-by: Steve Bennett <[email protected]>
1 parent b9f8342 commit 7c8c9ca

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

jim_tcl.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5465,14 +5465,16 @@ Time-based execution is also available via the eventloop API.
54655465
the type of the event. An error occurs if +'id'+ does not
54665466
match an event.
54675467

5468-
+*vwait ?-signal?* 'variable'+::
5468+
+*vwait ?-signal?* 'variable' ?script?+::
54695469
A call to `vwait` enters the eventloop. `vwait` processes
54705470
events until the named (global) variable changes or all
54715471
event handlers are removed. The variable need not exist
54725472
beforehand. If there are no event handlers defined, `vwait`
5473-
returns immediately. If +'-signal'+ is specified, `vwait` will
5473+
returns immediately. If +*-signal*+ is specified, `vwait` will
54745474
also quit if a handled signal occurs. In this case, `signal check -clear`
5475-
can be used to check for the signal that occurred.
5475+
can be used to check for the signal that occurred. If +'script'+ is given
5476+
it is evaluated after each event. If it returns break, `vwait` returns.
5477+
`vwait` also returns with an error if the script returns an error.
54765478

54775479
+*update ?idletasks?*+::
54785480
A call to `update` enters the eventloop to process expired events, but

0 commit comments

Comments
 (0)