summaryrefslogtreecommitdiffstats
path: root/Doc/libmacos.tex
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>1996-10-15 14:37:31 (GMT)
committerGuido van Rossum <guido@python.org>1996-10-15 14:37:31 (GMT)
commit7e42caba018e86cb658b6d445d7614532e5ed192 (patch)
treec6425a4515b6d6a822995d89c1cd48512d70d4b9 /Doc/libmacos.tex
parentacc875403128e0ff900df3ab468d24fd6dd3dcde (diff)
downloadcpython-7e42caba018e86cb658b6d445d7614532e5ed192.zip
cpython-7e42caba018e86cb658b6d445d7614532e5ed192.tar.gz
cpython-7e42caba018e86cb658b6d445d7614532e5ed192.tar.bz2
Patches for Mac module docs by Jack
Diffstat (limited to 'Doc/libmacos.tex')
-rw-r--r--Doc/libmacos.tex19
1 files changed, 16 insertions, 3 deletions
diff --git a/Doc/libmacos.tex b/Doc/libmacos.tex
index e48a0c3..2b7628f 100644
--- a/Doc/libmacos.tex
+++ b/Doc/libmacos.tex
@@ -15,6 +15,8 @@ This exception is raised on MacOS generated errors, either from
functions in this module or from other mac-specific modules like the
toolbox interfaces. The arguments are the integer error code (the
\var{OSErr} value) and a textual description of the error code.
+Symbolic names for all known error codes are defined in the standard
+module \var{macerrors}.
\end{excdesc}
\begin{funcdesc}{SetHighLevelEventHandler}{handler}
@@ -42,8 +44,8 @@ different values to use when python runs in the background, otherwise
the background values will be set the the same as the foreground
values. The function returns nothing.
-The default values, which are based on nothing at all, are 12, 6, 1
-and 12 respectively.
+The default values, which are based on minimal empirical testing, are 12, 1, 6
+and 2 respectively.
\end{funcdesc}
\begin{funcdesc}{EnableAppswitch}{onoff}
@@ -77,11 +79,22 @@ Return the textual description of MacOS error code \var{errno}.
This function will put a splash window
on-screen, with the contents of the DLOG resource specified by
\code{resid}. Calling with a zero argument will remove the splash
-screen. This function is useful if you want to post a splash screen
+screen. This function is useful if you want an applet to post a splash screen
early in initialization without first having to load numerous
extension modules.
\end{funcdesc}
+\begin{funcdesc}{DebugStr}{message \optional{\, object}}
+Drop to the low-level debugger with message \var{message}. The
+optional \var{object} argument is not used, but can easily be
+inspected from the debugger.
+
+Note that you should use this function with extreme care: if no
+low-level debugger like MacsBug is installed this call will crash your
+system. It is intended mainly for developers of Python extension
+modules.
+\end{funcdesc}
+
\begin{funcdesc}{openrf}{name \optional{\, mode}}
Open the resource fork of a file. Arguments are the same as for the
builtin function \code{open}. The object returned has file-like