[OpenSPARC-T2-DV] / tools / src / nas,5.n2.os.2 / lib / python / html / python / mac / aeserver-objects.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="mac.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="mac.html" title='Macintosh Library Modules' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="prev" href="module-MiniAEFrame.html" />
<link rel="parent" href="module-MiniAEFrame.html" />
<link rel="next" href="toolbox.html" />
<meta name='aesop' content='information' />
<title>3.5.1 AEServer Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="3.5 MiniAEFrame  "
  href="module-MiniAEFrame.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="3.5 MiniAEFrame  "
  href="module-MiniAEFrame.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="4. MacOS Toolbox Modules"
  href="toolbox.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Macintosh Library Modules</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-MiniAEFrame.html">3.5 MiniAEFrame  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-MiniAEFrame.html">3.5 MiniAEFrame  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="toolbox.html">4. MacOS Toolbox Modules</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION005510000000000000000"></A><A NAME="aeserver-objects"></A>
<BR>
3.5.1 AEServer Objects 
</H2>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-179' xml:id='l2h-179' class="method">installaehandler</tt></b>(</nobr></td>
  <td><var>classe, type, callback</var>)</td></tr></table></dt>
<dd>
Installs an AppleEvent handler. <var>classe</var> and <var>type</var> are the
four-character OSA Class and Type designators, <code>'****'</code> wildcards
are allowed. When a matching AppleEvent is received the parameters are
decoded and your callback is invoked.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-180' xml:id='l2h-180' class="method">callback</tt></b>(</nobr></td>
  <td><var>_object, **kwargs</var>)</td></tr></table></dt>
<dd>
Your callback is called with the OSA Direct Object as first positional
parameter. The other parameters are passed as keyword arguments, with
the 4-character designator as name. Three extra keyword parameters are
passed: <code>_class</code> and <code>_type</code> are the Class and Type
designators and <code>_attributes</code> is a dictionary with the AppleEvent
attributes.

<P>
The return value of your method is packed with
<tt class="function">aetools.packevent()</tt> and sent as reply.
</dl>

<P>
Note that there are some serious problems with the current
design. AppleEvents which have non-identifier 4-character designators
for arguments are not implementable, and it is not possible to return
an error to the originator. This will be addressed in a future
release.

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="3.5 MiniAEFrame  "
  href="module-MiniAEFrame.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="3.5 MiniAEFrame  "
  href="module-MiniAEFrame.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="4. MacOS Toolbox Modules"
  href="toolbox.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Macintosh Library Modules</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-MiniAEFrame.html">3.5 MiniAEFrame  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-MiniAEFrame.html">3.5 MiniAEFrame  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="toolbox.html">4. MacOS Toolbox Modules</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
Commit	Line	Data
86530b38 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="mac.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="mac.html" title='Macintosh Library Modules' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='index' href='genindex.html' title='Index' />
	10	<link rel='last' href='about.html' title='About this document...' />
	11	<link rel='help' href='about.html' title='About this document...' />
	12	<link rel="prev" href="module-MiniAEFrame.html" />
	13	<link rel="parent" href="module-MiniAEFrame.html" />
	14	<link rel="next" href="toolbox.html" />
	15	<meta name='aesop' content='information' />
	16	<title>3.5.1 AEServer Objects </title>
	17	</head>
	18	<body>
	19	<DIV CLASS="navigation">
	20	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	21	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	22	<tr>
	23	<td class='online-navigation'><a rel="prev" title="3.5 MiniAEFrame "
	24	href="module-MiniAEFrame.html"><img src='../icons/previous.png'
	25	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	26	<td class='online-navigation'><a rel="parent" title="3.5 MiniAEFrame "
	27	href="module-MiniAEFrame.html"><img src='../icons/up.png'
	28	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	29	<td class='online-navigation'><a rel="next" title="4. MacOS Toolbox Modules"
	30	href="toolbox.html"><img src='../icons/next.png'
	31	border='0' height='32' alt='Next Page' width='32' /></A></td>
	32	<td align="center" width="100%">Macintosh Library Modules</td>
	33	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	34	href="contents.html"><img src='../icons/contents.png'
	35	border='0' height='32' alt='Contents' width='32' /></A></td>
	36	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
	37	border='0' height='32' alt='Module Index' width='32' /></a></td>
	38	<td class='online-navigation'><a rel="index" title="Index"
	39	href="genindex.html"><img src='../icons/index.png'
	40	border='0' height='32' alt='Index' width='32' /></A></td>
	41	</tr></table>
	42	<div class='online-navigation'>
	43	<b class="navlabel">Previous:</b>
	44	<a class="sectref" rel="prev" href="module-MiniAEFrame.html">3.5 MiniAEFrame </A>
	45	<b class="navlabel">Up:</b>
	46	<a class="sectref" rel="parent" href="module-MiniAEFrame.html">3.5 MiniAEFrame </A>
	47	<b class="navlabel">Next:</b>
	48	<a class="sectref" rel="next" href="toolbox.html">4. MacOS Toolbox Modules</A>
	49	</div>
	50	<hr /></div>
	51	</DIV>
	52	<!--End of Navigation Panel-->
	53
	54	<H2><A NAME="SECTION005510000000000000000"></A><A NAME="aeserver-objects"></A>
	55	<BR>
	56	3.5.1 AEServer Objects
	57	</H2>
	58
	59	<P>
	60	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
	61	<td><nobr><b><tt id='l2h-179' xml:id='l2h-179' class="method">installaehandler</tt></b>(</nobr></td>
	62	<td><var>classe, type, callback</var>)</td></tr></table></dt>
	63	<dd>
	64	Installs an AppleEvent handler. <var>classe</var> and <var>type</var> are the
