Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CEGUI::TextComponent Class Reference

Class that encapsulates information for a text component. More...

#include <CEGUIFalTextComponent.h>

Inheritance diagram for CEGUI::TextComponent:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::TextComponent:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TextComponent ()
 Constructor.
const StringgetText () 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 StringgetFont () 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 ComponentAreagetComponentArea () const
 Return the ComponentArea of this ImageryComponent.
void setComponentArea (const ComponentArea &area)
 Set the ImageryComponent's ComponentArea.
const ColourRectgetColours () 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.

Detailed Description

Class that encapsulates information for a text component.

Definition at line 36 of file CEGUIFalTextComponent.h.


Constructor & Destructor Documentation

CEGUI::TextComponent::TextComponent  ) 
 

Constructor.

Definition at line 34 of file CEGUIFalTextComponent.cpp.


Member Function Documentation

const ColourRect & CEGUI::FalagardComponentBase::getColours  )  const [inherited]
 

Return the ColourRect set for use by this ImageryComponent.

Returns:
ColourRect object holding the colours currently in use by this ImageryComponent.

Definition at line 62 of file CEGUIFalComponentBase.cpp.

References CEGUI::FalagardComponentBase::d_colours.

const ComponentArea & CEGUI::FalagardComponentBase::getComponentArea  )  const [inherited]
 

Return the ComponentArea of this ImageryComponent.

Returns:
ComponentArea object describing the ImageryComponent's current target area.

Definition at line 52 of file CEGUIFalComponentBase.cpp.

References CEGUI::FalagardComponentBase::d_area.

const String & CEGUI::TextComponent::getFont  )  const
 

Return the name of the font to be used when rendering this TextComponent.

Returns:
String object containing the name of a font, or "" if the window font is to be used.

Definition at line 49 of file CEGUIFalTextComponent.cpp.

HorizontalTextFormatting CEGUI::TextComponent::getHorizontalFormatting  )  const
 

Return the current horizontal formatting setting for this TextComponent.

Returns:
One of the HorizontalTextFormatting enumerated values.

Definition at line 69 of file CEGUIFalTextComponent.cpp.

const String & CEGUI::TextComponent::getText  )  const
 

Return the text object that will be rendered by this TextComponent.

Returns:
String object containing the text that will be rendered.

Definition at line 39 of file CEGUIFalTextComponent.cpp.

VerticalTextFormatting CEGUI::TextComponent::getVerticalFormatting  )  const
 

Return the current vertical formatting setting for this TextComponent.

Returns:
One of the VerticalTextFormatting enumerated values.

Definition at line 59 of file CEGUIFalTextComponent.cpp.

void CEGUI::FalagardComponentBase::initColoursRect const Window wnd,
const ColourRect modCols,
ColourRect cr
const [protected, inherited]
 

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:

  • a property attached to wnd
  • or the integral d_colours value.

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().

void CEGUI::FalagardComponentBase::render Window srcWindow,
const Rect baseRect,
float  base_z,
const CEGUI::ColourRect modColours = 0,
const Rect clipper = 0,
bool  clipToDisplay = false
const [inherited]
 

Render this component. More correctly, the component is cached for rendering.

Parameters:
srcWindow Window to use as the base for translating the component's ComponentArea into pixel values.
baseRect Rect to use as the base for translating the component's ComponentArea into pixel values.
base_z The z value to use for rendering the component. Note that this is not the final z value to use, but some z offset from a currently unknown starting value.
modColours ColourRect describing colours that are to be modulated with the component's stored colour values to calculate a set of 'final' colour values to be used. May be 0.
Returns:
Nothing.

Definition at line 46 of file CEGUIFalComponentBase.cpp.

References CEGUI::FalagardComponentBase::d_area, CEGUI::ComponentArea::getPixelRect(), and CEGUI::FalagardComponentBase::render_impl().

void CEGUI::FalagardComponentBase::render Window srcWindow,
float  base_z,
const CEGUI::ColourRect modColours = 0,
const Rect clipper = 0,
bool  clipToDisplay = false
const [inherited]
 

