highlight::DocumentStyle Class Reference

Contains information about document formatting properties. More...

List of all members.

Public Member Functions

 DocumentStyle (const string &styleDefinitionPath)
bool load (const string &styleDefinitionFile)
vector< string > getClassNames ()
KeywordStylesgetKeywordStyles ()
string & getFontSize ()
StyleColourgetBgColour ()
ElementStylegetDefaultStyle ()
ElementStylegetCommentStyle ()
ElementStylegetSingleLineCommentStyle ()
ElementStylegetKeywordStyle ()
ElementStylegetStringStyle ()
ElementStylegetDirectiveStringStyle ()
ElementStylegetEscapeCharStyle ()
ElementStylegetNumberStyle ()
ElementStylegetDirectiveStyle ()
ElementStylegetTypeStyle ()
ElementStylegetLineStyle ()
ElementStylegetSymbolStyle ()
ElementStylegetKeywordStyle (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


Member Function Documentation

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

load sytle definition

Parameters:
styleDefinitionFile Style definition path
Returns:
True if successfull

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

Returns:
class names defined in the theme file

KeywordStyles & highlight::DocumentStyle::getKeywordStyles (  ) 

Returns:
keyword styles

string & highlight::DocumentStyle::getFontSize (  ) 

Returns:
Font size

StyleColour & highlight::DocumentStyle::getBgColour (  ) 

Returns:
Background colour

ElementStyle & highlight::DocumentStyle::getDefaultStyle (  ) 

Returns:
Style of default (unrecognized) strings

ElementStyle & highlight::DocumentStyle::getCommentStyle (  ) 

Returns:
Comment style

ElementStyle & highlight::DocumentStyle::getSingleLineCommentStyle (  ) 

Returns:
Single line comment style

ElementStyle& highlight::DocumentStyle::getKeywordStyle (  ) 

Returns:
Keyword style

ElementStyle & highlight::DocumentStyle::getStringStyle (  ) 

Returns:
String style

ElementStyle & highlight::DocumentStyle::getDirectiveStringStyle (  ) 

Returns:
Directive line string style

ElementStyle & highlight::DocumentStyle::getEscapeCharStyle (  ) 

Returns:
Escape character style

ElementStyle & highlight::DocumentStyle::getNumberStyle (  ) 

Returns:
Number style

ElementStyle & highlight::DocumentStyle::getDirectiveStyle (  ) 

Returns:
Directive style

ElementStyle& highlight::DocumentStyle::getTypeStyle (  ) 

Returns:
Type style

ElementStyle & highlight::DocumentStyle::getLineStyle (  ) 

Returns:
Line number style

ElementStyle & highlight::DocumentStyle::getSymbolStyle (  ) 

Returns:
Bracket style

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

Parameters:
className Name of keyword class
Returns:
keyword style of the given className

bool highlight::DocumentStyle::found (  )  const

Returns:
True if language definition was found


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