wxTreeCtrl Class Reference
[Controls]

#include <wx/treectrl.h>

Inheritance diagram for wxTreeCtrl:

Detailed Description

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

A similar control with a fully native implemtation for GTK+ and OS X as well is wxDataViewTreeCtrl.

To intercept events from a tree control, use the event table macros described in wxTreeEvent.

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_DEFAULT_STYLE:
The set of flags that are closest to the defaults for the native control for a particular toolkit.

Events:

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxTreeEvent& event)

Event macros:

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):
An item was deleted.
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_ITEM_RIGHT_CLICK(id, func):
The user has clicked the item with the right mouse button.
EVT_TREE_ITEM_MIDDLE_CLICK(id, func):
The user has clicked the item with the middle mouse button.
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.
EVT_TREE_ITEM_MENU(id, func):
The context menu for the selected item has been requested, either by a right click or by using the menu key.
EVT_TREE_STATE_IMAGE_CLICK(id, func):
The state image has been clicked. Windows only.

Constructor & Destructor Documentation

wxTreeCtrl::wxTreeCtrl ( )

Default Constructor.

wxTreeCtrl::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	Parent window. Must not be NULL.
	id	Window identifier. The value `wxID_ANY` indicates a default value.
	pos	Window position.
	size	Window size. If wxDefaultSize is specified then the window is sized appropriately.
	style	Window style. See wxTreeCtrl.
	validator	Window validator.
	name	Window name.

See also:: Create(), wxValidator

virtual wxTreeCtrl::~wxTreeCtrl ( ) [virtual]

Destructor, destroying the tree control.

Member Function Documentation

virtual wxTreeItemId wxTreeCtrl::AddRoot	(	const wxString &	text,
		int	image = `-1`,
		int	selImage = `-1`,
		wxTreeItemData *	data = `NULL`
	)			`[virtual]`

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 wxTreeCtrl::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 wxTreeCtrl::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 wxTreeCtrl::AssignImageList ( wxImageList * imageList )

Sets the normal image list. The 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 wxTreeCtrl::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().

virtual void wxTreeCtrl::Collapse ( const wxTreeItemId & item ) [virtual]

Collapses the given item.

void wxTreeCtrl::CollapseAll ( )

Collapses the root item.

See also:: ExpandAll()

void wxTreeCtrl::CollapseAllChildren ( const wxTreeItemId & item )

Collapses this item and all of its children, recursively.

See also:: ExpandAllChildren()

virtual void wxTreeCtrl::CollapseAndReset ( const wxTreeItemId & item ) [virtual]

Collapses the given item and removes all children.

bool wxTreeCtrl::Create	(	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.

virtual void wxTreeCtrl::Delete ( const wxTreeItemId & item ) [virtual]

Deletes the specified item. A EVT_TREE_DELETE_ITEM() event will be generated.

This function may cause a subsequent call to GetNextChild() to fail.

virtual void wxTreeCtrl::DeleteAllItems ( ) [virtual]

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.

virtual void wxTreeCtrl::DeleteChildren ( const wxTreeItemId & item ) [virtual]

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 SetItemHasChildren(), you may need to call it again since DeleteChildren() does not automatically clear the setting.

void wxTreeCtrl::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:: EndEditLabel(), wxTreeEvent

void wxTreeCtrl::EndEditLabel ( bool cancelEdit )

Ends label editing. If cancelEdit is true, the edit will be cancelled.

Note:: This function is currently supported under Windows only.

See also:: EditLabel()

virtual void wxTreeCtrl::EnsureVisible ( const wxTreeItemId & item ) [virtual]

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

virtual void wxTreeCtrl::Expand ( const wxTreeItemId & item ) [virtual]

Expands the given item.

void wxTreeCtrl::ExpandAll ( )

Expands all items in the tree.

void wxTreeCtrl::ExpandAllChildren ( const wxTreeItemId & item )

Expands the given item and all its children recursively.

bool wxTreeCtrl::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.

wxImageList* wxTreeCtrl::GetButtonsImageList ( ) const

Returns the buttons image list (from which application-defined button images are taken).

This function is only available in the generic version.

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

virtual unsigned int wxTreeCtrl::GetCount ( ) const [virtual]

Returns the number of items in the control.

virtual wxTextCtrl* wxTreeCtrl::GetEditControl ( ) const [virtual]

Returns the edit control being currently used to edit a label. Returns NULL if no label is being edited.

Note:: This is currently only implemented for wxMSW.

wxTreeItemId wxTreeCtrl::GetFirstChild	(	const wxTreeItemId &	item,
		wxTreeItemIdValue &	cookie
	)			const

Returns the first child; call 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. wxTreeItemId::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.

See also:: GetNextChild(), GetNextSibling()

virtual wxTreeItemId wxTreeCtrl::GetFirstVisibleItem ( ) const [virtual]

Returns the first visible item.

wxImageList* wxTreeCtrl::GetImageList ( ) const

Returns the normal image list.

int wxTreeCtrl::GetIndent ( ) const

Returns the current tree control indentation.

virtual wxColour wxTreeCtrl::GetItemBackgroundColour ( const wxTreeItemId & item ) const [virtual]

Returns the background colour of the item.

virtual wxTreeItemData* wxTreeCtrl::GetItemData ( const wxTreeItemId & item ) const [virtual]

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.

virtual wxFont wxTreeCtrl::GetItemFont ( const wxTreeItemId & item ) const [virtual]

Returns the font of the item label.

int wxTreeCtrl::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).

