Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 4d0d621

Browse files
freddrakefreddrake
committed
Chapters on Mac Toolbox modules and other undocumented modules, ready to
be filled in with real information. Contributed by Chris Barker <[email protected]>.
1 parent 1bd905e commit 4d0d621

2 files changed

Lines changed: 245 additions & 0 deletions

File tree

‎Doc/mac/toolbox.tex‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
\chapter{MacOS Toolbox Modules \label{toolbox}}
2+
3+
There are a set of modules that provide interfaces to various MacOS
4+
toolboxes. If applicable the module will define a number of Python
5+
objects for the various structures declared by the toolbox, and
6+
operations will be implemented as methods of the object. Other
7+
operations will be implemented as functions in the module. Not all
8+
operations possible in C will also be possible in Python (callbacks
9+
are often a problem), and parameters will occasionally be different in
10+
Python (input and output buffers, especially). All methods and
11+
functions have a \member{__doc__} string describing their arguments
12+
and return values, and for additional description you are referred to
13+
\citetitle[http://developer.apple.com/techpubs/macos8/mac8.html]{Inside
14+
Macintosh} or similar works.
15+
16+
17+
\strong{Warning!} These modules are not yet documented. If you
18+
wish to contribute documentation of any of these modules, please get
19+
in touch with \email{[email protected]}.
20+
21+
\localmoduletable
22+
23+
24+
%\section{Argument Handling for Toolbox Modules}
25+
26+
27+
\section{\module{AE} --- Apple Events}
28+
\declaremodule{standard}{AE}
29+
\platform{Mac}
30+
\modulesynopsis{Interface to the Apple Events toolbox}
31+
32+
33+
\section{\module{Cm} --- Component Manager}
34+
\declaremodule{standard}{Cm}
35+
\platform{Cm}
36+
\modulesynopsis{Interface to the Component Manager}
37+
38+
39+
\section{\module{Ctl} --- Control Manager}
40+
\declaremodule{standard}{Ctl}
41+
\platform{Mac}
42+
\modulesynopsis{Interface to the Control Manager}
43+
44+
45+
\section{\module{Dlg} --- Dialog Manager}
46+
\declaremodule{standard}{Dlg}
47+
\platform{Mac}
48+
\modulesynopsis{Interface to the Dialog Manager}
49+
50+
51+
\section{\module{Evt} --- Event Manager}
52+
\declaremodule{standard}{Evt}
53+
\platform{Mac}
54+
\modulesynopsis{Interface to the Event Manager}
55+
56+
57+
\section{\module{Fm} --- Font Manager}
58+
\declaremodule{standard}{Fm}
59+
\platform{Mac}
60+
\modulesynopsis{Interface to the Font Manager}
61+
62+
63+
\section{\module{List} --- List Manager}
64+
\declaremodule{standard}{List}
65+
\platform{Mac}
66+
\modulesynopsis{Interface to the List Manager}
67+
68+
69+
\section{\module{Menu} --- Menu Manager}
70+
\declaremodule{standard}{Menu}
71+
\platform{Mac}
72+
\modulesynopsis{Interface to the Menu Manager}
73+
74+
75+
\section{\module{Qd} --- QuickDraw}
76+
\declaremodule{builtin}{Qd}
77+
\platform{Mac}
78+
\modulesynopsis{Interface to the QuickDraw toolbox}
79+
80+
81+
\section{\module{Qt} --- QuickTime}
82+
\declaremodule{standard}{Qt}
83+
\platform{Mac}
84+
\modulesynopsis{Interface to the QuickTime toolbox}
85+
86+
87+
\section{\module{Res} --- Resource Manager and Handles}
88+
\declaremodule{standard}{Res}
89+
\platform{Mac}
90+
\modulesynopsis{Interface to the Resource Manager and Handles}
91+
92+
93+
\section{\module{Scrap} --- Scrap Manager}
94+
\declaremodule{standard}{Scrap}
95+
\platform{Mac}
96+
\modulesynopsis{Interface to the Scrap Manager}
97+
98+
99+
\section{\module{Snd} --- Sound Manager}
100+
\declaremodule{standard}{Snd}
101+
\platform{Mac}
102+
\modulesynopsis{Interface to the Sound Manager }
103+
104+
105+
\section{\module{TE} --- TextEdit}
106+
\declaremodule{standard}{TE}
107+
\platform{Mac}
108+
\modulesynopsis{Interface to TextEdit}
109+
110+
111+
\section{\module{waste} --- non-Apple \program{TextEdit} replacement}
112+
\declaremodule{standard}{waste}
113+
\platform{Mac}
114+
\modulesynopsis{Interface to the ``WorldScript-Aware Styled Text Engine.''}
115+
116+
\begin{seealso}
117+
\seetitle[http://www.merzwaren.com/waste/]{About WASTE}{Information
118+
about the WASTE widget and library, including
119+
documentation and downloads.}
120+
\end{seealso}
121+
122+
123+
\section{\module{Win} --- Window Manager}
124+
\declaremodule{standard}{Win}
125+
\platform{Mac}
126+
\modulesynopsis{Interface to the Window Manager}

