Crazy Eddie's GUI System  ${CEGUI_VERSION}
CEGUI::RenderedStringParser Class Referenceabstract

Specifies interface for classes that parse text into RenderedString objects. More...

Inherits CEGUI::AllocatedObject< RenderedStringParser >, and CEGUI::AllocatedObject< RenderedStringParser >.

Inherited by CEGUI::BasicRenderedStringParser, CEGUI::BasicRenderedStringParser, CEGUI::DefaultRenderedStringParser, CEGUI::DefaultRenderedStringParser, and RenderedStringParser_wrapper.

+ Collaboration diagram for CEGUI::RenderedStringParser:

Public Member Functions

virtual RenderedString parse (const String &input_string, const Font *initial_font, const ColourRect *initial_colours)=0
 parse a text string and return a RenderedString representation. More...
 
virtual RenderedString parse (const String &input_string, const Font *initial_font, const ColourRect *initial_colours)=0
 parse a text string and return a RenderedString representation. More...
 

Detailed Description

Specifies interface for classes that parse text into RenderedString objects.

Member Function Documentation

§ parse() [1/2]

virtual RenderedString CEGUI::RenderedStringParser::parse ( const String input_string,
const Font initial_font,
const ColourRect initial_colours 
)
pure virtual

parse a text string and return a RenderedString representation.

Parameters
input_stringString object holding the text that is to be parsed.
initial_fontPointer to the initial font to be used for text (0 for system default).
initial_coloursPointer to the initial colours to be used (0 for default).
Returns
RenderedString object holding the result of the parse operation.

Implemented in CEGUI::BasicRenderedStringParser, CEGUI::BasicRenderedStringParser, CEGUI::DefaultRenderedStringParser, and CEGUI::DefaultRenderedStringParser.

Referenced by CEGUI::Window::getRenderedString(), and CEGUI::TextComponent::updateFormatting().

§ parse() [2/2]

virtual RenderedString CEGUI::RenderedStringParser::parse ( const String input_string,
const Font initial_font,
const ColourRect initial_colours 
)
pure virtual

parse a text string and return a RenderedString representation.

Parameters
input_stringString object holding the text that is to be parsed.
initial_fontPointer to the initial font to be used for text (0 for system default).
initial_coloursPointer to the initial colours to be used (0 for default).
Returns
RenderedString object holding the result of the parse operation.

Implemented in CEGUI::BasicRenderedStringParser, CEGUI::BasicRenderedStringParser, CEGUI::DefaultRenderedStringParser, and CEGUI::DefaultRenderedStringParser.