HtmlHelpIndex Class Reference

List of all members.

Public Member Functions

 HtmlHelpIndex ()
 ~HtmlHelpIndex ()
void addItem (const char *first, const char *second, const char *url, const char *anchor, bool hasLink, bool reversed)
void writeFields (QTextStream &t)

Detailed Description

A helper class for HtmlHelp that manages a two level index in alphabetical order

Definition at line 70 of file htmlhelp.cpp.

Constructor & Destructor Documentation

HtmlHelpIndex::HtmlHelpIndex (  ) 

Constructs a new HtmlHelp index

Definition at line 85 of file htmlhelp.cpp.

HtmlHelpIndex::~HtmlHelpIndex (  ) 

Destroys the HtmlHelp index

Definition at line 93 of file htmlhelp.cpp.

Member Function Documentation

void HtmlHelpIndex::addItem ( const char *  level1,
const char *  level2,
const char *  url,
const char *  anchor,
bool  hasLink,
bool  reversed 
)

Stores an item in the index if it is not already present. Items are stored in alphetical order, by sorting on the concatenation of level1 and level2 (if present).

Parameters:
level1 the string at level 1 in the index.
level2 the string at level 2 in the index (or 0 if not applicable).
url the url of the documentation (without .html extension).
anchor the anchor of the documentation within the page.
hasLink if true, the url (without anchor) can be used in the level1 item, when writing the header of a list of level2 items.
reversed TRUE if level1 is the member name and level2 the compound name.

Definition at line 112 of file htmlhelp.cpp.

References QCString.

Referenced by HtmlHelp::addIndexItem().

void HtmlHelpIndex::writeFields ( QTextStream &  t  ) 

Writes the sorted list of index items into a html like list.

An list of calls with name = level1,level2 as follows: 

    a1,b1
    a1,b2
    a2,b1
    a2,b2
    a3
    a4,b1

Will result in the following list:

    a1       -> link to url if hasLink==TRUE
      b1     -> link to url::anchor
      b2     -> link to url::anchor
    a2       -> link to url if hasLink==TRUE
      b1     -> link to url::anchor
      b2     -> link to url::anchor
    a3       -> link to url if hasLink==TRUE
    a4       -> link to url if hasLink==TRUE
      b1     -> link to url::anchor

Definition at line 159 of file htmlhelp.cpp.

References IndexField::anchor, Doxygen::htmlFileExtension, IndexField::link, IndexField::name, QCString, IndexField::reversed, and IndexField::url.

Referenced by HtmlHelp::finalize().

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


Generated on Mon Mar 31 10:59:00 2008 by  doxygen 1.5.1