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

Class used for textual items in a list box. More...

+ Inheritance diagram for CEGUI::ListboxTextItem:
+ Collaboration diagram for CEGUI::ListboxTextItem:

List of all members.

Public Member Functions

 ListboxTextItem (const String &text, uint item_id=0, void *item_data=0, bool disabled=false, bool auto_delete=true)
 base class constructor
virtual ~ListboxTextItem (void)
 base class destructor
const FontgetFont (void) const
 Return a pointer to the font being used by this ListboxTextItem.
ColourRect getTextColours (void) const
 Return the current colours used for text rendering.
void setFont (Font *font)
 Set the font to be used by this ListboxTextItem.
void setFont (const String &font_name)
 Set the font to be used by this ListboxTextItem.
void setTextColours (const ColourRect &cols)
 Set the colours used for text rendering.
void setTextColours (Colour top_left_colour, Colour top_right_colour, Colour bottom_left_colour, Colour bottom_right_colour)
 Set the colours used for text rendering.
void setTextColours (Colour col)
 Set the colours used for text rendering.
void setTextParsingEnabled (const bool enable)
 Set whether the the ListboxTextItem will have it's text parsed via the BasicRenderedStringParser or not.
bool isTextParsingEnabled () const
 return whether text parsing is enabled for this ListboxTextItem.
void setText (const String &text)
 set the text string for this list box item.
bool handleFontRenderSizeChange (const Font *const font)
 Perform any updates needed because the given font's render size has changed.
Sizef getPixelSize (void) const
 Return the rendered pixel size of this list box item.
void draw (GeometryBuffer &buffer, const Rectf &targetRect, float alpha, const Rectf *clipper) const
 Draw the list box item in its current state.

Static Public Attributes

static const Colour DefaultTextColour
 Default text colour.

Protected Member Functions

void parseTextString () const

Protected Attributes

ColourRect d_textCols
 Colours used for rendering the text.
Fontd_font
RenderedString d_renderedString
 RenderedString drawn by this item.
bool d_renderedStringValid
 boolean used to track when item state changes (and needs re-parse)
bool d_textParsingEnabled
 boolean that specifies whether text parsing is enabled for the item.

Static Protected Attributes

static BasicRenderedStringParser d_stringParser
 Parser used to produce a final RenderedString from the standard String.
static DefaultRenderedStringParser d_noTagsStringParser
 Parser used when parsing is off. Basically just does linebreaks.

Detailed Description

Class used for textual items in a list box.


Member Function Documentation

void CEGUI::ListboxTextItem::draw ( GeometryBuffer buffer,
const Rectf targetRect,
float  alpha,
const Rectf clipper 
) const [virtual]

Draw the list box item in its current state.

Parameters:
positionVecor2 object describing the upper-left corner of area that should be rendered in to for the draw operation.
alphaAlpha value to be used when rendering the item (between 0.0f and 1.0f).
clipperRect object describing the clipping rectangle for the draw operation.
Returns:
Nothing.

Implements CEGUI::ListboxItem.

const Font* CEGUI::ListboxTextItem::getFont ( void  ) const

Return a pointer to the font being used by this ListboxTextItem.

This method will try a number of places to find a font to be used. If no font can be found, NULL is returned.

Returns:
Font to be used for rendering this item
Sizef CEGUI::ListboxTextItem::getPixelSize ( void  ) const [virtual]

Return the rendered pixel size of this list box item.

Returns:
Size object describing the size of the list box item in pixels.

Implements CEGUI::ListboxItem.

Return the current colours used for text rendering.

Returns:
ColourRect object describing the currently set colours
bool CEGUI::ListboxTextItem::handleFontRenderSizeChange ( const Font *const  font) [virtual]

Perform any updates needed because the given font's render size has changed.

/note The base implementation just returns false.

Parameters:
fontPointer to the Font whose render size has changed.
Returns:
  • true if some action was taken.
  • false if no action was taken (i.e font is not used here).

Reimplemented from CEGUI::ListboxItem.

Set the font to be used by this ListboxTextItem.

Parameters:
fontFont to be used for rendering this item
Returns:
Nothing
void CEGUI::ListboxTextItem::setFont ( const String font_name)

Set the font to be used by this ListboxTextItem.

Parameters:
font_nameString object containing the name of the Font to be used for rendering this item
Returns:
Nothing
void CEGUI::ListboxTextItem::setText ( const String text) [virtual]

set the text string for this list box item.

Note that even if the item does not render text, the text string can still be useful, since it is used for sorting list box items.

Parameters:
textString object containing the text to set for the list box item.
Returns:
Nothing.

Reimplemented from CEGUI::ListboxItem.

void CEGUI::ListboxTextItem::setTextColours ( const ColourRect cols) [inline]

Set the colours used for text rendering.

Parameters:
colsColourRect object describing the colours to be used.
Returns:
Nothing.
void CEGUI::ListboxTextItem::setTextColours ( Colour  top_left_colour,
Colour  top_right_colour,
Colour  bottom_left_colour,
Colour  bottom_right_colour 
)

Set the colours used for text rendering.

Parameters:
top_left_colourColour (as ARGB value) to be applied to the top-left corner of each text glyph rendered.
top_right_colourColour (as ARGB value) to be applied to the top-right corner of each text glyph rendered.
bottom_left_colourColour (as ARGB value) to be applied to the bottom-left corner of each text glyph rendered.
bottom_right_colourColour (as ARGB value) to be applied to the bottom-right corner of each text glyph rendered.
Returns:
Nothing.

Set the colours used for text rendering.

Parameters:
colcolour value to be used when rendering.
Returns:
Nothing.

References setTextColours().

Referenced by setTextColours().

void CEGUI::ListboxTextItem::setTextParsingEnabled ( const bool  enable)

Set whether the the ListboxTextItem will have it's text parsed via the BasicRenderedStringParser or not.

Parameters:
enable

Member Data Documentation

Font used for rendering text.

 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends