Crazy Eddie's GUI System 0.8.7
|
Class that encapsulates information for a text component. More...
#include <TextComponent.h>
Public Member Functions | |
TextComponent (const TextComponent &obj) | |
TextComponent & | operator= (const TextComponent &other) |
const String & | getText () const |
Return the text set for this TextComponent. | |
String | getEffectiveText (const Window &wnd) const |
const String & | getTextVisual () const |
return text string with visual ordering of glyphs. | |
String | getEffectiveVisualText (const Window &wnd) const |
void | setText (const String &text) |
Set the text string for this TextComponent. | |
const String & | getFont () const |
Return the name of the font set to be used when rendering this TextComponent. | |
String | getEffectiveFont (const Window &wnd) const |
void | setFont (const String &font) |
Set the name of a font to be used when rendering this TextComponent. | |
VerticalTextFormatting | getVerticalFormatting (const Window &wnd) const |
Return the current vertical formatting setting for this TextComponent. | |
VerticalTextFormatting | getVerticalFormattingFromComponent () const |
Directly returns the vertical formatting which was set for the ImageryComponent. | |
void | setVerticalFormatting (VerticalTextFormatting fmt) |
Set the vertical formatting setting for this TextComponent. | |
HorizontalTextFormatting | getHorizontalFormatting (const Window &wnd) const |
Return the current horizontal formatting setting for this TextComponent. | |
HorizontalTextFormatting | getHorizontalFormattingFromComponent () const |
Directly returns the horizontal formatting which was set for the ImageryComponent. | |
void | setHorizontalFormatting (HorizontalTextFormatting fmt) |
Set the horizontal formatting setting for this TextComponent. | |
const String & | getHorizontalFormattingPropertySource () const |
Returns the name of the property that will be used to obtain the horizontal formatting to use for this ImageryComponent or an empty string if none is set. | |
void | setHorizontalFormattingPropertySource (const String &property_name) |
Set the name of a property that will be used to obtain the horizontal formatting to use for this ImageryComponent. | |
const String & | getVerticalFormattingPropertySource () const |
Returns the name of the property that will be used to obtain the vertical formatting to use for this ImageryComponent or an empty string if none is set. | |
void | setVerticalFormattingPropertySource (const String &property_name) |
Set the name of a property that will be used to obtain the vertical formatting to use for this ImageryComponent. | |
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 Window &window) const |
return the horizontal pixel extent of the formatted rendered string. | |
float | getVerticalTextExtent (const Window &window) const |
return the vertical pixel extent of the formatted rendered string. | |
bool | handleFontRenderSizeChange (Window &window, const Font *font) const |
perform any processing required due to the given font having changed. | |
void | updateFormatting (const Window &srcWindow) const |
Update string formatting. | |
void | updateFormatting (const Window &srcWindow, const Sizef &size) const |
Update string formatting. | |
![]() | |
void | render (Window &srcWindow, const CEGUI::ColourRect *modColours=0, const Rectf *clipper=0, bool clipToDisplay=false) const |
Render this component. More correctly, the component is cached for rendering. | |
void | render (Window &srcWindow, const Rectf &baseRect, const CEGUI::ColourRect *modColours=0, const Rectf *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 component. | |
void | setComponentArea (const ComponentArea &area) |
Set the conponent's ComponentArea. | |
const ColourRect & | getColours () const |
Return the ColourRect used by this component. | |
void | setColours (const ColourRect &cols) |
Set the colours to be used by this component. | |
const String & | getColoursPropertySource () const |
Returns the name of the property from which the colour values will be obtained, if set. | |
void | setColoursPropertySource (const String &property) |
Set the name of the property where colour values will be obtained, if set. | |
Protected Member Functions | |
void | render_impl (Window &srcWindow, Rectf &destRect, const CEGUI::ColourRect *modColours, const Rectf *clipper, bool clipToDisplay) const |
Function to do main render caching work. | |
void | setupStringFormatter (const Window &window, const RenderedString &rendered_string) const |
helper to set up an appropriate FormattedRenderedString | |
const Font * | getFontObject (const Window &window) const |
helper to get the font object to use | |
![]() | |
void | initColoursRect (const Window &wnd, const ColourRect *modCols, ColourRect &cr) const |
Helper function to initialise a ColourRect with appropriate values according to the way the component is set up. | |
bool | writeColoursXML (XMLSerializer &xml_stream) const |
Writes xml for the colours to a OutStream. Will prefer property colours before explicit. | |
Additional Inherited Members | |
![]() | |
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. | |
Class that encapsulates information for a text component.
Return the name of the font set to be used when rendering this TextComponent.
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 Window & | wnd | ) | const |
Return the current horizontal formatting setting for this TextComponent.
HorizontalTextFormatting CEGUI::TextComponent::getHorizontalFormattingFromComponent | ( | ) | const |
Directly returns the horizontal formatting which was set for the ImageryComponent.
Returns the name of the property that will be used to obtain the horizontal formatting to use for this ImageryComponent or an empty string if none is set.
Return the text set for this TextComponent.
Return the name of the property that will be used to determine the text string to render for this TextComponent.
return text string with visual ordering of glyphs.
VerticalTextFormatting CEGUI::TextComponent::getVerticalFormatting | ( | const Window & | wnd | ) | const |
Return the current vertical formatting setting for this TextComponent.
VerticalTextFormatting CEGUI::TextComponent::getVerticalFormattingFromComponent | ( | ) | const |
Directly returns the vertical formatting which was set for the ImageryComponent.
Returns the name of the property that will be used to obtain the vertical formatting to use for this ImageryComponent or an empty string if none is set.
|
virtual |
perform any processing required due to the given font having changed.
Reimplemented from CEGUI::FalagardComponentBase.
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.
|
protectedvirtual |
Function to do main render caching work.
Implements CEGUI::FalagardComponentBase.
Set the name of a font to be used when rendering this TextComponent.
font | String containing name of a font |
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. |
Set the text string for this TextComponent.
text | String containing text to set on the TextComponent. |
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. |
Update string formatting.
size | The pixel size of the component. |
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. |