Inheritance diagram for CEGUI::ListboxItem:
Public Member Functions | |
ListboxItem (const String &text, uint item_id=0, void *item_data=NULL, bool disabled=false, bool auto_delete=true) | |
base class constructor | |
virtual | ~ListboxItem (void) |
base class destructor | |
const String & | getText (void) const |
return the text string set for this list box item. | |
const String & | getTooltipText (void) const |
uint | getID (void) const |
Return the current ID assigned to this list box item. | |
void * | getUserData (void) const |
Return the pointer to any client assigned user data attached to this lis box item. | |
bool | isSelected (void) const |
return whether this item is selected. | |
bool | isDisabled (void) const |
return whether this item is disabled. | |
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. | |
const Window * | getOwnerWindow (const Window *owner) |
Get the owner window for this ListboxItem. | |
ColourRect | getSelectionColours (void) const |
Return the current colours used for selection highlighting. | |
const Image * | getSelectionBrushImage (void) const |
Return the current selection highlighting brush. | |
void | setText (const String &text) |
set the text string for this list box item. | |
void | setTooltipText (const String &text) |
void | setID (uint item_id) |
Set the ID assigned to this list box item. | |
void | setUserData (void *item_data) |
Set the client assigned user data attached to this lis box item. | |
void | setSelected (bool setting) |
set whether this item is selected. | |
void | setDisabled (bool setting) |
set whether this item is disabled. | |
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. | |
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. | |
void | setSelectionColours (const ColourRect &cols) |
Set the colours used for selection highlighting. | |
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. | |
void | setSelectionColours (colour col) |
Set the colours used for selection highlighting. | |
void | setSelectionBrushImage (const Image *image) |
Set the selection highlighting brush image. | |
void | setSelectionBrushImage (const String &imageset, const String &image) |
Set the selection highlighting brush image. | |
virtual Size | getPixelSize (void) const =0 |
Return the rendered pixel size of this list box item. | |
virtual void | draw (const Vector3 &position, float alpha, const Rect &clipper) const =0 |
Draw the list box item in its current state. | |
virtual void | draw (RenderCache &cache, const Rect &targetRect, float zBase, float alpha, const Rect *clipper) const =0 |
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 | 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. | |
const Window * | d_owner |
Pointer to the window that owns this item. | |
ColourRect | d_selectCols |
Colours used for selection highlighting. | |
const Image * | d_selectBrush |
Image used for rendering selection. |
|
Draw the list box item in its current state.
Implemented in CEGUI::ListboxTextItem. |
|
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.
|
|
Get the owner window for this ListboxItem. The owner of a ListboxItem is typically set by the list box widgets when an item is added or inserted.
|
|
Return the rendered pixel size of this list box item.
Implemented in CEGUI::ListboxTextItem. |
|
Return the current selection highlighting brush.
|
|
Return the current colours used for selection highlighting.
|
|
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.
|
|
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.
|
|
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.
|
|
return whether this item is disabled.
|
|
return whether this item is selected.
|
|
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.
|
|
set whether this item is disabled.
|
|
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.
|
|
Set the owner window for this ListboxItem. This is called by all the list box widgets when an item is added or inserted.
|
|
set whether this item is selected.
|
|
Set the selection highlighting brush image.
|
|
Set the selection highlighting brush image.
|
|
Set the colours used for selection highlighting.
|
|
Set the colours used for selection highlighting.
|
|
Set the colours used for selection highlighting.
|
|
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.
|
|
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.
|