summaryrefslogtreecommitdiffstats
path: root/Doc/mac/libmacui.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-04-04 06:23:02 (GMT)
committerFred Drake <fdrake@acm.org>1998-04-04 06:23:02 (GMT)
commit41788db3e221d8558fdfc0384be8561c95576fe2 (patch)
tree41282466082e476a36a62fb03def765055767d69 /Doc/mac/libmacui.tex
parent9b28fe285de48cf774691f9bbea080862566da7a (diff)
downloadcpython-41788db3e221d8558fdfc0384be8561c95576fe2.zip
cpython-41788db3e221d8558fdfc0384be8561c95576fe2.tar.gz
cpython-41788db3e221d8558fdfc0384be8561c95576fe2.tar.bz2
Logical markup.
Index entries.
Diffstat (limited to 'Doc/mac/libmacui.tex')
-rw-r--r--Doc/mac/libmacui.tex33
1 files changed, 16 insertions, 17 deletions
diff --git a/Doc/mac/libmacui.tex b/Doc/mac/libmacui.tex
index bf8a30f..7f5237b 100644
--- a/Doc/mac/libmacui.tex
+++ b/Doc/mac/libmacui.tex
@@ -1,16 +1,15 @@
-\section{Standard Module \sectcode{EasyDialogs}}
+\section{Standard Module \module{EasyDialogs}}
\label{module-EasyDialogs}
\stmodindex{EasyDialogs}
-The \code{EasyDialogs} module contains some simple dialogs for
-the Macintosh, modelled after the \code{stdwin} dialogs with similar
+The \module{EasyDialogs} module contains some simple dialogs for
+the Macintosh, modelled after the \module{stdwin} dialogs with similar
names. All routines have an optional parameter \var{id} with which you
can override the DLOG resource used for the dialog, as long as the
item numbers correspond. See the source for details.
+
+The \module{EasyDialogs} module defines the following functions:
-The \code{EasyDialogs} module defines the following functions:
-
-\setindexsubitem{(in module EasyDialogs)}
\begin{funcdesc}{Message}{str}
A modal dialog with the message text \var{str}, which should be at
@@ -19,11 +18,11 @@ user clicks ``OK''.
\end{funcdesc}
\begin{funcdesc}{AskString}{prompt\optional{, default}}
-Ask the user to input a string value, in a modal dialog. \var{Prompt}
+Ask the user to input a string value, in a modal dialog. \var{prompt}
is the promt message, the optional \var{default} arg is the initial
value for the string. All strings can be at most 255 bytes
-long. \var{AskString} returns the string entered or \code{None} in
-case the user cancelled.
+long. \function{AskString()} returns the string entered or \code{None}
+in case the user cancelled.
\end{funcdesc}
\begin{funcdesc}{AskYesNoCancel}{question\optional{, default}}
@@ -34,19 +33,19 @@ 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.
+\begin{funcdesc}{ProgressBar}{\optional{label\optional{, maxval}}}
+Display a modeless progress dialog with a thermometer bar. \var{label}
+is the text string displayed (default ``Working...''), \var{maxval} is
+the value at which progress is complete (default \code{100}). The
+returned object has one method, \code{set(\var{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 \module{EasyDialogs} does not currently use the notification
manager. This means that displaying dialogs while the program is in
the background will lead to unexpected results and possibly
crashes. Also, all dialogs are modeless and hence expect to be at the