Public Member Functions | |
TextComponent () | |
Constructor. | |
const String & | getText () const |
Return the text object that will be rendered by this TextComponent. | |
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. | |
Protected Member Functions | |
void | render_impl (Window &srcWindow, Rect &destRect, float base_z, const CEGUI::ColourRect *modColours, const Rect *clipper, bool clipToDisplay) const |
Method to do main render caching work. |
const String & CEGUI::TextComponent::getFont | ( | void | ) | 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.
HorizontalTextFormatting CEGUI::TextComponent::getHorizontalFormatting | ( | ) | const |
Return the current horizontal formatting setting for this TextComponent.
const String & CEGUI::TextComponent::getText | ( | void | ) | 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.
VerticalTextFormatting CEGUI::TextComponent::getVerticalFormatting | ( | ) | const |
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.
References CEGUI::String::empty().
bool CEGUI::TextComponent::isTextFetchedFromProperty | ( | ) | const |
Return whether this TextComponent fetches it's text string via a property on the target window.
References CEGUI::String::empty().
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. |
void CEGUI::TextComponent::setHorizontalFormatting | ( | HorizontalTextFormatting | fmt | ) |
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. |
void CEGUI::TextComponent::setVerticalFormatting | ( | VerticalTextFormatting | fmt | ) |
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. |
References CEGUI::XMLSerializer::attribute(), CEGUI::XMLSerializer::closeTag(), CEGUI::FalagardComponentBase::d_area, CEGUI::String::empty(), CEGUI::XMLSerializer::openTag(), CEGUI::FalagardComponentBase::writeColoursXML(), CEGUI::FalagardComponentBase::writeHorzFormatXML(), CEGUI::FalagardComponentBase::writeVertFormatXML(), and CEGUI::ComponentArea::writeXMLToStream().