Inheritance diagram for CEGUI::ItemListBase:
Public Member Functions | |
size_t | getItemCount (void) const |
Return number of items attached to the list. | |
ItemEntry * | getItemFromIndex (size_t index) const |
Return the item at index position index. | |
size_t | getItemIndex (const ItemEntry *item) const |
Return the index of ItemEntry item. | |
ItemEntry * | findItemWithText (const String &text, const ItemEntry *start_item) |
Search the list for an item with the specified text. | |
bool | isItemInList (const ItemEntry *item) const |
Return whether the specified ItemEntry is in the List. | |
bool | isAutoResizeEnabled () const |
Return wheter this window is automatically resized to fit its content. | |
virtual void | initialise (void) |
Initialise the Window based object ready for use. | |
void | resetList (void) |
Remove all items from the list. | |
void | addItem (ItemEntry *item) |
Add the given ItemEntry to the list. | |
void | insertItem (ItemEntry *item, const ItemEntry *position) |
Insert an item into the list after a specified item already in the list. | |
void | removeItem (ItemEntry *item) |
Removes the given item from the list. If the item is has the auto delete state set, the item will be deleted. | |
void | handleUpdatedItemData (void) |
Causes the list to update it's internal state after changes have been made to one or more attached ItemEntry objects. | |
void | setAutoResizeEnabled (bool setting) |
Set whether or not this ItemListBase widget should automatically resize to fit its content. | |
virtual void | sizeToContent (void) |
Resize the ItemListBase to exactly fit the content that is attached to it. Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering items. | |
ItemListBase (const String &type, const String &name) | |
Constructor for ItemListBase base class. | |
virtual | ~ItemListBase (void) |
Destructor for ItemListBase base class. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | EventListContentsChanged |
Event triggered when the contents of the list is changed. | |
Protected Types | |
typedef std::vector< ItemEntry * > | ItemEntryList |
Protected Member Functions | |
virtual void | sizeToContent_impl (void)=0 |
Resize the ItemListBase to exactly fit the content that is attached to it. Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering items. | |
virtual Size | getContentSize ()=0 |
Returns the Size in unclipped pixels of the content attached to this ItemListBase that is attached to it. | |
virtual Rect | getItemRenderArea (void) const =0 |
Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. | |
virtual void | layoutItemWidgets ()=0 |
Setup size and position for the item widgets attached to this ItemListBase. | |
virtual void | populateRenderCache ()=0 |
Perform the actual rendering for this Window. | |
void | addItemListBaseEvents (void) |
Add list box specific events. | |
bool | resetList_impl (void) |
Remove all items from the list. | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. | |
virtual void | onListContentsChanged (WindowEventArgs &e) |
Handler called internally when the list contents are changed. | |
virtual void | onSized (WindowEventArgs &e) |
Handler called when the window's size changes. | |
Protected Attributes | |
ItemEntryList | d_listItems |
list of items in the list. | |
bool | d_autoResize |
|
Add the given ItemEntry to the list.
|
|
Search the list for an item with the specified text.
|
|
Returns the Size in unclipped pixels of the content attached to this ItemListBase that is attached to it.
Implemented in CEGUI::Menubar, and CEGUI::PopupMenu. |
|
Return number of items attached to the list.
|
|
Return the item at index position index.
|
|
Return the index of ItemEntry item.
|
|
Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items.
|
|
Causes the list to update it's internal state after changes have been made to one or more attached ItemEntry objects. Client code must call this whenever it has made any changes to ItemEntry objects already attached to the list. If you are just adding items, or removed items to update them prior to re-adding them, there is no need to call this method.
|
|
Initialise the Window based object ready for use.
Reimplemented from CEGUI::Window. |
|
Insert an item into the list after a specified item already in the list. Note that if the list is sorted, the item may not end up in the requested position.
|
|
Return wheter this window is automatically resized to fit its content.
|
|
Return whether the specified ItemEntry is in the List.
|
|
Setup size and position for the item widgets attached to this ItemListBase.
Implemented in CEGUI::Menubar, and CEGUI::PopupMenu. |
|
Handler called when the window's size changes.
Reimplemented from CEGUI::Window. |
|
Perform the actual rendering for this Window.
Reimplemented from CEGUI::Window. |
|
Removes the given item from the list. If the item is has the auto delete state set, the item will be deleted.
|
|
Remove all items from the list. Note that this will cause 'AutoDelete' items to be deleted. |
|
Remove all items from the list.
|
|
Set whether or not this ItemListBase widget should automatically resize to fit its content.
|
|
Resize the ItemListBase to exactly fit the content that is attached to it. Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering items.
|
|
Resize the ItemListBase to exactly fit the content that is attached to it. Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering items.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::Window. Reimplemented in CEGUI::Menubar, CEGUI::MenuBase, and CEGUI::PopupMenu. |