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


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


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
Membervariables
kw2obj
Methods
WriteKeyword, WriteLetter, addItem, clear, kwIndex, writeIndexBody

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

WriteKeyword (keyword)

Internal method to generate the formatting for keyword.
Argument: keywordThe index phrase whose section is written.

WriteLetter (letter)

Internal method to generate the formatting for all keywords beginning with letter.
Argument: letterThe letter whose section is written.

addItem (phrase object)

Adds the object to the index and associates it with the specified key phrase.
Argument: phraseKeyword the object is indexed under.
Argument: objectThe handle of the added object.

clear ()

Resets state information

kwIndex ()

Constructor, parameterizes the base class.

writeIndexBody ()

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


Generated by AutoDoc 2.1 at 02/15/1999, invoked by Andreas Kupries