Crazy Eddies GUI System  0.6.0
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
CEGUI::TreeItem Class Reference

Base class for list box items. More...

+ Collaboration diagram for CEGUI::TreeItem:

Public Types

typedef std::vector< TreeItem * > LBItemList
 

Public Member Functions

 TreeItem (const String &text, uint item_id=0, void *item_data=0, bool disabled=false, bool auto_delete=true)
 base class constructor
 
virtual ~TreeItem (void)
 base class destructor
 
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...
 
const StringgetText (void) const
 return the text string set for this list box item. More...
 
const StringgetTooltipText (void) const
 
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 (void)
 Get the owner window for this TreeItem. 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 setText (const String &text)
 set the text string for this list box item. 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 TreeItem. 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 &imageset, const String &image)
 Set the selection highlighting brush image. More...
 
void setButtonLocation (Rect &buttonOffset)
 Tell the treeItem where its button is located. Calculated and set in Tree.cpp. More...
 
RectgetButtonLocation (void)
 
bool getIsOpen (void)
 
void toggleIsOpen (void)
 
TreeItemgetTreeItemFromIndex (size_t itemIndex)
 
size_t getItemCount (void) const
 
LBItemList & getItemList (void)
 
void addItem (TreeItem *item)
 
void setIcon (const Image &theIcon)
 
virtual Size getPixelSize (void) const
 Return the rendered pixel size of this list box item. More...
 
virtual void draw (const Vector3 &position, float alpha, const Rect &clipper) const
 Draw the list box item in its current state. More...
 
virtual void draw (RenderCache &cache, const Rect &targetRect, float zBase, float alpha, const Rect *clipper) const
 
virtual bool operator< (const TreeItem &rhs) const
 Less-than operator, compares item texts.
 
virtual bool operator> (const TreeItem &rhs) const
 Greater-than operator, compares item texts.
 

Static Public Attributes

static const colour DefaultTextColour = 0xFFFFFFFF
 Default text colour.
 
static const colour DefaultSelectionColour = 0xFF4444AA
 Default selection brush colour.
 

Protected Member Functions

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

String d_itemText
 Text for this list box item. If not rendered, this is still used for list sorting.
 
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.
 
Rect d_buttonLocation
 
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.
 
ColourRect d_textCols
 Colours used for rendering the text.
 
Fontd_font
 Font used for rendering text.
 
Imaged_iconImage
 Icon to be displayed with this treeItem.
 
LBItemList d_listItems
 list of items in this item's tree branch.
 
bool d_isOpen
 true if the this item's tree branch is opened
 

Detailed Description

Base class for list box items.

Member Function Documentation

void CEGUI::TreeItem::draw ( const Vector3 position,
float  alpha,
const Rect clipper 
) const
virtual

Draw the list box item in its current state.

Parameters
positionVecor3 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.

References d_itemText, d_selectBrush, d_selectCols, d_selected, d_textCols, CEGUI::Image::draw(), CEGUI::Font::drawText(), CEGUI::Font::getBaseline(), getFont(), CEGUI::Font::getLineSpacing(), and getModulateAlphaColourRect().

Font * CEGUI::TreeItem::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

References d_font, d_owner, CEGUI::System::getDefaultFont(), CEGUI::Window::getFont(), and CEGUI::System::getSingleton().

Referenced by draw(), getPixelSize(), and setFont().

uint CEGUI::TreeItem::getID ( void  ) const
inline

Return the current ID assigned to this list box item.

Note that the system does not make use of this value, client code can assign any meaning it wishes to the ID.

Returns
ID code currently assigned to this list box item
const Window* CEGUI::TreeItem::getOwnerWindow ( void  )
inline

Get the owner window for this TreeItem.

The owner of a TreeItem is typically set by the list box widgets when an item is added or inserted.

Returns
Ponter to the window that is considered the owner of this TreeItem.
Size CEGUI::TreeItem::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.

References d_itemText, getFont(), CEGUI::Font::getLineSpacing(), and CEGUI::Font::getTextExtent().

Referenced by CEGUI::Tree::ensureItemIsVisible().

const Image* CEGUI::TreeItem::getSelectionBrushImage ( void  ) const
inline

Return the current selection highlighting brush.

Returns
Pointer to the Image object currently used for selection highlighting.
ColourRect CEGUI::TreeItem::getSelectionColours ( void  ) const
inline

Return the current colours used for selection highlighting.

Returns
ColourRect object describing the currently set colours
const String& CEGUI::TreeItem::getText ( void  ) const
inline

return the text string set 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.

Returns
String object containing the current text for the list box item.

Referenced by operator<(), and operator>().

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

Return the current colours used for text rendering.

Returns
ColourRect object describing the currently set colours
void* CEGUI::TreeItem::getUserData ( void  ) const
inline