virtual wxTreeItemId wxTreeCtrl::GetItemParent ( const wxTreeItemId & item ) const [virtual]

Returns the item's parent.

int wxTreeCtrl::GetItemSelectedImage ( const wxTreeItemId & item ) const

Gets the selected item image (this function is obsolete, use GetItemImage( item, wxTreeItemIcon_Selected) instead).

int wxTreeCtrl::GetItemState ( const wxTreeItemId & item ) const

Gets the specified item state.

virtual wxString wxTreeCtrl::GetItemText ( const wxTreeItemId & item ) const [virtual]

Returns the item label.

virtual wxColour wxTreeCtrl::GetItemTextColour ( const wxTreeItemId & item ) const [virtual]

Returns the colour of the item label.

virtual wxTreeItemId wxTreeCtrl::GetLastChild ( const wxTreeItemId & item ) const [virtual]

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

See also:: GetFirstChild(), GetNextSibling(), GetLastChild()

wxTreeItemId wxTreeCtrl::GetNextChild	(	const wxTreeItemId &	item,
		wxTreeItemIdValue &	cookie
	)			const

Returns the next child; call 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.

wxPython Note: In wxPython the returned wxTreeItemId and the new cookie value are both returned as a tuple containing the two values.

See also:: GetFirstChild()

virtual wxTreeItemId wxTreeCtrl::GetNextSibling ( const wxTreeItemId & item ) const [virtual]

Returns the next sibling of the specified item; call GetPrevSibling() for the previous sibling.

Returns an invalid tree item if there are no further siblings.

See also:: GetPrevSibling()

virtual wxTreeItemId wxTreeCtrl::GetNextVisible ( const wxTreeItemId & item ) const [virtual]

Returns the next visible item or an invalid item if this item is the last visible one.

Note:: The item itself must be visible.

virtual wxTreeItemId wxTreeCtrl::GetPrevSibling ( const wxTreeItemId & item ) const [virtual]

Returns the previous sibling of the specified item; call GetNextSibling() for the next sibling.

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

See also:: GetNextSibling()

virtual wxTreeItemId wxTreeCtrl::GetPrevVisible ( const wxTreeItemId & item ) const [virtual]

Returns the previous visible item or an invalid item if this item is the first visible one.

Note:: The item itself must be visible.

bool wxTreeCtrl::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:: SetQuickBestSize()

virtual wxTreeItemId wxTreeCtrl::GetRootItem ( ) const [virtual]

Returns the root item for the tree control.

virtual wxTreeItemId wxTreeCtrl::GetSelection ( ) const [virtual]

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.

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

wxImageList* wxTreeCtrl::GetStateImageList ( ) const

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

wxTreeItemId wxTreeCtrl::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.

wxTreeItemId wxTreeCtrl::InsertItem	(	const wxTreeItemId &	parent,
		const wxTreeItemId &	previous,
		const wxString &	text,
		int	image = `-1`,
		int	selImage = `-1`,
		wxTreeItemData *	data = `NULL`
	)

Inserts an item after a given one (previous).

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 wxTreeCtrl::InsertItem	(	const wxTreeItemId &	parent,
		size_t	before,
		const wxString &	text,
		int	image = `-1`,
		int	selImage = `-1`,
		wxTreeItemData *	data = `NULL`
	)

