Doc/mac/undoc.tex

   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
   7 \ulink{\email{python-docs@python.org}}{mailto:python-docs@python.org}.
   8
   9 \localmoduletable
  10
  11
  12 \section{\module{applesingle} --- AppleSingle decoder}
  13 \declaremodule{standard}{applesingle}
  14   \platform{Mac}
  15 \modulesynopsis{Rudimentary decoder for AppleSingle format files.}
  16
  17
  18 \section{\module{buildtools} --- Helper module for BuildApplet and Friends}
  19 \declaremodule{standard}{buildtools}
  20   \platform{Mac}
  21 \modulesynopsis{Helper module for BuildApplet, BuildApplication and
  22                 macfreeze.}
  23
  24
  25 \section{\module{py_resource} --- Resources from Python code}
  26 \declaremodule[pyresource]{standard}{py_resource}
  27   \platform{Mac}
  28 \modulesynopsis{Helper to create \texttt{'PYC~'} resources for compiled
  29                 applications.}
  30
  31 This module is primarily used as a help module for
  32 \program{BuildApplet} and \program{BuildApplication}.  It is able to
  33 store compiled Python code as \texttt{'PYC~'} resources in a file.
  34
  35
  36 \section{\module{cfmfile} --- Code Fragment Resource module}
  37 \declaremodule{standard}{cfmfile}
  38   \platform{Mac}
  39 \modulesynopsis{Code Fragment Resource module.}
  40
  41 \module{cfmfile} is a module that understands Code Fragments and the
  42 accompanying ``cfrg'' resources. It can parse them and merge them, and is
  43 used by BuildApplication to combine all plugin modules to a single
  44 executable.
  45
  46
  47 \section{\module{icopen} --- Internet Config replacement for \method{open()}}
  48 \declaremodule{standard}{icopen}
  49   \platform{Mac}
  50 \modulesynopsis{Internet Config replacement for \method{open()}.}
  51
  52 Importing \module{icopen} will replace the builtin \method{open()}
  53 with a version that uses Internet Config to set file type and creator
  54 for new files.
  55
  56
  57 \section{\module{macerrors} --- Mac OS Errors}
  58 \declaremodule{standard}{macerrors}
  59   \platform{Mac}
  60 \modulesynopsis{Constant definitions for many Mac OS error codes.}
  61
  62 \module{macerrors} cotains constant definitions for many Mac OS error
  63 codes.
  64
  65
  66 \section{\module{macresource} --- Locate script resources}
  67 \declaremodule{standard}{macresource}
  68   \platform{Mac}
  69 \modulesynopsis{Locate script resources.}
  70
  71 \module{macresource} helps scripts finding their resources, such as
  72 dialogs and menus, without requiring special case code for when the
  73 script is run under MacPython, as a MacPython applet or under OSX Python.
  74
  75 \section{\module{Nav} --- NavServices calls}
  76 \declaremodule{standard}{Nac}
  77   \platform{Mac}
  78 \modulesynopsis{Interface to Navigation Services.}
  79
  80 A low-level interface to Navigation Services.
  81
  82 \section{\module{mkcwproject} --- Create CodeWarrior projects}
  83 \declaremodule{standard}{mkcwproject}
  84   \platform{Mac}
  85 \modulesynopsis{Create CodeWarrior projects.}
  86
  87 \module{mkcwproject} creates project files for the Metrowerks CodeWarrior
  88 development environment. It is a helper module for
  89 \refmodule{distutils}\refbimodindex{distutils} but can be used separately for more
  90 control.
  91
  92
  93 \section{\module{nsremote} --- Wrapper around Netscape OSA modules}
  94 \declaremodule{standard}{nsremote}
  95   \platform{Mac}
  96 \modulesynopsis{Wrapper around Netscape OSA modules.}
  97
  98 \module{nsremote} is a wrapper around the Netscape OSA modules that
  99 allows you to easily send your browser to a given URL.  A related
 100 module that may be of interest is the \module{webbrowser} module,
 101 documented in the \citetitle[../lib/lib.html]{Python Library
 102 Reference}.
 103
 104
 105 \section{\module{PixMapWrapper} --- Wrapper for PixMap objects}
 106 \declaremodule{standard}{PixMapWrapper}
 107   \platform{Mac}
 108 \modulesynopsis{Wrapper for PixMap objects.}
 109
 110 \module{PixMapWrapper} wraps a PixMap object with a Python object that
 111 allows access to the fields by name. It also has methods to convert
 112 to and from \module{PIL} images.
 113
 114
 115 \section{\module{preferences} --- Application preferences manager}
 116 \declaremodule{standard}{preferences}
 117   \platform{Mac}
 118 \modulesynopsis{Nice application preferences manager with support for
 119                 defaults.}
 120
 121 The \module{preferences} module allows storage of user preferences in
 122 the system-wide preferences folder, with defaults coming from the
 123 application itself and the possibility to override preferences for
 124 specific situations.
 125
 126
 127 \section{\module{pythonprefs} --- Preferences manager for Python}
 128 \declaremodule{standard}{pythonprefs}
 129   \platform{Mac}
 130 \modulesynopsis{Specialized preferences manager for the Python
 131                 interpreter.}
 132
 133 This module is a specialization of the \refmodule{preferences} module
 134 that allows reading and writing of the preferences for the Python
 135 interpreter.
 136
 137
 138 \section{\module{quietconsole} --- Non-visible standard output}
 139 \declaremodule{standard}{quietconsole}
 140   \platform{Mac}
 141 \modulesynopsis{Buffered, non-visible standard output.}
 142
 143 \module{quietconsole} allows you to keep stdio output in a buffer
 144 without displaying it (or without displaying the stdout window
 145 altogether, if set with \program{EditPythonPrefs}) until you try to read from
 146 stdin or disable the buffering, at which point all the saved output is
 147 sent to the window.  Good for programs with graphical user interfaces
 148 that do want to display their output at a crash.
 149
 150
 151 \section{\module{videoreader} --- Read QuickTime movies}
 152 \declaremodule{standard}{videoreader}
 153   \platform{Mac}
 154 \modulesynopsis{Read QuickTime movies frame by frame for further processing.}
 155
 156 \module{videoreader} reads and decodes QuickTime movies and passes
 157 a stream of images to your program. It also provides some support for
 158 audio tracks.
 159
 160 \section{\module{W} --- Widgets built on \module{FrameWork}}
 161 \declaremodule{standard}{W}
 162   \platform{Mac}
 163 \modulesynopsis{Widgets for the Mac, built on top of \refmodule{FrameWork}.}
 164
 165 The \module{W} widgets are used extensively in the \program{IDE}.
 166
 167 \section{\module{waste} --- non-Apple \program{TextEdit} replacement}
 168 \declaremodule{standard}{waste}
 169   \platform{Mac}
 170 \modulesynopsis{Interface to the ``WorldScript-Aware Styled Text Engine.''}
 171
 172 \begin{seealso}
 173   \seetitle[http://www.merzwaren.com/waste/]{About WASTE}{Information
 174             about the WASTE widget and library, including
 175             documentation and downloads.}
 176 \end{seealso}
 177