Return the pointer to any client assigned user data attached to this lis box item.

Note that the system does not make use of this data, client code can assign any meaning it wishes to the attached data.

Returns
Pointer to the currently assigned user data.
bool CEGUI::TreeItem::isAutoDeleted ( void  ) const
inline

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.

Returns
true if the item object will be deleted by the system when the list box it is attached to is destroyed, or when the item is removed from the list. false if client code must destroy the item after it is removed from the list.

Referenced by CEGUI::Tree::removeItem().

bool CEGUI::TreeItem::isDisabled ( void  ) const
inline

return whether this item is disabled.

Returns
true if the item is disabled, false if the item is enabled.
bool CEGUI::TreeItem::isSelected ( void  ) const
inline

return whether this item is selected.

Returns
true if the item is selected, false if the item is not selected.

Referenced by CEGUI::Tree::onMouseButtonDown().

void CEGUI::TreeItem::setAutoDeleted ( bool  setting)
inline

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.

Parameters
settingtrue if the item object should be deleted by the system when the list box it is attached to is destroyed, or when the item is removed from the list. false if client code will destroy the item after it is removed from the list.
Returns
Nothing.
void CEGUI::TreeItem::setButtonLocation ( Rect buttonOffset)
inline

Tell the treeItem where its button is located. Calculated and set in Tree.cpp.

Parameters
buttonOffsetLocation of the button in screenspace.
void CEGUI::TreeItem::setDisabled ( bool  setting)
inline

set whether this item is disabled.

Parameters
settingtrue if the item is disabled, false if the item is enabled.
Returns
Nothing.
void CEGUI::TreeItem::setFont ( Font font)
inline

Set the font to be used by this ListboxTextItem.

Parameters
fontFont to be used for rendering this item
Returns
Nothing

Referenced by setFont().

void CEGUI::TreeItem::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

References getFont(), and setFont().

void CEGUI::TreeItem::setID ( uint  item_id)
inline

Set the ID assigned to this list box item.

Note that the system does not make use of this value, client code can assign any meaning it wishes to the ID.

Parameters
item_idID code to be assigned to this list box item
Returns
Nothing.
void CEGUI::TreeItem::setOwnerWindow ( const Window owner)
inline

Set the owner window for this TreeItem. This is called by all the list box widgets when an item is added or inserted.

Parameters
ownerPonter to the window that should be considered the owner of this TreeItem.
Returns
Nothing

Referenced by CEGUI::Tree::addItem(), and CEGUI::Tree::insertItem().

void CEGUI::TreeItem::setSelected ( bool  setting)
inline

set whether this item is selected.

Parameters
settingtrue if the item is selected, false if the item is not selected.
Returns
Nothing.

Referenced by CEGUI::Tree::onMouseButtonDown(), and CEGUI::Tree::setMultiselectEnabled().

void CEGUI::TreeItem::setSelectionBrushImage ( const Image image)
inline

Set the selection highlighting brush image.

Parameters
imagePointer to the Image object to be used for selection highlighting.
Returns
Nothing.

Referenced by setSelectionBrushImage().

void CEGUI::TreeItem::setSelectionBrushImage ( const String imageset,
const String image 
)

Set the selection highlighting brush image.

Parameters
imagesetName of the imagest containing the image to be used.
imageName of the image to be used
Returns
Nothing.

References setSelectionBrushImage().

void CEGUI::TreeItem::setSelectionColours ( const ColourRect cols)
inline

Set the colours used for selection highlighting.

Parameters
colsColourRect object describing the colours to be used.
Returns
Nothing.
void CEGUI::TreeItem::setSelectionColours ( colour  top_left_colour,
colour  top_right_colour,
colour  bottom_left_colour,
colour  bottom_right_colour 
)

Set the colours used for selection highlighting.

Parameters
top_left_colourColour (as ARGB value) to be applied to the top-left corner of the selection area.
top_right_colourColour (as ARGB value) to be applied to the top-right corner of the selection area.
bottom_left_colourColour (as ARGB value) to be applied to the bottom-left corner of the selection area.
bottom_right_colourColour (as ARGB value) to be applied to the bottom-right corner of the selection area.
Returns
Nothing.

References d_selectCols.

void CEGUI::TreeItem::setSelectionColours ( colour  col)
inline

Set the colours used for selection highlighting.

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

References setSelectionColours().

Referenced by setSelectionColours().

void CEGUI::TreeItem::setText ( const String text)
inline

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.
void CEGUI::TreeItem::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::TreeItem::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.

References d_textCols.

void CEGUI::TreeItem::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::TreeItem::setUserData ( void *  item_data)
inline

Set the client assigned user data attached to this lis box item.

Note that the system does not make use of this data, client code can assign any meaning it wishes to the attached data.

Parameters
item_dataPointer to the user data to attach to this list item.
Returns
Nothing.