highlight::HtmlGenerator Class Reference

This class generates HTML. More...

Inheritance diagram for highlight::HtmlGenerator:

List of all members.

Public Member Functions
virtual	~HtmlGenerator ()
bool	printExternalStyle (const string &outFile)
bool	printIndexFile (const vector< string > &fileList, const string &outPath)
void	setHTMLAttachAnchors (bool b)
void	setHTMLAnchorPrefix (const string &prefix)
void	setHTMLOrderedList (bool b)
void	setHTMLInlineCSS (bool b)
void	setHTMLEnclosePreTag (bool b)
void	setHTMLClassName (const string &name)
Protected Member Functions
string	getStyleDefinition ()
string	readUserStyleDef ()
virtual string	getHeaderStart (const string &title)
string	getGeneratorComment ()
Protected Attributes
string	brTag
	break tag
string	hrTag
	horizontal ruler tag
string	idAttr
	ID tag.
string	fileSuffix
	filename extension
string	cssClassName
	css class name prefix
string	styleDefinitionCache
bool	orderedList
bool	useInlineCSS
bool	enclosePreTag

---

Detailed Description

This class generates HTML.

It contains information about the resulting document structure (document header and footer), the colour system, white space handling and text formatting attributes.

Author:

Andre Simon

---

Constructor & Destructor Documentation

virtual highlight::HtmlGenerator::~HtmlGenerator

(

)

[inline, virtual]

Destructor, virtual as it is base for xhtmlgenerator

---

Member Function Documentation

string highlight::HtmlGenerator::getGeneratorComment

(

)

[protected]

Returns:

Comment with program information

Referenced by printIndexFile().

string highlight::HtmlGenerator::getHeaderStart

(

const string &

title

)

[protected, virtual]

Parameters:

title

Dociment title

Returns:

Start of file header

References highlight::CodeGenerator::encoding, and highlight::CodeGenerator::encodingDefined().

Referenced by printIndexFile().

string highlight::HtmlGenerator::getStyleDefinition

(

)

[protected, virtual]

Returns:

CSS definition

Reimplemented from highlight::CodeGenerator.

References cssClassName, highlight::CodeGenerator::docStyle, highlight::CodeGenerator::getBaseFont(), highlight::CodeGenerator::getBaseFontSize(), highlight::DocumentStyle::getBgColour(), highlight::ElementStyle::getColour(), highlight::DocumentStyle::getCommentStyle(), highlight::DocumentStyle::getDefaultStyle(), highlight::DocumentStyle::getDirectiveStringStyle(), highlight::DocumentStyle::getDirectiveStyle(), highlight::DocumentStyle::getEscapeCharStyle(), highlight::DocumentStyle::getKeywordStyles(), highlight::DocumentStyle::getLineStyle(), highlight::DocumentStyle::getMarkLineColour(), highlight::DocumentStyle::getNumberStyle(), highlight::DocumentStyle::getSingleLineCommentStyle(), highlight::DocumentStyle::getStringStyle(), highlight::DocumentStyle::getSymbolStyle(), orderedList, and styleDefinitionCache.

bool highlight::HtmlGenerator::printExternalStyle

(

const string &

outFile

)

Print style definitions to external file

Parameters:

outFile

Path of external style definition

Reimplemented from highlight::CodeGenerator.

bool highlight::HtmlGenerator::printIndexFile	(	const vector< string > &	fileList,
		const string &	outPath
	)			[virtual]

Print index file with all input file names

Parameters:

	fileList	List of output file names
	outPath	Output path

Reimplemented from highlight::CodeGenerator.

References brTag, fileSuffix, getGeneratorComment(), getHeaderStart(), and hrTag.

string highlight::HtmlGenerator::readUserStyleDef

(

)

[protected]

Returns:

Content of user defined style file

Reimplemented from highlight::CodeGenerator.

void highlight::HtmlGenerator::setHTMLAnchorPrefix

(

const string &

prefix

)

[inline, virtual]

Parameters:

prefix

anchor prefix

Reimplemented from highlight::CodeGenerator.

void highlight::HtmlGenerator::setHTMLAttachAnchors

(

bool

b

)

[inline, virtual]

Parameters:

b

set true if anchors should be attached to line numbers

Reimplemented from highlight::CodeGenerator.

void highlight::HtmlGenerator::setHTMLClassName

(

const string &

name

)

[inline, virtual]

Parameters:

name

CSS Class name

Reimplemented from highlight::CodeGenerator.

References cssClassName.

void highlight::HtmlGenerator::setHTMLEnclosePreTag

(

bool

b

)

[inline, virtual]

Parameters:

b

if truefragmented output will be enclosed in pre tag

Reimplemented from highlight::CodeGenerator.

References enclosePreTag.

void highlight::HtmlGenerator::setHTMLInlineCSS

(

bool

b

)

[inline, virtual]

Parameters:

b

if true CSS formatting will be inserted into each tag

Reimplemented from highlight::CodeGenerator.

References useInlineCSS.

void highlight::HtmlGenerator::setHTMLOrderedList

(

bool

b

)

[inline, virtual]

Parameters:

b

if true line numbers should be replaced by list items

Reimplemented from highlight::CodeGenerator.

References orderedList.

---

Member Data Documentation

bool highlight::HtmlGenerator::enclosePreTag [protected]

pre tag should be outputted in fragment mode

Referenced by setHTMLEnclosePreTag().

bool highlight::HtmlGenerator::orderedList [protected]

line count should be replaced by ordered list

Referenced by getStyleDefinition(), and setHTMLOrderedList().

string highlight::HtmlGenerator::styleDefinitionCache [protected]

caches style definition

Referenced by getStyleDefinition().

bool highlight::HtmlGenerator::useInlineCSS [protected]

CSS definition should be outputted inline

Referenced by setHTMLInlineCSS().

---

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

• htmlgenerator.h
• htmlgenerator.cpp