Back to index

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

List of all members.

Public Member Functions

def close
def data_size
def get
def make
def open
def print_
def save
def set
def turn_anchor_indexing
def turn_remote_root
def use_tokenizer
def select
def revert

Static Private Attributes

string _signature = 'hiti'
string _moduleName = 'HelpIndexingTool'

Detailed Description

Definition at line 75 of file __init__.py.


Member Function Documentation

def HelpIndexingTool.Standard_Suite.Standard_Suite_Events.close (   self,
  _object,
  _attributes = {},
  _arguments 
) [inherited]
close: Close an object
Required argument: the objects to close
Keyword argument saving: specifies whether or not changes should be saved before closing
Keyword argument in_: the file in which to save the object
Keyword argument _attributes: AppleEvent attribute dictionary

Definition at line 21 of file Standard_Suite.py.

00021 
00022     def close(self, _object, _attributes={}, **_arguments):
00023         """close: Close an object
00024         Required argument: the objects to close
00025         Keyword argument saving: specifies whether or not changes should be saved before closing
00026         Keyword argument in_: the file in which to save the object
00027         Keyword argument _attributes: AppleEvent attribute dictionary
00028         """
00029         _code = 'core'
00030         _subcode = 'clos'
00031 
00032         aetools.keysubst(_arguments, self._argmap_close)
00033         _arguments['----'] = _object
00034 
00035         aetools.enumsubst(_arguments, 'savo', _Enum_savo)
00036 
00037         _reply, _arguments, _attributes = self.send(_code, _subcode,
00038                 _arguments, _attributes)
00039         if _arguments.get('errn', 0):
00040             raise aetools.Error(aetools.decodeerror(_arguments))
00041         # XXXX Optionally decode result
00042         if _arguments.has_key('----'):
00043             return _arguments['----']

Here is the call graph for this function:

Here is the caller graph for this function:

def HelpIndexingTool.Standard_Suite.Standard_Suite_Events.data_size (   self,
  _object,
  _attributes = {},
  _arguments 
) [inherited]
data size: Return the size in bytes of an object
Required argument: the object whose data size is to be returned
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: the size of the object in bytes

Definition at line 44 of file Standard_Suite.py.

00044 
00045     def data_size(self, _object, _attributes={}, **_arguments):
00046         """data size: Return the size in bytes of an object
00047         Required argument: the object whose data size is to be returned
00048         Keyword argument _attributes: AppleEvent attribute dictionary
00049         Returns: the size of the object in bytes
00050         """
00051         _code = 'core'
00052         _subcode = 'dsiz'
00053 
00054         if _arguments: raise TypeError('No optional args expected')
00055         _arguments['----'] = _object
00056 
00057 
00058         _reply, _arguments, _attributes = self.send(_code, _subcode,
00059                 _arguments, _attributes)
00060         if _arguments.get('errn', 0):
00061             raise aetools.Error(aetools.decodeerror(_arguments))
00062         # XXXX Optionally decode result
00063         if _arguments.has_key('----'):
00064             return _arguments['----']

Here is the call graph for this function:

def HelpIndexingTool.Standard_Suite.Standard_Suite_Events.get (   self,
  _object,
  _attributes = {},
  _arguments 
) [inherited]
get: Get the data for an object
Required argument: the object whose data is to be returned
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: The data from the object

Definition at line 65 of file Standard_Suite.py.

00065 
00066     def get(self, _object, _attributes={}, **_arguments):
00067         """get: Get the data for an object
00068         Required argument: the object whose data is to be returned
00069         Keyword argument _attributes: AppleEvent attribute dictionary
00070         Returns: The data from the object
00071         """
00072         _code = 'core'
00073         _subcode = 'getd'
00074 
00075         if _arguments: raise TypeError('No optional args expected')
00076         _arguments['----'] = _object
00077 
00078 
00079         _reply, _arguments, _attributes = self.send(_code, _subcode,
00080                 _arguments, _attributes)
00081         if _arguments.get('errn', 0):
00082             raise aetools.Error(aetools.decodeerror(_arguments))
00083         # XXXX Optionally decode result
00084         if _arguments.has_key('----'):
00085             return _arguments['----']

Here is the call graph for this function:

Here is the caller graph for this function:

