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