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

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

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

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. More...
 
ColourRect getTextColours (void) const
 Return the current colours used for text rendering. More...
 
void setFont (Font *font)
 Set the font to be used by this ListboxTextItem. More...
 
void setFont (const String &font_name)
 Set the font to be used by this ListboxTextItem. More...
 
void setTextColours (const ColourRect &cols)
 Set the colours used for text rendering. More...
 
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. More...
 
void setTextColours (Colour col)
 Set the colours used for text rendering. More...
 
void setTextParsingEnabled (const bool enable)
 Set whether the the ListboxTextItem will have it's text parsed via the BasicRenderedStringParser or not. More...
 
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. More...
 
bool handleFontRenderSizeChange (const Font *const font)
 Perform any updates needed because the given font's render size has changed. More...
 
Sizef getPixelSize (void) const
 Return the rendered pixel size of this list box item. More...
 
void draw (GeometryBuffer &buffer, const Rectf &targetRect, float alpha, const Rectf *clipper) const
 Draw the list box item in its current state. More...
 
- Public Member Functions inherited from CEGUI::ListboxItem
 ListboxItem (const String &text, uint item_id=0, void *item_data=0, bool disabled=false, bool auto_delete=true)
 base class constructor
 
virtual ~ListboxItem (void)
 base class destructor
 
const StringgetTooltipText (void) const
 return the text string set for this list box item. More...
 
const StringgetText (void) const
 
const StringgetTextVisual () const
 return text string with visual ordering of glyphs.
 
uint getID (void) const
 Return the current ID assigned to this list box item. More...
 
void * getUserData (void) const
 Return the pointer to any client assigned user data attached to this lis box item. More...
 
bool isSelected (void) const
 return whether this item is selected. More...
 
bool isDisabled (void) const
 return whether this item is disabled. More...
 
bool isAutoDeleted (void) const
 return whether this item will be automatically deleted when the list box it is attached to is destroyed, or when the item is removed from the list box. More...
 
const WindowgetOwnerWindow () const
 Get the owner window for this ListboxItem. More...
 
ColourRect getSelectionColours (void) const
 Return the current colours used for selection highlighting. More...
 
const ImagegetSelectionBrushImage (void) const
 Return the current selection highlighting brush. More...
 
void setTooltipText (const String &text)
 
void setID (uint item_id)
 Set the ID assigned to this list box item. More...
 
void setUserData (void *item_data)
 Set the client assigned user data attached to this lis box item. More...
 
void setSelected (bool setting)
 set whether this item is selected. More...
 
void setDisabled (bool setting)
 set whether this item is disabled. More...
 
void setAutoDeleted (bool setting)
 Set whether this item will be automatically deleted when the list box it is attached to is destroyed, or when the item is removed from the list box. More...
 
void setOwnerWindow (const Window *owner)
 Set the owner window for this ListboxItem. This is called by all the list box widgets when an item is added or inserted. More...
 
void setSelectionColours (const ColourRect &cols)
 Set the colours used for selection highlighting. More...
 
void setSelectionColours (Colour top_left_colour, Colour top_right_colour, Colour bottom_left_colour, Colour bottom_right_colour)
 Set the colours used for selection highlighting. More...
 
void setSelectionColours (Colour col)
 Set the colours used for selection highlighting. More...
 
void setSelectionBrushImage (const Image *image)
 Set the selection highlighting brush image. More...
 
void setSelectionBrushImage (const String &name)
 Set the selection highlighting brush image. More...
 
virtual bool operator< (const ListboxItem &rhs) const
 Less-than operator, compares item texts.
 
virtual bool operator> (const ListboxItem &rhs) const
 Greater-than operator, compares item texts.
 

Static Public Attributes

static const Colour DefaultTextColour
 Default text colour.
 
- Static Public Attributes inherited from CEGUI::ListboxItem
static const Colour DefaultSelectionColour
 Default selection brush colour.
 

Protected Member Functions

void parseTextString () const
 
- Protected Member Functions inherited from CEGUI::ListboxItem
ColourRect getModulateAlphaColourRect (const ColourRect &cols, float alpha) const
 Return a ColourRect object describing the colours in cols after having their alpha component modulated by the value alpha.
 
Colour calculateModulatedAlphaColour (Colour col, float alpha) const
 Return a colour value describing the colour specified by col after having its alpha component modulated by the value alpha.
 

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.
 
- Protected Attributes inherited from CEGUI::ListboxItem
String d_textLogical
 
BidiVisualMappingd_bidiVisualMapping
 pointer to bidirection support object
 
bool d_bidiDataValid
 whether bidi visual mapping has been updated since last text change.
 
String d_tooltipText
 Text for the individual tooltip of this item.
 
uint d_itemID
 ID code assigned by client code. This has no meaning within the GUI system.
 
void * d_itemData
 Pointer to some client code data. This has no meaning within the GUI system.
 
bool d_selected
 true if this item is selected. false if the item is not selected.
 
bool d_disabled
 true if this item is disabled. false if the item is not disabled.
 
bool d_autoDelete
 true if the system should destroy this item, false if client code will destroy the item.
 
const Windowd_owner
 Pointer to the window that owns this item.
 
ColourRect d_selectCols
 Colours used for selection highlighting.
 
const Imaged_selectBrush
 Image used for rendering selection.
 

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.

ColourRect CEGUI::ListboxTextItem::getTextColours ( void  ) const
inline

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.

void CEGUI::ListboxTextItem::setFont ( Font font)

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.
void CEGUI::ListboxTextItem::setTextColours ( Colour  col)
inline

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* CEGUI::ListboxTextItem::d_font
protected

Font used for rendering text.