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 \email{python-docs@python.org}.
   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}.