diff options
| author | Jack Jansen <jack.jansen@cwi.nl> | 1995-11-14 10:30:27 (GMT) |
|---|---|---|
| committer | Jack Jansen <jack.jansen@cwi.nl> | 1995-11-14 10:30:27 (GMT) |
| commit | 350b2b956e584872f3165921dbba1596226b0f76 (patch) | |
| tree | 88cfb8e0c7af96af4ec3d182787518c820bf99ae /Doc | |
| parent | a550328432889385822c9f8adb9ef91206b62bb5 (diff) | |
| download | cpython-350b2b956e584872f3165921dbba1596226b0f76.zip cpython-350b2b956e584872f3165921dbba1596226b0f76.tar.gz cpython-350b2b956e584872f3165921dbba1596226b0f76.tar.bz2 | |
Documented ProgressBar and idle()
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/libmacui.tex | 22 | ||||
| -rw-r--r-- | Doc/mac/libmacui.tex | 22 |
2 files changed, 42 insertions, 2 deletions
diff --git a/Doc/libmacui.tex b/Doc/libmacui.tex index 08f0236..f785679 100644 --- a/Doc/libmacui.tex +++ b/Doc/libmacui.tex @@ -31,9 +31,25 @@ hitting return is \code{0}. This can be changed with the optional \var{default} argument. \end{funcdesc} +\begin{funcdesc}{ProgressBar}{\optional{label\, maxval}} +Display a modeless progress dialog with a thermometer bar. \var{Label} +is the textstring displayed (default ``Working...''), \var{maxval} is +the value at which progress is complete (default 100). The returned +object has one method, \code{set(value)}, which sets the value of the +progress bar. The bar remains visible until the object returned is +discarded. + +The progress bar has a ``cancel'' button, but it is currently +non-functional. +\end{funcdesc} + Note that \code{EasyDialogs} does not currently use the notification manager. This means that displaying dialogs while the program is in -the background will need to unexpected results and possibly crashes. +the background will lead to unexpected results and possibly +crashes. Also, all dialogs are modeless and hence expect to be at the +top of the stacking order. This is true when the dialogs are created, +but windows that pop-up later (like a console window) may also result +in crashes. \section{Standard module \sectcode{FrameWork}} @@ -145,6 +161,10 @@ through the the \code{DialogWindow} object involved). Override if you need special handling of dialog events (keyboard shortcuts, etc). \end{funcdesc} +\begin{funcdesc}{idle}{} +Called by the main event loop when no events are available. +\end{funcdesc} + \subsection{Window Objects} Window objects have the following methods, among others: diff --git a/Doc/mac/libmacui.tex b/Doc/mac/libmacui.tex index 08f0236..f785679 100644 --- a/Doc/mac/libmacui.tex +++ b/Doc/mac/libmacui.tex @@ -31,9 +31,25 @@ hitting return is \code{0}. This can be changed with the optional \var{default} argument. \end{funcdesc} +\begin{funcdesc}{ProgressBar}{\optional{label\, maxval}} +Display a modeless progress dialog with a thermometer bar. \var{Label} +is the textstring displayed (default ``Working...''), \var{maxval} is +the value at which progress is complete (default 100). The returned +object has one method, \code{set(value)}, which sets the value of the +progress bar. The bar remains visible until the object returned is +discarded. + +The progress bar has a ``cancel'' button, but it is currently +non-functional. +\end{funcdesc} + Note that \code{EasyDialogs} does not currently use the notification manager. This means that displaying dialogs while the program is in -the background will need to unexpected results and possibly crashes. +the background will lead to unexpected results and possibly +crashes. Also, all dialogs are modeless and hence expect to be at the +top of the stacking order. This is true when the dialogs are created, +but windows that pop-up later (like a console window) may also result +in crashes. \section{Standard module \sectcode{FrameWork}} @@ -145,6 +161,10 @@ through the the \code{DialogWindow} object involved). Override if you need special handling of dialog events (keyboard shortcuts, etc). \end{funcdesc} +\begin{funcdesc}{idle}{} +Called by the main event loop when no events are available. +\end{funcdesc} + \subsection{Window Objects} Window objects have the following methods, among others: |