Crazy Eddie's GUI System
0.8.7
|
Basic RenderedStringParser class that offers support for the following tags: More...
Public Member Functions | |
BasicRenderedStringParser () | |
Constructor. | |
BasicRenderedStringParser (const String &initial_font, const ColourRect &initial_colours) | |
Initialising constructor. More... | |
virtual | ~BasicRenderedStringParser () |
Destructor. | |
void | setInitialFontName (const String &font_name) |
set the initial font name to be used on subsequent calls to parse. More... | |
void | setInitialColours (const ColourRect &colours) |
Set the initial colours to be used on subsequent calls to parse. More... | |
const String & | getInitialFontName () const |
Return the name of the initial font used in each parse. More... | |
const ColourRect & | getInitialColours () const |
Return a ColourRect describing the initial colours used in each parse. More... | |
RenderedString | parse (const String &input_string, const Font *active_font, const ColourRect *active_colours) |
parse a text string and return a RenderedString representation. More... | |
Static Public Attributes | |
static const String | ColourTagName |
static const String | FontTagName |
static const String | ImageTagName |
static const String | WindowTagName |
static const String | VertAlignmentTagName |
static const String | PaddingTagName |
static const String | TopPaddingTagName |
static const String | BottomPaddingTagName |
static const String | LeftPaddingTagName |
static const String | RightPaddingTagName |
static const String | AspectLockTagName |
static const String | ImageSizeTagName |
static const String | ImageWidthTagName |
static const String | ImageHeightTagName |
static const String | TopAlignedValueName |
static const String | BottomAlignedValueName |
static const String | CentreAlignedValueName |
static const String | StretchAlignedValueName |
Protected Types | |
typedef void(BasicRenderedStringParser::* | TagHandler) (RenderedString &, const String &) |
definition of type used for handler functions | |
typedef std::map< String, TagHandler, StringFastLessCompare > | TagHandlerMap |
definition of type used to despatch tag handler functions | |
Protected Member Functions | |
virtual void | appendRenderedText (RenderedString &rs, const String &text) const |
append the text string text to the RenderedString rs. | |
virtual void | processControlString (RenderedString &rs, const String &ctrl_str) |
Process the control string ctrl_str. | |
virtual void | initialiseDefaultState () |
initialise the default state | |
void | initialiseTagHandlers () |
initialise tag handlers | |
void | handleColour (RenderedString &rs, const String &value) |
handlers for the various tags supported | |
void | handleFont (RenderedString &rs, const String &value) |
void | handleImage (RenderedString &rs, const String &value) |
void | handleWindow (RenderedString &rs, const String &value) |
void | handleVertAlignment (RenderedString &rs, const String &value) |
void | handlePadding (RenderedString &rs, const String &value) |
void | handleTopPadding (RenderedString &rs, const String &value) |
void | handleBottomPadding (RenderedString &rs, const String &value) |
void | handleLeftPadding (RenderedString &rs, const String &value) |
void | handleRightPadding (RenderedString &rs, const String &value) |
void | handleAspectLock (RenderedString &rs, const String &value) |
void | handleImageSize (RenderedString &rs, const String &value) |
void | handleImageWidth (RenderedString &rs, const String &value) |
void | handleImageHeight (RenderedString &rs, const String &value) |
Protected Attributes | |
String | d_initialFontName |
ColourRect | d_initialColours |
Rectf | d_padding |
active padding values. | |
ColourRect | d_colours |
active colour values. | |
String | d_fontName |
active font. | |
VerticalFormatting | d_vertAlignment |
active vertical alignment | |
Sizef | d_imageSize |
active image size | |
bool | d_aspectLock |
active 'aspect lock' state | |
bool | d_initialised |
true if handlers have been registered | |
TagHandlerMap | d_tagHandlers |
Collection to map tag names to their handler functions. | |
Basic RenderedStringParser class that offers support for the following tags:
CEGUI::BasicRenderedStringParser::BasicRenderedStringParser | ( | const String & | initial_font, |
const ColourRect & | initial_colours | ||
) |
Initialising constructor.
initial_font | Reference to a String holding the name of the initial font to be used. |
initial_colours | Reference to a ColourRect describing the initial colours to be used. |
const ColourRect& CEGUI::BasicRenderedStringParser::getInitialColours | ( | ) | const |
Return a ColourRect describing the initial colours used in each parse.
const String& CEGUI::BasicRenderedStringParser::getInitialFontName | ( | ) | const |
Return the name of the initial font used in each parse.
|
virtual |
parse a text string and return a RenderedString representation.
input_string | String object holding the text that is to be parsed. |
initial_font | Pointer to the initial font to be used for text (0 for system default). |
initial_colours | Pointer to the initial colours to be used (0 for default). |
Implements CEGUI::RenderedStringParser.
void CEGUI::BasicRenderedStringParser::setInitialColours | ( | const ColourRect & | colours | ) |
Set the initial colours to be used on subsequent calls to parse.
colours | ColourRect object holding the colours. |
void CEGUI::BasicRenderedStringParser::setInitialFontName | ( | const String & | font_name | ) |
set the initial font name to be used on subsequent calls to parse.
font_name | String object holding the name of the font. |
|
protected |
|
protected |