traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

A bunch of nits fix and some additional information added by Chris 

Barker <cbarker@jps.net>.
This commit is contained in:
Fred Drake 2000-10-14 04:45:22 +00:00
parent 8f176accde
commit eecdc7f47e
2 changed files with 18 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Doc/mac/libmacfs.tex
View File

@ -15,10 +15,13 @@ Manager, \program{finder} aliases and the Standard File package.
Whenever a function or method expects a \var{file} argument, this Whenever a function or method expects a \var{file} argument, this
argument can be one of three things:\ (1) a full or partial Macintosh argument can be one of three things:\ (1) a full or partial Macintosh
pathname, (2) an \pytype{FSSpec} object or (3) a 3-tuple \code{(\var{wdRefNum}, pathname, (2) an \pytype{FSSpec} object or (3) a 3-tuple
\var{parID}, \var{name})} as described in \citetitle{Inside \code{(\var{wdRefNum}, \var{parID}, \var{name})} as described in
Macintosh:\ Files}. A description of aliases and the Standard File \citetitle{Inside Macintosh:\ Files}. A description of aliases and the
package can also be found there. Standard File package can also be found there.
\strong{Note:} A module, \refmodule{macfsn}, is auto-imported to replace
StandardFile calls in macfs with NavServices calls.
\begin{funcdesc}{FSSpec}{file} \begin{funcdesc}{FSSpec}{file}
Create an \pytype{FSSpec} object for the specified file. Create an \pytype{FSSpec} object for the specified file.
@ -59,7 +62,7 @@ without cancelling.
\begin{funcdesc}{PromptGetFile}{prompt\optional{, type, \moreargs}} \begin{funcdesc}{PromptGetFile}{prompt\optional{, type, \moreargs}}
Similar to \function{StandardGetFile()} but allows you to specify a Similar to \function{StandardGetFile()} but allows you to specify a
prompt. prompt which will be displayed at the top of the dialog.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{StandardPutFile}{prompt\optional{, default}} \begin{funcdesc}{StandardPutFile}{prompt\optional{, default}}
@ -71,9 +74,11 @@ completed the dialog without cancelling.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{GetDirectory}{\optional{prompt}} \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. You
dialog. \var{prompt} is the prompt string, and the optional. have to first open the directory before clicking on the ``select current
Return an \pytype{FSSpec} object and a success-indicator. directory'' button. \var{prompt} is the prompt string which will be
displayed at the top of the dialog. Return an \pytype{FSSpec} object and
a success-indicator.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{SetFolder}{\optional{fsspec}} \begin{funcdesc}{SetFolder}{\optional{fsspec}}
@ -84,7 +89,7 @@ though). If no argument is passed the folder will be set to the
current directory, i.e. what \function{os.getcwd()} returns. current directory, i.e. what \function{os.getcwd()} returns.
Note that starting with system 7.5 the user can change Standard File Note that starting with system 7.5 the user can change Standard File
behaviour with the ``general controls'' controlpanel, thereby making behaviour with the ``general controls'' control panel, thereby making
this call inoperative. this call inoperative.
\end{funcdesc} \end{funcdesc}
@ -106,7 +111,7 @@ standard module \var{MACFS}.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{FindApplication}{creator} \begin{funcdesc}{FindApplication}{creator}
Locate the application with 4-char creator code \var{creator}. The Locate the application with 4-character creator code \var{creator}. The
function returns an \pytype{FSSpec} object pointing to the application. function returns an \pytype{FSSpec} object pointing to the application.
\end{funcdesc} \end{funcdesc}

6
Doc/mac/libmacic.tex
View File

@ -12,7 +12,7 @@ which stores preferences for Internet programs such as mail address,
default homepage, etc. Also, Internet Config contains an elaborate set default homepage, etc. Also, Internet Config contains an elaborate set
of mappings from Macintosh creator/type codes to foreign filename of mappings from Macintosh creator/type codes to foreign filename
extensions plus information on how to transfer files (binary, ascii, extensions plus information on how to transfer files (binary, ascii,
etc). etc.). Since MacOS 9, this module is a control panel named Internet.
There is a low-level companion module There is a low-level companion module
\module{icglue}\refbimodindex{icglue} which provides the basic \module{icglue}\refbimodindex{icglue} which provides the basic
@ -61,7 +61,7 @@ works, and changes the option in the configuration file.
The module knows about various datatypes, and converts the internal IC The module knows about various datatypes, and converts the internal IC
representation to a ``logical'' Python data structure. Running the representation to a ``logical'' Python data structure. Running the
\module{ic} module standalone will run a test program that lists all \module{ic} module standalone will run a test program that lists all
keys and values in your IC database, this will have to server as keys and values in your IC database, this will have to serve as
documentation. documentation.
If the module does not know how to represent the data it returns an If the module does not know how to represent the data it returns an
@ -84,7 +84,7 @@ scheme. If \var{hint} is not provided, incomplete URLs are invalid.
Find an URL somewhere in \var{data} and return start position, end Find an URL somewhere in \var{data} and return start position, end
position and the URL. The optional \var{start} and \var{end} can be position and the URL. The optional \var{start} and \var{end} can be
used to limit the search, so for instance if a user clicks in a long used to limit the search, so for instance if a user clicks in a long
textfield you can pass the whole textfield and the click-position in text field you can pass the whole text field and the click-position in
\var{start} and this routine will return the whole URL in which the \var{start} and this routine will return the whole URL in which the
user clicked. As above, \var{hint} is an optional scheme used to user clicked. As above, \var{hint} is an optional scheme used to
complete incomplete URLs. complete incomplete URLs.