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

Description (short): Keyword indices.
Written by: Andreas Kupries
Description: Management of keyword indices.
Keywords: keywords, keyword index, indices

Class 'kwIndex'

Description

Manages a single class index. Entries are the keywords encountered during the scan of the various packages, files, procedures and classes.

Superclasses

azIndex

Methods

public: WriteKeyword (keyword)
WriteLetter (letter)
addItem (phrase object)
clear ()
kwIndex ()
writeIndexBody ()

Membervariables

public: kw2obj

Methods

WriteKeyword (keyword)

Internal method to generate the formatting for keyword.

Argument: keyword The index phrase whose section is written.

WriteLetter (letter)

Internal method to generate the formatting for all keywords beginning with letter.

Argument: letter The letter whose section is written.

addItem (phrase object)

Overrides azIndex:addItem
Adds the object to the index and associates it with the specified key phrase.

Argument: phrase Keyword the object is indexed under.

Argument: object The handle of the added object.

clear ()

Overrides azIndex:clear
Resets state information

kwIndex ()

Constructor, parameterizes the base class.

writeIndexBody ()

Overrides azIndex:writeIndexBody
Overrides base class definition (indexBase:writeIndexBody) to deal with our special index information. Generates the required formatting for this index.

Membervariables

kw2obj: The relevant index information. Maps keywords (key phrases actually) to a list containing the handles of all objects

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

WriteKeyword (keyword)
Internal method to generate the formatting for keyword.
Argument: keyword	The index phrase whose section is written.

WriteLetter (letter)
Internal method to generate the formatting for all keywords beginning with letter.
Argument: letter	The letter whose section is written.

addItem (phrase object)
Overrides azIndex:addItem Adds the object to the index and associates it with the specified key phrase.
Argument: phrase	Keyword the object is indexed under.
Argument: object	The handle of the added object.

writeIndexBody ()
Overrides azIndex:writeIndexBody Overrides base class definition (indexBase:writeIndexBody) to deal with our special index information. Generates the required formatting for this index.