Back to index

python3.2  3.2.2
Public Member Functions | Static Private Attributes
HelpIndexingTool.Help_Indexing_Tool_Suite.Help_Indexing_Tool_Suite_Events Class Reference
Inheritance diagram for HelpIndexingTool.Help_Indexing_Tool_Suite.Help_Indexing_Tool_Suite_Events:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def turn_anchor_indexing
def turn_remote_root
def use_tokenizer

Static Private Attributes

dictionary _argmap_turn_remote_root

Detailed Description

Definition at line 13 of file Help_Indexing_Tool_Suite.py.


Member Function Documentation

def HelpIndexingTool.Help_Indexing_Tool_Suite.Help_Indexing_Tool_Suite_Events.turn_anchor_indexing (   self,
  _object,
  _attributes = {},
  _arguments 
)
turn anchor indexing: Turns anchor indexing on or off.
Required argument: \xd2on\xd3 or \xd2off\xd3, to turn anchor indexing on or off
Keyword argument _attributes: AppleEvent attribute dictionary

Definition at line 15 of file Help_Indexing_Tool_Suite.py.

00015 
00016     def turn_anchor_indexing(self, _object, _attributes={}, **_arguments):
00017         """turn anchor indexing: Turns anchor indexing on or off.
00018         Required argument: \xd2on\xd3 or \xd2off\xd3, to turn anchor indexing on or off
00019         Keyword argument _attributes: AppleEvent attribute dictionary
00020         """
00021         _code = 'HIT '
00022         _subcode = 'tAnc'
00023 
00024         if _arguments: raise TypeError('No optional args expected')
00025         _arguments['----'] = _object
00026 
00027 
00028         _reply, _arguments, _attributes = self.send(_code, _subcode,
00029                 _arguments, _attributes)
00030         if _arguments.get('errn', 0):
00031             raise aetools.Error(aetools.decodeerror(_arguments))
00032         # XXXX Optionally decode result
00033         if _arguments.has_key('----'):
00034             return _arguments['----']

Here is the call graph for this function:

def HelpIndexingTool.Help_Indexing_Tool_Suite.Help_Indexing_Tool_Suite_Events.turn_remote_root (   self,
  _object,
  _attributes = {},
  _arguments 
)
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.
Required argument: \xd2on\xd3 or \xd2off\xd3, to turn remote root on or off
Keyword argument with_root_url: The remote root to use, in the form of \xd2http://www.apple.com/help/\xd3.
Keyword argument _attributes: AppleEvent attribute dictionary

Definition at line 39 of file Help_Indexing_Tool_Suite.py.

00039 
00040     def turn_remote_root(self, _object, _attributes={}, **_arguments):
00041         """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.
00042         Required argument: \xd2on\xd3 or \xd2off\xd3, to turn remote root on or off
00043         Keyword argument with_root_url: The remote root to use, in the form of \xd2http://www.apple.com/help/\xd3.
00044         Keyword argument _attributes: AppleEvent attribute dictionary
00045         """
00046         _code = 'HIT '
00047         _subcode = 'tRem'
00048 
00049         aetools.keysubst(_arguments, self._argmap_turn_remote_root)
00050         _arguments['----'] = _object
00051 
00052 
00053         _reply, _arguments, _attributes = self.send(_code, _subcode,
00054                 _arguments, _attributes)
00055         if _arguments.get('errn', 0):
00056             raise aetools.Error(aetools.decodeerror(_arguments))
00057         # XXXX Optionally decode result
00058         if _arguments.has_key('----'):
00059             return _arguments['----']

Here is the call graph for this function:

def HelpIndexingTool.Help_Indexing_Tool_Suite.Help_Indexing_Tool_Suite_Events.use_tokenizer (   self,
  _object,
  _attributes = {},
  _arguments 
)
use tokenizer: Tells the indexing tool which tokenizer to use.
Required argument: Specify \xd2English\xd3, \xd2European\xd3, \xd2Japanese\xd3, \xd2Korean\xd3, or \xd2Simple\xd3.
Keyword argument _attributes: AppleEvent attribute dictionary

Definition at line 60 of file Help_Indexing_Tool_Suite.py.

00060 
00061     def use_tokenizer(self, _object, _attributes={}, **_arguments):
00062         """use tokenizer: Tells the indexing tool which tokenizer to use.
00063         Required argument: Specify \xd2English\xd3, \xd2European\xd3, \xd2Japanese\xd3, \xd2Korean\xd3, or \xd2Simple\xd3.
00064         Keyword argument _attributes: AppleEvent attribute dictionary
00065         """
00066         _code = 'HIT '
00067         _subcode = 'uTok'
00068 
00069         if _arguments: raise TypeError('No optional args expected')
00070         _arguments['----'] = _object
00071 
00072 
00073         _reply, _arguments, _attributes = self.send(_code, _subcode,
00074                 _arguments, _attributes)
00075         if _arguments.get('errn', 0):
00076             raise aetools.Error(aetools.decodeerror(_arguments))
00077         # XXXX Optionally decode result
00078         if _arguments.has_key('----'):
00079             return _arguments['----']
00080 

Here is the call graph for this function:


Member Data Documentation

Initial value:
{
        'with_root_url' : 'rURL',
    }

Definition at line 35 of file Help_Indexing_Tool_Suite.py.


The documentation for this class was generated from the following file: