blob: 0c2795a7b088f8aa39c6787cfb5c78aede5e1001 [file] [log] [blame]
Fred Drake1bd905e2000-10-14 05:06:24 +00001\section{\module{aetypes} ---
2 AppleEvent objects}
3
4\declaremodule{standard}{aetypes}
5 \platform{Mac}
6%\moduleauthor{Jack Jansen?}{email}
7\modulesynopsis{Python representation of the Apple Event Object Model.}
8\sectionauthor{Vincent Marchetti}{vincem@en.com}
9
10
11The \module{aetypes} defines classes used to represent Apple Event
12object specifiers. An object specifier is essentially an address of an
13object implemented in a Apple Event server. An Apple Event specifier
14is used as the direct object for an Apple Event or as the argument of
15an optional parameter. In AppleScript an object specifier is
16represented by a phrase such as:
17\code{character 23 of document "Semprini"}. The classes defined in
18this module allow this specifier to be represented by a Python object
19which is initialized as follows:
20\code{res = Document(1).Character(23)}
21
22
23The \module{AEObjects} module defines the following class:
24
25\begin{classdesc}{ObjectSpecifier}{want, form, seld, from}
26 This is the base class for representing object specifiers and is
27 generally not constructed directly by the user. Its important
28 functionality is to define an \function{__aepack__()} function,
29 which returns the Apple Event descriptor containing the object
30 specifier. Its data members, set directly from the constructor
31 arguments, are:
32\end{classdesc}
33
34\begin{memberdesc}{want}
35 A four character string representing the class code of the
36 object. These class codes are specified in Apple Event Suites; for
37 example the standard code for a character object is the 4 bytes
38 \samp{char}.
39\end{memberdesc}