wxtreectrl

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

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_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.

wxtreectrl::wxtreectrl

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 = "treectrl")

constructor, creating and showing a tree control.

parameters

parent

null

window identifier. a value of -1 indicates a default value.

pos

window position.

size

window size. if the default size (-1, -1) is specified then the window is sized appropriately.

style

wxtreectrl

validator

window validator.

name

window name.

see also

wxtreectrl::create, wxvalidator

wxtreectrl::~wxtreectrl

void ~wxtreectrl()

destructor, destroying the tree control.

wxtreectrl::addroot

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.

wxtreectrl::appenditem

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.

wxtreectrl::assignbuttonsimagelist

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.

wxtreectrl::assignimagelist

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).

wxtreectrl::assignstateimagelist

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).

wxtreectrl::collapse

void collapse(const wxtreeitemid& item)

collapses the given item.

wxtreectrl::collapseall

void collapseall()

collapses the root item.

see also

expandall

wxtreectrl::collapseallchildren

void collapseallchildren(const wxtreeitemid& item)

collapses this item and all of its children, recursively.

see also

expandallchildren

wxtreectrl::collapseandreset

void collapseandreset(const wxtreeitemid& item)

collapses the given item and removes all children.

wxtreectrl::create

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 = "treectrl")

creates the tree control. see wxtreectrl::wxtreectrl for further details.

wxtreectrl::delete

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.

wxtreectrl::deleteallitems

void deleteallitems()

deletes all 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.

wxtreectrl::deletechildren

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.

wxtreectrl::editlabel

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

wxtreectrl::endeditlabel

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

wxtreectrl::editlabel

wxtreectrl::ensurevisible

void ensurevisible(const wxtreeitemid& item)

scrolls and/or expands items to ensure that the given item is visible.

wxtreectrl::expand

void expand(const wxtreeitemid& item)

expands the given item.

wxtreectrl::expandall

void expandall()

expands all items in the tree.

wxtreectrl::expandallchildren

void expandallchildren(const wxtreeitemid& item)

expands the given item and all its children recursively.

wxtreectrl::getboundingrect

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.

notice that the rectangle coordinates are logical, not physical ones. so, for example, the x coordinate may be negative if the tree has a horizontal scrollbar and its position is not 0.

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 ).

wxtreectrl::getbuttonsimagelist

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.

wxtreectrl::getchildrencount

unsigned int 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.

wxtreectrl::getcount

unsigned int getcount() const

returns the number of items in the control.

wxtreectrl::geteditcontrol

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.

wxtreectrl::getfirstchild

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 (i.e. isok() returns false) if there are no further children.

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 ).

wxtreectrl::getfirstvisibleitem

wxtreeitemid getfirstvisibleitem() const

returns the first visible item.

wxtreectrl::getimagelist

wximagelist* getimagelist() const

returns the normal image list.

wxtreectrl::getindent

int getindent() const

returns the current tree control indentation.

wxtreectrl::getitembackgroundcolour

wxcolour getitembackgroundcolour(const wxtreeitemid& item) const

returns the background colour of the item.

wxtreectrl::getitemdata

wxtreeitemdata* getitemdata(const wxtreeitemid& item) const

returns the tree item data associated with the item.

see also

wxtreeitemdata

wxpython note: wxpython provides the following shortcut method:

getpydata(item)

returns the python object associated with the wxtreeitemdata for the given item id.

wxperl note: wxperl provides the following shortcut method:

getpldata( item )

returns the perl data associated with the wx::treeitemdata. it is just the same as tree->getitemdata(item)->getdata().

wxtreectrl::getitemfont

wxfont getitemfont(const wxtreeitemid& item) const

returns the font of the item label.

wxtreectrl::getitemimage

int getitemimage(const wxtreeitemid& item, wxtreeitemicon which = wxtreeitemicon_normal) const

gets the specified item image. the value of which may be:

wxtreeitemicon_normal to get the normal item image
wxtreeitemicon_selected to get the selected item image (i.e. the image which is shown when the item is currently selected)
wxtreeitemicon_expanded to get the expanded image (this only makes sense for items which have children - then this image is shown when the item is expanded and the normal image is shown when it is collapsed)
wxtreeitemicon_selectedexpanded to get the selected expanded image (which is shown when an expanded item is currently selected)

wxtreectrl::getitemtext

wxstring getitemtext(const wxtreeitemid& item) const

returns the item label.

wxtreectrl::getitemtextcolour

wxcolour getitemtextcolour(const wxtreeitemid& item) const

returns the colour of the item label.

wxtreectrl::getlastchild

wxtreeitemid getlastchild(const wxtreeitemid& item) const

returns the last child of the item (or an invalid tree item if this item has no children).

wxtreectrl::getnextchild

wxtreeitemid getnextchild(const wxtreeitemid& item, wxtreeitemidvalue & cookie) const

returns the next child; call wxtreectrl::getfirstchild for the first child.

returns an invalid tree item if there are no further children.

see also

wxtreectrl::getfirstchild

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.

wxtreectrl::getnextsibling

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

wxtreectrl::getprevsibling

wxtreectrl::getnextvisible

