1 """Suite Web Browser Suite: Class of events which are sent to Web Browser applications
4 Generated from Macintosh HD:Internet:Internet-programma's:Internet Explorer 4.5-map:Internet Explorer 4.5
5 AETE/AEUT resource version 1/0, language 0, script 0
13 class Web_Browser_Suite_Events
:
21 'ProgressApp' : 'PROG',
25 def OpenURL(self
, _object
, _attributes
={}, **_arguments
):
26 """OpenURL: Retrieves URL off the Web.
27 Required argument: Fully specified URL
28 Keyword argument to: File to save downloaded data into.
29 Keyword argument toWindow: Window to open this URL into. (Use -1 for top window, 0 for new window)
30 Keyword argument Flags: Valid Flags settings are: 1-Ignore the document cache; 2-Ignore the image cache; 4-Operate in background mode.
31 Keyword argument FormData: Posting of forms of a given MIMEType.
32 Keyword argument MIMEType: MIME type for the FormData.
33 Keyword argument ProgressApp: If specified, ProgressApp can be named to handle the user interface for process messages.
34 Keyword argument ResultApp: When the requested URL has been accessed and all associated documents loaded, the Web browser will issue an OpenURLResult to the ResultApp.
35 Keyword argument _attributes: AppleEvent attribute dictionary
36 Returns: TransactionID
41 aetools
.keysubst(_arguments
, self
._argmap
_OpenURL
)
42 _arguments
['----'] = _object
45 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
46 _arguments
, _attributes
)
47 if _arguments
.has_key('errn'):
48 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
49 # XXXX Optionally decode result
50 if _arguments
.has_key('----'):
51 return _arguments
['----']
60 def ShowFile(self
, _object
, _attributes
={}, **_arguments
):
61 """ShowFile: Passes FileSpec containing data of a given MIME type to be rendered in a given WindowID.
62 Required argument: The file to show.
63 Keyword argument MIME_type: MIME type
64 Keyword argument Window_ID: ID of the window to open the file into. (Can use -1 for top window)
65 Keyword argument URL: A URL which allows this document to be reloaded if necessary.
66 Keyword argument ResultApp: When the requested URL has been accessed and all associated documents loaded, the Web browser will issue a ShowFileResult to the ResultApp.
67 Keyword argument _attributes: AppleEvent attribute dictionary
68 Returns: TransactionID
73 aetools
.keysubst(_arguments
, self
._argmap
_ShowFile
)
74 _arguments
['----'] = _object
77 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
78 _arguments
, _attributes
)
79 if _arguments
.has_key('errn'):
80 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
81 # XXXX Optionally decode result
82 if _arguments
.has_key('----'):
83 return _arguments
['----']
85 def CancelTransaction(self
, _object
, _attributes
={}, **_arguments
):
86 """CancelTransaction: Tells the Web browser to cancel a TransactionID is progress which the application has initiated via an OpenURL or ShowFile command.
87 Required argument: TransactionID
88 Keyword argument _attributes: AppleEvent attribute dictionary
93 if _arguments
: raise TypeError, 'No optional args expected'
94 _arguments
['----'] = _object
97 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
98 _arguments
, _attributes
)
99 if _arguments
.has_key('errn'):
100 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
101 # XXXX Optionally decode result
102 if _arguments
.has_key('----'):
103 return _arguments
['----']
105 _argmap_QueryVersion
= {
106 'Major_Version' : 'MAJV',
107 'Minor_Version' : 'MINV',
110 def QueryVersion(self
, _no_object
=None, _attributes
={}, **_arguments
):
111 """QueryVersion: Tells the Web browser that an application which wishes to communicate with it supports a specific version (major.minor) of this SDI specification
112 Keyword argument Major_Version: Major version of the SDI specification the sending application supports.
113 Keyword argument Minor_Version: Minor version of the SDI specification the sending application supports.
114 Keyword argument _attributes: AppleEvent attribute dictionary
120 aetools
.keysubst(_arguments
, self
._argmap
_QueryVersion
)
121 if _no_object
!= None: raise TypeError, 'No direct arg expected'
124 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
125 _arguments
, _attributes
)
126 if _arguments
.has_key('errn'):
127 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
128 # XXXX Optionally decode result
129 if _arguments
.has_key('----'):
130 return _arguments
['----']
132 def CloseAllWindows(self
, _no_object
=None, _attributes
={}, **_arguments
):
133 """CloseAllWindows: Tells the Web browser to close all windows
134 Keyword argument _attributes: AppleEvent attribute dictionary
140 if _arguments
: raise TypeError, 'No optional args expected'
141 if _no_object
!= None: raise TypeError, 'No direct arg expected'
144 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
145 _arguments
, _attributes
)
146 if _arguments
.has_key('errn'):
147 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
148 # XXXX Optionally decode result
149 if _arguments
.has_key('----'):
150 return _arguments
['----']
152 _argmap_CloseWindow
= {
157 def CloseWindow(self
, _no_object
=None, _attributes
={}, **_arguments
):
158 """CloseWindow: Tells the Web browser to close the window specified either by Window ID or Title. If no parameters are specified, the top window will be closed.
159 Keyword argument ID: ID of the window to close. (Can use -1 for top window)
160 Keyword argument Title: Title of the window to close.
161 Keyword argument _attributes: AppleEvent attribute dictionary
167 aetools
.keysubst(_arguments
, self
._argmap
_CloseWindow
)
168 if _no_object
!= None: raise TypeError, 'No direct arg expected'
171 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
172 _arguments
, _attributes
)
173 if _arguments
.has_key('errn'):
174 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
175 # XXXX Optionally decode result
176 if _arguments
.has_key('----'):
177 return _arguments
['----']
183 def Activate(self
, _object
=None, _attributes
={}, **_arguments
):
184 """Activate: Tells the Web browser to bring itself to the front and show WindowID. (Can use -1 for top window)
185 Required argument: WindowID
186 Keyword argument Flags: Reserved for future use
187 Keyword argument _attributes: AppleEvent attribute dictionary
188 Returns: WindowID of the front window
193 aetools
.keysubst(_arguments
, self
._argmap
_Activate
)
194 _arguments
['----'] = _object
197 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
198 _arguments
, _attributes
)
199 if _arguments
.has_key('errn'):
200 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
201 # XXXX Optionally decode result
202 if _arguments
.has_key('----'):
203 return _arguments
['----']
205 def ListWindows(self
, _no_object
=None, _attributes
={}, **_arguments
):
206 """ListWindows: Return a list of WindowIDs representing each windows currently being used by the Web browser.
207 Keyword argument _attributes: AppleEvent attribute dictionary
208 Returns: undocumented, typecode 'list'
213 if _arguments
: raise TypeError, 'No optional args expected'
214 if _no_object
!= None: raise TypeError, 'No direct arg expected'
217 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
218 _arguments
, _attributes
)
219 if _arguments
.has_key('errn'):
220 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
221 # XXXX Optionally decode result
222 if _arguments
.has_key('----'):
223 return _arguments
['----']
225 def GetWindowInfo(self
, _object
, _attributes
={}, **_arguments
):
226 """GetWindowInfo: Returns a window info record (URL/Title) for the specified window.
227 Required argument: WindowID of the window to get info about
228 Keyword argument _attributes: AppleEvent attribute dictionary
234 if _arguments
: raise TypeError, 'No optional args expected'
235 _arguments
['----'] = _object
238 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
239 _arguments
, _attributes
)
240 if _arguments
.has_key('errn'):
241 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
242 # XXXX Optionally decode result
243 if _arguments
.has_key('----'):
244 return _arguments
['----']
246 _argmap_ParseAnchor
= {
250 def ParseAnchor(self
, _object
, _attributes
={}, **_arguments
):
251 """ParseAnchor: Combine a base URL and a relative URL to produce a fully-specified URL
252 Required argument: MainURL.The base URL.
253 Keyword argument withURL: RelativeURL, which, when combined with the MainURL (in the direct object), is used to produce a fully-specified URL.
254 Keyword argument _attributes: AppleEvent attribute dictionary
255 Returns: The Fully specified URL
260 aetools
.keysubst(_arguments
, self
._argmap
_ParseAnchor
)
261 _arguments
['----'] = _object
264 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
265 _arguments
, _attributes
)
266 if _arguments
.has_key('errn'):
267 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
268 # XXXX Optionally decode result
269 if _arguments
.has_key('----'):
270 return _arguments
['----']
272 _argmap_BeginProgress
= {
273 'with_Message' : 'PMSG',
276 def BeginProgress(self
, _object
, _attributes
={}, **_arguments
):
277 """BeginProgress: Initialize a progress indicator.
278 Required argument: TransactionID
279 Keyword argument with_Message: Message to display with the progress indicator.
280 Keyword argument _attributes: AppleEvent attribute dictionary
286 aetools
.keysubst(_arguments
, self
._argmap
_BeginProgress
)
287 _arguments
['----'] = _object
290 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
291 _arguments
, _attributes
)
292 if _arguments
.has_key('errn'):
293 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
294 # XXXX Optionally decode result
295 if _arguments
.has_key('----'):
296 return _arguments
['----']
298 _argmap_SetProgressRange
= {
302 def SetProgressRange(self
, _object
, _attributes
={}, **_arguments
):
303 """SetProgressRange: Sets a max value for the progress indicator associated with TransactionID
304 Required argument: TransactionID
305 Keyword argument Max: Max value for this progress indicator
306 Keyword argument _attributes: AppleEvent attribute dictionary
311 aetools
.keysubst(_arguments
, self
._argmap
_SetProgressRange
)
312 _arguments
['----'] = _object
315 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
316 _arguments
, _attributes
)
317 if _arguments
.has_key('errn'):
318 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
319 # XXXX Optionally decode result
320 if _arguments
.has_key('----'):
321 return _arguments
['----']
323 _argmap_MakingProgress
= {
324 'with_message' : 'PMSG',
325 'current_setting' : 'CURR',
328 def MakingProgress(self
, _object
, _attributes
={}, **_arguments
):
329 """MakingProgress: Updates the progress indicator associated with TransactionID
330 Required argument: TransactionID
331 Keyword argument with_message: Message to display in the progress indicator
332 Keyword argument current_setting: Current value of the progress indicator
333 Keyword argument _attributes: AppleEvent attribute dictionary
339 aetools
.keysubst(_arguments
, self
._argmap
_MakingProgress
)
340 _arguments
['----'] = _object
343 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
344 _arguments
, _attributes
)
345 if _arguments
.has_key('errn'):
346 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
347 # XXXX Optionally decode result
348 if _arguments
.has_key('----'):
349 return _arguments
['----']
351 def EndProgress(self
, _object
, _attributes
={}, **_arguments
):
352 """EndProgress: Nortifies the application that the progress indicator associated with TransactionID is no longer needed.
353 Required argument: TransactionID
354 Keyword argument _attributes: AppleEvent attribute dictionary
359 if _arguments
: raise TypeError, 'No optional args expected'
360 _arguments
['----'] = _object
363 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
364 _arguments
, _attributes
)
365 if _arguments
.has_key('errn'):
366 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
367 # XXXX Optionally decode result
368 if _arguments
.has_key('----'):
369 return _arguments
['----']
371 def RegisterDone(self
, _object
, _attributes
={}, **_arguments
):
372 """RegisterDone: Signals that all processing initiated by the RegisteNow event associated by TransactionID has finished.
373 Required argument: TransactionID
374 Keyword argument _attributes: AppleEvent attribute dictionary
375 Returns: 0 = failure; 1 = success; 2 = sending application needs more time to complete operation.
380 if _arguments
: raise TypeError, 'No optional args expected'
381 _arguments
['----'] = _object
384 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
385 _arguments
, _attributes
)
386 if _arguments
.has_key('errn'):
387 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
388 # XXXX Optionally decode result
389 if _arguments
.has_key('----'):
390 return _arguments
['----']
392 _argmap_RegisterProtocol
= {
396 def RegisterProtocol(self
, _object
, _attributes
={}, **_arguments
):
397 """RegisterProtocol: Notifies that the sending application is able to handle all URLs for the specified protocol.
398 Required argument: application
399 Keyword argument _for: Protocol, such as NEWS, MAILTO, etc...
400 Keyword argument _attributes: AppleEvent attribute dictionary
406 aetools
.keysubst(_arguments
, self
._argmap
_RegisterProtocol
)
407 _arguments
['----'] = _object
410 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
411 _arguments
, _attributes
)
412 if _arguments
.has_key('errn'):
413 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
414 # XXXX Optionally decode result
415 if _arguments
.has_key('----'):
416 return _arguments
['----']
418 _argmap_UnRegisterProtocol
= {
422 def UnRegisterProtocol(self
, _object
, _attributes
={}, **_arguments
):
423 """UnRegisterProtocol: Notifies that the sending application is no longer wishes to handle URLs for the specified protocol.
424 Required argument: application
425 Keyword argument _for: Protocol, such as NEWS, MAILTO, etc...
426 Keyword argument _attributes: AppleEvent attribute dictionary
431 aetools
.keysubst(_arguments
, self
._argmap
_UnRegisterProtocol
)
432 _arguments
['----'] = _object
435 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
436 _arguments
, _attributes
)
437 if _arguments
.has_key('errn'):
438 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
439 # XXXX Optionally decode result
440 if _arguments
.has_key('----'):
441 return _arguments
['----']
443 _argmap_RegisterViewer
= {
449 def RegisterViewer(self
, _object
, _attributes
={}, **_arguments
):
450 """RegisterViewer: Notifies that the sending application is able to handle all documents for the specified MIMEType.
451 Required argument: application
452 Keyword argument _for: MIMEType
453 Keyword argument as: File type for saved documents
454 Keyword argument Flags: undocumented, typecode 'shor'
455 Keyword argument _attributes: AppleEvent attribute dictionary
460 aetools
.keysubst(_arguments
, self
._argmap
_RegisterViewer
)
461 _arguments
['----'] = _object
464 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
465 _arguments
, _attributes
)
466 if _arguments
.has_key('errn'):
467 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
468 # XXXX Optionally decode result
469 if _arguments
.has_key('----'):
470 return _arguments
['----']
472 _argmap_UnRegisterViewer
= {
476 def UnRegisterViewer(self
, _object
, _attributes
={}, **_arguments
):
477 """UnRegisterViewer: Notifies that the sending application is no longer wishes to handle documents of the specified MIMEType.
478 Required argument: application
479 Keyword argument _for: MIMEType
480 Keyword argument _attributes: AppleEvent attribute dictionary
485 aetools
.keysubst(_arguments
, self
._argmap
_UnRegisterViewer
)
486 _arguments
['----'] = _object
489 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
490 _arguments
, _attributes
)
491 if _arguments
.has_key('errn'):
492 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
493 # XXXX Optionally decode result
494 if _arguments
.has_key('----'):
495 return _arguments
['----']
497 def RegisterURLEcho(self
, _object
, _attributes
={}, **_arguments
):
498 """RegisterURLEcho: Notifies that the sending application would like to receive EchoURL events.
499 Required argument: application
500 Keyword argument _attributes: AppleEvent attribute dictionary
506 if _arguments
: raise TypeError, 'No optional args expected'
507 _arguments
['----'] = _object
510 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
511 _arguments
, _attributes
)
512 if _arguments
.has_key('errn'):
513 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
514 # XXXX Optionally decode result
515 if _arguments
.has_key('----'):
516 return _arguments
['----']
518 def UnRegisterURLEcho(self
, _object
, _attributes
={}, **_arguments
):
519 """UnRegisterURLEcho: Notifies that the sending application would no longer like to receive EchoURL events.
520 Required argument: application
521 Keyword argument _attributes: AppleEvent attribute dictionary
526 if _arguments
: raise TypeError, 'No optional args expected'
527 _arguments
['----'] = _object
530 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
531 _arguments
, _attributes
)
532 if _arguments
.has_key('errn'):
533 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
534 # XXXX Optionally decode result
535 if _arguments
.has_key('----'):
536 return _arguments
['----']
538 def RegisterWindowClose(self
, _object
, _attributes
={}, **_arguments
):
539 """RegisterWindowClose: Notifies that the sending application would like to receive WindowClose events.
540 Required argument: application
541 Keyword argument _attributes: AppleEvent attribute dictionary
546 if _arguments
: raise TypeError, 'No optional args expected'
547 _arguments
['----'] = _object
550 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
551 _arguments
, _attributes
)
552 if _arguments
.has_key('errn'):
553 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
554 # XXXX Optionally decode result
555 if _arguments
.has_key('----'):
556 return _arguments
['----']
558 def UnRegisterWindowClose(self
, _object
, _attributes
={}, **_arguments
):
559 """UnRegisterWindowClose: Notifies that the sending application would no longer like to receive WindowClose events.
560 Required argument: application
561 Keyword argument _attributes: AppleEvent attribute dictionary
566 if _arguments
: raise TypeError, 'No optional args expected'
567 _arguments
['----'] = _object
570 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
571 _arguments
, _attributes
)
572 if _arguments
.has_key('errn'):
573 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
574 # XXXX Optionally decode result
575 if _arguments
.has_key('----'):
576 return _arguments
['----']
578 def RegisterAppClose(self
, _object
, _attributes
={}, **_arguments
):
579 """RegisterAppClose: Notifies that the sending application would like to receive AppClose events.
580 Required argument: application
581 Keyword argument _attributes: AppleEvent attribute dictionary
586 if _arguments
: raise TypeError, 'No optional args expected'
587 _arguments
['----'] = _object
590 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
591 _arguments
, _attributes
)
592 if _arguments
.has_key('errn'):
593 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
594 # XXXX Optionally decode result
595 if _arguments
.has_key('----'):
596 return _arguments
['----']
598 def UnRegisterAppClose(self
, _object
, _attributes
={}, **_arguments
):
599 """UnRegisterAppClose: Notifies that the sending application would no longer like to receive AppClose events.
600 Required argument: application
601 Keyword argument _attributes: AppleEvent attribute dictionary
606 if _arguments
: raise TypeError, 'No optional args expected'
607 _arguments
['----'] = _object
610 _reply
, _arguments
, _attributes
= self
.send(_code
, _subcode
,
611 _arguments
, _attributes
)
612 if _arguments
.has_key('errn'):
613 raise aetools
.Error
, aetools
.decodeerror(_arguments
)
614 # XXXX Optionally decode result
615 if _arguments
.has_key('----'):
616 return _arguments
['----']
620 # Indices of types declared in this module
622 _classdeclarations
= {
625 _propdeclarations
= {
628 _compdeclarations
= {
631 _enumdeclarations
= {