Public Member Functions | |
void | doTreeRender () |
void | doScrollbars () |
size_t | getItemCount (void) const |
Return number of items attached to the list box. | |
size_t | getSelectedCount (void) const |
Return the number of selected items in the list box. | |
TreeItem * | getFirstSelectedItem (void) const |
Return a pointer to the first selected item. | |
TreeItem * | getLastSelectedItem (void) const |
Return a pointer to the first selected item. | |
TreeItem * | getNextSelected (const TreeItem *start_item) const |
Return a pointer to the next selected item after item start_item. | |
TreeItem * | getNextSelectedItemFromList (const LBItemList &itemList, const TreeItem *start_item, bool foundStartItem) const |
bool | isSortEnabled (void) const |
return whether list sorting is enabled | |
void | setItemRenderArea (Rect &r) |
Scrollbar * | getVertScrollbar () |
Scrollbar * | getHorzScrollbar () |
bool | isMultiselectEnabled (void) const |
return whether multi-select is enabled | |
bool | isItemTooltipsEnabled (void) const |
TreeItem * | findFirstItemWithText (const String &text) |
Search the list for an item with the specified text. | |
TreeItem * | findNextItemWithText (const String &text, const TreeItem *start_item) |
TreeItem * | findItemWithTextFromList (const LBItemList &itemList, const String &text, const TreeItem *start_item, bool foundStartItem) |
TreeItem * | findFirstItemWithID (uint searchID) |
Search the list for an item with the specified text. | |
TreeItem * | findNextItemWithID (uint searchID, const TreeItem *start_item) |
TreeItem * | findItemWithIDFromList (const LBItemList &itemList, uint searchID, const TreeItem *start_item, bool foundStartItem) |
bool | isTreeItemInList (const TreeItem *item) const |
Return whether the specified TreeItem is in the List. | |
bool | isVertScrollbarAlwaysShown (void) const |
Return whether the vertical scroll bar is always shown. | |
bool | isHorzScrollbarAlwaysShown (void) const |
Return whether the horizontal scroll bar is always shown. | |
virtual void | initialise (void) |
Initialise the Window based object ready for use. | |
void | resetList (void) |
Remove all items from the list. | |
void | addItem (TreeItem *item) |
Add the given TreeItem to the list. | |
void | insertItem (TreeItem *item, const TreeItem *position) |
Insert an item into the list box after a specified item already in the list. | |
void | removeItem (const TreeItem *item) |
Removes the given item from the list box. If the item is has the auto delete state set, the item will be deleted. | |
void | clearAllSelections (void) |
Clear the selected state for all items. | |
bool | clearAllSelectionsFromList (const LBItemList &itemList) |
void | setSortingEnabled (bool setting) |
Set whether the list should be sorted. | |
void | setMultiselectEnabled (bool setting) |
Set whether the list should allow multiple selections or just a single selection. | |
void | setShowVertScrollbar (bool setting) |
Set whether the vertical scroll bar should always be shown. | |
void | setShowHorzScrollbar (bool setting) |
Set whether the horizontal scroll bar should always be shown. | |
void | setItemTooltipsEnabled (bool setting) |
void | setItemSelectState (TreeItem *item, bool state) |
Set the select state of an attached TreeItem. | |
void | setItemSelectState (size_t item_index, bool state) |
Set the select state of an attached TreeItem. | |
virtual void | setLookNFeel (const String &look) |
Set the LookNFeel that shoule be used for this window. | |
void | handleUpdatedItemData (void) |
Causes the list box to update it's internal state after changes have been made to one or more attached TreeItem objects. | |
void | ensureItemIsVisible (const TreeItem *item) |
Ensure the item at the specified index is visible within the list box. | |
Tree (const String &type, const String &name) | |
Constructor for Tree base class. | |
virtual | ~Tree (void) |
Destructor for Tree base class. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | WidgetTypeName |
static const String | EventListContentsChanged |
Event triggered when the contents of the list is changed. | |
static const String | EventSelectionChanged |
Event triggered when there is a change to the currently selected item(s). | |
static const String | EventSortModeChanged |
Event triggered when the sort mode setting changes. | |
static const String | EventMultiselectModeChanged |
Event triggered when the multi-select mode setting changes. | |
static const String | EventVertScrollbarModeChanged |
Event triggered when the vertical scroll bar 'force' setting changes. | |
static const String | EventHorzScrollbarModeChanged |
Event triggered when the horizontal scroll bar 'force' setting changes. | |
static const String | EventBranchOpened |
Event triggered when a branch of the tree is opened by the user. | |
static const String | EventBranchClosed |
Event triggered when a branch of the tree is closed by the user. | |
Protected Member Functions | |
virtual Rect | getTreeRenderArea (void) const |
Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. | |
virtual Scrollbar * | createVertScrollbar (const String &name) const |
create and return a pointer to a Scrollbar widget for use as vertical scroll bar | |
virtual Scrollbar * | createHorzScrollbar (const String &name) const |
create and return a pointer to a Scrollbar widget for use as horizontal scroll bar | |
virtual void | cacheTreeBaseImagery () |
Perform caching of the widget control frame and other 'static' areas. This method should not render the actual items. Note that the items are typically rendered to layer 3, other layers can be used for rendering imagery behind and infront of the items. | |
void | addTreeEvents (void) |
Add list box specific events. | |
void | configureScrollbars (void) |
display required integrated scroll bars according to current state of the list box and update their values. | |
void | selectRange (size_t start, size_t end) |
select all strings between positions start and end. (inclusive) including end. | |
float | getTotalItemsHeight (void) const |
Return the sum of all item heights. | |
void | getTotalItemsInListHeight (const LBItemList &itemList, float *heightSum) const |
float | getWidestItemWidth (void) const |
Return the width of the widest item. | |
void | getWidestItemWidthInList (const LBItemList &itemList, int itemDepth, float *widest) const |
bool | getHeightToItemInList (const LBItemList &itemList, const TreeItem *treeItem, int itemDepth, float *height) const |
Clear the selected state for all items (implementation). | |
bool | clearAllSelections_impl (void) |
Clear the selected state for all items (implementation). | |
TreeItem * | getItemAtPoint (const Point &pt) const |
Return the TreeItem under the given window local pixel co-ordinate. | |
TreeItem * | getItemFromListAtPoint (const LBItemList &itemList, float *bottomY, const Point &pt) const |
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. | |
bool | handle_scrollChange (const EventArgs &args) |
Internal handler that is triggered when the user interacts with the scrollbars. | |
virtual void | populateRenderCache () |
Update the rendering cache. | |
void | drawItemList (LBItemList &itemList, Rect &itemsArea, float widest, Vector3 &itemPos, RenderCache &cache, float alpha) |
virtual void | onListContentsChanged (WindowEventArgs &e) |
Handler called internally when the list contents are changed. | |
virtual void | onSelectionChanged (TreeEventArgs &e) |
Handler called internally when the currently selected item or items changes. | |
virtual void | onSortModeChanged (WindowEventArgs &e) |
Handler called internally when the sort mode setting changes. | |
virtual void | onMultiselectModeChanged (WindowEventArgs &e) |
Handler called internally when the multi-select mode setting changes. | |
virtual void | onVertScrollbarModeChanged (WindowEventArgs &e) |
Handler called internally when the forced display of the vertical scroll bar setting changes. | |
virtual void | onHorzScrollbarModeChanged (WindowEventArgs &e) |
Handler called internally when the forced display of the horizontal scroll bar setting changes. | |
virtual void | onBranchOpened (TreeEventArgs &e) |
Handler called internally when the user opens a branch of the tree. | |
virtual void | onBranchClosed (TreeEventArgs &e) |
Handler called internally when the user closes a branch of the tree. | |
virtual void | onSized (WindowEventArgs &e) |
Handler called when the window's size changes. | |
virtual void | onMouseButtonDown (MouseEventArgs &e) |
Handler called when a mouse button has been depressed within this window's area. | |
virtual void | onMouseWheel (MouseEventArgs &e) |
Handler called when the mouse wheel (z-axis) position changes within this window's area. | |
virtual void | onMouseMove (MouseEventArgs &e) |
Handler called when the mouse cursor has been moved within this window's area. | |
Protected Attributes | |
bool | d_sorted |
true if list is sorted | |
bool | d_multiselect |
true if multi-select is enabled | |
bool | d_forceVertScroll |
true if vertical scrollbar should always be displayed | |
bool | d_forceHorzScroll |
true if horizontal scrollbar should always be displayed | |
bool | d_itemTooltips |
true if each item should have an individual tooltip | |
Scrollbar * | d_vertScrollbar |
vertical scroll-bar widget | |
Scrollbar * | d_horzScrollbar |
horizontal scroll-bar widget | |
LBItemList | d_listItems |
list of items in the list box. | |
TreeItem * | d_lastSelected |
holds pointer to the last selected item (used in range selections) | |
ImagerySection * | openButtonImagery |
ImagerySection * | closeButtonImagery |
Friends | |
class | TreeItem |
size_t CEGUI::Tree::getItemCount | ( | void | ) | const [inline] |
Return number of items attached to the list box.
size_t CEGUI::Tree::getSelectedCount | ( | void | ) | const |
Return the number of selected items in the list box.
TreeItem * CEGUI::Tree::getFirstSelectedItem | ( | void | ) | const |
Return a pointer to the first selected item.
TreeItem* CEGUI::Tree::getLastSelectedItem | ( | void | ) | const [inline] |
Return a pointer to the first selected item.
Return a pointer to the next selected item after item start_item.
start_item | Pointer to the TreeItem where the search for the next selected item is to begin. If this parameter is NULL, the search will begin with the first item in the list box. |
InvalidRequestException | thrown if start_item is not attached to this list box. |
bool CEGUI::Tree::isSortEnabled | ( | void | ) | const [inline] |
return whether list sorting is enabled
bool CEGUI::Tree::isMultiselectEnabled | ( | void | ) | const [inline] |
return whether multi-select is enabled
Search the list for an item with the specified text.
text | String object containing the text to be searched for. | |
start_item | TreeItem 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. |
TreeItem * CEGUI::Tree::findFirstItemWithID | ( | uint | searchID | ) |
Search the list for an item with the specified text.
text | String object containing the text to be searched for. | |
start_item | TreeItem 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 CEGUI::Tree::isTreeItemInList | ( | const TreeItem * | item | ) | const |
bool CEGUI::Tree::isVertScrollbarAlwaysShown | ( | void | ) | const |
Return whether the vertical scroll bar is always shown.
bool CEGUI::Tree::isHorzScrollbarAlwaysShown | ( | void | ) | const |
Return whether the horizontal scroll bar is always shown.
void CEGUI::Tree::initialise | ( | void | ) | [virtual] |
Initialise the Window based object ready for use.
void CEGUI::Tree::resetList | ( | void | ) |
Remove all items from the list.
Note that this will cause 'AutoDelete' items to be deleted.
void CEGUI::Tree::addItem | ( | TreeItem * | item | ) |
Insert an item into the list box 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 TreeItem 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 TreeItem that item is to be inserted after. If this parameter is NULL, the item is inserted at the start of the list. |
InvalidRequestException | thrown if no TreeItem position is attached to this list box. |
void CEGUI::Tree::removeItem | ( | const TreeItem * | item | ) |
Removes the given item from the list box. If the item is has the auto delete state set, the item will be deleted.
item | Pointer to the TreeItem that is to be removed. If item is not attached to this list box then nothing will happen. |
void CEGUI::Tree::clearAllSelections | ( | void | ) |
Clear the selected state for all items.
void CEGUI::Tree::setSortingEnabled | ( | bool | setting | ) |
Set whether the list should be sorted.
setting | true if the list should be sorted, false if the list should not be sorted. |
void CEGUI::Tree::setMultiselectEnabled | ( | bool | setting | ) |
Set whether the list should allow multiple selections or just a single selection.
setting | true if the widget should allow multiple items to be selected, false if the widget should only allow a single selection. |
void CEGUI::Tree::setShowVertScrollbar | ( | bool | setting | ) |
Set whether the vertical scroll bar should always be shown.
setting | true if the vertical scroll bar should be shown even when it is not required. false if the vertical scroll bar should only be shown when it is required. |
void CEGUI::Tree::setShowHorzScrollbar | ( | bool | setting | ) |
Set whether the horizontal scroll bar should always be shown.
setting | true if the horizontal scroll bar should be shown even when it is not required. false if the horizontal scroll bar should only be shown when it is required. |
void CEGUI::Tree::setItemSelectState | ( | TreeItem * | item, | |
bool | state | |||
) |
Set the select state of an attached TreeItem.
This is the recommended way of selecting and deselecting items attached to a list box as it respects the multi-select mode setting. It is possible to modify the setting on TreeItems directly, but that approach does not respect the settings of the list box.
item | The TreeItem to be affected. This item must be attached to the list box. | |
state | true to select the item, false to de-select the item. |
InvalidRequestException | thrown if item is not attached to this list box. |
void CEGUI::Tree::setItemSelectState | ( | size_t | item_index, | |
bool | state | |||
) |
Set the select state of an attached TreeItem.
This is the recommended way of selecting and deselecting items attached to a list box as it respects the multi-select mode setting. It is possible to modify the setting on TreeItems directly, but that approach does not respect the settings of the list box.
item_index | The zero based index of the TreeItem to be affected. This must be a valid index (0 <= index < getItemCount()) | |
state | true to select the item, false to de-select the item. |
InvalidRequestException | thrown if item_index is out of range for the list box |
void CEGUI::Tree::setLookNFeel | ( | const String & | look | ) | [virtual] |
Set the LookNFeel that shoule be used for this window.
look | String object holding the name of the look to be assigned to the window. |
UnknownObjectException | thrown if the look'n'feel specified by look does not exist. |
Reimplemented from CEGUI::Window.
void CEGUI::Tree::handleUpdatedItemData | ( | void | ) |
Causes the list box to update it's internal state after changes have been made to one or more attached TreeItem objects.
Client code must call this whenever it has made any changes to TreeItem objects already attached to the list box. 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.
void CEGUI::Tree::ensureItemIsVisible | ( | const TreeItem * | item | ) |
Ensure the item at the specified index is visible within the list box.
item | Pointer to the TreeItem to be made visible in the list box. |
InvalidRequestException | thrown if item is not attached to this list box. |
virtual Rect CEGUI::Tree::getTreeRenderArea | ( | void | ) | const [inline, protected, virtual] |
virtual void CEGUI::Tree::cacheTreeBaseImagery | ( | ) | [inline, protected, virtual] |
Perform caching of the widget control frame and other 'static' areas. This method should not render the actual items. Note that the items are typically rendered to layer 3, other layers can be used for rendering imagery behind and infront of the items.
bool CEGUI::Tree::getHeightToItemInList | ( | const LBItemList & | itemList, | |
const TreeItem * | treeItem, | |||
int | itemDepth, | |||
float * | height | |||
) | const [protected] |
Clear the selected state for all items (implementation).
bool CEGUI::Tree::clearAllSelections_impl | ( | void | ) | [protected] |
Clear the selected state for all items (implementation).
bool CEGUI::Tree::resetList_impl | ( | void | ) | [protected] |
Remove all items from the list.
virtual bool CEGUI::Tree::testClassName_impl | ( | const String & | class_name | ) | const [inline, protected, virtual] |
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
class_name | The class name that is to be checked. |
Reimplemented from CEGUI::Window.
void CEGUI::Tree::populateRenderCache | ( | ) | [protected, virtual] |
Update the rendering cache.
Populates the Window's RenderCache with imagery to be sent to the renderer.
Reimplemented from CEGUI::Window.
void CEGUI::Tree::onSized | ( | WindowEventArgs & | e | ) | [protected, virtual] |
Handler called when the window's size changes.
e | WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'. |
Reimplemented from CEGUI::Window.
void CEGUI::Tree::onMouseButtonDown | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when a mouse button has been depressed within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
void CEGUI::Tree::onMouseWheel | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when the mouse wheel (z-axis) position changes within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
void CEGUI::Tree::onMouseMove | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when the mouse cursor has been moved within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.