Lib/plat-mac/lib-scriptpackages/Netscape/Mozilla_suite.py

   1 """Suite Mozilla suite: Experimental Mozilla suite
   2 Level 1, version 1
   3
   4 Generated from /Volumes/Sap/Applications (Mac OS 9)/Netscape Communicator\xe2\x84\xa2 Folder/Netscape Communicator\xe2\x84\xa2
   5 AETE/AEUT resource version 1/0, language 0, script 0
   6 """
   7
   8 import aetools
   9 import MacOS
  10
  11 _code = 'MOSS'
  12
  13 class Mozilla_suite_Events:
  14
  15     def Get_Import_Data(self, _no_object=None, _attributes={}, **_arguments):
  16         """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.
  17         Keyword argument _attributes: AppleEvent attribute dictionary
  18         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, \xd4Brwz\xd5 browser, \xd4Addr\xd5 addressbook, \xd4Mesg\xd5 messenger, etc., 4 bytes)
  19         """
  20         _code = 'MOSS'
  21         _subcode = 'Impt'
  22
  23         if _arguments: raise TypeError, 'No optional args expected'
  24         if _no_object != None: raise TypeError, 'No direct arg expected'
  25
  26
  27         _reply, _arguments, _attributes = self.send(_code, _subcode,
  28                 _arguments, _attributes)
  29         if _arguments.get('errn', 0):
  30             raise aetools.Error, aetools.decodeerror(_arguments)
  31         # XXXX Optionally decode result
  32         if _arguments.has_key('----'):
  33             return _arguments['----']
  34
  35     def Get_Profile_Name(self, _no_object=None, _attributes={}, **_arguments):
  36         """Get Profile Name: Get the current User Profile
  37         Keyword argument _attributes: AppleEvent attribute dictionary
  38         Returns: Name of the current profile, like \xd2Joe Bloggs\xd3. This is the name of the profile folder in the Netscape Users folder.
  39         """
  40         _code = 'MOSS'
  41         _subcode = 'upro'
  42
  43         if _arguments: raise TypeError, 'No optional args expected'
  44         if _no_object != None: raise TypeError, 'No direct arg expected'
  45
  46
  47         _reply, _arguments, _attributes = self.send(_code, _subcode,
  48                 _arguments, _attributes)
  49         if _arguments.get('errn', 0):
  50             raise aetools.Error, aetools.decodeerror(_arguments)
  51         # XXXX Optionally decode result
  52         if _arguments.has_key('----'):
  53             return _arguments['----']
  54
  55     def Get_workingURL(self, _no_object=None, _attributes={}, **_arguments):
  56         """Get workingURL: Get the path to the running application in URL format.  This will allow a script to construct a relative URL
  57         Keyword argument _attributes: AppleEvent attribute dictionary
  58         Returns: Will return text of the from \xd2FILE://foo/applicationname\xd3
  59         """
  60         _code = 'MOSS'
  61         _subcode = 'wurl'
  62
  63         if _arguments: raise TypeError, 'No optional args expected'
  64         if _no_object != None: raise TypeError, 'No direct arg expected'
  65
  66
  67         _reply, _arguments, _attributes = self.send(_code, _subcode,
  68                 _arguments, _attributes)
  69         if _arguments.get('errn', 0):
  70             raise aetools.Error, aetools.decodeerror(_arguments)
  71         # XXXX Optionally decode result
  72         if _arguments.has_key('----'):
  73             return _arguments['----']
  74
  75     _argmap_Go = {
  76         'direction' : 'dire',
  77     }
  78
  79     def Go(self, _object, _attributes={}, **_arguments):
  80         """Go: navigate a window: back, forward, again(reload), home)
  81         Required argument: window
  82         Keyword argument direction: undocumented, typecode 'dire'
  83         Keyword argument _attributes: AppleEvent attribute dictionary
  84         """
  85         _code = 'MOSS'
  86         _subcode = 'gogo'
  87
  88         aetools.keysubst(_arguments, self._argmap_Go)
  89         _arguments['----'] = _object
  90
  91         aetools.enumsubst(_arguments, 'dire', _Enum_dire)
  92
  93         _reply, _arguments, _attributes = self.send(_code, _subcode,
  94                 _arguments, _attributes)
  95         if _arguments.get('errn', 0):
  96             raise aetools.Error, aetools.decodeerror(_arguments)
  97         # XXXX Optionally decode result
  98         if _arguments.has_key('----'):
  99             return _arguments['----']
 100
 101     def Handle_command(self, _object, _attributes={}, **_arguments):
 102         """Handle command: Handle a command
 103         Required argument: The command to handle
 104         Keyword argument _attributes: AppleEvent attribute dictionary
 105         """
 106         _code = 'MOSS'
 107         _subcode = 'hcmd'
 108
 109         if _arguments: raise TypeError, 'No optional args expected'
 110         _arguments['----'] = _object
 111
 112
 113         _reply, _arguments, _attributes = self.send(_code, _subcode,
 114                 _arguments, _attributes)
 115         if _arguments.get('errn', 0):
 116             raise aetools.Error, aetools.decodeerror(_arguments)
 117         # XXXX Optionally decode result
 118         if _arguments.has_key('----'):
 119             return _arguments['----']
 120
 121     def Open_Address_Book(self, _no_object=None, _attributes={}, **_arguments):
 122         """Open Address Book: Opens the address book
 123         Keyword argument _attributes: AppleEvent attribute dictionary
 124         """
 125         _code = 'MOSS'
 126         _subcode = 'addr'
 127
 128         if _arguments: raise TypeError, 'No optional args expected'
 129         if _no_object != None: raise TypeError, 'No direct arg expected'
 130
 131
 132         _reply, _arguments, _attributes = self.send(_code, _subcode,
 133                 _arguments, _attributes)
 134         if _arguments.get('errn', 0):
 135             raise aetools.Error, aetools.decodeerror(_arguments)
 136         # XXXX Optionally decode result
 137         if _arguments.has_key('----'):
 138             return _arguments['----']
 139
 140     def Open_Component(self, _object, _attributes={}, **_arguments):
 141         """Open Component: Open a Communicator component
 142         Required argument: The component to open
 143         Keyword argument _attributes: AppleEvent attribute dictionary
 144         """
 145         _code = 'MOSS'
 146         _subcode = 'cpnt'
 147
 148         if _arguments: raise TypeError, 'No optional args expected'
 149         _arguments['----'] = _object
 150
 151
 152         _reply, _arguments, _attributes = self.send(_code, _subcode,
 153                 _arguments, _attributes)
 154         if _arguments.get('errn', 0):
 155             raise aetools.Error, aetools.decodeerror(_arguments)
 156         # XXXX Optionally decode result
 157         if _arguments.has_key('----'):
 158             return _arguments['----']
 159
 160     def Open_Profile_Manager(self, _no_object=None, _attributes={}, **_arguments):
 161         """Open Profile Manager: Open the user profile manager (obsolete)
 162         Keyword argument _attributes: AppleEvent attribute dictionary
 163         """
 164         _code = 'MOSS'
 165         _subcode = 'prfl'
 166
 167         if _arguments: raise TypeError, 'No optional args expected'
 168         if _no_object != None: raise TypeError, 'No direct arg expected'
 169
 170
 171         _reply, _arguments, _attributes = self.send(_code, _subcode,
 172                 _arguments, _attributes)
 173         if _arguments.get('errn', 0):
 174             raise aetools.Error, aetools.decodeerror(_arguments)
 175         # XXXX Optionally decode result
 176         if _arguments.has_key('----'):
 177             return _arguments['----']
 178
 179     def Open_bookmark(self, _object=None, _attributes={}, **_arguments):
 180         """Open bookmark: Reads in a bookmark file
 181         Required argument: If not available, reloads the current bookmark file
 182         Keyword argument _attributes: AppleEvent attribute dictionary
 183         """
 184         _code = 'MOSS'
 185         _subcode = 'book'
 186
 187         if _arguments: raise TypeError, 'No optional args expected'
 188         _arguments['----'] = _object
 189
 190
 191         _reply, _arguments, _attributes = self.send(_code, _subcode,
 192                 _arguments, _attributes)
 193         if _arguments.get('errn', 0):
 194             raise aetools.Error, aetools.decodeerror(_arguments)
 195         # XXXX Optionally decode result
 196         if _arguments.has_key('----'):
 197             return _arguments['----']
 198
 199     _argmap_Read_help_file = {
 200         'with_index' : 'idid',
 201         'search_text' : 'sear',
 202     }
 203
 204     def Read_help_file(self, _object, _attributes={}, **_arguments):
 205         """Read help file: Reads in the help file (file should be in the help file format)
 206         Required argument: undocumented, typecode 'alis'
 207         Keyword argument with_index: Index to the help file. Defaults to  \xd4DEFAULT\xd5)
 208         Keyword argument search_text: Optional text to search for
 209         Keyword argument _attributes: AppleEvent attribute dictionary
 210         """
 211         _code = 'MOSS'
 212         _subcode = 'help'
 213
 214         aetools.keysubst(_arguments, self._argmap_Read_help_file)
 215         _arguments['----'] = _object
 216
 217
 218         _reply, _arguments, _attributes = self.send(_code, _subcode,
 219                 _arguments, _attributes)
 220         if _arguments.get('errn', 0):
 221             raise aetools.Error, aetools.decodeerror(_arguments)
 222         # XXXX Optionally decode result
 223         if _arguments.has_key('----'):
 224             return _arguments['----']
 225
 226 _Enum_comp = {
 227     'Navigator' : 'navg',       # The Navigator component
 228     'InBox' : 'inbx',   # The InBox component
 229     'Newsgroups' : 'colb',      # The Newsgroups component
 230     'Composer' : 'cpsr',        # The Page Composer component
 231     'Conference' : 'conf',      # The Conference Component
 232     'Calendar' : 'cald',        # The Calendar Component
 233 }
 234
 235 _Enum_dire = {
 236     'again' : 'agai',   # Again (reload)
 237     'home' : 'home',    # Home
 238     'backward' : 'prev',        # Previous page
 239     'forward' : 'next', # Next page
 240 }
 241
 242 _Enum_ncmd = {
 243     'Get_new_mail' : '\x00\x00\x04W',   #
 244     'Send_queued_messages' : '\x00\x00\x04X',   #
 245     'Read_newsgroups' : '\x00\x00\x04\x04',     #
 246     'Show_Inbox' : '\x00\x00\x04\x05',  #
 247     'Show_Bookmarks_window' : '\x00\x00\x04\x06',       #
 248     'Show_History_window' : '\x00\x00\x04\x07', #
 249     'Show_Address_Book_window' : '\x00\x00\x04\t',      #
 250 }
 251
 252
 253 #
 254 # Indices of types declared in this module
 255 #
 256 _classdeclarations = {
 257 }
 258
 259 _propdeclarations = {
 260 }
 261
 262 _compdeclarations = {
 263 }
 264
 265 _enumdeclarations = {
 266     'comp' : _Enum_comp,
 267     'dire' : _Enum_dire,
 268     'ncmd' : _Enum_ncmd,
 269 }