clean up some markup

This commit is contained in:
Fred Drake 2003-09-05 13:48:02 +00:00
parent 7a55642ff6
commit b24e84c558

View file

@ -15,7 +15,7 @@ code for details.
The \module{EasyDialogs} module defines the following functions: The \module{EasyDialogs} module defines the following functions:
\begin{funcdesc}{Message}{str\optional{, id\optional{, ok=None}}} \begin{funcdesc}{Message}{str\optional{, id\optional{, ok}}}
Displays a modal dialog with the message text \var{str}, which should be Displays a modal dialog with the message text \var{str}, which should be
at most 255 characters long. The button text defaults to ``OK'', but is at most 255 characters long. The button text defaults to ``OK'', but is
set to the string argument \var{ok} if the latter is supplied. Control set to the string argument \var{ok} if the latter is supplied. Control
@ -30,8 +30,8 @@ is the prompt message, and the optional \var{default} supplies the
initial value for the string (otherwise \code{""} is used). The text of initial value for the string (otherwise \code{""} is used). The text of
the ``OK'' and ``Cancel'' buttons can be changed with the \var{ok} and the ``OK'' and ``Cancel'' buttons can be changed with the \var{ok} and
\var{cancel} arguments. All strings can be at most 255 bytes long. \var{cancel} arguments. All strings can be at most 255 bytes long.
\function{AskString()} returns the string entered or \code{None} in case \function{AskString()} returns the string entered or \constant{None}
the user cancelled. in case the user cancelled.
\end{funcdesc} \end{funcdesc}
@ -128,23 +128,23 @@ off.
\optional{, wanted} \optional{, wanted}
} }
Post a dialog asking the user for a file to open, and return the file Post a dialog asking the user for a file to open, and return the file
selected or \var{None} if the user cancelled. selected or \constant{None} if the user cancelled.
\var{message} is a text message to display, \var{message} is a text message to display,
\var{typeList} is a list of 4-char filetypes allowable, \var{typeList} is a list of 4-char filetypes allowable,
\var{defaultLocation} is the pathname, FSSpec or FSRef of the folder \var{defaultLocation} is the pathname, \class{FSSpec} or \class{FSRef}
to show initially, of the folder to show initially,
\var{location} is the \code{(x, y)} position on the screen where the \var{location} is the \code{(x, y)} position on the screen where the
dialog is shown, dialog is shown,
\var{actionButtonLabel} is a string to show in stead of ``Open'' in the \var{actionButtonLabel} is a string to show in stead of ``Open'' in the
OK button, OK button,
\var{cancelButtonLabel} is a string to show in stead of ``Cancel'' in the \var{cancelButtonLabel} is a string to show in stead of ``Cancel'' in the
cancel button, cancel button,
\var{wanted} is the type of value wanted as a return: \class{string}, \var{wanted} is the type of value wanted as a return: \class{str},
\class{unicode}, \class{FSSpec}, \class{FSRef} and subtypes thereof are \class{unicode}, \class{FSSpec}, \class{FSRef} and subtypes thereof are
acceptable. acceptable.
For a description of the other arguments please see the Apple Navigation For a description of the other arguments please see the Apple Navigation
Services documentation and the EasyDialogs sourcecode. Services documentation and the \module{EasyDialogs} source code.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{AskFileForSave}{ \begin{funcdesc}{AskFileForSave}{
@ -164,10 +164,11 @@ Services documentation and the EasyDialogs sourcecode.
\optional{, eventProc} \optional{, eventProc}
\optional{, wanted} \optional{, wanted}
} }
Post a dialog asking the user for a file to save to, and return the file Post a dialog asking the user for a file to save to, and return the
selected or \var{None} if the user cancelled. \var{savedFileName} is the file selected or \constant{None} if the user cancelled.
default for the file name to save to (the return value). See AskFileForOpen \var{savedFileName} is the default for the file name to save to (the
for a description of the other arguments. return value). See \function{AskFileForOpen()} for a description of
the other arguments.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{AskFolder}{ \begin{funcdesc}{AskFolder}{
@ -185,9 +186,9 @@ for a description of the other arguments.
\optional{, filterProc} \optional{, filterProc}
\optional{, wanted} \optional{, wanted}
} }
Post a dialog asking the user to select a folder, and return the folder Post a dialog asking the user to select a folder, and return the
selected or \var{None} if the user cancelled. See AskFileForOpen folder selected or \constant{None} if the user cancelled. See
for a description of the arguments. \function{AskFileForOpen()} for a description of the arguments.
\end{funcdesc} \end{funcdesc}
\subsection{ProgressBar Objects \label{progressbar-objects}} \subsection{ProgressBar Objects \label{progressbar-objects}}