wxtreeitemid getnextvisible(const wxtreeitemid& item) const

returns the next visible item.

wxtreectrl::getitemparent

wxtreeitemid getitemparent(const wxtreeitemid& item) const

returns the item's parent.

wxtreectrl::getprevsibling

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

wxtreectrl::getnextsibling

wxtreectrl::getprevvisible

wxtreeitemid getprevvisible(const wxtreeitemid& item) const

returns the previous visible item.

wxtreectrl::getquickbestsize

bool getquickbestsize() const

returns true if the control will use a quick calculation for the best size, looking only at the first and last items. the default is false.

see also

wxtreectrl::setquickbestsize

wxtreectrl::getrootitem

wxtreeitemid getrootitem() const

returns the root item for the tree control.

wxtreectrl::getitemselectedimage

int getitemselectedimage(const wxtreeitemid& item) const

gets the selected item image (this function is obsolete, use getitemimage(item, wxtreeitemicon_selected) instead).

wxtreectrl::getselection

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.

wxtreectrl::getselections

unsigned int 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.

wxtreectrl::getstateimagelist

wximagelist* getstateimagelist() const

returns the state image list (from which application-defined state images are taken).

wxtreectrl::hittest

wxtreeitemid hittest(const wxpoint& point, int& flags) const

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 ).

wxtreectrl::insertitem

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.

wxpython note: the second form of this method is called insertitembefore in wxpython.

wxtreectrl::isbold

bool isbold(const wxtreeitemid& item) const

returns true if the given item is in bold state.

wxtreectrl::isempty

bool isempty() const

returns true if the control is empty (i.e. has no items, even no root one).

wxtreectrl::isexpanded

bool isexpanded(const wxtreeitemid& item) const

returns true if the item is expanded (only makes sense if it has children).

wxtreectrl::isselected

bool isselected(const wxtreeitemid& item) const

returns true if the item is selected.

wxtreectrl::isvisible

bool isvisible(const wxtreeitemid& item) const

returns true if the item is visible (it might be outside the view, or not expanded).

wxtreectrl::itemhaschildren

bool itemhaschildren(const wxtreeitemid& item) const

returns true if the item has children.

wxtreectrl::oncompareitems

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.

please note that you must use wxrtti macros declare_dynamic_class and implement_dynamic_class if you override this function because otherwise the base class considers that it is not overridden and uses the default comparison, i.e. sorts the items alphabetically, which allows it optimize away the calls to the virtual function completely.

wxtreectrl::prependitem

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.

wxtreectrl::scrollto

void scrollto(const wxtreeitemid& item)

scrolls the specified item into view.

wxtreectrl::selectitem

void 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.

wxtreectrl::setbuttonsimagelist

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.

wxtreectrl::setindent

void setindent(int indent)

sets the indentation for the tree control.

wxtreectrl::setimagelist

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.

wxtreectrl::setitembackgroundcolour

void setitembackgroundcolour(const wxtreeitemid& item, const wxcolour& col)

sets the colour of the item's background.

wxtreectrl::setitembold

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.

wxtreectrl::setitemdata

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.

wxperl note: wxperl provides the following shortcut method:

setpldata( item, data )

sets the perl data associated with the wx::treeitemdata. it is just the same as tree->getitemdata(item)->setdata(data).

wxtreectrl::setitemdrophighlight

void setitemdrophighlight(const wxtreeitemid& item, boolhighlight = true)

gives the item the visual feedback for drag'n'drop actions, which is useful if something is dragged from the outside onto the tree control (as opposed to a dnd operation within the tree control, which already is implemented internally).

wxtreectrl::setitemfont

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

setitembold

wxtreectrl::setitemhaschildren

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.

wxtreectrl::setitemimage

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.

wxtreectrl::setitemselectedimage

void setitemselectedimage(const wxtreeitemid& item, int selimage)

sets the selected item image (this function is obsolete, use setitemimage(item, wxtreeitemicon_selected) instead).

wxtreectrl::setitemtext

void setitemtext(const wxtreeitemid& item, const wxstring& text)

sets the item label.

wxtreectrl::setitemtextcolour

void setitemtextcolour(const wxtreeitemid& item, const wxcolour& col)

sets the colour of the item's text.

wxtreectrl::setquickbestsize

void setquickbestsize(bool quickbestsize)

if true is passed, specifies that the control will use a quick calculation for the best size, looking only at the first and last items. otherwise, it will look at all items. the default is false.

see also

wxtreectrl::getquickbestsize

wxtreectrl::setstateimagelist

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.

wxtreectrl::setwindowstyle

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.)

wxtreectrl::sortchildren

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

wxtreectrl::toggle

void toggle(const wxtreeitemid& item)

toggles the given item between collapsed and expanded states.

wxtreectrl::toggleitemselection

void toggleitemselection(const wxtreeitemid& item)

toggles the given item between selected and unselected states. for multiselection controls only.

wxtreectrl::unselect

void unselect()

removes the selection from the currently selected item (if any).

wxtreectrl::unselectall

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.

wxtreectrl::unselectitem

void unselectitem(const wxtreeitemid& item)

unselects the given item. this works in multiselection controls only.