Crazy Eddie's GUI System 0.8.7
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...

#include <RenderedStringWordWrapper.h>

+ 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
 
CEGUIEXPORT void format (const Window *ref_wnd, const Sizef &area_size)
 specialised version of format used with Justified text More...
 
- Public Member Functions inherited from CEGUI::FormattedRenderedString
virtual ~FormattedRenderedString ()
 Destructor.
 
virtual void format (const Window *ref_wnd, const Sizef &area_size)=0
 
virtual void draw (const Window *ref_wnd, GeometryBuffer &buffer, const Vector2f &position, const ColourRect *mod_colours, const Rectf *clip_rect) const =0
 
virtual size_t getFormattedLineCount () const =0
 
virtual float getHorizontalExtent (const Window *ref_wnd) const =0
 
virtual float getVerticalExtent (const Window *ref_wnd) const =0
 
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.
 

Protected Member Functions

void deleteFormatters ()
 Delete the current formatters and associated RenderedStrings.
 
- Protected Member Functions inherited from CEGUI::FormattedRenderedString
 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'.

Member Function Documentation

◆ draw()

template<typename T >
void CEGUI::RenderedStringWordWrapper< T >::draw ( const Window ref_wnd,
GeometryBuffer buffer,
const Vector2f position,
const ColourRect mod_colours,
const Rectf clip_rect 
) const
virtual

◆ format() [1/2]

template<typename T >
void CEGUI::RenderedStringWordWrapper< T >::format ( const Window ref_wnd,
const Sizef area_size 
)
virtual

◆ format() [2/2]

CEGUIEXPORT void CEGUI::RenderedStringWordWrapper< JustifiedRenderedString >::format ( const Window ref_wnd,
const Sizef area_size 
)
virtual

specialised version of format used with Justified text

Implements CEGUI::FormattedRenderedString.

◆ getFormattedLineCount()

template<typename T >
size_t CEGUI::RenderedStringWordWrapper< T >::getFormattedLineCount
virtual

◆ getHorizontalExtent()

template<typename T >
float CEGUI::RenderedStringWordWrapper< T >::getHorizontalExtent ( const Window ref_wnd) const
virtual

◆ getVerticalExtent()

template<typename T >
float CEGUI::RenderedStringWordWrapper< T >::getVerticalExtent ( const Window ref_wnd) const
virtual