Commit dfcb3715 authored by Jack Jansen's avatar Jack Jansen

Documented PromptGetFile and optional prompt to GetDirectory.

parent 8e4826c7
...@@ -48,6 +48,10 @@ object and a flag indicating that the user completed the dialog ...@@ -48,6 +48,10 @@ object and a flag indicating that the user completed the dialog
without cancelling. without cancelling.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{PromptGetFile}{prompt\optional{\, type\, ...}}
Similar to \var{StandardGetFile} but allows you to specify a prompt.
\end{funcdesc}
\begin{funcdesc}{StandardPutFile}{prompt\, \optional{default}} \begin{funcdesc}{StandardPutFile}{prompt\, \optional{default}}
Present the user with a standard ``open output file'' Present the user with a standard ``open output file''
dialog. \var{prompt} is the prompt string, and the optional dialog. \var{prompt} is the prompt string, and the optional
...@@ -56,9 +60,10 @@ returns an FSSpec object and a flag indicating that the user completed ...@@ -56,9 +60,10 @@ returns an FSSpec object and a flag indicating that the user completed
the dialog without cancelling. the dialog without cancelling.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{GetDirectory}{} \begin{funcdesc}{GetDirectory}{\optional{prompt}}
Present the user with a non-standard ``select a directory'' Present the user with a non-standard ``select a directory''
dialog. Return an FSSpec object and a success-indicator. dialog. \var{prompt} is the prompt string, and the optional.
Return an FSSpec object and a success-indicator.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{FindFolder}{where\, which\, create} \begin{funcdesc}{FindFolder}{where\, which\, create}
......
...@@ -48,6 +48,10 @@ object and a flag indicating that the user completed the dialog ...@@ -48,6 +48,10 @@ object and a flag indicating that the user completed the dialog
without cancelling. without cancelling.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{PromptGetFile}{prompt\optional{\, type\, ...}}
Similar to \var{StandardGetFile} but allows you to specify a prompt.
\end{funcdesc}
\begin{funcdesc}{StandardPutFile}{prompt\, \optional{default}} \begin{funcdesc}{StandardPutFile}{prompt\, \optional{default}}
Present the user with a standard ``open output file'' Present the user with a standard ``open output file''
dialog. \var{prompt} is the prompt string, and the optional dialog. \var{prompt} is the prompt string, and the optional
...@@ -56,9 +60,10 @@ returns an FSSpec object and a flag indicating that the user completed ...@@ -56,9 +60,10 @@ returns an FSSpec object and a flag indicating that the user completed
the dialog without cancelling. the dialog without cancelling.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{GetDirectory}{} \begin{funcdesc}{GetDirectory}{\optional{prompt}}
Present the user with a non-standard ``select a directory'' Present the user with a non-standard ``select a directory''
dialog. Return an FSSpec object and a success-indicator. dialog. \var{prompt} is the prompt string, and the optional.
Return an FSSpec object and a success-indicator.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{FindFolder}{where\, which\, create} \begin{funcdesc}{FindFolder}{where\, which\, create}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment