Mac/OSX/Doc/HelpIndexingTool/Help_Indexing_Tool_Suite.py

   1 """Suite Help Indexing Tool Suite: Special events that just the Help Indexing Tool supports.
   2 Level 0, version 0
   3
   4 Generated from /Developer/Applications/Apple Help Indexing Tool.app
   5 AETE/AEUT resource version 1/1, language 0, script 0
   6 """
   7
   8 import aetools
   9 import MacOS
  10
  11 _code = 'HIT '
  12
  13 class Help_Indexing_Tool_Suite_Events:
  14
  15     def turn_anchor_indexing(self, _object, _attributes={}, **_arguments):
  16         """turn anchor indexing: Turns anchor indexing on or off.
  17         Required argument: \xd2on\xd3 or \xd2off\xd3, to turn anchor indexing on or off
  18         Keyword argument _attributes: AppleEvent attribute dictionary
  19         """
  20         _code = 'HIT '
  21         _subcode = 'tAnc'
  22
  23         if _arguments: raise TypeError, 'No optional args expected'
  24         _arguments['----'] = _object
  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     _argmap_turn_remote_root = {
  36         'with_root_url' : 'rURL',
  37     }
  38
  39     def turn_remote_root(self, _object, _attributes={}, **_arguments):
  40         """turn remote root: Turn usage of remote root for content on the web on or off. If turning \xd2on\xd3, supply a string as second parameter.
  41         Required argument: \xd2on\xd3 or \xd2off\xd3, to turn remote root on or off
  42         Keyword argument with_root_url: The remote root to use, in the form of \xd2http://www.apple.com/help/\xd3.
  43         Keyword argument _attributes: AppleEvent attribute dictionary
  44         """
  45         _code = 'HIT '
  46         _subcode = 'tRem'
  47
  48         aetools.keysubst(_arguments, self._argmap_turn_remote_root)
  49         _arguments['----'] = _object
  50
  51
  52         _reply, _arguments, _attributes = self.send(_code, _subcode,
  53                 _arguments, _attributes)
  54         if _arguments.get('errn', 0):
  55             raise aetools.Error, aetools.decodeerror(_arguments)
  56         # XXXX Optionally decode result
  57         if _arguments.has_key('----'):
  58             return _arguments['----']
  59
  60     def use_tokenizer(self, _object, _attributes={}, **_arguments):
  61         """use tokenizer: Tells the indexing tool which tokenizer to use.
  62         Required argument: Specify \xd2English\xd3, \xd2European\xd3, \xd2Japanese\xd3, \xd2Korean\xd3, or \xd2Simple\xd3.
  63         Keyword argument _attributes: AppleEvent attribute dictionary
  64         """
  65         _code = 'HIT '
  66         _subcode = 'uTok'
  67
  68         if _arguments: raise TypeError, 'No optional args expected'
  69         _arguments['----'] = _object
  70
  71
  72         _reply, _arguments, _attributes = self.send(_code, _subcode,
  73                 _arguments, _attributes)
  74         if _arguments.get('errn', 0):
  75             raise aetools.Error, aetools.decodeerror(_arguments)
  76         # XXXX Optionally decode result
  77         if _arguments.has_key('----'):
  78             return _arguments['----']
  79
  80
  81 class application(aetools.ComponentItem):
  82     """application - Application class """
  83     want = 'capp'
  84 class _Prop_idleStatus(aetools.NProperty):
  85     """idleStatus -  """
  86     which = 'sIdl'
  87     want = 'bool'
  88 application._superclassnames = []
  89 application._privpropdict = {
  90     'idleStatus' : _Prop_idleStatus,
  91 }
  92 application._privelemdict = {
  93 }
  94
  95 #
  96 # Indices of types declared in this module
  97 #
  98 _classdeclarations = {
  99     'capp' : application,
 100 }
 101
 102 _propdeclarations = {
 103     'sIdl' : _Prop_idleStatus,
 104 }
 105
 106 _compdeclarations = {
 107 }
 108
 109 _enumdeclarations = {
 110 }