mirror of https://github.com/python/cpython.git
Documented ProgressBar and idle()
This commit is contained in:
parent
a550328432
commit
350b2b956e
|
@ -31,9 +31,25 @@ hitting return is \code{0}. This can be changed with the optional
|
||||||
\var{default} argument.
|
\var{default} argument.
|
||||||
\end{funcdesc}
|
\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
|
Note that \code{EasyDialogs} does not currently use the notification
|
||||||
manager. This means that displaying dialogs while the program is in
|
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}}
|
\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).
|
need special handling of dialog events (keyboard shortcuts, etc).
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
|
\begin{funcdesc}{idle}{}
|
||||||
|
Called by the main event loop when no events are available.
|
||||||
|
\end{funcdesc}
|
||||||
|
|
||||||
\subsection{Window Objects}
|
\subsection{Window Objects}
|
||||||
|
|
||||||
Window objects have the following methods, among others:
|
Window objects have the following methods, among others:
|
||||||
|
|
|
@ -31,9 +31,25 @@ hitting return is \code{0}. This can be changed with the optional
|
||||||
\var{default} argument.
|
\var{default} argument.
|
||||||
\end{funcdesc}
|
\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
|
Note that \code{EasyDialogs} does not currently use the notification
|
||||||
manager. This means that displaying dialogs while the program is in
|
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}}
|
\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).
|
need special handling of dialog events (keyboard shortcuts, etc).
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
|
\begin{funcdesc}{idle}{}
|
||||||
|
Called by the main event loop when no events are available.
|
||||||
|
\end{funcdesc}
|
||||||
|
|
||||||
\subsection{Window Objects}
|
\subsection{Window Objects}
|
||||||
|
|
||||||
Window objects have the following methods, among others:
|
Window objects have the following methods, among others:
|
||||||
|
|
Loading…
Reference in New Issue