diff options
author | Georg Brandl <georg@python.org> | 2007-08-15 14:26:55 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2007-08-15 14:26:55 (GMT) |
commit | f56181ff53ba00b7bed3997a4dccd9a1b6217b57 (patch) | |
tree | 1200947a7ffc78c2719831e4c7fd900a8ab01368 /Doc/mac/libaepack.tex | |
parent | af62d9abfb78067a54c769302005f952ed999f6a (diff) | |
download | cpython-f56181ff53ba00b7bed3997a4dccd9a1b6217b57.zip cpython-f56181ff53ba00b7bed3997a4dccd9a1b6217b57.tar.gz cpython-f56181ff53ba00b7bed3997a4dccd9a1b6217b57.tar.bz2 |
Delete the LaTeX doc tree.
Diffstat (limited to 'Doc/mac/libaepack.tex')
-rw-r--r-- | Doc/mac/libaepack.tex | 82 |
1 files changed, 0 insertions, 82 deletions
diff --git a/Doc/mac/libaepack.tex b/Doc/mac/libaepack.tex deleted file mode 100644 index 26a672e..0000000 --- a/Doc/mac/libaepack.tex +++ /dev/null @@ -1,82 +0,0 @@ -\section{\module{aepack} --- - Conversion between Python variables and AppleEvent data containers} - -\declaremodule{standard}{aepack} - \platform{Mac} -%\moduleauthor{Jack Jansen?}{email} -\modulesynopsis{Conversion between Python variables and AppleEvent - data containers.} -\sectionauthor{Vincent Marchetti}{vincem@en.com} - - -The \module{aepack} module defines functions for converting (packing) -Python variables to AppleEvent descriptors and back (unpacking). -Within Python the AppleEvent descriptor is handled by Python objects -of built-in type \class{AEDesc}, defined in module \refmodule{Carbon.AE}. - -The \module{aepack} module defines the following functions: - - -\begin{funcdesc}{pack}{x\optional{, forcetype}} -Returns an \class{AEDesc} object containing a conversion of Python -value x. If \var{forcetype} is provided it specifies the descriptor -type of the result. Otherwise, a default mapping of Python types to -Apple Event descriptor types is used, as follows: - -\begin{tableii}{l|l}{textrm}{Python type}{descriptor type} - \lineii{\class{FSSpec}}{typeFSS} - \lineii{\class{FSRef}}{typeFSRef} - \lineii{\class{Alias}}{typeAlias} - \lineii{integer}{typeLong (32 bit integer)} - \lineii{float}{typeFloat (64 bit floating point)} - \lineii{string}{typeText} - \lineii{unicode}{typeUnicodeText} - \lineii{list}{typeAEList} - \lineii{dictionary}{typeAERecord} - \lineii{instance}{\emph{see below}} -\end{tableii} - -If \var{x} is a Python instance then this function attempts to call an -\method{__aepack__()} method. This method should return an -\class{AEDesc} object. - -If the conversion \var{x} is not defined above, this function returns -the Python string representation of a value (the repr() function) -encoded as a text descriptor. -\end{funcdesc} - -\begin{funcdesc}{unpack}{x\optional{, formodulename}} - \var{x} must be an object of type \class{AEDesc}. This function - returns a Python object representation of the data in the Apple - Event descriptor \var{x}. Simple AppleEvent data types (integer, - text, float) are returned as their obvious Python counterparts. - Apple Event lists are returned as Python lists, and the list - elements are recursively unpacked. Object references - (ex. \code{line 3 of document 1}) are returned as instances of - \class{aetypes.ObjectSpecifier}, unless \code{formodulename} - is specified. AppleEvent descriptors with - descriptor type typeFSS are returned as \class{FSSpec} - objects. AppleEvent record descriptors are returned as Python - dictionaries, with 4-character string keys and elements recursively - unpacked. - - The optional \code{formodulename} argument is used by the stub packages - generated by \module{gensuitemodule}, and ensures that the OSA classes - for object specifiers are looked up in the correct module. This ensures - that if, say, the Finder returns an object specifier for a window - you get an instance of \code{Finder.Window} and not a generic - \code{aetypes.Window}. The former knows about all the properties - and elements a window has in the Finder, while the latter knows - no such things. -\end{funcdesc} - - -\begin{seealso} - \seemodule{Carbon.AE}{Built-in access to Apple Event Manager routines.} - \seemodule{aetypes}{Python definitions of codes for Apple Event - descriptor types.} - \seetitle[http://developer.apple.com/techpubs/mac/IAC/IAC-2.html]{ - Inside Macintosh: Interapplication - Communication}{Information about inter-process - communications on the Macintosh.} -\end{seealso} |