Inserts an item 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: In wxPython, this form of this method is called InsertItemBefore().

virtual bool wxTreeCtrl::IsBold ( const wxTreeItemId & item ) const [virtual]

Returns true if the given item is in bold state.

See also:: SetItemBold()

bool wxTreeCtrl::IsEmpty ( ) const

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

virtual bool wxTreeCtrl::IsExpanded ( const wxTreeItemId & item ) const [virtual]

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

virtual bool wxTreeCtrl::IsSelected ( const wxTreeItemId & item ) const [virtual]

Returns true if the item is selected.

virtual bool wxTreeCtrl::IsVisible ( const wxTreeItemId & item ) const [virtual]

Returns true if the item is visible on the screen.

virtual bool wxTreeCtrl::ItemHasChildren ( const wxTreeItemId & item ) const [virtual]

Returns true if the item has children.

int wxTreeCtrl::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.

See also:: SortChildren()

wxTreeItemId wxTreeCtrl::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.

virtual void wxTreeCtrl::ScrollTo ( const wxTreeItemId & item ) [virtual]

Scrolls the specified item into view.

virtual void wxTreeCtrl::SelectItem	(	const wxTreeItemId &	item,
		bool	select = `true`
	)			`[virtual]`

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 wxTreeCtrl::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.

Note:: This function is only available in the generic version.

See also:: AssignButtonsImageList().

virtual void wxTreeCtrl::SetImageList ( wxImageList * imageList ) [virtual]

Sets the normal image list. The image list assigned with this method will not be deleted by wxTreeCtrl's destructor, you must delete it yourself.

See also:: AssignImageList().

void wxTreeCtrl::SetIndent ( int indent )

Sets the indentation for the tree control.

void wxTreeCtrl::SetItemBackgroundColour	(	const wxTreeItemId &	item,
		const wxColour &	col
	)

Sets the colour of the item's background.

virtual void wxTreeCtrl::SetItemBold	(	const wxTreeItemId &	item,
		bool	bold = `true`
	)			`[virtual]`

Makes item appear in bold font if bold parameter is true or resets it to the normal state.

See also:: IsBold()

virtual void wxTreeCtrl::SetItemData	(	const wxTreeItemId &	item,
		wxTreeItemData *	data
	)			`[virtual]`

Sets the item client data.

wxPython Note:

SetPyData( item, obj): Associate the given Python Object with the wxTreeItemData for the given item Id.

