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/documentation/macos8/mac8.html]{Inside
|
---|
14 | Macintosh} or similar works.
|
---|
15 |
|
---|
16 | These modules all live in a package called \module{Carbon}. Despite that name
|
---|
17 | they are not all part of the Carbon framework: CF is really in the CoreFoundation
|
---|
18 | framework and Qt is in the QuickTime framework.
|
---|
19 | The normal use pattern is
|
---|
20 |
|
---|
21 | \begin{verbatim}
|
---|
22 | from Carbon import AE
|
---|
23 | \end{verbatim}
|
---|
24 |
|
---|
25 | \strong{Warning!} These modules are not yet documented. If you
|
---|
26 | wish to contribute documentation of any of these modules, please get
|
---|
27 | in touch with \email{docs@python.org}.
|
---|
28 |
|
---|
29 | \localmoduletable
|
---|
30 |
|
---|
31 |
|
---|
32 | %\section{Argument Handling for Toolbox Modules}
|
---|
33 |
|
---|
34 |
|
---|
35 | \section{\module{Carbon.AE} --- Apple Events}
|
---|
36 | \declaremodule{standard}{Carbon.AE}
|
---|
37 | \platform{Mac}
|
---|
38 | \modulesynopsis{Interface to the Apple Events toolbox.}
|
---|
39 |
|
---|
40 | \section{\module{Carbon.AH} --- Apple Help}
|
---|
41 | \declaremodule{standard}{Carbon.AH}
|
---|
42 | \platform{Mac}
|
---|
43 | \modulesynopsis{Interface to the Apple Help manager.}
|
---|
44 |
|
---|
45 |
|
---|
46 | \section{\module{Carbon.App} --- Appearance Manager}
|
---|
47 | \declaremodule{standard}{Carbon.App}
|
---|
48 | \platform{Mac}
|
---|
49 | \modulesynopsis{Interface to the Appearance Manager.}
|
---|
50 |
|
---|
51 |
|
---|
52 | \section{\module{Carbon.CF} --- Core Foundation}
|
---|
53 | \declaremodule{standard}{Carbon.CF}
|
---|
54 | \platform{Mac}
|
---|
55 | \modulesynopsis{Interface to the Core Foundation.}
|
---|
56 |
|
---|
57 | The
|
---|
58 | \code{CFBase}, \code{CFArray}, \code{CFData}, \code{CFDictionary},
|
---|
59 | \code{CFString} and \code{CFURL} objects are supported, some
|
---|
60 | only partially.
|
---|
61 |
|
---|
62 | \section{\module{Carbon.CG} --- Core Graphics}
|
---|
63 | \declaremodule{standard}{Carbon.CG}
|
---|
64 | \platform{Mac}
|
---|
65 | \modulesynopsis{Interface to the Component Manager.}
|
---|
66 |
|
---|
67 | \section{\module{Carbon.CarbonEvt} --- Carbon Event Manager}
|
---|
68 | \declaremodule{standard}{Carbon.CaronEvt}
|
---|
69 | \platform{Mac}
|
---|
70 | \modulesynopsis{Interface to the Carbon Event Manager.}
|
---|
71 |
|
---|
72 | \section{\module{Carbon.Cm} --- Component Manager}
|
---|
73 | \declaremodule{standard}{Carbon.Cm}
|
---|
74 | \platform{Mac}
|
---|
75 | \modulesynopsis{Interface to the Component Manager.}
|
---|
76 |
|
---|
77 |
|
---|
78 | \section{\module{Carbon.Ctl} --- Control Manager}
|
---|
79 | \declaremodule{standard}{Carbon.Ctl}
|
---|
80 | \platform{Mac}
|
---|
81 | \modulesynopsis{Interface to the Control Manager.}
|
---|
82 |
|
---|
83 |
|
---|
84 | \section{\module{Carbon.Dlg} --- Dialog Manager}
|
---|
85 | \declaremodule{standard}{Carbon.Dlg}
|
---|
86 | \platform{Mac}
|
---|
87 | \modulesynopsis{Interface to the Dialog Manager.}
|
---|
88 |
|
---|
89 |
|
---|
90 | \section{\module{Carbon.Evt} --- Event Manager}
|
---|
91 | \declaremodule{standard}{Carbon.Evt}
|
---|
92 | \platform{Mac}
|
---|
93 | \modulesynopsis{Interface to the classic Event Manager.}
|
---|
94 |
|
---|
95 |
|
---|
96 | \section{\module{Carbon.Fm} --- Font Manager}
|
---|
97 | \declaremodule{standard}{Carbon.Fm}
|
---|
98 | \platform{Mac}
|
---|
99 | \modulesynopsis{Interface to the Font Manager.}
|
---|
100 |
|
---|
101 | \section{\module{Carbon.Folder} --- Folder Manager}
|
---|
102 | \declaremodule{standard}{Carbon.Folder}
|
---|
103 | \platform{Mac}
|
---|
104 | \modulesynopsis{Interface to the Folder Manager.}
|
---|
105 |
|
---|
106 |
|
---|
107 | \section{\module{Carbon.Help} --- Help Manager}
|
---|
108 | \declaremodule{standard}{Carbon.Help}
|
---|
109 | \platform{Mac}
|
---|
110 | \modulesynopsis{Interface to the Carbon Help Manager.}
|
---|
111 |
|
---|
112 | \section{\module{Carbon.List} --- List Manager}
|
---|
113 | \declaremodule{standard}{Carbon.List}
|
---|
114 | \platform{Mac}
|
---|
115 | \modulesynopsis{Interface to the List Manager.}
|
---|
116 |
|
---|
117 |
|
---|
118 | \section{\module{Carbon.Menu} --- Menu Manager}
|
---|
119 | \declaremodule{standard}{Carbon.Menu}
|
---|
120 | \platform{Mac}
|
---|
121 | \modulesynopsis{Interface to the Menu Manager.}
|
---|
122 |
|
---|
123 |
|
---|
124 | \section{\module{Carbon.Mlte} --- MultiLingual Text Editor}
|
---|
125 | \declaremodule{standard}{Carbon.Mlte}
|
---|
126 | \platform{Mac}
|
---|
127 | \modulesynopsis{Interface to the MultiLingual Text Editor.}
|
---|
128 |
|
---|
129 |
|
---|
130 | \section{\module{Carbon.Qd} --- QuickDraw}
|
---|
131 | \declaremodule{builtin}{Carbon.Qd}
|
---|
132 | \platform{Mac}
|
---|
133 | \modulesynopsis{Interface to the QuickDraw toolbox.}
|
---|
134 |
|
---|
135 |
|
---|
136 | \section{\module{Carbon.Qdoffs} --- QuickDraw Offscreen}
|
---|
137 | \declaremodule{builtin}{Carbon.Qdoffs}
|
---|
138 | \platform{Mac}
|
---|
139 | \modulesynopsis{Interface to the QuickDraw Offscreen APIs.}
|
---|
140 |
|
---|
141 |
|
---|
142 | \section{\module{Carbon.Qt} --- QuickTime}
|
---|
143 | \declaremodule{standard}{Carbon.Qt}
|
---|
144 | \platform{Mac}
|
---|
145 | \modulesynopsis{Interface to the QuickTime toolbox.}
|
---|
146 |
|
---|
147 |
|
---|
148 | \section{\module{Carbon.Res} --- Resource Manager and Handles}
|
---|
149 | \declaremodule{standard}{Carbon.Res}
|
---|
150 | \platform{Mac}
|
---|
151 | \modulesynopsis{Interface to the Resource Manager and Handles.}
|
---|
152 |
|
---|
153 | \section{\module{Carbon.Scrap} --- Scrap Manager}
|
---|
154 | \declaremodule{standard}{Carbon.Scrap}
|
---|
155 | \platform{Mac}
|
---|
156 | \modulesynopsis{Interface to the Carbon Scrap Manager.}
|
---|
157 |
|
---|
158 | \section{\module{Carbon.Snd} --- Sound Manager}
|
---|
159 | \declaremodule{standard}{Carbon.Snd}
|
---|
160 | \platform{Mac}
|
---|
161 | \modulesynopsis{Interface to the Sound Manager.}
|
---|
162 |
|
---|
163 |
|
---|
164 | \section{\module{Carbon.TE} --- TextEdit}
|
---|
165 | \declaremodule{standard}{Carbon.TE}
|
---|
166 | \platform{Mac}
|
---|
167 | \modulesynopsis{Interface to TextEdit.}
|
---|
168 |
|
---|
169 |
|
---|
170 | \section{\module{Carbon.Win} --- Window Manager}
|
---|
171 | \declaremodule{standard}{Carbon.Win}
|
---|
172 | \platform{Mac}
|
---|
173 | \modulesynopsis{Interface to the Window Manager.}
|
---|