TextComponent_wrapper Struct Reference

Inheritance diagram for TextComponent_wrapper:

Collaboration diagram for TextComponent_wrapper:

Public Member Functions
	TextComponent_wrapper (::CEGUI::TextComponent const &obj)
::CEGUI::Font const *	getFontObject (::CEGUI::Window const &window) const
virtual bool	handleFontRenderSizeChange (::CEGUI::Window &window,::CEGUI::Font const *font) const
bool	default_handleFontRenderSizeChange (::CEGUI::Window &window,::CEGUI::Font const *font) const
virtual void	render_impl (::CEGUI::Window &srcWindow,::CEGUI::Rectf &destRect,::CEGUI::ColourRect const *modColours,::CEGUI::Rectf const *clipper, bool clipToDisplay) const
virtual void	default_render_impl (::CEGUI::Window &srcWindow,::CEGUI::Rectf &destRect,::CEGUI::ColourRect const *modColours,::CEGUI::Rectf const *clipper, bool clipToDisplay) const
void	setupStringFormatter (::CEGUI::Window const &window,::CEGUI::RenderedString const &rendered_string) const
void	initColoursRect (::CEGUI::Window const &wnd,::CEGUI::ColourRect const *modCols,::CEGUI::ColourRect &cr) const
bool	writeColoursXML (::CEGUI::XMLSerializer &xml_stream) const
Public Member Functions inherited from CEGUI::TextComponent
	TextComponent (const TextComponent &obj)
TextComponent &	operator= (const TextComponent &other)
const String &	getText () const
	Return the text set for this TextComponent. More...
String	getEffectiveText (const Window &wnd) const
const String &	getTextVisual () const
	return text string with visual ordering of glyphs. More...
String	getEffectiveVisualText (const Window &wnd) const
void	setText (const String &text)
	Set the text string for this TextComponent. More...
const String &	getFont () const
	Return the name of the font set to be used when rendering this TextComponent. More...
String	getEffectiveFont (const Window &wnd) const
void	setFont (const String &font)
	Set the name of a font to be used when rendering this TextComponent. More...
VerticalTextFormatting	getVerticalFormatting (const Window &wnd) const
	Return the current vertical formatting setting for this TextComponent. More...
void	setVerticalFormatting (VerticalTextFormatting fmt)
	Set the vertical formatting setting for this TextComponent. More...
HorizontalTextFormatting	getHorizontalFormatting (const Window &wnd) const
	Return the current horizontal formatting setting for this TextComponent. More...
void	setHorizontalFormatting (HorizontalTextFormatting fmt)
	Set the horizontal formatting setting for this TextComponent. More...
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.
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. More...
bool	isTextFetchedFromProperty () const
	Return whether this TextComponent fetches it's text string via a property on the target window. More...
const String &	getTextPropertySource () const
	Return the name of the property that will be used to determine the text string to render for this TextComponent. More...
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. More...
bool	isFontFetchedFromProperty () const
	Return whether this TextComponent fetches it's font via a property on the target window. More...
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. More...
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. More...
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.
	TextComponent (const TextComponent &obj)
TextComponent &	operator= (const TextComponent &other)
const String &	getText () const
	Return the text set for this TextComponent. More...
String	getEffectiveText (const Window &wnd) const
const String &	getTextVisual () const
	return text string with visual ordering of glyphs. More...
String	getEffectiveVisualText (const Window &wnd) const
void	setText (const String &text)
	Set the text string for this TextComponent. More...
const String &	getFont () const
	Return the name of the font set to be used when rendering this TextComponent. More...
String	getEffectiveFont (const Window &wnd) const
void	setFont (const String &font)
	Set the name of a font to be used when rendering this TextComponent. More...
VerticalTextFormatting	getVerticalFormatting (const Window &wnd) const
	Return the current vertical formatting setting for this TextComponent. More...
void	setVerticalFormatting (VerticalTextFormatting fmt)
	Set the vertical formatting setting for this TextComponent. More...
HorizontalTextFormatting	getHorizontalFormatting (const Window &wnd) const
	Return the current horizontal formatting setting for this TextComponent. More...
void	setHorizontalFormatting (HorizontalTextFormatting fmt)
	Set the horizontal formatting setting for this TextComponent. More...
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.
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. More...
bool	isTextFetchedFromProperty () const
	Return whether this TextComponent fetches it's text string via a property on the target window. More...
const String &	getTextPropertySource () const
	Return the name of the property that will be used to determine the text string to render for this TextComponent. More...
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. More...
bool	isFontFetchedFromProperty () const
	Return whether this TextComponent fetches it's font via a property on the target window. More...
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. More...
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. More...
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.
Public Member Functions inherited from CEGUI::FalagardComponentBase
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. More...
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. More...
const ComponentArea &	getComponentArea () const
	Return the ComponentArea of this component. More...
void	setComponentArea (const ComponentArea &area)
	Set the conponent's ComponentArea. More...
const ColourRect &	getColours () const
	Return the ColourRect used by this component. More...
void	setColours (const ColourRect &cols)
	Set the colours to be used by this component. More...
void	setColoursPropertySource (const String &property)
	Set the name of the property where colour values can be obtained. More...
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. More...
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. More...
const ComponentArea &	getComponentArea () const
	Return the ComponentArea of this component. More...
void	setComponentArea (const ComponentArea &area)
	Set the conponent's ComponentArea. More...
const ColourRect &	getColours () const
	Return the ColourRect used by this component. More...
void	setColours (const ColourRect &cols)
	Set the colours to be used by this component. More...
void	setColoursPropertySource (const String &property)
	Set the name of the property where colour values can be obtained. More...

Additional Inherited Members
Protected Member Functions inherited from CEGUI::TextComponent
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	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
Protected Member Functions inherited from CEGUI::FalagardComponentBase
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. More...
bool	writeColoursXML (XMLSerializer &xml_stream) const
	Writes xml for the colours to a OutStream. Will prefer property colours before explicit. More...
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. More...
bool	writeColoursXML (XMLSerializer &xml_stream) const
	Writes xml for the colours to a OutStream. Will prefer property colours before explicit. More...
Protected Attributes inherited from CEGUI::FalagardComponentBase
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.