Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 350b2b9

Browse files
jackjansenjackjansen
committed
Documented ProgressBar and idle()
1 parent a550328 commit 350b2b9

2 files changed

Lines changed: 42 additions & 2 deletions

File tree

‎Doc/libmacui.tex‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,25 @@ \section{Standard module \sectcode{EasyDialogs}}
3131
\var{default} argument.
3232
\end{funcdesc}
3333

34+
\begin{funcdesc}{ProgressBar}{\optional{label\, maxval}}
35+
Display a modeless progress dialog with a thermometer bar. \var{Label}
36+
is the textstring displayed (default ``Working...''), \var{maxval} is
37+
the value at which progress is complete (default 100). The returned
38+
object has one method, \code{set(value)}, which sets the value of the
39+
progress bar. The bar remains visible until the object returned is
40+
discarded.
41+
42+
The progress bar has a ``cancel'' button, but it is currently
43+
non-functional.
44+
\end{funcdesc}
45+
3446
Note that \code{EasyDialogs} does not currently use the notification
3547
manager. This means that displaying dialogs while the program is in
36-
the background will need to unexpected results and possibly crashes.
48+
the background will lead to unexpected results and possibly
49+
crashes. Also, all dialogs are modeless and hence expect to be at the
50+
top of the stacking order. This is true when the dialogs are created,
51+
but windows that pop-up later (like a console window) may also result
52+
in crashes.
3753

3854

3955
\section{Standard module \sectcode{FrameWork}}
@@ -145,6 +161,10 @@ \subsection{Application objects}
145161
need special handling of dialog events (keyboard shortcuts, etc).
146162
\end{funcdesc}
147163

164+
\begin{funcdesc}{idle}{}
165+
Called by the main event loop when no events are available.
166+
\end{funcdesc}
167+
148168
\subsection{Window Objects}
149169

150170
Window objects have the following methods, among others:

‎Doc/mac/libmacui.tex‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,25 @@ \section{Standard module \sectcode{EasyDialogs}}
3131
\var{default} argument.
3232
\end{funcdesc}
3333

34+
\begin{funcdesc}{ProgressBar}{\optional{label\, maxval}}
35+
Display a modeless progress dialog with a thermometer bar. \var{Label}
36+
is the textstring displayed (default ``Working...''), \var{maxval} is
37+
the value at which progress is complete (default 100). The returned
38+
object has one method, \code{set(value)}, which sets the value of the
39+
progress bar. The bar remains visible until the object returned is
40+
discarded.
41+
42+
The progress bar has a ``cancel'' button, but it is currently
43+
non-functional.
44+
\end{funcdesc}
45+
3446
Note that \code{EasyDialogs} does not currently use the notification
3547
manager. This means that displaying dialogs while the program is in
36-
the background will need to unexpected results and possibly crashes.
48+
the background will lead to unexpected results and possibly
49+
crashes. Also, all dialogs are modeless and hence expect to be at the
50+
top of the stacking order. This is true when the dialogs are created,
51+
but windows that pop-up later (like a console window) may also result
52+
in crashes.
3753

3854

3955
\section{Standard module \sectcode{FrameWork}}
@@ -145,6 +161,10 @@ \subsection{Application objects}
145161
need special handling of dialog events (keyboard shortcuts, etc).
146162
\end{funcdesc}
147163

164+
\begin{funcdesc}{idle}{}
165+
Called by the main event loop when no events are available.
166+
\end{funcdesc}
167+
148168
\subsection{Window Objects}
149169

150170
Window objects have the following methods, among others:

0 commit comments

Comments
 (0)