def HelpIndexingTool.Standard_Suite.Standard_Suite_Events.make (   self,
  _no_object = None,
  _attributes = {},
  _arguments 
) [inherited]
make: Make a new element
Keyword argument new: the class of the new element
Keyword argument at: the location at which to insert the element
Keyword argument with_data: the initial data for the element
Keyword argument with_properties: the initial values for the properties of the element
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Object specifier for the new element

Definition at line 93 of file Standard_Suite.py.

00093 
00094     def make(self, _no_object=None, _attributes={}, **_arguments):
00095         """make: Make a new element
00096         Keyword argument new: the class of the new element
00097         Keyword argument at: the location at which to insert the element
00098         Keyword argument with_data: the initial data for the element
00099         Keyword argument with_properties: the initial values for the properties of the element
00100         Keyword argument _attributes: AppleEvent attribute dictionary
00101         Returns: Object specifier for the new element
00102         """
00103         _code = 'core'
00104         _subcode = 'crel'
00105 
00106         aetools.keysubst(_arguments, self._argmap_make)
00107         if _no_object is not None: raise TypeError('No direct arg expected')
00108 
00109 
00110         _reply, _arguments, _attributes = self.send(_code, _subcode,
00111                 _arguments, _attributes)
00112         if _arguments.get('errn', 0):
00113             raise aetools.Error(aetools.decodeerror(_arguments))
00114         # XXXX Optionally decode result
00115         if _arguments.has_key('----'):
00116             return _arguments['----']

Here is the call graph for this function:

def HelpIndexingTool.Standard_Suite.Standard_Suite_Events.open (   self,
  _object,
  _attributes = {},
  _arguments 
) [inherited]
open: Open the specified object(s)
Required argument: Objects to open. Can be a list of files or an object specifier.
Keyword argument _attributes: AppleEvent attribute dictionary

Definition at line 117 of file Standard_Suite.py.

00117 
00118     def open(self, _object, _attributes={}, **_arguments):
00119         """open: Open the specified object(s)
00120         Required argument: Objects to open. Can be a list of files or an object specifier.
00121         Keyword argument _attributes: AppleEvent attribute dictionary
00122         """
00123         _code = 'aevt'
00124         _subcode = 'odoc'
00125 
00126         if _arguments: raise TypeError('No optional args expected')
00127         _arguments['----'] = _object
00128 
00129 
00130         _reply, _arguments, _attributes = self.send(_code, _subcode,
00131                 _arguments, _attributes)
00132         if _arguments.get('errn', 0):
00133             raise aetools.Error(aetools.decodeerror(_arguments))
00134         # XXXX Optionally decode result
00135         if _arguments.has_key('----'):
00136             return _arguments['----']

Here is the call graph for this function:

def HelpIndexingTool.Standard_Suite.Standard_Suite_Events.print_ (   self,
  _object,
  _attributes = {},
  _arguments 
) [inherited]
print: Print the specified object(s)
Required argument: Objects to print. Can be a list of files or an object specifier.
Keyword argument _attributes: AppleEvent attribute dictionary

Definition at line 137 of file Standard_Suite.py.

00137 
00138     def print_(self, _object, _attributes={}, **_arguments):
00139         """print: Print the specified object(s)
00140         Required argument: Objects to print. Can be a list of files or an object specifier.
00141         Keyword argument _attributes: AppleEvent attribute dictionary
00142         """
00143         _code = 'aevt'
00144         _subcode = 'pdoc'
00145 
00146         if _arguments: raise TypeError('No optional args expected')
00147         _arguments['----'] = _object
00148 
00149 
00150         _reply, _arguments, _attributes = self.send(_code, _subcode,
00151                 _arguments, _attributes)
00152         if _arguments.get('errn', 0):
00153             raise aetools.Error(aetools.decodeerror(_arguments))
00154         # XXXX Optionally decode result
00155         if _arguments.has_key('----'):
00156             return _arguments['----']

Here is the call graph for this function:

def HelpIndexingTool.Miscellaneous_Standards.Miscellaneous_Standards_Events.revert (   self,
  _object,
  _attributes = {},
  _arguments 
) [inherited]
revert: Revert an object to the most recently saved version
Required argument: object to revert
Keyword argument _attributes: AppleEvent attribute dictionary

