A tree control presents information as a hierarchy, with items that may be expanded to show further items. Items in a tree control are referenced by wxTreeItemId handles, which may be tested for validity by calling wxTreeItemId::IsOk.
To intercept events from a tree control, use the event table macros described in wxTreeEvent.
Derived from
wxControl
wxWindow
wxEvtHandler
wxObject
Include files
<wx/treectrl.h>
Window styles
| wxTR_EDIT_LABELS | Use this style if you wish the user to be able to edit labels in the tree control. |
| wxTR_NO_BUTTONS | For convenience to document that no buttons are to be drawn. |
| wxTR_HAS_BUTTONS | Use this style to show + and - buttons to the left of parent items. |
| wxTR_TWIST_BUTTONS | Use this style to show Mac-style twister buttons to the left of parent items. If both wxTR_HAS_BUTTONS and wxTR_TWIST_BUTTONS are given, twister buttons are generated. Generic only. |
| wxTR_NO_LINES | Use this style to hide vertical level connectors. |
| wxTR_FULL_ROW_HIGHLIGHT | Use this style to have the background colour and the selection highlight extend over the entire horizontal row of the tree control window. (This flag is ignored under Windows unless you specify wxTR_NO_LINES as well.) |
| wxTR_LINES_AT_ROOT | Use this style to show lines between root nodes. Only applicable if wxTR_HIDE_ROOT is set and wxTR_NO_LINES is not set. |
| wxTR_HIDE_ROOT | Use this style to suppress the display of the root node, effectively causing the first-level nodes to appear as a series of root nodes. |
| wxTR_ROW_LINES | Use this style to draw a contrasting border between displayed rows. |
| wxTR_HAS_VARIABLE_ROW_HEIGHT | Use this style to cause row heights to be just big enough to fit the content. If not set, all rows use the largest row height. The default is that this flag is unset. Generic only. |
| wxTR_SINGLE | For convenience to document that only one item may be selected at a time. Selecting another item causes the current selection, if any, to be deselected. This is the default. |
| wxTR_MULTIPLE | Use this style to allow a range of items to be selected. If a second range is selected, the current range, if any, is deselected. |
| wxTR_EXTENDED | Use this style to allow disjoint items to be selected. (Only partially implemented; may not work in all cases.) |
| wxTR_DEFAULT_STYLE | The set of flags that are closest to the defaults for the native control for a particular toolkit. |
See also window styles overview.
Event handling
To process input from a tree control, use these event handler macros to direct input to member functions that take a wxTreeEvent argument.
| EVT_TREE_BEGIN_DRAG(id, func) | Begin dragging with the left mouse button. |
| EVT_TREE_BEGIN_RDRAG(id, func) | Begin dragging with the right mouse button. |
| EVT_TREE_END_DRAG(id, func) | End dragging with the left or right mouse button. |
| EVT_TREE_BEGIN_LABEL_EDIT(id, func) | Begin editing a label. This can be prevented by calling Veto(). |
| EVT_TREE_END_LABEL_EDIT(id, func) | Finish editing a label. This can be prevented by calling Veto(). |
| EVT_TREE_DELETE_ITEM(id, func) | Delete an item. |
| EVT_TREE_GET_INFO(id, func) | Request information from the application. |
| EVT_TREE_SET_INFO(id, func) | Information is being supplied. |
| EVT_TREE_ITEM_ACTIVATED(id, func) | The item has been activated, i.e. chosen by double clicking it with mouse or from keyboard |
| EVT_TREE_ITEM_COLLAPSED(id, func) | The item has been collapsed. |
| EVT_TREE_ITEM_COLLAPSING(id, func) | The item is being collapsed. This can be prevented by calling Veto(). |
| EVT_TREE_ITEM_EXPANDED(id, func) | The item has been expanded. |
| EVT_TREE_ITEM_EXPANDING(id, func) | The item is being expanded. This can be prevented by calling Veto(). |
| EVT_TREE_SEL_CHANGED(id, func) | Selection has changed. |
| EVT_TREE_SEL_CHANGING(id, func) | Selection is changing. This can be prevented by calling Veto(). |
| EVT_TREE_KEY_DOWN(id, func) | A key has been pressed. |
| EVT_TREE_ITEM_GETTOOLTIP(id, func) | The opportunity to set the item tooltip is being given to the application (call wxTreeEvent::SetToolTip). Windows only. |
See also
wxTreeItemData, wxTreeCtrl overview, wxListBox, wxListCtrl, wxImageList, wxTreeEvent
Win32 notes
wxTreeCtrl class uses the standard common treeview control under Win32 implemented in the system library comctl32.dll. Some versions of this library are known to have bugs with handling the tree control colours: the usual symptom is that the expanded items leave black (or otherwise incorrectly coloured) background behind them, especially for the controls using non default background colour. The recommended solution is to upgrade the comctl32.dll to a newer version: see http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp.
Members
wxTreeCtrl::wxTreeCtrl
wxTreeCtrl::~wxTreeCtrl
wxTreeCtrl::AddRoot
wxTreeCtrl::AppendItem
wxTreeCtrl::AssignButtonsImageList
wxTreeCtrl::AssignImageList
wxTreeCtrl::AssignStateImageList
wxTreeCtrl::Collapse
wxTreeCtrl::CollapseAndReset
wxTreeCtrl::Create
wxTreeCtrl::Delete
wxTreeCtrl::DeleteAllItems
wxTreeCtrl::DeleteChildren
wxTreeCtrl::EditLabel
wxTreeCtrl::EndEditLabel
wxTreeCtrl::EnsureVisible
wxTreeCtrl::Expand
wxTreeCtrl::GetBoundingRect
wxTreeCtrl::GetButtonsImageList
wxTreeCtrl::GetChildrenCount
wxTreeCtrl::GetCount
wxTreeCtrl::GetEditControl
wxTreeCtrl::GetFirstChild
wxTreeCtrl::GetFirstVisibleItem
wxTreeCtrl::GetImageList
wxTreeCtrl::GetIndent
wxTreeCtrl::GetItemBackgroundColour
wxTreeCtrl::GetItemData
wxTreeCtrl::GetItemFont
wxTreeCtrl::GetItemImage
wxTreeCtrl::GetItemText
wxTreeCtrl::GetItemTextColour
wxTreeCtrl::GetLastChild
wxTreeCtrl::GetNextChild
wxTreeCtrl::GetNextSibling
wxTreeCtrl::GetNextVisible
wxTreeCtrl::GetItemParent
wxTreeCtrl::GetParent
wxTreeCtrl::GetPrevSibling
wxTreeCtrl::GetPrevVisible
wxTreeCtrl::GetRootItem
wxTreeCtrl::GetItemSelectedImage
wxTreeCtrl::GetSelection
wxTreeCtrl::GetSelections
wxTreeCtrl::GetStateImageList
wxTreeCtrl::HitTest
wxTreeCtrl::InsertItem
wxTreeCtrl::IsBold
wxTreeCtrl::IsExpanded
wxTreeCtrl::IsSelected
wxTreeCtrl::IsVisible
wxTreeCtrl::ItemHasChildren
wxTreeCtrl::OnCompareItems
wxTreeCtrl::PrependItem
wxTreeCtrl::ScrollTo
wxTreeCtrl::SelectItem
wxTreeCtrl::SetButtonsImageList
wxTreeCtrl::SetIndent
wxTreeCtrl::SetImageList
wxTreeCtrl::SetItemBackgroundColour
wxTreeCtrl::SetItemBold
wxTreeCtrl::SetItemData
wxTreeCtrl::SetItemFont
wxTreeCtrl::SetItemHasChildren
wxTreeCtrl::SetItemImage
wxTreeCtrl::SetItemSelectedImage
wxTreeCtrl::SetItemText
wxTreeCtrl::SetItemTextColour
wxTreeCtrl::SetStateImageList
wxTreeCtrl::SetWindowStyle
wxTreeCtrl::SortChildren
wxTreeCtrl::Toggle
wxTreeCtrl::ToggleItemSelection
wxTreeCtrl::Unselect
wxTreeCtrl::UnselectAll
wxTreeCtrl::UnselectItem
wxTreeCtrl()
Default constructor.
wxTreeCtrl(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxTR_HAS_BUTTONS, const wxValidator& validator = wxDefaultValidator, const wxString& name = "listCtrl")
Constructor, creating and showing a tree control.
Parameters
parent
id
pos
size
style
validator
name
See also
wxTreeCtrl::Create, wxValidator
void ~wxTreeCtrl()
Destructor, destroying the list control.
wxTreeItemId AddRoot(const wxString& text, int image = -1, int selImage = -1, wxTreeItemData* data = NULL)
Adds the root node to the tree, returning the new item.
The image and selImage parameters are an index within the normal image list specifying the image to use for unselected and selected items, respectively. If image > -1 and selImage is -1, the same image is used for both selected and unselected items.
wxTreeItemId AppendItem(const wxTreeItemId& parent, const wxString& text, int image = -1, int selImage = -1, wxTreeItemData* data = NULL)
Appends an item to the end of the branch identified by parent, return a new item id.
The image and selImage parameters are an index within the normal image list specifying the image to use for unselected and selected items, respectively. If image > -1 and selImage is -1, the same image is used for both selected and unselected items.
void AssignButtonsImageList(wxImageList* imageList)
Sets the buttons image list. The button images assigned with this method will be automatically deleted by wxTreeCtrl as appropriate (i.e. it takes ownership of the list).
Setting or assigning the button image list enables the display of image buttons. Once enabled, the only way to disable the display of button images is to set the button image list to NULL.
This function is only available in the generic version.
See also SetButtonsImageList.
void AssignImageList(wxImageList* imageList)
Sets the normal image list. Image list assigned with this method will be automatically deleted by wxTreeCtrl as appropriate (i.e. it takes ownership of the list).
See also SetImageList.
void AssignStateImageList(wxImageList* imageList)
Sets the state image list. Image list assigned with this method will be automatically deleted by wxTreeCtrl as appropriate (i.e. it takes ownership of the list).
See also SetStateImageList.
void Collapse(const wxTreeItemId& item)
Collapses the given item.
void CollapseAndReset(const wxTreeItemId& item)
Collapses the given item and removes all children.
bool wxTreeCtrl(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxTR_HAS_BUTTONS, const wxValidator& validator = wxDefaultValidator, const wxString& name = "listCtrl")
Creates the tree control. See wxTreeCtrl::wxTreeCtrl for further details.
void Delete(const wxTreeItemId& item)
Deletes the specified item. A EVT_TREE_DELETE_ITEM event will be generated.
This function may cause a subsequent call to GetNextChild to fail.
void DeleteAllItems()
Deletes all the items in the control. Note that this may not generate EVT_TREE_DELETE_ITEM events under some Windows versions although normally such event is generated for each removed item.
void DeleteChildren(const wxTreeItemId& item)
Deletes all children of the given item (but not the item itself). Note that this will not generate any events unlike Delete method.
If you have called wxTreeCtrl::SetItemHasChildren, you may need to call it again since DeleteChildren does not automatically clear the setting.
void EditLabel(const wxTreeItemId& item)
Starts editing the label of the given item. This function generates a EVT_TREE_BEGIN_LABEL_EDIT event which can be vetoed so that no text control will appear for in-place editing.
If the user changed the label (i.e. s/he does not press ESC or leave the text control without changes, a EVT_TREE_END_LABEL_EDIT event will be sent which can be vetoed as well.
See also
wxTreeCtrl::EndEditLabel, wxTreeEvent
void EndEditLabel(bool cancelEdit)
Ends label editing. If cancelEdit is true, the edit will be cancelled.
This function is currently supported under Windows only.
See also
void EnsureVisible(const wxTreeItemId& item)
Scrolls and/or expands items to ensure that the given item is visible.
void Expand(const wxTreeItemId& item)
Expands the given item.
bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect, bool textOnly = false) const
Retrieves the rectangle bounding the item. If textOnly is true, only the rectangle around the item's label will be returned, otherwise the item's image is also taken into account.
The return value is true if the rectangle was successfully retrieved or false if it was not (in this case rect is not changed) - for example, if the item is currently invisible.
wxPython note: The wxPython version of this method requires only the item and textOnly parameters. The return value is either a wxRect object or None.
wxPerl note: In wxPerl this method only takes the parameters item and textOnly, and returns a Wx::Rect ( or undef ).
wxImageList* GetButtonsImageList() const
Returns the buttons image list (from which application-defined button images are taken).
This function is only available in the generic version.
size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = true) const
Returns the number of items in the branch. If recursively is true, returns the total number of descendants, otherwise only one level of children is counted.
int GetCount() const
Returns the number of items in the control.
wxTextCtrl * GetEditControl() const
Returns the edit control being currently used to edit a label. Returns NULL if no label is being edited.
NB: It is currently only implemented for wxMSW.
wxTreeItemId GetFirstChild(const wxTreeItemId& item, wxTreeItemIdValue & cookie) const
Returns the first child; call wxTreeCtrl::GetNextChild for the next child.
For this enumeration function you must pass in a 'cookie' parameter which is opaque for the application but is necessary for the library to make these functions reentrant (i.e. allow more than one enumeration on one and the same object simultaneously). The cookie passed to GetFirstChild and GetNextChild should be the same variable.
Returns an invalid tree item if there are no further children.
See also
wxTreeCtrl::GetNextChild, wxTreeCtrl::GetNextSibling
wxPython note: In wxPython the returned wxTreeItemId and the new cookie value are both returned as a tuple containing the two values.
wxPerl note: In wxPerl this method only takes the item parameter, and returns a 2-element list ( item, cookie ).
wxTreeItemId GetFirstVisibleItem() const
Returns the first visible item.
wxImageList* GetImageList() const
Returns the normal image list.
int GetIndent() const
Returns the current tree control indentation.
wxColour GetItemBackgroundColour(const wxTreeItemId& item) const
Returns the background colour of the item.
wxTreeItemData* GetItemData(const wxTreeItemId& item) const
Returns the tree item data associated with the item.
See also
wxPython note: wxPython provides the following shortcut method:
| GetPyData(item) | Returns the Python Object associated with the wxTreeItemData for the given item Id. |
| GetPlData( item ) | Returns the Perl data associated with the Wx::TreeItemData. It is just the same as tree->GetItemData(item)->GetData(). |
wxFont GetItemFont(const wxTreeItemId& item) const
Returns the font of the item label.
int GetItemImage(const wxTreeItemId& item, wxTreeItemIcon which = wxTreeItemIcon_Normal) const
Gets the specified item image. The value of which may be:
wxString GetItemText(const wxTreeItemId& item) const
Returns the item label.
wxColour GetItemTextColour(const wxTreeItemId& item) const
Returns the colour of the item label.
wxTreeItemId GetLastChild(const wxTreeItemId& item) const
Returns the last child of the item (or an invalid tree item if this item has no children).
See also
GetFirstChild, wxTreeCtrl::GetNextSibling, GetLastChild
wxTreeItemId GetNextChild(const wxTreeItemId& item, wxTreeItemIdValue & cookie) const
Returns the next child; call wxTreeCtrl::GetFirstChild for the first child.
For this enumeration function you must pass in a 'cookie' parameter which is opaque for the application but is necessary for the library to make these functions reentrant (i.e. allow more than one enumeration on one and the same object simultaneously). The cookie passed to GetFirstChild and GetNextChild should be the same.
Returns an invalid tree item if there are no further children.
See also
wxPython note: In wxPython the returned wxTreeItemId and the new cookie value are both returned as a tuple containing the two values.
wxPerl note: In wxPerl this method returns a 2-element list ( item, cookie ), instead of modifying its parameters.
wxTreeItemId GetNextSibling(const wxTreeItemId& item) const
Returns the next sibling of the specified item; call wxTreeCtrl::GetPrevSibling for the previous sibling.
Returns an invalid tree item if there are no further siblings.
See also
wxTreeItemId GetNextVisible(const wxTreeItemId& item) const
Returns the next visible item.
wxTreeItemId GetItemParent(const wxTreeItemId& item) const
Returns the item's parent.
wxTreeItemId GetParent(const wxTreeItemId& item) const
NOTE: This function is deprecated and will only work if WXWIN_COMPATIBILITY_2_2 is defined. Use wxTreeCtrl::GetItemParent instead.
Returns the item's parent.
wxPython note: This method is named GetItemParent to avoid a name clash with wxWindow::GetParent.
wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const
Returns the previous sibling of the specified item; call wxTreeCtrl::GetNextSibling for the next sibling.
Returns an invalid tree item if there are no further children.
See also
wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const
Returns the previous visible item.
wxTreeItemId GetRootItem() const
Returns the root item for the tree control.
int GetItemSelectedImage(const wxTreeItemId& item) const
Gets the selected item image (this function is obsolete, use GetItemImage(item, wxTreeItemIcon_Selected) instead).
wxTreeItemId GetSelection() const
Returns the selection, or an invalid item if there is no selection. This function only works with the controls without wxTR_MULTIPLE style, use GetSelections for the controls which do have this style.
size_t GetSelections(wxArrayTreeItemIds& selection) const
Fills the array of tree items passed in with the currently selected items. This function can be called only if the control has the wxTR_MULTIPLE style.
Returns the number of selected items.
wxPython note: The wxPython version of this method accepts no parameters and returns a Python list of wxTreeItemIds.
wxPerl note: In wxPerl this method takes no parameters and returns a list of Wx::TreeItemIds.
wxImageList* GetStateImageList() const
Returns the state image list (from which application-defined state images are taken).
wxTreeItemId HitTest(const wxPoint& point, int& flags)
Calculates which (if any) item is under the given point, returning the tree item id at this point plus extra information flags. flags is a bitlist of the following:
| wxTREE_HITTEST_ABOVE | Above the client area. |
| wxTREE_HITTEST_BELOW | Below the client area. |
| wxTREE_HITTEST_NOWHERE | In the client area but below the last item. |
| wxTREE_HITTEST_ONITEMBUTTON | On the button associated with an item. |
| wxTREE_HITTEST_ONITEMICON | On the bitmap associated with an item. |
| wxTREE_HITTEST_ONITEMINDENT | In the indentation associated with an item. |
| wxTREE_HITTEST_ONITEMLABEL | On the label (string) associated with an item. |
| wxTREE_HITTEST_ONITEMRIGHT | In the area to the right of an item. |
| wxTREE_HITTEST_ONITEMSTATEICON | On the state icon for a tree view item that is in a user-defined state. |
| wxTREE_HITTEST_TOLEFT | To the right of the client area. |
| wxTREE_HITTEST_TORIGHT | To the left of the client area. |
wxPython note: in wxPython both the wxTreeItemId and the flags are returned as a tuple.
wxPerl note: In wxPerl this method only takes the point parameter and returns a 2-element list ( item, flags ).
wxTreeItemId InsertItem(const wxTreeItemId& parent, const wxTreeItemId& previous, const wxString& text, int image = -1, int selImage = -1, wxTreeItemData* data = NULL)
wxTreeItemId InsertItem(const wxTreeItemId& parent, size_t before, const wxString& text, int image = -1, int selImage = -1, wxTreeItemData* data = NULL)
Inserts an item after a given one (previous) or before one identified by its position (before). before must be less than the number of children.
The image and selImage parameters are an index within the normal image list specifying the image to use for unselected and selected items, respectively. If image > -1 and selImage is -1, the same image is used for both selected and unselected items.
wxPython note: The second form of this method is called InsertItemBefore in wxPython.
bool IsBold(const wxTreeItemId& item) const
Returns true if the given item is in bold state.
See also: SetItemBold
bool IsExpanded(const wxTreeItemId& item) const
Returns true if the item is expanded (only makes sense if it has children).
bool IsSelected(const wxTreeItemId& item) const
Returns true if the item is selected.
bool IsVisible(const wxTreeItemId& item) const
Returns true if the item is visible (it might be outside the view, or not expanded).
bool ItemHasChildren(const wxTreeItemId& item) const
Returns true if the item has children.
int OnCompareItems(const wxTreeItemId& item1, const wxTreeItemId& item2)
Override this function in the derived class to change the sort order of the items in the tree control. The function should return a negative, zero or positive value if the first item is less than, equal to or greater than the second one.
The base class version compares items alphabetically.
See also: SortChildren
wxTreeItemId PrependItem(const wxTreeItemId& parent, const wxString& text, int image = -1, int selImage = -1, wxTreeItemData* data = NULL)
Appends an item as the first child of parent, return a new item id.
The image and selImage parameters are an index within the normal image list specifying the image to use for unselected and selected items, respectively. If image > -1 and selImage is -1, the same image is used for both selected and unselected items.
void ScrollTo(const wxTreeItemId& item)
Scrolls the specified item into view.
bool SelectItem(const wxTreeItemId& item, bool select = true)
Selects the given item. In multiple selection controls, can be also used to deselect a currently selected item if the value of select is false.
void SetButtonsImageList(wxImageList* imageList)
Sets the buttons image list (from which application-defined button images are taken). The button images assigned with this method will not be deleted by wxTreeCtrl's destructor, you must delete it yourself.
Setting or assigning the button image list enables the display of image buttons. Once enabled, the only way to disable the display of button images is to set the button image list to NULL.
This function is only available in the generic version.
See also AssignButtonsImageList.
void SetIndent(int indent)
Sets the indentation for the tree control.
void SetImageList(wxImageList* imageList)
Sets the normal image list. Image list assigned with this method will not be deleted by wxTreeCtrl's destructor, you must delete it yourself.
See also AssignImageList.
void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col)
Sets the colour of the item's background.
void SetItemBold(const wxTreeItemId& item, bool bold = true)
Makes item appear in bold font if bold parameter is true or resets it to the normal state.
See also: IsBold
void SetItemData(const wxTreeItemId& item, wxTreeItemData* data)
Sets the item client data.
wxPython note: wxPython provides the following shortcut method:
| SetPyData(item, obj) | Associate the given Python Object with the wxTreeItemData for the given item Id. |
| SetPlData( item, data ) | Sets the Perl data associated with the Wx::TreeItemData. It is just the same as tree->GetItemData(item)->SetData(data). |
void SetItemFont(const wxTreeItemId& item, const wxFont& font)
Sets the item's font. All items in the tree should have the same height to avoid text clipping, so the fonts height should be the same for all of them, although font attributes may vary.
See also
void SetItemHasChildren(const wxTreeItemId& item, bool hasChildren = true)
Force appearance of the button next to the item. This is useful to allow the user to expand the items which don't have any children now, but instead adding them only when needed, thus minimizing memory usage and loading time.
void SetItemImage(const wxTreeItemId& item, int image, wxTreeItemIcon which = wxTreeItemIcon_Normal)
Sets the specified item image. See GetItemImage for the description of the which parameter.
void SetItemSelectedImage(const wxTreeItemId& item, int selImage)
Sets the selected item image (this function is obsolete, use SetItemImage(item, wxTreeItemIcon_Selected) instead).
void SetItemText(const wxTreeItemId& item, const wxString& text)
Sets the item label.
void SetItemTextColour(const wxTreeItemId& item, const wxColour& col)
Sets the colour of the item's text.
void SetStateImageList(wxImageList* imageList)
Sets the state image list (from which application-defined state images are taken). Image list assigned with this method will not be deleted by wxTreeCtrl's destructor, you must delete it yourself.
See also AssignStateImageList.
void SetWindowStyle(longstyles)
Sets the mode flags associated with the display of the tree control. The new mode takes effect immediately. (Generic only; MSW ignores changes.)
void SortChildren(const wxTreeItemId& item)
Sorts the children of the given item using OnCompareItems method of wxTreeCtrl. You should override that method to change the sort order (the default is ascending case-sensitive alphabetical order).
See also
wxTreeItemData, OnCompareItems
void Toggle(const wxTreeItemId& item)
Toggles the given item between collapsed and expanded states.
void ToggleItemSelection(const wxTreeItemId& item)
Toggles the given item between selected and unselected states. For multiselection controls only.
void Unselect()
Removes the selection from the currently selected item (if any).
void UnselectAll()
This function either behaves the same as Unselect if the control doesn't have wxTR_MULTIPLE style, or removes the selection from all items if it does have this style.
void UnselectItem(const wxTreeItemId& item)
Unselects the given item. This works in multiselection controls only.