void wxTreeCtrl::SetItemDropHighlight	(	const wxTreeItemId &	item,
		bool	highlight = `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).

virtual void wxTreeCtrl::SetItemFont	(	const wxTreeItemId &	item,
		const wxFont &	font
	)			`[virtual]`

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

void wxTreeCtrl::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 wxTreeCtrl::SetItemImage ( const wxTreeItemId &


Public Member Functions
	wxTreeCtrl ()
	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")
virtual	~wxTreeCtrl ()
virtual wxTreeItemId	AddRoot (const wxString &text, int image=-1, int selImage=-1, wxTreeItemData *data=NULL)
wxTreeItemId	AppendItem (const wxTreeItemId &parent, const wxString &text, int image=-1, int selImage=-1, wxTreeItemData *data=NULL)
void	AssignButtonsImageList (wxImageList *imageList)
void	AssignImageList (wxImageList *imageList)
void	AssignStateImageList (wxImageList *imageList)
virtual void	Collapse (const wxTreeItemId &item)
void	CollapseAll ()
void	CollapseAllChildren (const wxTreeItemId &item)
virtual void	CollapseAndReset (const wxTreeItemId &item)
bool	Create (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")
virtual void	Delete (const wxTreeItemId &item)
virtual void	DeleteAllItems ()
virtual void	DeleteChildren (const wxTreeItemId &item)
void	EditLabel (const wxTreeItemId &item)
void	EndEditLabel (bool cancelEdit)
virtual void	EnsureVisible (const wxTreeItemId &item)
virtual void	Expand (const wxTreeItemId &item)
void	ExpandAll ()
void	ExpandAllChildren (const wxTreeItemId &item)
bool	GetBoundingRect (const wxTreeItemId &item, wxRect &rect, bool textOnly=false) const
wxImageList *	GetButtonsImageList () const
unsigned int	GetChildrenCount (const wxTreeItemId &item, bool recursively=true) const
virtual unsigned int	GetCount () const
virtual wxTextCtrl *	GetEditControl () const
wxTreeItemId	GetFirstChild (const wxTreeItemId &item, wxTreeItemIdValue &cookie) const
virtual wxTreeItemId	GetFirstVisibleItem () const
wxImageList *	GetImageList () const
int	GetIndent () const
virtual wxColour	GetItemBackgroundColour (const wxTreeItemId &item) const
virtual wxTreeItemData *	GetItemData (const wxTreeItemId &item) const
virtual wxFont	GetItemFont (const wxTreeItemId &item) const
int	GetItemImage (const wxTreeItemId &item, wxTreeItemIcon which=wxTreeItemIcon_Normal) const
virtual wxTreeItemId	GetItemParent (const wxTreeItemId &item) const
int	GetItemSelectedImage (const wxTreeItemId &item) const
int	GetItemState (const wxTreeItemId &item) const
virtual wxString	GetItemText (const wxTreeItemId &item) const
virtual wxColour	GetItemTextColour (const wxTreeItemId &item) const
virtual wxTreeItemId	GetLastChild (const wxTreeItemId &item) const
wxTreeItemId	GetNextChild (const wxTreeItemId &item, wxTreeItemIdValue &cookie) const
virtual wxTreeItemId	GetNextSibling (const wxTreeItemId &item) const
virtual wxTreeItemId	GetNextVisible (const wxTreeItemId &item) const
virtual wxTreeItemId	GetPrevSibling (const wxTreeItemId &item) const
virtual wxTreeItemId	GetPrevVisible (const wxTreeItemId &item) const
bool	GetQuickBestSize () const
virtual wxTreeItemId	GetRootItem () const
virtual wxTreeItemId	GetSelection () const
unsigned int	GetSelections (wxArrayTreeItemIds &selection) const
wxImageList *	GetStateImageList () const
wxTreeItemId	HitTest (const wxPoint &point, int &flags) const
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)
virtual bool	IsBold (const wxTreeItemId &item) const
bool	IsEmpty () const
virtual bool	IsExpanded (const wxTreeItemId &item) const
virtual bool	IsSelected (const wxTreeItemId &item) const
virtual bool	IsVisible (const wxTreeItemId &item) const
virtual bool	ItemHasChildren (const wxTreeItemId &item) const
int	OnCompareItems (const wxTreeItemId &item1, const wxTreeItemId &item2)
wxTreeItemId	PrependItem (const wxTreeItemId &parent, const wxString &text, int image=-1, int selImage=-1, wxTreeItemData *data=NULL)
virtual void	ScrollTo (const wxTreeItemId &item)
virtual void	SelectItem (const wxTreeItemId &item, bool select=true)
void	SetButtonsImageList (wxImageList *imageList)
virtual void	SetImageList (wxImageList *imageList)
void	SetIndent (int indent)
void	SetItemBackgroundColour (const wxTreeItemId &item, const wxColour &col)
virtual void	SetItemBold (const wxTreeItemId &item, bool bold=true)
virtual void	SetItemData (const wxTreeItemId &item, wxTreeItemData *data)
void	SetItemDropHighlight (const wxTreeItemId &item, bool highlight=true)
virtual void	SetItemFont (const wxTreeItemId &item, const wxFont &font)
void	SetItemHasChildren (const wxTreeItemId &item, bool hasChildren=true)
void	SetItemImage (const wxTreeItemId &item, int image, wxTreeItemIcon which=wxTreeItemIcon_Normal)
void	SetItemSelectedImage (const wxTreeItemId &item, int selImage)
void	SetItemState (const wxTreeItemId &item, int state)
virtual void	SetItemText (const wxTreeItemId &item, const wxString &text)
void	SetItemTextColour (const wxTreeItemId &item, const wxColour &col)
void	SetQuickBestSize (bool quickBestSize)
virtual void	SetStateImageList (wxImageList *imageList)
void	SetWindowStyle (long styles)
virtual void	SortChildren (const wxTreeItemId &item)
virtual void	Toggle (const wxTreeItemId &item)
void	ToggleItemSelection (const wxTreeItemId &item)
virtual void	Unselect ()
virtual void	UnselectAll ()
void	UnselectItem (const wxTreeItemId &item)

wxTreeCtrl Class Reference [Controls]

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

wxTreeCtrl Class Reference
[Controls]