Render this component. More correctly, the component is cached for rendering.

Parameters:
srcWindow Window to use as the base for translating the component's ComponentArea into pixel values.
base_z The z value to use for rendering the component. Note that this is not the final z value to use, but some z offset from a currently unknown starting value.
modColours ColourRect describing colours that are to be modulated with the component's stored colour values to calculate a set of 'final' colour values to be used. May be 0.
Returns:
Nothing.

Definition at line 40 of file CEGUIFalComponentBase.cpp.

References CEGUI::FalagardComponentBase::d_area, CEGUI::ComponentArea::getPixelRect(), and CEGUI::FalagardComponentBase::render_impl().

void CEGUI::TextComponent::render_impl Window srcWindow,
Rect destRect,
float  base_z,
const CEGUI::ColourRect modColours,
const Rect clipper,
bool  clipToDisplay
const [protected, virtual]
 

Method to do main render caching work.

Implements CEGUI::FalagardComponentBase.

Definition at line 79 of file CEGUIFalTextComponent.cpp.

References CEGUI::RenderCache::cacheText(), CEGUI::Rect::d_bottom, CEGUI::FalagardComponentBase::d_horzFormatPropertyName, CEGUI::Rect::d_top, CEGUI::FalagardComponentBase::d_vertFormatPropertyName, CEGUI::String::empty(), CEGUI::FontManager::getFont(), CEGUI::Window::getFont(), CEGUI::Font::getFormattedLineCount(), CEGUI::Rect::getHeight(), CEGUI::Font::getLineSpacing(), CEGUI::PropertySet::getProperty(), CEGUI::Window::getRenderCache(), CEGUI::FontManager::getSingleton(), CEGUI::Window::getText(), CEGUI::FalagardComponentBase::initColoursRect(), CEGUI::FalagardXMLHelper::stringToHorzTextFormat(), CEGUI::FalagardXMLHelper::stringToVertTextFormat(), CEGUI::VTF_BOTTOM_ALIGNED, and CEGUI::VTF_CENTRE_ALIGNED.

void CEGUI::FalagardComponentBase::setColours const ColourRect cols  )  [inherited]
 

Set the colours to be used by this ImageryComponent.

Parameters:
cols ColourRect object describing 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().

void CEGUI::FalagardComponentBase::setColoursPropertyIsColourRect bool  setting = true  )  [inherited]
 

Set whether the colours property source represents a full ColourRect.

Parameters:
setting 
  • true if the colours property will access a ColourRect object.
  • false if the colours property will access a colour object.
Returns:
Nothing.

Definition at line 77 of file CEGUIFalComponentBase.cpp.

References CEGUI::FalagardComponentBase::d_colourProperyIsRect.

Referenced by CEGUI::Falagard_xmlHandler::elementStart().

void CEGUI::FalagardComponentBase::setColoursPropertySource const String property  )  [inherited]
 

Set the name of the property where colour values can be obtained.

Parameters:
property String containing the name of the property.
Returns:
Nothing.

Definition at line 72 of file CEGUIFalComponentBase.cpp.

References CEGUI::FalagardComponentBase::d_colourPropertyName.

Referenced by CEGUI::Falagard_xmlHandler::elementStart().

void CEGUI::FalagardComponentBase::setComponentArea const ComponentArea area  )  [inherited]
 

Set the ImageryComponent's ComponentArea.

Parameters:
area ComponentArea object describing a new target area for the ImageryComponent.
Returns:
Nothing.

Definition at line 57 of file CEGUIFalComponentBase.cpp.

References CEGUI::FalagardComponentBase::d_area.

Referenced by CEGUI::Falagard_xmlHandler::elementEnd().

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.

Parameters:
font String containing name of a font
Returns:
Nothing.

Definition at line 54 of file CEGUIFalTextComponent.cpp.

Referenced by CEGUI::Falagard_xmlHandler::elementStart().

void CEGUI::TextComponent::setHorizontalFormatting HorizontalTextFormatting  fmt  ) 
 

Set the horizontal formatting setting for this TextComponent.

