Crazy Eddies GUI System  0.7.2
Public Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
CEGUI::RenderedStringTextComponent Class Reference

String component that draws an image. More...

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

Public Member Functions

 RenderedStringTextComponent ()
 Constructor.
 
 RenderedStringTextComponent (const String &text)
 
 RenderedStringTextComponent (const String &text, const String &font_name)
 
 RenderedStringTextComponent (const String &text, 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 (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.
 
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 (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
 
RenderedStringTextComponentsplit (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...
 
RenderedStringTextComponentclone () 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 RectgetPadding () 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
 

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.
 
Fontd_font
 Font to use for text rendering, 0 for system default.
 
ColourRect d_colours
 ColourRect object describing the colours to use when rendering.
 
- 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 draws an image.

Member Function Documentation

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

Implements CEGUI::RenderedStringComponent.