highlight::HtmlGenerator Class Reference

This class generates HTML. More...

Inheritance diagram for highlight::HtmlGenerator:

highlight::CodeGenerator highlight::XHtmlGenerator List of all members.

Public Member Functions

virtual ~HtmlGenerator ()
virtual void insertLineNumber (bool insertNewLine=true)
string getHeader (const string &title)
void printBody ()
string getFooter ()
bool printExternalStyle (const string &outFile)
bool printIndexFile (const vector< string > &fileList, const string &outPath)
void setAttachAnchors (bool b)
void setOrderedList (bool b)

Protected Member Functions

string getStyleDefinition ()
string readUserStyleDef ()
virtual string getHeaderStart (const string &title)
string getGeneratorComment ()

Protected Attributes

string brTag
string hrTag
string idAttr
string fileSuffix
string styleDefinitionCache
bool orderedList

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


Member Function Documentation

void highlight::HtmlGenerator::insertLineNumber ( bool  insertNewLine = true  )  [virtual]

insert line number in the beginning of the new line

Reimplemented from highlight::CodeGenerator.

string highlight::HtmlGenerator::getHeader ( const string &  title  )  [virtual]

Print document header

Parameters:
title Title of the document

Implements highlight::CodeGenerator.

void highlight::HtmlGenerator::printBody (  )  [virtual]

Print document body

Implements highlight::CodeGenerator.

string highlight::HtmlGenerator::getFooter (  )  [virtual]

Print document footer

Implements highlight::CodeGenerator.

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.

void highlight::HtmlGenerator::setAttachAnchors ( bool  b  )  [inline]

Parameters:
b set true if anchors should be attached to line numbers

void highlight::HtmlGenerator::setOrderedList ( bool  b  )  [inline]

Parameters:
b set true line numbers should be replaced by list items

string highlight::HtmlGenerator::getStyleDefinition (  )  [protected, virtual]

Returns:
CSS definition

Reimplemented from highlight::CodeGenerator.

string highlight::HtmlGenerator::readUserStyleDef (  )  [protected]

Returns:
Content of user defined style file

Reimplemented from highlight::CodeGenerator.

string highlight::HtmlGenerator::getHeaderStart ( const string &  title  )  [protected, virtual]

Parameters:
title Dociment title
Returns:
Start of file header


Member Data Documentation

string highlight::HtmlGenerator::brTag [protected]

some strings which are similar in HTML and XHTML

string highlight::HtmlGenerator::styleDefinitionCache [protected]

caches style definition

bool highlight::HtmlGenerator::orderedList [protected]

test if line count should be replaced by ordered list


The documentation for this class was generated from the following files:
Generated on Fri Apr 27 13:12:36 2007 for Highlight Code Converter by  doxygen 1.5.2