Main Page | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

HtmlHelp Class Reference

#include <htmlhelp.h>

List of all members.

Public Member Functions

void initialize ()
void finalize ()
int incContentsDepth ()
int decContentsDepth ()
int contentsDepth ()
void addContentsItem (bool isDir, const char *name, const char *ref=0, const char *anchor=0)
void addIndexItem (const char *level1, const char *level2, const char *ref, const char *anchor)

Static Public Member Functions

HtmlHelp * getInstance ()

Detailed Description

A class that generated the HTML Help specific files. These files can be used with the Microsoft HTML Help workshop to generate compressed HTML files (.chm).

Definition at line 35 of file htmlhelp.h.

Member Function Documentation

void HtmlHelp::addContentsItem (  bool  isDir,
const char *  name,
const char *  ref = 0,
const char *  anchor = 0
) 
 

Add an list item to the contents file.

Parameters:
isDir boolean indicating if this is a dir or file entry
name the name of the item.
ref the URL of to the item.
anchor the anchor of the item.
Definition at line 489 of file htmlhelp.cpp.

void HtmlHelp::addIndexItem (  const char *  level1,
const char *  level2,
const char *  ref,
const char *  anchor
) 
 

Add an list item to the index file.

Parameters:
level1 the main index of the item.
level2 the sub index of the item.
ref the URL of to the item.
anchor the anchor of the item.
See also:
HtmlHelpIndex
Definition at line 529 of file htmlhelp.cpp.

References HtmlHelpIndex::addItem().

int HtmlHelp::contentsDepth (   )  [inline]
 

return the current depth of the contents tree Definition at line 70 of file htmlhelp.h.

int HtmlHelp::decContentsDepth (   ) 
 

Decrease the level of the contents hierarchy. This will end the unnumber HTML list.

See also:
incContentsDepth()
Definition at line 476 of file htmlhelp.cpp.

void HtmlHelp::finalize (   ) 
 

Finalizes the HTML help. This will finish and close the contents file (index.hhc) and the index file (index.hhk).

See also:
initialize()
Definition at line 441 of file htmlhelp.cpp.

References HtmlHelpIndex::writeFields().

HtmlHelp * HtmlHelp::getInstance (   )  [static]
 

return a reference to the one and only instance of this class. Definition at line 246 of file htmlhelp.cpp.

int HtmlHelp::incContentsDepth (   ) 
 

Increase the level of the contents hierarchy. This will start a new unnumbered HTML list in contents file.

See also:
decContentsDepth()
Definition at line 465 of file htmlhelp.cpp.

void HtmlHelp::initialize (   ) 
 

This will create a contents file (index.hhc) and a index file (index.hhk) and write the header of those files. It also creates a project file (index.hhp)

See also:
finalize()
Definition at line 259 of file htmlhelp.cpp.

The documentation for this class was generated from the following files:
Generated on Sat Aug 21 19:11:58 2004 for Doxygen by doxygen 1.3.8