Crazy Eddie's GUI System  0.8.4
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:

List of all members.

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 WindowgetWindow () const
 return the window currently controlled by 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
RenderedStringWidgetComponentsplit (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.
RenderedStringWidgetComponentclone () 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

WindowgetEffectiveWindow (const Window *ref_wnd) const

Protected Attributes

String d_windowName
 Name of window to manipulate.
bool d_windowPtrSynched
 whether d_window is synched.
Windowd_window
 pointer to the window controlled by this component.
bool d_selected

Detailed Description

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


Member Function Documentation

RenderedStringWidgetComponent* CEGUI::RenderedStringWidgetComponent::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