‎Doc/mac/undoc.tex‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
\chapter{Undocumented Modules \label{undocumented-modules}}
2+
3+
4+
The modules in this chapter are poorly documented (if at all). If you
5+
wish to contribute documentation of any of these modules, please get in
6+
touch with \email{[email protected]}.
7+
8+
\localmoduletable
9+
10+
11+
\section{\module{buildtools} --- Helper module for BuildApplet and Friends}
12+
\declaremodule{standard}{buildtools}
13+
\platform{Mac}
14+
\modulesynopsis{Helper module for BuildApple, BuildApplication and macfreeze}
15+
16+
17+
\section{\module{py_resource} --- }
18+
\declaremodule[pyresource]{standard}{py_resource}
19+
\platform{Mac}
20+
\modulesynopsis{}
21+
22+
23+
\section{\module{cfmfile} --- Code Fragment Resource module}
24+
\declaremodule{standard}{cfmfile}
25+
\platform{Mac}
26+
\modulesynopsis{Code Fragment Resource module}
27+
28+
\module{cfmfile} is a module that understands Code Fragments and the
29+
accompanying ``cfrg'' resources. It can parse them and merge them, and is
30+
used by BuildApplication to combine all plugin modules to a single
31+
executable.
32+
33+
34+
\section{\module{macerrors} --- MacOS Errors}
35+
\declaremodule{standard}{macerrors}
36+
\platform{Mac}
37+
\modulesynopsis{Constant definitions for many MacOS error codes}
38+
39+
\module{macerrors} cotains constant definitions for many MacOS error codes.
40+
41+
42+
\section{\module{macfsn} --- NavServices calls}
43+
\declaremodule{standard}{macfsn}
44+
\platform{Mac}
45+
\modulesynopsis{NavServices versions of StandardFile calls}
46+
47+
48+
\module{macfsn} contains wrapper functions that have the same API as the macfs
49+
StandardFile calls, but are implemented with Navigation Services. Importing it
50+
will replace the methods in macfs with these, if Navigation Services is
51+
available on your machine.
52+
53+
54+
\section{\module{icopen} --- Internet Config replacement for \method{open()}}
55+
\declaremodule{standard}{icopen}
56+
\platform{Mac}
57+
\modulesynopsis{Internet Config replacement for \method{open()}}
58+
59+
Importing \module{icopen} will replace the builtin \method{open()}
60+
with a version that uses Internet Config to set file type and creator
61+
for new files.
62+
63+
64+
\section{\module{mactty} --- }
65+
\declaremodule{standard}{mactty}
66+
\platform{Mac}
67+
\modulesynopsis{}
68+
69+
70+
\section{\module{nsremote} --- Wrapper around Netscape OSA modules}
71+
\declaremodule{standard}{nsremote}
72+
\platform{Mac}
73+
\modulesynopsis{Wrapper around Netscape OSA modules}
74+
75+
\module{nsremote} is a wrapper around the Netscape OSA modules that
76+
allows you to easily send your browser to a given URL.
77+
78+
79+
\section{\module{PixMapWrapper} --- Wrapper for PixMap objects}
80+
\declaremodule{standard}{PixMapWrapper}
81+
\platform{Mac}
82+
\modulesynopsis{Wrapper for PixMap objects}
83+
84+
\module{PixMapWrapper} wraps a PixMap object with a Python object that
85+
allows access to the fields by name. It also has methods to convert
86+
to and from \module{PIL} images.
87+
88+
89+
\section{\module{preferences} --- }
90+
\declaremodule{standard}{preferences}
91+
\platform{Mac}
92+
\modulesynopsis{}
93+
94+
95+
\section{\module{pythonprefs} --- }
96+
\declaremodule{standard}{pythonprefs}
97+
\platform{Mac}
98+
\modulesynopsis{}
99+
100+
101+
\section{\module{quietconsole} --- non-visible stdout output}
102+
\declaremodule{standard}{quietconsole}
103+
\platform{Mac}
104+
\modulesynopsis{buffered, non-visible stdout output}
105+
106+
\module{quietconsole} allows you to keep stdio output in a buffer
107+
without displaying it (or without displaying the stdout window
108+
altogether, if set with \program{EditPythonPrefs}) until you try to read from
109+
stdin or disable the buffering, at which point all the saved output is
110+
sent to the window. Good for GUI programs that do want to display their
111+
output at a crash.
112+
113+
114+
\section{\module{W} --- Widgets built on \module{FrameWork}}
115+
\declaremodule{standard}{W}
116+
\platform{Mac}
117+
\modulesynopsis{Widgets for the Mac, built on top of \module{FrameWork}}
118+
119+
The \module{W} widgets are used extensively in the \program{IDE}.

0 commit comments

Comments
 (0)