#include <CEGUIInterfaces.h>
Inherits DigitalSpaces::DIObjectBase.
Public Member Functions | |
| unsigned long | getItemCount () |
| Return number of items attached to the list. | |
| DICEGUIItemEntry * | getItemFromIndex (unsigned long index) |
| Return the item at index position index. | |
| unsigned long | getItemIndex (DICEGUIItemEntry *item) |
| Return the index of ItemEntry item. | |
| DICEGUIItemEntry * | findItemWithText (const char *text, DICEGUIItemEntry *start_item) |
| Search the list for an item with the specified text. | |
| bool | isItemInList (DICEGUIItemEntry *item) |
| Return whether the specified ItemEntry is in the List. | |
| bool | isAutoResizeEnabled () |
| Return whether this window is automatically resized to fit its content. | |
| bool | isSortEnabled () |
| Returns 'true' if the list is sorted. | |
| CEGUIItemListBaseSortMode | getSortMode () |
| Get sort mode. | |
| void | resetList () |
| Get user sorting callback. | |
| void | addItem (DICEGUIItemEntry *item) |
| Add the given ItemEntry to the list. | |
| void | insertItem (DICEGUIItemEntry *item, DICEGUIItemEntry *position) |
| Insert an item into the list after a specified item already in the list. | |
| void | removeItem (DICEGUIItemEntry *item) |
| Removes the given item from the list. If the item is has the 'DestroyedByParent' property set to 'true', the item will be deleted. | |
| void | handleUpdatedItemData () |
| Causes the list to update it's internal state after changes have been made to one or more attached ItemEntry objects. | |
| void | handleUpdatedItemData (bool resort) |
| void | setAutoResizeEnabled (bool setting) |
| Set whether or not this ItemListBase widget should automatically resize to fit its content. | |
| void | sizeToContent () |
| 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. | |
| void | endInitialisation () |
| Triggers a ListContentsChanged event. These are not fired during initialisation for optimization purposes. | |
| void | performChildWindowLayout () |
| method called to perform extended laying out of attached child windows. | |
| void | getItemRenderArea (out_Vector4f *area) |
| Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. | |
| DICEGUIWindow * | getContentPane () |
| Returns a pointer to the window that all items are directed too. | |
| void | notifyItemClicked (DICEGUIItemEntry *li) |
| Notify this ItemListBase that the given item was just clicked. Internal function - NOT to be used from client code. | |
| void | notifyItemSelectState (DICEGUIItemEntry *li, bool state) |
| Notify this ItemListBase that the given item just changed selection state. Internal function - NOT to be used from client code. | |
| void | setSortEnabled (bool setting) |
| Set whether the list should be sorted (by text). | |
| void | setSortMode (CEGUIItemListBaseSortMode mode) |
| Set mode to be used when sorting the list. | |
| void | sortList () |
| Set a user callback as sorting function. | |
| void | sortList (bool relayout) |
| unsigned long DigitalSpaces::DICEGUIItemListBase::getItemCount | ( | ) |
Return number of items attached to the list.
| DICEGUIItemEntry* DigitalSpaces::DICEGUIItemListBase::getItemFromIndex | ( | unsigned long | index | ) |
Return the item at index position index.
| index | Zero based index of the item to be returned. |
| InvalidRequestException | thrown if index is out of range. |
| unsigned long DigitalSpaces::DICEGUIItemListBase::getItemIndex | ( | DICEGUIItemEntry * | item | ) |
Return the index of ItemEntry item.
| item | Pointer to a ItemEntry whos zero based index is to be returned. |
| InvalidRequestException | thrown if item is not attached to this list. |
| DICEGUIItemEntry* DigitalSpaces::DICEGUIItemListBase::findItemWithText | ( | const char * | text, | |
| DICEGUIItemEntry * | start_item | |||
| ) |
Search the list for an item with the specified text.
| text | String object containing the text to be searched for. | |
| start_item | ItemEntry where the search is to begin, the search will not include item. If item is NULL, the search will begin from the first item in the list. |
| InvalidRequestException | thrown if item is not attached to this list box. |
| bool DigitalSpaces::DICEGUIItemListBase::isItemInList | ( | DICEGUIItemEntry * | item | ) |
Return whether the specified ItemEntry is in the List.
| bool DigitalSpaces::DICEGUIItemListBase::isAutoResizeEnabled | ( | ) |
Return whether this window is automatically resized to fit its content.
| bool DigitalSpaces::DICEGUIItemListBase::isSortEnabled | ( | ) |
Returns 'true' if the list is sorted.
| CEGUIItemListBaseSortMode DigitalSpaces::DICEGUIItemListBase::getSortMode | ( | ) |
Get sort mode.
| void DigitalSpaces::DICEGUIItemListBase::resetList | ( | ) |
Get user sorting callback.
Remove all items from the list. Note that this will cause items, which does not have the 'DestroyedByParent' property set to 'false', to be deleted.
| void DigitalSpaces::DICEGUIItemListBase::addItem | ( | DICEGUIItemEntry * | item | ) |
Add the given ItemEntry to the list.
| item | Pointer to the ItemEntry to be added to the list. Note that it is the passed object that is added to the list, a copy is not made. If this parameter is NULL, nothing happens. |
| void DigitalSpaces::DICEGUIItemListBase::insertItem | ( | DICEGUIItemEntry * | item, | |
| DICEGUIItemEntry * | position | |||
| ) |
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.
| item | Pointer to the ItemEntry to be inserted. Note that it is the passed object that is added to the list, a copy is not made. If this parameter is NULL, nothing happens. | |
| position | Pointer to a ItemEntry that item is to be inserted after. If this parameter is NULL, the item is inserted at the start of the list. |
| void DigitalSpaces::DICEGUIItemListBase::removeItem | ( | DICEGUIItemEntry * | item | ) |
Removes the given item from the list. If the item is has the 'DestroyedByParent' property set to 'true', the item will be deleted.
| item | Pointer to the ItemEntry that is to be removed. If item is not attached to this list then nothing will happen. |
| void DigitalSpaces::DICEGUIItemListBase::handleUpdatedItemData | ( | ) |
Causes the list to update it's internal state after changes have been made to one or more attached ItemEntry objects.
It should not be necessary to call this from client code, as the ItemEntries themselves call it if their parent is an ItemListBase.
| resort | 'true' to redo the list sorting as well. 'false' to only do layout and perhaps auto resize. (defaults to 'false') |
| void DigitalSpaces::DICEGUIItemListBase::handleUpdatedItemData | ( | bool | resort | ) |
| void DigitalSpaces::DICEGUIItemListBase::setAutoResizeEnabled | ( | bool | setting | ) |
Set whether or not this ItemListBase widget should automatically resize to fit its content.
| setting | Boolean value that if true enables automatic resizing, if false disables automatic resizing. |
| void DigitalSpaces::DICEGUIItemListBase::sizeToContent | ( | ) |
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.
| void DigitalSpaces::DICEGUIItemListBase::endInitialisation | ( | ) |
Triggers a ListContentsChanged event. These are not fired during initialisation for optimization purposes.
| void DigitalSpaces::DICEGUIItemListBase::performChildWindowLayout | ( | ) |
method called to perform extended laying out of attached child windows.
The system may call this at various times (like when it is resized for example), and it may be invoked directly where required.
| void DigitalSpaces::DICEGUIItemListBase::getItemRenderArea | ( | out_Vector4f * | area | ) |
Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items.
| DICEGUIWindow* DigitalSpaces::DICEGUIItemListBase::getContentPane | ( | ) |
Returns a pointer to the window that all items are directed too.
| void DigitalSpaces::DICEGUIItemListBase::notifyItemClicked | ( | DICEGUIItemEntry * | li | ) |
Notify this ItemListBase that the given item was just clicked. Internal function - NOT to be used from client code.
| void DigitalSpaces::DICEGUIItemListBase::notifyItemSelectState | ( | DICEGUIItemEntry * | li, | |
| bool | state | |||
| ) |
Notify this ItemListBase that the given item just changed selection state. Internal function - NOT to be used from client code.
| void DigitalSpaces::DICEGUIItemListBase::setSortEnabled | ( | bool | setting | ) |
Set whether the list should be sorted (by text).
| void DigitalSpaces::DICEGUIItemListBase::setSortMode | ( | CEGUIItemListBaseSortMode | mode | ) |
Set mode to be used when sorting the list.
| mode | SortMode enum. |
| void DigitalSpaces::DICEGUIItemListBase::sortList | ( | ) |
Set a user callback as sorting function.
| mode | SortCallback |
| relayout | True if the item layout should be redone after the sorting. False to only sort the internal list. Nothing more. |
| void DigitalSpaces::DICEGUIItemListBase::sortList | ( | bool | relayout | ) |
1.5.6