CEGUI::RenderedStringWidgetComponent Class Reference

String component that moves a widget to appear as part of the string. More...

Inheritance diagram for CEGUI::RenderedStringWidgetComponent:

Collaboration diagram for CEGUI::RenderedStringWidgetComponent:

Public Member Functions
	RenderedStringWidgetComponent ()
	Constructor.
	RenderedStringWidgetComponent (const String &widget_name)
	RenderedStringWidgetComponent (Window *widget)
void	setWindow (const String &widget_name)
	Set the window to be controlled by this component.
void	setWindow (Window *widget)
	Set the window to be controlled by this component.
const Window *	getWindow () const
	return the window currently controlled by this component
void	draw (GeometryBuffer &buffer, const Vector2 &position, const ColourRect *mod_colours, const Rect *clip_rect, const float vertical_space, const float space_extra) const
	draw the component.
Size	getPixelSize () const
	return the pixel size of the rendered component.
bool	canSplit () const
	return whether the component can be split
RenderedStringWidgetComponent *	split (float split_point, bool first_component)
	split the component as close to split_point as possible, returning a new RenderedStringComponent of the same type as '*this' holding the left side of the split, and leaving the right side of the split in this object. More...
RenderedStringWidgetComponent *	clone () const
	clone this component.
size_t	getSpaceCount () const
	return the total number of spacing characters in the string.
Public Member Functions inherited from CEGUI::RenderedStringComponent
virtual	~RenderedStringComponent ()
	Destructor.
void	setVerticalFormatting (VerticalFormatting fmt)
	Set the VerticalFormatting option for this component.
VerticalFormatting	getVerticalFormatting () const
	return the current VerticalFormatting option.
void	setPadding (const Rect &padding)
	set the padding values.
void	setLeftPadding (const float padding)
	set the left padding value.
void	setRightPadding (const float padding)
	set the right padding value.
void	setTopPadding (const float padding)
	set the top padding value.
void	setBottomPadding (const float padding)
	set the Bottom padding value.
const Rect &	getPadding () const
	return the current padding value Rect.
float	getLeftPadding () const
	return the left padding value.
float	getRightPadding () const
	return the right padding value.
float	getTopPadding () const
	return the top padding value.
float	getBottomPadding () const
	return the bottom padding value.
void	setAspectLock (const bool setting)
	set the aspect-lock state
bool	getAspectLock () const
	return the aspect-lock state

Protected Attributes
Window *	d_window
	pointer to the window controlled by this component.
Protected Attributes inherited from CEGUI::RenderedStringComponent
Rect	d_padding
	Rect object holding the padding values for this component.
VerticalFormatting	d_verticalFormatting
	Vertical formatting to be used for this component.
bool	d_aspectLock
	true if the aspect ratio should be maintained where possible.

Additional Inherited Members
Protected Member Functions inherited from CEGUI::RenderedStringComponent
	RenderedStringComponent ()
	Protected constructor.

Detailed Description

String component that moves a widget to appear as part of the string.

Member Function Documentation

RenderedStringWidgetComponent* CEGUI::RenderedStringWidgetComponent::split ( float  split_point, bool  first_component  )

virtual

split the component as close to split_point as possible, returning a new RenderedStringComponent of the same type as '*this' holding the left side of the split, and leaving the right side of the split in this object.

Exceptions

InvalidRequestException

thrown if the RenderedStringComponent does not support being split.

Implements CEGUI::RenderedStringComponent.