File 'lib/indexBaseEntry.cls' (part of 'AutoDOC')

Home | Packages | Files | Procedures | Classes | Namespaces | Keywords | External packages

Description (short)
General interface of an index entry.
Written by
Andreas Kupries
Description
General interface of an index entry.
Keywords
index entries, general interface to index entry.

Class 'indexBaseEntry'

Description
Interface common to all objects used by indices. Manages the object name, a reference to the index it is part of and location information.
Superclasses
distInterface
formatterInterface
Options
name
index
Methods
public
link ()
name ()
page ()
short ()
Membervariables
public
page
shortDescription
entity

Options

-name
The name of the indexed object. Empty by default.
-index
Handle of the index containing this object. Automatically set during addition of this object to its index.

Methods

link ()
Returns: a string containing a hyperlink to the page of this object. The name of the object is used for the textual part of the link. Uses the current formatter object to obtain the data.

name ()
Returns: the name of this object.

page ()
Retrieval interface to the location information. Generates a unique page upon the first call and then returns always this information.

short ()
Returns: the short description of the object.

Membervariables

page
Name of the file containing the page describing this object. Defaults to {}, which is an indicator that the information was never requested before too.
shortDescription
A short description of the object. This text is used by the index to embellish the reference to the page of the object and give a user hints about the purpose of the object
entity
The type of the entity described by the object. Derived classes have to overide the default value (in their constructor).
initial value: entity

Home | Packages | Files | Procedures | Classes | Namespaces | Keywords | External packages

Generated by AutoDoc 2.4 at 09/28/2001, invoked by Andreas Kupries,,,