Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / cpython3 / 5ed317d790023e766e6992020d268e0e9fc35dfc / . / Doc / mac / undoc.tex
blob: adbf58943010df26dd4d8e95f8941521a3e9b04e [file] [log] [blame]
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]1\chapter{Undocumented Modules \label{undocumented-modules}}
2
3
4The modules in this chapter are poorly documented (if at all). If you
5wish to contribute documentation of any of these modules, please get in
Fred Drake8da359b2001-07-14 02:09:32 +0000[diff] [blame]6touch with
Fred Drake9d843082003-07-30 02:55:28 +0000[diff] [blame]7\ulink{\email{docs@python.org}}{mailto:docs@python.org}.
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]8
9\localmoduletable
10
11
Jack Jansen945bf5f2001-09-11 21:24:07 +0000[diff] [blame]12\section{\module{applesingle} --- AppleSingle decoder}
13\declaremodule{standard}{applesingle}
14 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +0000[diff] [blame]15\modulesynopsis{Rudimentary decoder for AppleSingle format files.}
Jack Jansen945bf5f2001-09-11 21:24:07 +0000[diff] [blame]16
17
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]18\section{\module{buildtools} --- Helper module for BuildApplet and Friends}
19\declaremodule{standard}{buildtools}
20 \platform{Mac}
Fred Drake12060e52001-07-10 14:19:45 +0000[diff] [blame]21\modulesynopsis{Helper module for BuildApplet, BuildApplication and
Fred Drakeac968682002-01-17 04:51:55 +0000[diff] [blame]22 macfreeze.}
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]23
Guido van Rossumd8faa362007-04-27 19:54:29 +0000[diff] [blame]24\deprecated{2.4}{}
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]25
Jack Jansen945bf5f2001-09-11 21:24:07 +0000[diff] [blame]26\section{\module{icopen} --- Internet Config replacement for \method{open()}}
27\declaremodule{standard}{icopen}
28 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +0000[diff] [blame]29\modulesynopsis{Internet Config replacement for \method{open()}.}
Jack Jansen945bf5f2001-09-11 21:24:07 +0000[diff] [blame]30
31Importing \module{icopen} will replace the builtin \method{open()}
32with a version that uses Internet Config to set file type and creator
33for new files.
34
35
Fred Drake0f0380a2001-10-01 17:04:10 +0000[diff] [blame]36\section{\module{macerrors} --- Mac OS Errors}
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]37\declaremodule{standard}{macerrors}
38 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +0000[diff] [blame]39\modulesynopsis{Constant definitions for many Mac OS error codes.}
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]40
Raymond Hettinger68804312005-01-01 00:28:46 +0000[diff] [blame]41\module{macerrors} contains constant definitions for many Mac OS error
Fred Drakeac968682002-01-17 04:51:55 +0000[diff] [blame]42codes.
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]43
44
Jack Jansen945bf5f2001-09-11 21:24:07 +0000[diff] [blame]45\section{\module{macresource} --- Locate script resources}
46\declaremodule{standard}{macresource}
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]47 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +0000[diff] [blame]48\modulesynopsis{Locate script resources.}
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]49
Jack Jansen945bf5f2001-09-11 21:24:07 +0000[diff] [blame]50\module{macresource} helps scripts finding their resources, such as
51dialogs and menus, without requiring special case code for when the
52script is run under MacPython, as a MacPython applet or under OSX Python.
53
Fred Drakeee0fe0b2001-09-12 00:43:13 +0000[diff] [blame]54\section{\module{Nav} --- NavServices calls}
Andrew M. Kuchlingc12527e2004-07-21 21:34:45 +0000[diff] [blame]55\declaremodule{standard}{Nav}
Jack Jansen945bf5f2001-09-11 21:24:07 +0000[diff] [blame]56 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +0000[diff] [blame]57\modulesynopsis{Interface to Navigation Services.}
Jack Jansen945bf5f2001-09-11 21:24:07 +0000[diff] [blame]58
59A low-level interface to Navigation Services.
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]60
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]61\section{\module{PixMapWrapper} --- Wrapper for PixMap objects}
62\declaremodule{standard}{PixMapWrapper}
63 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +0000[diff] [blame]64\modulesynopsis{Wrapper for PixMap objects.}
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]65
66\module{PixMapWrapper} wraps a PixMap object with a Python object that
67allows access to the fields by name. It also has methods to convert
68to and from \module{PIL} images.
69
Fred Drakeac968682002-01-17 04:51:55 +0000[diff] [blame]70\section{\module{videoreader} --- Read QuickTime movies}
Jack Jansen945bf5f2001-09-11 21:24:07 +0000[diff] [blame]71\declaremodule{standard}{videoreader}
72 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +0000[diff] [blame]73\modulesynopsis{Read QuickTime movies frame by frame for further processing.}
Jack Jansen945bf5f2001-09-11 21:24:07 +0000[diff] [blame]74
75\module{videoreader} reads and decodes QuickTime movies and passes
76a stream of images to your program. It also provides some support for
77audio tracks.
78
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]79\section{\module{W} --- Widgets built on \module{FrameWork}}
80\declaremodule{standard}{W}
81 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +0000[diff] [blame]82\modulesynopsis{Widgets for the Mac, built on top of \refmodule{FrameWork}.}
Fred Drake4d0d6212000-10-14 05:08:34 +0000[diff] [blame]83
84The \module{W} widgets are used extensively in the \program{IDE}.
Jack Jansen945bf5f2001-09-11 21:24:07 +0000[diff] [blame]85