HtmlHelp Class Reference

#include <htmlhelp.h>

Inheritance diagram for HtmlHelp:

List of all members.

Public Member Functions
	HtmlHelp ()
void	initialize ()
void	finalize ()
void	incContentsDepth ()
void	decContentsDepth ()
void	addContentsItem (bool isDir, const char *name, const char *ref=0, const char *file=0, const char *anchor=0)
void	addIndexItem (const char *level1, const char *level2, const char *contRef, const char *memRef, const char *anchor, const MemberDef *md)
void	addIndexFile (const char *name)

---

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 36 of file htmlhelp.h.

---

Constructor & Destructor Documentation

HtmlHelp::HtmlHelp

(

)

Constructs an html object. The object has to be initialized before it can be used.

Definition at line 265 of file htmlhelp.cpp.

---

Member Function Documentation

void HtmlHelp::initialize

(

)

[virtual]

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()

Implements IndexIntf.

Definition at line 290 of file htmlhelp.cpp.

References Config_getString, err(), and QCString.

void HtmlHelp::finalize

(

)

[virtual]

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

See also:

initialize()

Implements IndexIntf.

Definition at line 477 of file htmlhelp.cpp.

References HtmlHelpIndex::writeFields().

void HtmlHelp::incContentsDepth

(

)

[virtual]

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

See also:

decContentsDepth()

Implements IndexIntf.

Definition at line 505 of file htmlhelp.cpp.

void HtmlHelp::decContentsDepth

(

)

[virtual]

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

See also:

incContentsDepth()

Implements IndexIntf.

Definition at line 516 of file htmlhelp.cpp.

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

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.
	file	the file in which the item is defined.
	anchor	the anchor of the item.

Implements IndexIntf.

Definition at line 530 of file htmlhelp.cpp.

References Config_getBool, and Doxygen::htmlFileExtension.

void HtmlHelp::addIndexItem	(	const char *	level1,
		const char *	level2,
		const char *	contRef,
		const char *	memRef,
		const char *	anchor,
		const MemberDef *	md
	)			[virtual]

Add an list item to the index file.

Parameters:

	level1	the main index of the item.
	level2	the sub index of the item.
	contRef	the output file refering to the container.
	memRef	the output file containing to the member documentation.
	anchor	the anchor of the item.
	md	the member definition corresponding to this item.

See also:

HtmlHelpIndex

Implements IndexIntf.

Definition at line 574 of file htmlhelp.cpp.

References HtmlHelpIndex::addItem().

void HtmlHelp::addIndexFile

(

const char *

name

)

[virtual]

Implements IndexIntf.

Definition at line 464 of file htmlhelp.cpp.

---

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

• htmlhelp.h
• htmlhelp.cpp

---

• ソフトウェア開発
• ホームページ制作
• Tcl版
• STLport版
• Dradnats C++ Library
• 要約文庫