Parameters:
fmt One of the HorizontalTextFormatting enumerated values.
Returns:
Nothing.

Definition at line 74 of file CEGUIFalTextComponent.cpp.

Referenced by CEGUI::Falagard_xmlHandler::elementStart().

void CEGUI::FalagardComponentBase::setHorzFormattingPropertySource const String property  )  [inherited]
 

Set the name of the property where horizontal formatting option can be obtained.

Parameters:
property String containing the name of the property.
Returns:
Nothing.

Definition at line 120 of file CEGUIFalComponentBase.cpp.

References CEGUI::FalagardComponentBase::d_horzFormatPropertyName.

Referenced by CEGUI::Falagard_xmlHandler::elementStart().

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.

Parameters:
text String containing text to render, or "" to render text from window.
Returns:
Nothing.

Definition at line 44 of file CEGUIFalTextComponent.cpp.

Referenced by CEGUI::Falagard_xmlHandler::elementStart().

void CEGUI::FalagardComponentBase::setVertFormattingPropertySource const String property  )  [inherited]
 

Set the name of the property where vertical formatting option can be obtained.

Parameters:
property String containing the name of the property.
Returns:
Nothing.

Definition at line 115 of file CEGUIFalComponentBase.cpp.

References CEGUI::FalagardComponentBase::d_vertFormatPropertyName.

Referenced by CEGUI::Falagard_xmlHandler::elementStart().

void CEGUI::TextComponent::setVerticalFormatting VerticalTextFormatting  fmt  ) 
 

Set the vertical formatting setting for this TextComponent.

Parameters:
fmt One of the VerticalTextFormatting enumerated values.
Returns:
Nothing.

Definition at line 64 of file CEGUIFalTextComponent.cpp.

Referenced by CEGUI::Falagard_xmlHandler::elementStart().

bool CEGUI::FalagardComponentBase::writeColoursXML OutStream out_stream  )  const [protected, inherited]
 

Writes xml for the colours to a OutStream. Will prefer property colours before explicit.

Note:
This is intended as a helper method for sub-classes when outputting xml to a stream.
Returns:
  • true if xml element was written.
  • false if nothing was output due to the formatting not being set (sub-class may then choose to do something else.)

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().

bool CEGUI::FalagardComponentBase::writeHorzFormatXML OutStream out_stream  )  const [protected, inherited]
 

Writes xml for the horizontal formatting to a OutStream if such a property is defined.

Note:
This is intended as a helper method for sub-classes when outputting xml to a stream.
Returns:
  • true if xml element was written.
  • false if nothing was output due to the formatting not being set (sub-class may then choose to do something else.)

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().

bool CEGUI::FalagardComponentBase::writeVertFormatXML OutStream out_stream  )  const [protected, inherited]
 

Writes xml for the vertical formatting to a OutStream if such a property is defined.

Note:
This is intended as a helper method for sub-classes when outputting xml to a stream.
Returns:
  • true if xml element was written.
  • false if nothing was output due to the formatting not being set (sub-class may then choose to do something else.)

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().

void CEGUI::TextComponent::writeXMLToStream OutStream out_stream  )  const
 

Writes an xml representation of this TextComponent to out_stream.

Parameters:
out_stream Stream where xml data should be output.
Returns:
Nothing.

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().


Member Data Documentation

ComponentArea CEGUI::FalagardComponentBase::d_area [protected, inherited]
 

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().

String CEGUI::FalagardComponentBase::d_colourPropertyName [protected, inherited]
 

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().

bool CEGUI::FalagardComponentBase::d_colourProperyIsRect [protected, inherited]
 

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().

ColourRect CEGUI::FalagardComponentBase::d_colours [protected, inherited]
 

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().

String CEGUI::FalagardComponentBase::d_horzFormatPropertyName [protected, inherited]
 

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().

String CEGUI::FalagardComponentBase::d_vertFormatPropertyName [protected, inherited]
 

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().


The documentation for this class was generated from the following files:
Generated on Wed Sep 7 10:10:13 2005 for Crazy Eddies GUI System by  doxygen 1.4.3