Crazy Eddies GUI System
0.7.6
|
Class that encapsulates information for a text component. More...
Public Member Functions | |
TextComponent () | |
Constructor. | |
~TextComponent () | |
Destructor. | |
TextComponent (const TextComponent &obj) | |
Copy constructor. | |
TextComponent & | operator= (const TextComponent &other) |
Assignment. | |
const String & | getText () const |
Return the text object that will be rendered by this TextComponent. | |
const String & | getTextVisual () const |
return text string with visual ordering of glyphs. | |
void | setText (const String &text) |
Set the text that will be rendered by this TextComponent. | |
const String & | getFont () const |
Return the name of the font to be used when rendering this TextComponent. | |
void | setFont (const String &font) |
Set the name of the font to be used when rendering this TextComponent. | |
VerticalTextFormatting | getVerticalFormatting () const |
Return the current vertical formatting setting for this TextComponent. | |
void | setVerticalFormatting (VerticalTextFormatting fmt) |
Set the vertical formatting setting for this TextComponent. | |
HorizontalTextFormatting | getHorizontalFormatting () const |
Return the current horizontal formatting setting for this TextComponent. | |
void | setHorizontalFormatting (HorizontalTextFormatting fmt) |
Set the horizontal formatting setting for this TextComponent. | |
void | writeXMLToStream (XMLSerializer &xml_stream) const |
Writes an xml representation of this TextComponent to out_stream. | |
bool | isTextFetchedFromProperty () const |
Return whether this TextComponent fetches it's text string via a property on the target window. | |
const String & | getTextPropertySource () const |
Return the name of the property that will be used to determine the text string to render for this TextComponent. | |
void | setTextPropertySource (const String &property) |
Set the name of the property that will be used to determine the text string to render for this TextComponent. | |
bool | isFontFetchedFromProperty () const |
Return whether this TextComponent fetches it's font via a property on the target window. | |
const String & | getFontPropertySource () const |
Return the name of the property that will be used to determine the font to use for rendering the text string for this TextComponent. | |
void | setFontPropertySource (const String &property) |
Set the name of the property that will be used to determine the font to use for rendering the text string of this TextComponent. | |
float | getHorizontalTextExtent () const |
return the horizontal pixel extent of the formatted rendered string. | |
float | getVerticalTextExtent () const |
return the vertical pixel extent of the formatted rendered string. | |
Protected Member Functions | |
void | render_impl (Window &srcWindow, Rect &destRect, const CEGUI::ColourRect *modColours, const Rect *clipper, bool clipToDisplay) const |
Method to do main render caching work. | |
void | setupStringFormatter (const Window &window, const RenderedString &rendered_string) const |
helper to set up an appropriate FormattedRenderedString |
Class that encapsulates information for a text component.
const String& CEGUI::TextComponent::getFont | ( | ) | const |
Return the name of the font to be used when rendering this TextComponent.
const String& CEGUI::TextComponent::getFontPropertySource | ( | ) | const |
Return the name of the property that will be used to determine the font to use for rendering the text string for this TextComponent.
Return the current horizontal formatting setting for this TextComponent.
const String& CEGUI::TextComponent::getText | ( | ) | const |
Return the text object that will be rendered by this TextComponent.
const String& CEGUI::TextComponent::getTextPropertySource | ( | ) | const |
Return the name of the property that will be used to determine the text string to render for this TextComponent.
Return the current vertical formatting setting for this TextComponent.
bool CEGUI::TextComponent::isFontFetchedFromProperty | ( | ) | const |
Return whether this TextComponent fetches it's font via a property on the target window.
bool CEGUI::TextComponent::isTextFetchedFromProperty | ( | ) | const |
Return whether this TextComponent fetches it's text string via a property on the target window.
void CEGUI::TextComponent::setFont | ( | const String & | font | ) |
Set the name of the font to be used when rendering this TextComponent.
Note that setting this to the empty string ("") will cause the font from the base window passed when rendering to be used instead.
font | String containing name of a font |
void CEGUI::TextComponent::setFontPropertySource | ( | const String & | property | ) |
Set the name of the property that will be used to determine the font to use for rendering the text string of this TextComponent.
property | String object holding the name of a Propery. The property should access a valid font name. |
Set the horizontal formatting setting for this TextComponent.
fmt | One of the HorizontalTextFormatting enumerated values. |
void CEGUI::TextComponent::setText | ( | const String & | text | ) |
Set the text that will be rendered by this TextComponent.
Note that setting this to the empty string ("") will cause the text from the base window passed when rendering to be used instead.
text | String containing text to render, or "" to render text from window. |
void CEGUI::TextComponent::setTextPropertySource | ( | const String & | property | ) |
Set the name of the property that will be used to determine the text string to render for this TextComponent.
property | String object holding the name of a Propery. The property can contain any text string to render. |
Set the vertical formatting setting for this TextComponent.
fmt | One of the VerticalTextFormatting enumerated values. |
void CEGUI::TextComponent::writeXMLToStream | ( | XMLSerializer & | xml_stream | ) | const |
Writes an xml representation of this TextComponent to out_stream.
xml_stream | Stream where xml data should be output. |