#include <CEGUIFalTextComponent.h>
Inheritance diagram for CEGUI::TextComponent:
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 (OutStream &out_stream) const |
Writes an xml representation of this TextComponent to out_stream. | |
void | render (Window &srcWindow, float base_z, const CEGUI::ColourRect *modColours=0, const Rect *clipper=0, bool clipToDisplay=false) const |
Render this component. More correctly, the component is cached for rendering. | |
void | render (Window &srcWindow, const Rect &baseRect, float base_z, const CEGUI::ColourRect *modColours=0, const Rect *clipper=0, bool clipToDisplay=false) const |
Render this component. More correctly, the component is cached for rendering. | |
const ComponentArea & | getComponentArea () const |
Return the ComponentArea of this ImageryComponent. | |
void | setComponentArea (const ComponentArea &area) |
Set the ImageryComponent's ComponentArea. | |
const ColourRect & | getColours () const |
Return the ColourRect set for use by this ImageryComponent. | |
void | setColours (const ColourRect &cols) |
Set the colours to be used by this ImageryComponent. | |
void | setColoursPropertySource (const String &property) |
Set the name of the property where colour values can be obtained. | |
void | setColoursPropertyIsColourRect (bool setting=true) |
Set whether the colours property source represents a full ColourRect. | |
void | setVertFormattingPropertySource (const String &property) |
Set the name of the property where vertical formatting option can be obtained. | |
void | setHorzFormattingPropertySource (const String &property) |
Set the name of the property where horizontal formatting option can be obtained. | |
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. | |
void | initColoursRect (const Window &wnd, const ColourRect *modCols, ColourRect &cr) const |
Helper method to initialise a ColourRect with appropriate values according to the way the ImageryComponent is set up. | |
bool | writeColoursXML (OutStream &out_stream) const |
Writes xml for the colours to a OutStream. Will prefer property colours before explicit. | |
bool | writeVertFormatXML (OutStream &out_stream) const |
Writes xml for the vertical formatting to a OutStream if such a property is defined. | |
bool | writeHorzFormatXML (OutStream &out_stream) const |
Writes xml for the horizontal formatting to a OutStream if such a property is defined. | |
Protected Attributes | |
ComponentArea | d_area |
Destination area for this component. | |
ColourRect | d_colours |
base colours to be applied when rendering the image component. | |
String | d_colourPropertyName |
name of property to fetch colours from. | |
bool | d_colourProperyIsRect |
true if the colour property will fetch a full ColourRect. | |
String | d_vertFormatPropertyName |
name of property to fetch vertical formatting setting from. | |
String | d_horzFormatPropertyName |
name of property to fetch horizontal formatting setting from. |
Definition at line 36 of file CEGUIFalTextComponent.h.
|
Constructor.
Definition at line 34 of file CEGUIFalTextComponent.cpp. |
|
Return the ColourRect set for use by this ImageryComponent.
Definition at line 62 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_colours. |
|
Return the ComponentArea of this ImageryComponent.
Definition at line 52 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_area. |
|
Return the name of the font to be used when rendering this TextComponent.
Definition at line 49 of file CEGUIFalTextComponent.cpp. |
|
Return the current horizontal formatting setting for this TextComponent.
Definition at line 69 of file CEGUIFalTextComponent.cpp. |
|
Return the text object that will be rendered by this TextComponent.
Definition at line 39 of file CEGUIFalTextComponent.cpp. |
|
Return the current vertical formatting setting for this TextComponent.
Definition at line 59 of file CEGUIFalTextComponent.cpp. |
|
Helper method to initialise a ColourRect with appropriate values according to the way the ImageryComponent is set up. This will try and get values from multiple places:
Definition at line 82 of file CEGUIFalComponentBase.cpp. References CEGUI::ColourRect::d_bottom_left, CEGUI::ColourRect::d_bottom_right, CEGUI::FalagardComponentBase::d_colourPropertyName, CEGUI::FalagardComponentBase::d_colourProperyIsRect, CEGUI::FalagardComponentBase::d_colours, CEGUI::ColourRect::d_top_left, CEGUI::ColourRect::d_top_right, CEGUI::String::empty(), CEGUI::PropertySet::getProperty(), CEGUI::PropertyHelper::stringToColour(), and CEGUI::PropertyHelper::stringToColourRect(). Referenced by render_impl(), CEGUI::ImageryComponent::render_impl(), and CEGUI::FrameComponent::render_impl(). |
|
Render this component. More correctly, the component is cached for rendering.
Definition at line 46 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_area, CEGUI::ComponentArea::getPixelRect(), and CEGUI::FalagardComponentBase::render_impl(). |
|
Render this component. More correctly, the component is cached for rendering.
Definition at line 40 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_area, CEGUI::ComponentArea::getPixelRect(), and CEGUI::FalagardComponentBase::render_impl(). |
|
|
Set the colours to be used by this ImageryComponent.
Definition at line 67 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_colours. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set whether the colours property source represents a full ColourRect.
Definition at line 77 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_colourProperyIsRect. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set the name of the property where colour values can be obtained.
Definition at line 72 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_colourPropertyName. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set the ImageryComponent's ComponentArea.
Definition at line 57 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_area. Referenced by CEGUI::Falagard_xmlHandler::elementEnd(). |
|
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.
Definition at line 54 of file CEGUIFalTextComponent.cpp. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set the horizontal formatting setting for this TextComponent.
Definition at line 74 of file CEGUIFalTextComponent.cpp. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set the name of the property where horizontal formatting option can be obtained.
Definition at line 120 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_horzFormatPropertyName. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
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.
Definition at line 44 of file CEGUIFalTextComponent.cpp. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set the name of the property where vertical formatting option can be obtained.
Definition at line 115 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_vertFormatPropertyName. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set the vertical formatting setting for this TextComponent.
Definition at line 64 of file CEGUIFalTextComponent.cpp. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Writes xml for the colours to a OutStream. Will prefer property colours before explicit.
Definition at line 125 of file CEGUIFalComponentBase.cpp. References CEGUI::PropertyHelper::colourToString(), CEGUI::ColourRect::d_bottom_left, CEGUI::ColourRect::d_bottom_right, CEGUI::FalagardComponentBase::d_colourPropertyName, CEGUI::FalagardComponentBase::d_colourProperyIsRect, CEGUI::FalagardComponentBase::d_colours, CEGUI::ColourRect::d_top_left, CEGUI::ColourRect::d_top_right, CEGUI::String::empty(), and CEGUI::ColourRect::isMonochromatic(). Referenced by writeXMLToStream(), CEGUI::ImageryComponent::writeXMLToStream(), and CEGUI::FrameComponent::writeXMLToStream(). |
|
Writes xml for the horizontal formatting to a OutStream if such a property is defined.
Definition at line 163 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_horzFormatPropertyName, and CEGUI::String::empty(). Referenced by writeXMLToStream(), CEGUI::ImageryComponent::writeXMLToStream(), and CEGUI::FrameComponent::writeXMLToStream(). |
|
Writes xml for the vertical formatting to a OutStream if such a property is defined.
Definition at line 152 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_vertFormatPropertyName, and CEGUI::String::empty(). Referenced by writeXMLToStream(), CEGUI::ImageryComponent::writeXMLToStream(), and CEGUI::FrameComponent::writeXMLToStream(). |
|
Writes an xml representation of this TextComponent to out_stream.
Definition at line 133 of file CEGUIFalTextComponent.cpp. References CEGUI::FalagardComponentBase::d_area, CEGUI::FalagardXMLHelper::horzTextFormatToString(), CEGUI::FalagardXMLHelper::vertTextFormatToString(), CEGUI::FalagardComponentBase::writeColoursXML(), CEGUI::FalagardComponentBase::writeHorzFormatXML(), CEGUI::FalagardComponentBase::writeVertFormatXML(), and CEGUI::ComponentArea::writeXMLToStream(). |
|
Destination area for this component.
Definition at line 242 of file CEGUIFalComponentBase.h. Referenced by CEGUI::FalagardComponentBase::getComponentArea(), CEGUI::FalagardComponentBase::render(), CEGUI::FalagardComponentBase::setComponentArea(), writeXMLToStream(), CEGUI::ImageryComponent::writeXMLToStream(), and CEGUI::FrameComponent::writeXMLToStream(). |
|
name of property to fetch colours from.
Definition at line 244 of file CEGUIFalComponentBase.h. Referenced by CEGUI::FalagardComponentBase::initColoursRect(), CEGUI::FalagardComponentBase::setColoursPropertySource(), and CEGUI::FalagardComponentBase::writeColoursXML(). |
|
true if the colour property will fetch a full ColourRect.
Definition at line 245 of file CEGUIFalComponentBase.h. Referenced by CEGUI::FalagardComponentBase::initColoursRect(), CEGUI::FalagardComponentBase::setColoursPropertyIsColourRect(), and CEGUI::FalagardComponentBase::writeColoursXML(). |
|
base colours to be applied when rendering the image component.
Definition at line 243 of file CEGUIFalComponentBase.h. Referenced by CEGUI::FalagardComponentBase::getColours(), CEGUI::FalagardComponentBase::initColoursRect(), CEGUI::FalagardComponentBase::setColours(), and CEGUI::FalagardComponentBase::writeColoursXML(). |
|
name of property to fetch horizontal formatting setting from.
Definition at line 247 of file CEGUIFalComponentBase.h. Referenced by CEGUI::FrameComponent::doBackgroundRender(), render_impl(), CEGUI::ImageryComponent::render_impl(), CEGUI::FalagardComponentBase::setHorzFormattingPropertySource(), and CEGUI::FalagardComponentBase::writeHorzFormatXML(). |
|
name of property to fetch vertical formatting setting from.
Definition at line 246 of file CEGUIFalComponentBase.h. Referenced by CEGUI::FrameComponent::doBackgroundRender(), render_impl(), CEGUI::ImageryComponent::render_impl(), CEGUI::FalagardComponentBase::setVertFormattingPropertySource(), and CEGUI::FalagardComponentBase::writeVertFormatXML(). |