Crazy Eddie's GUI System  0.8.4
CEGUI::RenderedStringTextComponent Class Reference

String component that draws an image. More...

+ Inheritance diagram for CEGUI::RenderedStringTextComponent:
+ Collaboration diagram for CEGUI::RenderedStringTextComponent:

List of all members.

Public Member Functions

 RenderedStringTextComponent ()
 Constructor.
 RenderedStringTextComponent (const String &text)
 RenderedStringTextComponent (const String &text, const String &font_name)
 RenderedStringTextComponent (const String &text, const Font *font)
void setText (const String &text)
 Set the text to be rendered by this component.
const StringgetText () const
 return the text that will be rendered by this component
void setFont (const Font *font)
 set the font to use when rendering the text.
void setFont (const String &font_name)
 set the font to use when rendering the text.
const FontgetFont () const
 return the font set to be used. If 0 the default font will be used.
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 ColourRectgetColours () const
 return the ColourRect object used when drawing this component.
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
RenderedStringTextComponentsplit (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.
RenderedStringTextComponentclone () 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 Member Functions

const FontgetEffectiveFont (const Window *window) const

Static Protected Member Functions

static size_t getNextTokenLength (const String &text, size_t start_idx)

Protected Attributes

String d_text
 pointer to the image drawn by the component.
const Fontd_font
 Font to use for text rendering, 0 for system default.
ColourRect d_colours
 ColourRect object describing the colours to use when rendering.
size_t d_selectionStart
 last set selection
size_t d_selectionLength

Detailed Description

String component that draws an image.


Member Function Documentation

RenderedStringTextComponent* CEGUI::RenderedStringTextComponent::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:
InvalidRequestExceptionthrown if the RenderedStringComponent does not support being split.

Implements CEGUI::RenderedStringComponent.

 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends