New \grammartoken markup, similar to \token but allowed everywhere.
[python/dscho.git] / Mac / Lib / lib-scriptpackages / Netscape / Mozilla_suite.py
blob57b61b385ad901313c4c30693defde4d48a9ea94
1 """Suite Mozilla suite: Experimental Mozilla suite
2 Level 1, version 1
4 Generated from Macintosh HD:Internet:Internet-programma's:Netscape CommunicatorŽ-map:Netscape CommunicatorŽ
5 AETE/AEUT resource version 1/0, language 0, script 0
6 """
8 import aetools
9 import MacOS
11 _code = 'MOSS'
13 class Mozilla_suite_Events:
15 _argmap_Read_help_file = {
16 'with_index' : 'idid',
17 'search_text' : 'sear',
20 def Read_help_file(self, _object, _attributes={}, **_arguments):
21 """Read help file: Reads in the help file (file should be in the help file format)
22 Required argument: undocumented, typecode 'alis'
23 Keyword argument with_index: Index to the help file. Defaults to •DEFAULTÕ)
24 Keyword argument search_text: Optional text to search for
25 Keyword argument _attributes: AppleEvent attribute dictionary
26 """
27 _code = 'MOSS'
28 _subcode = 'help'
30 aetools.keysubst(_arguments, self._argmap_Read_help_file)
31 _arguments['----'] = _object
34 _reply, _arguments, _attributes = self.send(_code, _subcode,
35 _arguments, _attributes)
36 if _arguments.has_key('errn'):
37 raise aetools.Error, aetools.decodeerror(_arguments)
38 # XXXX Optionally decode result
39 if _arguments.has_key('----'):
40 return _arguments['----']
42 def Open_bookmark(self, _object=None, _attributes={}, **_arguments):
43 """Open bookmark: Reads in a bookmark file
44 Required argument: If not available, reloads the current bookmark file
45 Keyword argument _attributes: AppleEvent attribute dictionary
46 """
47 _code = 'MOSS'
48 _subcode = 'book'
50 if _arguments: raise TypeError, 'No optional args expected'
51 _arguments['----'] = _object
54 _reply, _arguments, _attributes = self.send(_code, _subcode,
55 _arguments, _attributes)
56 if _arguments.has_key('errn'):
57 raise aetools.Error, aetools.decodeerror(_arguments)
58 # XXXX Optionally decode result
59 if _arguments.has_key('----'):
60 return _arguments['----']
62 _argmap_Go = {
63 'direction' : 'dire',
66 def Go(self, _object, _attributes={}, **_arguments):
67 """Go: navigate a window: back, forward, again(reload), home)
68 Required argument: window
69 Keyword argument direction: undocumented, typecode 'dire'
70 Keyword argument _attributes: AppleEvent attribute dictionary
71 """
72 _code = 'MOSS'
73 _subcode = 'gogo'
75 aetools.keysubst(_arguments, self._argmap_Go)
76 _arguments['----'] = _object
78 aetools.enumsubst(_arguments, 'dire', _Enum_dire)
80 _reply, _arguments, _attributes = self.send(_code, _subcode,
81 _arguments, _attributes)
82 if _arguments.has_key('errn'):
83 raise aetools.Error, aetools.decodeerror(_arguments)
84 # XXXX Optionally decode result
85 if _arguments.has_key('----'):
86 return _arguments['----']
88 def Get_workingURL(self, _no_object=None, _attributes={}, **_arguments):
89 """Get workingURL: Get the path to the running application in URL format. This will allow a script to construct a relative URL
90 Keyword argument _attributes: AppleEvent attribute dictionary
91 Returns: Will return text of the from –FILE://foo/applicationname”
92 """
93 _code = 'MOSS'
94 _subcode = 'wurl'
96 if _arguments: raise TypeError, 'No optional args expected'
97 if _no_object != None: raise TypeError, 'No direct arg expected'
100 _reply, _arguments, _attributes = self.send(_code, _subcode,
101 _arguments, _attributes)
102 if _arguments.has_key('errn'):
103 raise aetools.Error, aetools.decodeerror(_arguments)
104 # XXXX Optionally decode result
105 if _arguments.has_key('----'):
106 return _arguments['----']
108 def Open_Profile_Manager(self, _no_object=None, _attributes={}, **_arguments):
109 """Open Profile Manager: Open the user profile manager (obsolete)
110 Keyword argument _attributes: AppleEvent attribute dictionary
112 _code = 'MOSS'
113 _subcode = 'prfl'
115 if _arguments: raise TypeError, 'No optional args expected'
116 if _no_object != None: raise TypeError, 'No direct arg expected'
119 _reply, _arguments, _attributes = self.send(_code, _subcode,
120 _arguments, _attributes)
121 if _arguments.has_key('errn'):
122 raise aetools.Error, aetools.decodeerror(_arguments)
123 # XXXX Optionally decode result
124 if _arguments.has_key('----'):
125 return _arguments['----']
127 def Get_Import_Data(self, _no_object=None, _attributes={}, **_arguments):
128 """Get Import Data: Returns a structure containing information that is of use to an external module in importing data from an external mail application into Communicator.
129 Keyword argument _attributes: AppleEvent attribute dictionary
130 Returns: vRefNum and dirID of profile folder (2+4 bytes), vRefNum and DirID of the local mail folder (2+4 bytes), window type of front window (0 if none, •BrwzÕ browser, •AddrÕ addressbook, •MesgÕ messenger, etc., 4 bytes)
132 _code = 'MOSS'
133 _subcode = 'Impt'
135 if _arguments: raise TypeError, 'No optional args expected'
136 if _no_object != None: raise TypeError, 'No direct arg expected'
139 _reply, _arguments, _attributes = self.send(_code, _subcode,
140 _arguments, _attributes)
141 if _arguments.has_key('errn'):
142 raise aetools.Error, aetools.decodeerror(_arguments)
143 # XXXX Optionally decode result
144 if _arguments.has_key('----'):
145 return _arguments['----']
147 def Get_Profile_Name(self, _no_object=None, _attributes={}, **_arguments):
148 """Get Profile Name: Get the current User Profile
149 Keyword argument _attributes: AppleEvent attribute dictionary
150 Returns: Name of the current profile, like –Joe Bloggs”. This is the name of the profile folder in the Netscape Users folder.
152 _code = 'MOSS'
153 _subcode = 'upro'
155 if _arguments: raise TypeError, 'No optional args expected'
156 if _no_object != None: raise TypeError, 'No direct arg expected'
159 _reply, _arguments, _attributes = self.send(_code, _subcode,
160 _arguments, _attributes)
161 if _arguments.has_key('errn'):
162 raise aetools.Error, aetools.decodeerror(_arguments)
163 # XXXX Optionally decode result
164 if _arguments.has_key('----'):
165 return _arguments['----']
167 def Open_Address_Book(self, _no_object=None, _attributes={}, **_arguments):
168 """Open Address Book: Opens the address book
169 Keyword argument _attributes: AppleEvent attribute dictionary
171 _code = 'MOSS'
172 _subcode = 'addr'
174 if _arguments: raise TypeError, 'No optional args expected'
175 if _no_object != None: raise TypeError, 'No direct arg expected'
178 _reply, _arguments, _attributes = self.send(_code, _subcode,
179 _arguments, _attributes)
180 if _arguments.has_key('errn'):
181 raise aetools.Error, aetools.decodeerror(_arguments)
182 # XXXX Optionally decode result
183 if _arguments.has_key('----'):
184 return _arguments['----']
186 def Open_Component(self, _object, _attributes={}, **_arguments):
187 """Open Component: Open a Communicator component
188 Required argument: The component to open
189 Keyword argument _attributes: AppleEvent attribute dictionary
191 _code = 'MOSS'
192 _subcode = 'cpnt'
194 if _arguments: raise TypeError, 'No optional args expected'
195 _arguments['----'] = _object
198 _reply, _arguments, _attributes = self.send(_code, _subcode,
199 _arguments, _attributes)
200 if _arguments.has_key('errn'):
201 raise aetools.Error, aetools.decodeerror(_arguments)
202 # XXXX Optionally decode result
203 if _arguments.has_key('----'):
204 return _arguments['----']
206 def Handle_command(self, _object, _attributes={}, **_arguments):
207 """Handle command: Handle a command
208 Required argument: The command to handle
209 Keyword argument _attributes: AppleEvent attribute dictionary
211 _code = 'MOSS'
212 _subcode = 'hcmd'
214 if _arguments: raise TypeError, 'No optional args expected'
215 _arguments['----'] = _object
218 _reply, _arguments, _attributes = self.send(_code, _subcode,
219 _arguments, _attributes)
220 if _arguments.has_key('errn'):
221 raise aetools.Error, aetools.decodeerror(_arguments)
222 # XXXX Optionally decode result
223 if _arguments.has_key('----'):
224 return _arguments['----']
226 _Enum_dire = {
227 'again' : 'agai', # Again (reload)
228 'home' : 'home', # Home
229 'backward' : 'prev', # Previous page
230 'forward' : 'next', # Next page
233 _Enum_comp = {
234 'Navigator' : 'navg', # The Navigator component
235 'InBox' : 'inbx', # The InBox component
236 'Newsgroups' : 'colb', # The Newsgroups component
237 'Composer' : 'cpsr', # The Page Composer component
238 'Conference' : 'conf', # The Conference Component
239 'Calendar' : 'cald', # The Calendar Component
242 _Enum_ncmd = {
243 'Get_new_mail' : '\000\000\004W', #
244 'Send_queued_messages' : '\000\000\004X', #
245 'Read_newsgroups' : '\000\000\004\004', #
246 'Show_Inbox' : '\000\000\004\005', #
247 'Show_Bookmarks_window' : '\000\000\004\006', #
248 'Show_History_window' : '\000\000\004\007', #
249 'Show_Address_Book_window' : '\000\000\004\011', #
254 # Indices of types declared in this module
256 _classdeclarations = {
259 _propdeclarations = {
262 _compdeclarations = {
265 _enumdeclarations = {
266 'dire' : _Enum_dire,
267 'comp' : _Enum_comp,
268 'ncmd' : _Enum_ncmd,