CEGUI::RenderedStringImageComponent Class Reference

String component that draws an image. More...

Inheritance diagram for CEGUI::RenderedStringImageComponent:

Collaboration diagram for CEGUI::RenderedStringImageComponent:

List of all members.

Public Member Functions
	RenderedStringImageComponent ()
	Constructor.
	RenderedStringImageComponent (const String &name)
	RenderedStringImageComponent (const Image *image)
void	setImage (const String &name)
	Set the image to be drawn by this component.
void	setImage (const Image *image)
	Set the image to be drawn by this component.
const Image *	getImage () const
	return the current set image that will be drawn by this component
void	setColours (const ColourRect &cr)
	Set the colour values used when rendering this component.
void	setColours (const Colour &c)
	Set the colour values used when rendering this component.
const ColourRect &	getColours () const
	return the ColourRect object used when drawing this component.
void	setSize (const Sizef &sz)
	set the size for rendering the image (0s mean 'normal' size)
const Sizef &	getSize () const
	return the size for rendering the image (0s mean 'normal' size)
void	draw (const Window *ref_wnd, GeometryBuffer &buffer, const Vector2f &position, const ColourRect *mod_colours, const Rectf *clip_rect, const float vertical_space, const float space_extra) const
	draw the component.
Sizef	getPixelSize (const Window *ref_wnd) const
	return the pixel size of the rendered component.
bool	canSplit () const
	return whether the component can be split
RenderedStringImageComponent *	split (const Window *ref_wnd, 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.
RenderedStringImageComponent *	clone () const
	clone this component.
size_t	getSpaceCount () const
	return the total number of spacing characters in the string.
void	setSelection (const Window *ref_wnd, const float start, const float end)
	mark some region appropriate given /a start and /a end as selected.
Protected Attributes
const Image *	d_image
	pointer to the image drawn by the component.
ColourRect	d_colours
	ColourRect object describing the colours to use when rendering.
Sizef	d_size
	target size to render the image at (0s mean natural size)
bool	d_selected

---

Detailed Description

String component that draws an image.

---

Member Function Documentation

RenderedStringImageComponent* CEGUI::RenderedStringImageComponent::split	(	const Window *	ref_wnd,
		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.