summaryrefslogtreecommitdiffstats
path: root/Doc/mac
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/mac')
-rw-r--r--Doc/mac/libctb.tex6
-rw-r--r--Doc/mac/libmacconsole.tex8
-rw-r--r--Doc/mac/libmacdnr.tex10
-rw-r--r--Doc/mac/libmacfs.tex12
-rw-r--r--Doc/mac/libmacic.tex4
-rw-r--r--Doc/mac/libmacos.tex2
-rw-r--r--Doc/mac/libmacostools.tex4
-rw-r--r--Doc/mac/libmacspeech.tex6
-rw-r--r--Doc/mac/libmactcp.tex12
-rw-r--r--Doc/mac/libmacui.tex18
10 files changed, 41 insertions, 41 deletions
diff --git a/Doc/mac/libctb.tex b/Doc/mac/libctb.tex
index c9756d1..36d1289 100644
--- a/Doc/mac/libctb.tex
+++ b/Doc/mac/libctb.tex
@@ -1,7 +1,7 @@
\section{Built-in Module \sectcode{ctb}}
\label{module-ctb}
\bimodindex{ctb}
-\renewcommand{\indexsubitem}{(in module ctb)}
+\setindexsubitem{(in module ctb)}
This module provides a partial interface to the Macintosh
Communications Toolbox. Currently, only Connection Manager tools are
@@ -45,7 +45,7 @@ Alternatively, passing \code{None} will result in default buffer sizes.
For all connection methods that take a \var{timeout} argument, a value
of \code{-1} is indefinite, meaning that the command runs to completion.
-\renewcommand{\indexsubitem}{(connection object attribute)}
+\setindexsubitem{(connection object attribute)}
\begin{datadesc}{callback}
If this member is set to a value other than \code{None} it should point
@@ -60,7 +60,7 @@ calls for the time being.
\end{datadesc}
-\renewcommand{\indexsubitem}{(connection object method)}
+\setindexsubitem{(connection object method)}
\begin{funcdesc}{Open}{timeout}
Open an outgoing connection, waiting at most \var{timeout} seconds for
diff --git a/Doc/mac/libmacconsole.tex b/Doc/mac/libmacconsole.tex
index 4f67ab1..20b34bc 100644
--- a/Doc/mac/libmacconsole.tex
+++ b/Doc/mac/libmacconsole.tex
@@ -2,7 +2,7 @@
\label{module-macconsole}
\bimodindex{macconsole}
-\renewcommand{\indexsubitem}{(in module macconsole)}
+\setindexsubitem{(in module macconsole)}
This module is available on the Macintosh, provided Python has been
built using the Think C compiler. It provides an interface to the
@@ -36,7 +36,7 @@ object. \var{fp} should be one of \code{sys.stdin}, \code{sys.stdout} or
\subsection{macconsole options object}
These options are examined when a window is created:
-\renewcommand{\indexsubitem}{(macconsole option)}
+\setindexsubitem{(macconsole option)}
\begin{datadesc}{top}
\dataline{left}
The origin of the window.
@@ -63,7 +63,7 @@ If set non-zero, the window will wait for user action before closing.
\subsection{console window object}
-\renewcommand{\indexsubitem}{(console window attribute)}
+\setindexsubitem{(console window attribute)}
\begin{datadesc}{file}
The file object corresponding to this console window. If the file is
@@ -71,7 +71,7 @@ buffered, you should call \code{file.flush()} between \code{write()}
and \code{read()} calls.
\end{datadesc}
-\renewcommand{\indexsubitem}{(console window method)}
+\setindexsubitem{(console window method)}
\begin{funcdesc}{setmode}{mode}
Set the input mode of the console to \var{C_ECHO}, etc.
diff --git a/Doc/mac/libmacdnr.tex b/Doc/mac/libmacdnr.tex
index 5ae59a6..fabe3e1 100644
--- a/Doc/mac/libmacdnr.tex
+++ b/Doc/mac/libmacdnr.tex
@@ -9,7 +9,7 @@ all Mac Python versions.
The \code{macdnr} module defines the following functions:
-\renewcommand{\indexsubitem}{(in module macdnr)}
+\setindexsubitem{(in module macdnr)}
\begin{funcdesc}{Open}{\optional{filename}}
Open the domain name resolver extension. If \var{filename} is given it
@@ -64,7 +64,7 @@ this will result in an implicit wait for the query to complete.
The \var{rtnCode} and \var{cname} attributes are always available, the
others depend on the type of query (address, hinfo or mx).
-\renewcommand{\indexsubitem}{(dnr result object method)}
+\setindexsubitem{(dnr result object method)}
% Add args, as in {arg1\, arg2 \optional{\, arg3}}
\begin{funcdesc}{wait}{}
@@ -76,7 +76,7 @@ Wait for the query to complete.
Return 1 if the query is complete.
\end{funcdesc}
-\renewcommand{\indexsubitem}{(dnr result object attribute)}
+\setindexsubitem{(dnr result object attribute)}
\begin{datadesc}{rtnCode}
The error code returned by the query.
@@ -111,9 +111,9 @@ will only return a single mx record. Mx queries only.
The simplest way to use the module to convert names to dotted-decimal
strings, without worrying about idle time, etc:
-\bcode\begin{verbatim}
+\begin{verbatim}
>>> def gethostname(name):
... import macdnr
... dnrr = macdnr.StrToAddr(name)
... return macdnr.AddrToStr(dnrr.ip0)
-\end{verbatim}\ecode
+\end{verbatim}
diff --git a/Doc/mac/libmacfs.tex b/Doc/mac/libmacfs.tex
index 4b2f8fe..647e004 100644
--- a/Doc/mac/libmacfs.tex
+++ b/Doc/mac/libmacfs.tex
@@ -2,7 +2,7 @@
\label{module-macfs}
\bimodindex{macfs}
-\renewcommand{\indexsubitem}{(in module macfs)}
+\setindexsubitem{(in module macfs)}
This module provides access to macintosh FSSpec handling, the Alias
Manager, finder aliases and the Standard File package.
@@ -103,13 +103,13 @@ function returns an FSSpec object pointing to the application.
\subsection{FSSpec objects}
-\renewcommand{\indexsubitem}{(FSSpec object attribute)}
+\setindexsubitem{(FSSpec object attribute)}
\begin{datadesc}{data}
The raw data from the FSSpec object, suitable for passing
to other applications, for instance.
\end{datadesc}
-\renewcommand{\indexsubitem}{(FSSpec object method)}
+\setindexsubitem{(FSSpec object method)}
\begin{funcdesc}{as_pathname}{}
Return the full pathname of the file described by the FSSpec object.
\end{funcdesc}
@@ -159,13 +159,13 @@ Python.
\subsection{alias objects}
-\renewcommand{\indexsubitem}{(alias object attribute)}
+\setindexsubitem{(alias object attribute)}
\begin{datadesc}{data}
The raw data for the Alias record, suitable for storing in a resource
or transmitting to other programs.
\end{datadesc}
-\renewcommand{\indexsubitem}{(alias object method)}
+\setindexsubitem{(alias object method)}
\begin{funcdesc}{Resolve}{\optional{file}}
Resolve the alias. If the alias was created as a relative alias you
should pass the file relative to which it is. Return the FSSpec for
@@ -196,7 +196,7 @@ modifying the resource.
See Inside Mac for a complete description of what the various fields
mean.
-\renewcommand{\indexsubitem}{(FInfo object attribute)}
+\setindexsubitem{(FInfo object attribute)}
\begin{datadesc}{Creator}
The 4-char creator code of the file.
\end{datadesc}
diff --git a/Doc/mac/libmacic.tex b/Doc/mac/libmacic.tex
index d797cfa..aa3ba13 100644
--- a/Doc/mac/libmacic.tex
+++ b/Doc/mac/libmacic.tex
@@ -1,7 +1,7 @@
\section{Standard Module \sectcode{ic}}
\bimodindex{ic}
-\renewcommand{\indexsubitem}{(in module ic)}
+\setindexsubitem{(in module ic)}
This module provides access to macintosh Internet Config package,
which stores preferences for Internet programs such as mail address,
@@ -63,7 +63,7 @@ for assignment.
Besides the dictionary interface IC objects have the following methods:
-\renewcommand{\indexsubitem}{(IC object attribute)}
+\setindexsubitem{(IC object attribute)}
\begin{funcdesc}{launchurl}{url \optional{, hint}}
Parse the given URL, lauch the correct application and pass it the
diff --git a/Doc/mac/libmacos.tex b/Doc/mac/libmacos.tex
index 3d1f234..e52c9cc 100644
--- a/Doc/mac/libmacos.tex
+++ b/Doc/mac/libmacos.tex
@@ -2,7 +2,7 @@
\label{module-MacOS}
\bimodindex{MacOS}
-\renewcommand{\indexsubitem}{(in module MacOS)}
+\setindexsubitem{(in module MacOS)}
This module provides access to MacOS specific functionality in the
python interpreter, such as how the interpreter eventloop functions
diff --git a/Doc/mac/libmacostools.tex b/Doc/mac/libmacostools.tex
index adbf461..5c8487a 100644
--- a/Doc/mac/libmacostools.tex
+++ b/Doc/mac/libmacostools.tex
@@ -7,7 +7,7 @@ on the Macintosh.
The \code{macostools} module defines the following functions:
-\renewcommand{\indexsubitem}{(in module macostools)}
+\setindexsubitem{(in module macostools)}
\begin{funcdesc}{copy}{src\, dst\optional{\, createpath, copytimes}}
Copy file \var{src} to \var{dst}. The files can be specified as
@@ -60,7 +60,7 @@ pathnames or as \code{FSSpec} objects.
The \code{findertools} module defines the following functions:
-\renewcommand{\indexsubitem}{(in module macostools)}
+\setindexsubitem{(in module macostools)}
\begin{funcdesc}{launch}{file}
Tell the finder to launch \var{file}. What launching means depends on the file:
diff --git a/Doc/mac/libmacspeech.tex b/Doc/mac/libmacspeech.tex
index 92c0541..8c74268 100644
--- a/Doc/mac/libmacspeech.tex
+++ b/Doc/mac/libmacspeech.tex
@@ -2,7 +2,7 @@
\label{module-macspeech}
\bimodindex{macspeech}
-\renewcommand{\indexsubitem}{(in module macspeech)}
+\setindexsubitem{(in module macspeech)}
This module provides an interface to the Macintosh Speech Manager,
allowing you to let the Macintosh utter phrases. You need a version of
@@ -42,7 +42,7 @@ Return a voice object for voice number \var{num}.
Voice objects contain the description of a voice. It is currently not
yet possible to access the parameters of a voice.
-\renewcommand{\indexsubitem}{(voice object method)}
+\setindexsubitem{(voice object method)}
\begin{funcdesc}{GetGender}{}
Return the gender of the voice: 0 for male, 1 for female and -1 for neuter.
@@ -59,7 +59,7 @@ speakers at the same time. Please note that channel pitch and rate are
interrelated in some way, so that to make your Macintosh sing you will
have to adjust both.
-\renewcommand{\indexsubitem}{(speech channel object method)}
+\setindexsubitem{(speech channel object method)}
\begin{funcdesc}{SpeakText}{str}
Start uttering the given string.
\end{funcdesc}
diff --git a/Doc/mac/libmactcp.tex b/Doc/mac/libmactcp.tex
index a16afc8..f041280 100644
--- a/Doc/mac/libmactcp.tex
+++ b/Doc/mac/libmactcp.tex
@@ -2,7 +2,7 @@
\label{module-mactcp}
\bimodindex{mactcp}
-\renewcommand{\indexsubitem}{(in module mactcp)}
+\setindexsubitem{(in module mactcp)}
This module provides an interface to the Macintosh TCP/IP driver
MacTCP\@. There is an accompanying module \code{macdnr} which provides an
@@ -42,7 +42,7 @@ datagrams on, a value of zero will make MacTCP select a free port.
\subsection{TCP Stream Objects}
-\renewcommand{\indexsubitem}{(TCP stream attribute)}
+\setindexsubitem{(TCP stream attribute)}
\begin{datadesc}{asr}
When set to a value different than \code{None} this should point to a
@@ -54,7 +54,7 @@ is a Python addition to the MacTCP semantics.
It is safe to do further calls from the \code{asr}.
\end{datadesc}
-\renewcommand{\indexsubitem}{(TCP stream method)}
+\setindexsubitem{(TCP stream method)}
\begin{funcdesc}{PassiveOpen}{port}
Wait for an incoming connection on TCP port \var{port} (zero makes the
@@ -119,7 +119,7 @@ This object has no methods, only some members holding information on
the connection. A complete description of all fields in this objects
can be found in the Apple documentation. The most interesting ones are:
-\renewcommand{\indexsubitem}{(TCP status attribute)}
+\setindexsubitem{(TCP status attribute)}
\begin{datadesc}{localHost}
\dataline{localPort}
@@ -149,7 +149,7 @@ without blocking).
Note that, unlike the name suggests, there is nothing stream-like
about UDP.
-\renewcommand{\indexsubitem}{(UDP stream attribute)}
+\setindexsubitem{(UDP stream attribute)}
\begin{datadesc}{asr}
The asynchronous service routine to be called on events such as
@@ -161,7 +161,7 @@ single argument, the event code.
A read-only member giving the port number of this UDP stream.
\end{datadesc}
-\renewcommand{\indexsubitem}{(UDP stream method)}
+\setindexsubitem{(UDP stream method)}
\begin{funcdesc}{Read}{timeout}
Read a datagram, waiting at most \var{timeout} seconds (-1 is
diff --git a/Doc/mac/libmacui.tex b/Doc/mac/libmacui.tex
index c0478ac..eb11e14 100644
--- a/Doc/mac/libmacui.tex
+++ b/Doc/mac/libmacui.tex
@@ -10,7 +10,7 @@ item numbers correspond. See the source for details.
The \code{EasyDialogs} module defines the following functions:
-\renewcommand{\indexsubitem}{(in module EasyDialogs)}
+\setindexsubitem{(in module EasyDialogs)}
\begin{funcdesc}{Message}{str}
A modal dialog with the message text \var{str}, which should be at
@@ -75,7 +75,7 @@ for more details.
The \code{FrameWork} module defines the following functions:
-\renewcommand{\indexsubitem}{(in module FrameWork)}
+\setindexsubitem{(in module FrameWork)}
\begin{funcdesc}{Application}{}
An object representing the complete application. See below for a
@@ -148,7 +148,7 @@ Set the mouse cursor to an arrow.
\subsection{Application objects}
Application objects have the following methods, among others:
-\renewcommand{\indexsubitem}{(Application method)}
+\setindexsubitem{(Application method)}
\begin{funcdesc}{makeusermenus}{}
Override this method if you need menus in your application. Append the
@@ -225,7 +225,7 @@ null-event is passed (so you can look at mouse position, etc).
Window objects have the following methods, among others:
-\renewcommand{\indexsubitem}{(Window method)}
+\setindexsubitem{(Window method)}
\begin{funcdesc}{open}{}
Override this method to open a window. Store the MacOS window-id in
@@ -263,7 +263,7 @@ The window was activated (\code{activate==1}) or deactivated
ControlsWindow objects have the following methods besides those of
\code{Window} objects:
-\renewcommand{\indexsubitem}{(ControlsWindow method)}
+\setindexsubitem{(ControlsWindow method)}
\begin{funcdesc}{do_controlhit}{window\, control\, pcode\, event}
Part \code{pcode} of control \code{control} was hit by the
@@ -275,7 +275,7 @@ user. Tracking and such has already been taken care of.
ScrolledWindow objects are ControlsWindow objects with the following
extra methods:
-\renewcommand{\indexsubitem}{(ScrolledWindow method)}
+\setindexsubitem{(ScrolledWindow method)}
\begin{funcdesc}{scrollbars}{\optional{wantx\, wanty}}
Create (or destroy) horizontal and vertical scrollbars. The arguments
@@ -331,7 +331,7 @@ and has been handled.
DialogWindow objects have the following methods besides those of
\code{Window} objects:
-\renewcommand{\indexsubitem}{(DialogWindow method)}
+\setindexsubitem{(DialogWindow method)}
\begin{funcdesc}{open}{resid}
Create the dialog window, from the DLOG resource with id
@@ -358,7 +358,7 @@ application scriptable.
The \var{MiniAEFrame} module defines the following classes:
-\renewcommand{\indexsubitem}{(in module MiniAEFrame)}
+\setindexsubitem{(in module MiniAEFrame)}
\begin{funcdesc}{AEServer}{}
A class that handles AppleEvent dispatch. Your application should
@@ -379,7 +379,7 @@ provide its own windows, etc.
\subsection{AEServer Objects}
-\renewcommand{\indexsubitem}{(AEServer method)}
+\setindexsubitem{(AEServer method)}
\begin{funcdesc}{installaehandler}{classe\, type\, callback}
Installs an AppleEvent handler. \code{Classe} and \code{type} are the