highlight::DocumentStyle Class Reference

Contains information about document formatting properties. More...

List of all members.

Public Member Functions

 DocumentStyle (const string &styleDefinitionPath)
 DocumentStyle ()
bool load (const string &styleDefinitionFile)
vector< string > getClassNames () const
KeywordStyles getKeywordStyles () const
string getFontSize () const
Colour getBgColour () const
Colour getMarkLineColour () const
ElementStyle getDefaultStyle () const
ElementStyle getCommentStyle () const
ElementStyle getSingleLineCommentStyle () const
ElementStyle getStringStyle () const
ElementStyle getDirectiveStringStyle () const
ElementStyle getEscapeCharStyle () const
ElementStyle getNumberStyle () const
ElementStyle getDirectiveStyle () const
ElementStyle getTypeStyle () const
ElementStyle getLineStyle () const
ElementStyle getSymbolStyle () const
ElementStyle getKeywordStyle (const string &className)
bool found () const


Detailed Description

Contains information about document formatting properties.

Author:
Andre Simon

Constructor & Destructor Documentation

highlight::DocumentStyle::DocumentStyle ( const string &  styleDefinitionPath  ) 

Constructor

Parameters:
styleDefinitionPath Style definition path

References load().

highlight::DocumentStyle::DocumentStyle (  ) 

Constructor


Member Function Documentation

bool highlight::DocumentStyle::found (  )  const

Colour highlight::DocumentStyle::getBgColour (  )  const

vector< string > highlight::DocumentStyle::getClassNames (  )  const

Returns:
class names defined in the theme file

ElementStyle highlight::DocumentStyle::getCommentStyle (  )  const

Returns:
Comment style

Referenced by highlight::HtmlGenerator::getStyleDefinition().

ElementStyle highlight::DocumentStyle::getDefaultStyle (  )  const

Returns:
Style of default (unrecognized) strings

Referenced by highlight::HtmlGenerator::getStyleDefinition().

ElementStyle highlight::DocumentStyle::getDirectiveStringStyle (  )  const

Returns:
Directive line string style

Referenced by highlight::HtmlGenerator::getStyleDefinition().

ElementStyle highlight::DocumentStyle::getDirectiveStyle (  )  const

Returns:
Directive style

Referenced by highlight::HtmlGenerator::getStyleDefinition().

ElementStyle highlight::DocumentStyle::getEscapeCharStyle (  )  const

Returns:
Escape character style

Referenced by highlight::HtmlGenerator::getStyleDefinition().

string highlight::DocumentStyle::getFontSize (  )  const

Returns:
Font size

Referenced by highlight::CodeGenerator::getBaseFontSize().

ElementStyle highlight::DocumentStyle::getKeywordStyle ( const string &  className  ) 

Parameters:
className Name of keyword class (eg kwa, kwb, .., kwd)
Returns:
keyword style of the given className

KeywordStyles highlight::DocumentStyle::getKeywordStyles (  )  const

Returns:
keyword styles

Referenced by highlight::HtmlGenerator::getStyleDefinition().

ElementStyle highlight::DocumentStyle::getLineStyle (  )  const

Returns:
Line number style

Referenced by highlight::HtmlGenerator::getStyleDefinition().

Colour highlight::DocumentStyle::getMarkLineColour (  )  const

Returns:
Mark line colour

Referenced by highlight::HtmlGenerator::getStyleDefinition().

ElementStyle highlight::DocumentStyle::getNumberStyle (  )  const

Returns:
Number style

Referenced by highlight::HtmlGenerator::getStyleDefinition().

ElementStyle highlight::DocumentStyle::getSingleLineCommentStyle (  )  const

Returns:
Single line comment style

Referenced by highlight::HtmlGenerator::getStyleDefinition().

ElementStyle highlight::DocumentStyle::getStringStyle (  )  const

Returns:
String style

Referenced by highlight::HtmlGenerator::getStyleDefinition().

ElementStyle highlight::DocumentStyle::getSymbolStyle (  )  const

Returns:
Bracket style

Referenced by highlight::HtmlGenerator::getStyleDefinition().

ElementStyle highlight::DocumentStyle::getTypeStyle (  )  const

Returns:
Type style

bool highlight::DocumentStyle::load ( const string &  styleDefinitionFile  ) 

load style definition

Parameters:
styleDefinitionFile Style definition path
Returns:
True if successfull

References ConfigurationReader::found(), ConfigurationReader::getParameter(), ConfigurationReader::getParameterNames(), StringTools::getParantheseVal(), and highlight::ElementStyle::set().

Referenced by DocumentStyle(), and highlight::CodeGenerator::initTheme().


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

Generated on Wed Jun 9 21:34:17 2010 for Highlight Code Converter by  doxygen 1.5.7.1