Definition at line 15 of file Miscellaneous_Standards.py.

00015 
00016     def revert(self, _object, _attributes={}, **_arguments):
00017         """revert: Revert an object to the most recently saved version
00018         Required argument: object to revert
00019         Keyword argument _attributes: AppleEvent attribute dictionary
00020         """
00021         _code = 'misc'
00022         _subcode = 'rvrt'
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['----']
00035 
00036 
00037 #
00038 # Indices of types declared in this module
#

Here is the call graph for this function:

def HelpIndexingTool.Standard_Suite.Standard_Suite_Events.save (   self,
  _object,
  _attributes = {},
  _arguments 
) [inherited]
save: save a set of objects
Required argument: Objects to save.
Keyword argument in_: the file in which to save the object(s)
Keyword argument as: the file type of the document in which to save the data
Keyword argument _attributes: AppleEvent attribute dictionary

Definition at line 162 of file Standard_Suite.py.

00162 
00163     def save(self, _object, _attributes={}, **_arguments):
00164         """save: save a set of objects
00165         Required argument: Objects to save.
00166         Keyword argument in_: the file in which to save the object(s)
00167         Keyword argument as: the file type of the document in which to save the data
00168         Keyword argument _attributes: AppleEvent attribute dictionary
00169         """
00170         _code = 'core'
00171         _subcode = 'save'
00172 
00173         aetools.keysubst(_arguments, self._argmap_save)
00174         _arguments['----'] = _object
00175 
00176 
00177         _reply, _arguments, _attributes = self.send(_code, _subcode,
00178                 _arguments, _attributes)
00179         if _arguments.get('errn', 0):
00180             raise aetools.Error(aetools.decodeerror(_arguments))
00181         # XXXX Optionally decode result
00182         if _arguments.has_key('----'):
00183             return _arguments['----']

Here is the call graph for this function:

def HelpIndexingTool.odds_and_ends.odds_and_ends_Events.select (   self,
  _object = None,
  _attributes = {},
  _arguments 
) [inherited]
select: Select the specified object
Required argument: the object to select
Keyword argument _attributes: AppleEvent attribute dictionary

Definition at line 15 of file odds_and_ends.py.

00015 
00016     def select(self, _object=None, _attributes={}, **_arguments):
00017         """select: Select the specified object
00018         Required argument: the object to select
00019         Keyword argument _attributes: AppleEvent attribute dictionary
00020         """
00021         _code = 'misc'
00022         _subcode = 'slct'
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['----']
00035 
00036 
00037 #
00038 # Indices of types declared in this module
#

Here is the call graph for this function:

def HelpIndexingTool.Standard_Suite.Standard_Suite_Events.set (   self,
  _object,
  _attributes = {},
  _arguments 
) [inherited]
set: Set an object\xd5s data
Required argument: the object to change
Keyword argument to: the new value
Keyword argument _attributes: AppleEvent attribute dictionary

Definition at line 188 of file Standard_Suite.py.

00188 
00189     def set(self, _object, _attributes={}, **_arguments):
00190         """set: Set an object\xd5s data
00191         Required argument: the object to change
00192         Keyword argument to: the new value
00193         Keyword argument _attributes: AppleEvent attribute dictionary
00194         """
00195         _code = 'core'
00196         _subcode = 'setd'
00197 
00198         aetools.keysubst(_arguments, self._argmap_set)
00199         _arguments['----'] = _object
00200 
00201 
00202         _reply, _arguments, _attributes = self.send(_code, _subcode,
00203                 _arguments, _attributes)
00204         if _arguments.get('errn', 0):
00205             raise aetools.Error(aetools.decodeerror(_arguments))
00206         # XXXX Optionally decode result
00207         if _arguments.has_key('----'):
00208             return _arguments['----']
00209 

Here is the call graph for this function:

Here is the caller graph for this function:

def HelpIndexingTool.Help_Indexing_Tool_Suite.Help_Indexing_Tool_Suite_Events.turn_anchor_indexing (   self,
  _object,
  _attributes = {},
  _arguments 
) [inherited]
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 
) [inherited]
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 
) [inherited]
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

Definition at line 78 of file __init__.py.

Definition at line 76 of file __init__.py.


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