65	four-character OSA Class and Type designators, <code>'****'</code> wildcards
66	are allowed. When a matching AppleEvent is received the parameters are
67	decoded and your callback is invoked.
68	</dl>
69
70	<P>
71	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
72	<td><nobr><b><tt id='l2h-180' xml:id='l2h-180' class="method">callback</tt></b>(</nobr></td>
73	<td><var>_object, **kwargs</var>)</td></tr></table></dt>
74	<dd>
75	Your callback is called with the OSA Direct Object as first positional
76	parameter. The other parameters are passed as keyword arguments, with
77	the 4-character designator as name. Three extra keyword parameters are
78	passed: <code>_class</code> and <code>_type</code> are the Class and Type
79	designators and <code>_attributes</code> is a dictionary with the AppleEvent
80	attributes.
81
82	<P>
83	The return value of your method is packed with
84	<tt class="function">aetools.packevent()</tt> and sent as reply.
85	</dl>
86
87	<P>
88	Note that there are some serious problems with the current
89	design. AppleEvents which have non-identifier 4-character designators
90	for arguments are not implementable, and it is not possible to return
91	an error to the originator. This will be addressed in a future
92	release.
93
94	<P>
95
96	<DIV CLASS="navigation">
97	<div class='online-navigation'>
98	<p></p><hr />
99	<table align="center" width="100%" cellpadding="0" cellspacing="2">
100	<tr>
101	<td class='online-navigation'><a rel="prev" title="3.5 MiniAEFrame "
102	href="module-MiniAEFrame.html"><img src='../icons/previous.png'
103	border='0' height='32' alt='Previous Page' width='32' /></A></td>
104	<td class='online-navigation'><a rel="parent" title="3.5 MiniAEFrame "
105	href="module-MiniAEFrame.html"><img src='../icons/up.png'
106	border='0' height='32' alt='Up One Level' width='32' /></A></td>
107	<td class='online-navigation'><a rel="next" title="4. MacOS Toolbox Modules"
108	href="toolbox.html"><img src='../icons/next.png'
109	border='0' height='32' alt='Next Page' width='32' /></A></td>
110	<td align="center" width="100%">Macintosh Library Modules</td>
111	<td class='online-navigation'><a rel="contents" title="Table of Contents"
112	href="contents.html"><img src='../icons/contents.png'
113	border='0' height='32' alt='Contents' width='32' /></A></td>
114	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
115	border='0' height='32' alt='Module Index' width='32' /></a></td>
116	<td class='online-navigation'><a rel="index" title="Index"
117	href="genindex.html"><img src='../icons/index.png'
118	border='0' height='32' alt='Index' width='32' /></A></td>
119	</tr></table>
120	<div class='online-navigation'>
121	<b class="navlabel">Previous:</b>
122	<a class="sectref" rel="prev" href="module-MiniAEFrame.html">3.5 MiniAEFrame </A>
123	<b class="navlabel">Up:</b>
124	<a class="sectref" rel="parent" href="module-MiniAEFrame.html">3.5 MiniAEFrame </A>
125	<b class="navlabel">Next:</b>
126	<a class="sectref" rel="next" href="toolbox.html">4. MacOS Toolbox Modules</A>
127	</div>
128	</div>
129	<hr />
130	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
131	</DIV>
132	<!--End of Navigation Panel-->
133	<ADDRESS>
134	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
135	</ADDRESS>
136	</BODY>
137	</HTML>