Crazy Eddie's GUI System  ${CEGUI_VERSION}
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::RenderedStringWordWrapper< T > Class Template Reference

Class that handles wrapping of a rendered string into sub-strings. Each sub-string is rendered using the FormattedRenderedString based class 'T'. More...

+ Inheritance diagram for CEGUI::RenderedStringWordWrapper< T >:
+ Collaboration diagram for CEGUI::RenderedStringWordWrapper< T >:

Public Member Functions

 RenderedStringWordWrapper (const RenderedString &string)
 Constructor.
 
 ~RenderedStringWordWrapper ()
 Destructor.
 
void format (const Window *ref_wnd, const Sizef &area_size)
 
void draw (const Window *ref_wnd, GeometryBuffer &buffer, const Vector2f &position, const ColourRect *mod_colours, const Rectf *clip_rect) const
 
size_t getFormattedLineCount () const
 
float getHorizontalExtent (const Window *ref_wnd) const
 
float getVerticalExtent (const Window *ref_wnd) const
 
 RenderedStringWordWrapper (const RenderedString &string)
 Constructor.
 
 ~RenderedStringWordWrapper ()
 Destructor.
 
void format (const Window *ref_wnd, const Sizef &area_size)
 
void draw (const Window *ref_wnd, GeometryBuffer &buffer, const Vector2f &position, const ColourRect *mod_colours, const Rectf *clip_rect) const
 
size_t getFormattedLineCount () const
 
float getHorizontalExtent (const Window *ref_wnd) const
 
float getVerticalExtent (const Window *ref_wnd) const
 
template<>
CEGUIEXPORT void format (const Window *ref_wnd, const Sizef &area_size)
 
template<>
void format (const Window *ref_wnd, const Sizef &area_size)
 
template<>
CEGUIEXPORT void format (const Window *ref_wnd, const Sizef &area_size)
 
- Public Member Functions inherited from CEGUI::FormattedRenderedString
virtual ~FormattedRenderedString ()
 Destructor.
 
void setRenderedString (const RenderedString &string)
 set the RenderedString.
 
const RenderedStringgetRenderedString () const
 
virtual ~FormattedRenderedString ()
 Destructor.
 
void setRenderedString (const RenderedString &string)
 set the RenderedString.
 
const RenderedStringgetRenderedString () const
 

Protected Types

typedef std::vector
< FormattedRenderedString
*CEGUI_VECTOR_ALLOC(FormattedRenderedString *)> 
LineList
 type of collection used to track the formatted lines.
 
typedef std::vector
< FormattedRenderedString
*CEGUI_VECTOR_ALLOC(FormattedRenderedString *)> 
LineList
 type of collection used to track the formatted lines.
 

Protected Member Functions

void deleteFormatters ()
 Delete the current formatters and associated RenderedStrings.
 
void deleteFormatters ()
 Delete the current formatters and associated RenderedStrings.
 
- Protected Member Functions inherited from CEGUI::FormattedRenderedString
 FormattedRenderedString (const RenderedString &string)
 Constructor.
 
 FormattedRenderedString (const RenderedString &string)
 Constructor.
 

Protected Attributes

LineList d_lines
 collection of lines.
 
- Protected Attributes inherited from CEGUI::FormattedRenderedString
const RenderedStringd_renderedString
 RenderedString that we handle formatting for.
 

Detailed Description

template<typename T>
class CEGUI::RenderedStringWordWrapper< T >

Class that handles wrapping of a rendered string into sub-strings. Each sub-string is rendered using the FormattedRenderedString based class 'T'.