wxTreeCtrl

Implements methods from the following classes

• wxControl

Methods

• wxTreeCtrl
  Default Constructor.
• AddRoot
  Adds the root node to the tree, returning the new item.
• AppendItem
  Appends an item to the end of the branch identified by parent, return a new item id.
• AssignImageList
  Sets the normal image list.
• AssignStateImageList
  Sets the state image list.
• ClearFocusedItem
  Clears the currently focused item.
• Collapse
  Collapses the given item.
• CollapseAll
  Collapses the root item.
• CollapseAllChildren
  Collapses this item and all of its children, recursively.
• CollapseAndReset
  Collapses the given item and removes all children.
• Create
  Creates the tree control.
• Delete
  Deletes the specified item.
• DeleteAllItems
  Deletes all items in the control.
• DeleteChildren
  Deletes all children of the given item (but not the item itself).
• EndEditLabel
  Ends label editing.
• EnsureVisible
  Scrolls and/or expands items to ensure that the given item is visible.
• Expand
  Expands the given item.
• ExpandAll
  Expands all items in the tree.
• ExpandAllChildren
  Expands the given item and all its children recursively.
• GetBoundingRect
  Retrieves the rectangle bounding the item.
• GetChildrenCount
  Returns the number of items in the branch.
• GetCount
  Returns the number of items in the control.
• GetEditControl
  Returns the edit control being currently used to edit a label.
• GetFirstVisibleItem
  Returns the first visible item.
• GetFocusedItem
  Returns the item last clicked or otherwise selected.
• GetImageList
  Returns the normal image list.
• GetIndent
  Returns the current tree control indentation.
• GetItemBackgroundColour
  Returns the background colour of the item.
• GetItemData
  Returns the tree item data associated with the item.
• GetItemFont
  Returns the font of the item label.
• GetItemImage
  Gets the specified item image.
• GetItemParent
  Returns the item's parent.
• GetItemState
  Gets the specified item state.
• GetItemText
  Returns the item label.
• GetItemTextColour
  Returns the colour of the item label.
• GetLastChild
  Returns the last child of the item (or an invalid tree item if this item has no children).
• GetNextSibling
  Returns the next sibling of the specified item; call GetPrevSibling() for the previous sibling.
• GetNextVisible
  Returns the next visible item or an invalid item if this item is the last visible one.
• GetPrevSibling
  Returns the previous sibling of the specified item; call GetNextSibling() for the next sibling.
• GetPrevVisible
  Returns the previous visible item or an invalid item if this item is the first visible one.
• GetQuickBestSize
  Returns true if the control will use a quick calculation for the best size, looking only at the first and last items.
• GetRootItem
  Returns the root item for the tree control.
• GetSelection
  Returns the selection, or an invalid item if there is no selection.
• GetStateImageList
  Returns the state image list (from which application-defined state images are taken).
• HitTest
  Calculates which (if any) item is under the given point, returning the tree item id at this point plus extra information flags.
• InsertItem
  Inserts an item after a given one (previous).
• IsBold
  Returns true if the given item is in bold state.
• IsEmpty
  Returns true if the control is empty (i.e.
• IsExpanded
  Returns true if the item is expanded (only makes sense if it has children).
• IsSelected
  Returns true if the item is selected.
• IsVisible
  Returns true if the item is visible on the screen.
• ItemHasChildren
  Returns true if the item has children.
• PrependItem
  Appends an item as the first child of parent, return a new item id.
• ScrollTo
  Scrolls the specified item into view.
• SelectChildren
  Select all the immediate children of the given parent.
• SelectItem
  Selects the given item.
• SetFocusedItem
  Sets the currently focused item.
• SetImageList
  Sets the normal image list.
• SetIndent
  Sets the indentation for the tree control.
• SetItemBackgroundColour
  Sets the colour of the item's background.
• SetItemBold
  Makes item appear in bold font if bold parameter is true or resets it to the normal state.
• SetItemData
  Sets the item client data.
• SetItemDropHighlight
  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).
• SetItemFont
  Sets the item's font.
• SetItemHasChildren
  Force appearance of the button next to the item.
• SetItemImage
  Sets the specified item's image.
• SetItemState
  Sets the specified item state.
• SetItemText
  Sets the item label.
• SetItemTextColour
  Sets the colour of the item's text.
• SetQuickBestSize
  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.
• SetStateImageList
  Sets the state image list (from which application-defined state images are taken).
• SetWindowStyle
  Sets the mode flags associated with the display of the tree control.
• SortChildren
  Sorts the children of the given item using OnCompareItems().
• Toggle
  Toggles the given item between collapsed and expanded states.
• ToggleItemSelection
  Toggles the given item between selected and unselected states.
• Unselect
  Removes the selection from the currently selected item (if any).
• 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.
• UnselectItem
  Unselects the given item.

Static Methods

wxTreeCtrl

wxTreeCtrl ( )

Default Constructor.
wxTreeCtrl ( wxWindow &$parent, integer $id=wxID_ANY, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style=wxTR_DEFAULT_STYLE, wxValidator $validator=wxDefaultValidator, string $name=wxTreeCtrlNameStr )

Constructor, creating and showing a tree control.

AddRoot

wxTreeItemId AddRoot ( string $text, integer $image=-1, integer $selImage=-1, wxTreeItemData &$data=NULL )

Adds the root node to the tree, returning the new item.

AppendItem

wxTreeItemId AppendItem ( wxTreeItemId $parent, string $text, integer $image=-1, integer $selImage=-1, wxTreeItemData &$data=NULL )

Appends an item to the end of the branch identified by parent, return a new item id.

AssignImageList

AssignImageList ( wxImageList &$imageList )

Sets the normal image list.

AssignStateImageList

AssignStateImageList ( wxImageList &$imageList )

Sets the state image list.

ClearFocusedItem

ClearFocusedItem ( )

Clears the currently focused item.

Collapse

Collapse ( wxTreeItemId $item )

Collapses the given item.

CollapseAll

CollapseAll ( )

Collapses the root item.

CollapseAllChildren

CollapseAllChildren ( wxTreeItemId $item )

Collapses this item and all of its children, recursively.

CollapseAndReset

CollapseAndReset ( wxTreeItemId $item )

Collapses the given item and removes all children.

Create

bool Create ( wxWindow &$parent, integer $id=wxID_ANY, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style=wxTR_DEFAULT_STYLE, wxValidator $validator=wxDefaultValidator, string $name=wxTreeCtrlNameStr )

Creates the tree control.

Delete

Delete ( wxTreeItemId $item )

Deletes the specified item.

DeleteAllItems

DeleteAllItems ( )

Deletes all items in the control.

DeleteChildren

DeleteChildren ( wxTreeItemId $item )

Deletes all children of the given item (but not the item itself).

EndEditLabel

EndEditLabel ( wxTreeItemId $item, bool $discardChanges=false )

Ends label editing.

EnsureVisible

EnsureVisible ( wxTreeItemId $item )

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

Expand

Expand ( wxTreeItemId $item )

Expands the given item.

ExpandAll

ExpandAll ( )

Expands all items in the tree.

ExpandAllChildren

ExpandAllChildren ( wxTreeItemId $item )

Expands the given item and all its children recursively.

GetBoundingRect

bool GetBoundingRect ( wxTreeItemId $item, wxRect &$rect, bool $textOnly=false )

Retrieves the rectangle bounding the item.

GetChildrenCount

integer GetChildrenCount ( wxTreeItemId $item, bool $recursively=true )

Returns the number of items in the branch.

GetCount

integer GetCount ( )

Returns the number of items in the control.

GetEditControl

wxTextCtrl& GetEditControl ( )

Returns the edit control being currently used to edit a label.

GetFirstVisibleItem

wxTreeItemId GetFirstVisibleItem ( )

Returns the first visible item.

GetFocusedItem

wxTreeItemId GetFocusedItem ( )

Returns the item last clicked or otherwise selected.

GetImageList

wxImageList& GetImageList ( )

Returns the normal image list.

GetIndent

integer GetIndent ( )

Returns the current tree control indentation.

GetItemBackgroundColour

wxColour GetItemBackgroundColour ( wxTreeItemId $item )

Returns the background colour of the item.

GetItemData

wxTreeItemData& GetItemData ( wxTreeItemId $item )

Returns the tree item data associated with the item.

GetItemFont

wxFont GetItemFont ( wxTreeItemId $item )

Returns the font of the item label.

GetItemImage

integer GetItemImage ( wxTreeItemId $item, wxTreeItemIcon $which=wxTreeItemIcon_Normal )

Gets the specified item image.

GetItemParent

wxTreeItemId GetItemParent ( wxTreeItemId $item )

Returns the item's parent.

GetItemState

integer GetItemState ( wxTreeItemId $item )

Gets the specified item state.

GetItemText

string GetItemText ( wxTreeItemId $item )

Returns the item label.

GetItemTextColour

wxColour GetItemTextColour ( wxTreeItemId $item )

Returns the colour of the item label.

GetLastChild

wxTreeItemId GetLastChild ( wxTreeItemId $item )

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

GetNextSibling

wxTreeItemId GetNextSibling ( wxTreeItemId $item )

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

GetNextVisible

wxTreeItemId GetNextVisible ( wxTreeItemId $item )

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

GetPrevSibling

wxTreeItemId GetPrevSibling ( wxTreeItemId $item )

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

GetPrevVisible

wxTreeItemId GetPrevVisible ( wxTreeItemId $item )

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

GetQuickBestSize

bool GetQuickBestSize ( )

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

GetRootItem

wxTreeItemId GetRootItem ( )

Returns the root item for the tree control.

GetSelection

wxTreeItemId GetSelection ( )

Returns the selection, or an invalid item if there is no selection.

GetStateImageList

wxImageList& GetStateImageList ( )

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

HitTest

wxTreeItemId HitTest ( wxPoint $point, integer &$flags )

Calculates which (if any) item is under the given point, returning the tree item id at this point plus extra information flags.

InsertItem

wxTreeItemId InsertItem ( wxTreeItemId $parent, wxTreeItemId $previous, string $text, integer $image=-1, integer $selImage=-1, wxTreeItemData &$data=NULL )

Inserts an item after a given one (previous).
wxTreeItemId InsertItem ( wxTreeItemId $parent, integer $before, string $text, integer $image=-1, integer $selImage=-1, wxTreeItemData &$data=NULL )

Inserts an item before one identified by its position (before).

IsBold

bool IsBold ( wxTreeItemId $item )

Returns true if the given item is in bold state.

IsEmpty

bool IsEmpty ( )

Returns true if the control is empty (i.e.

IsExpanded

bool IsExpanded ( wxTreeItemId $item )

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

IsSelected

bool IsSelected ( wxTreeItemId $item )

Returns true if the item is selected.

IsVisible

bool IsVisible ( wxTreeItemId $item )

Returns true if the item is visible on the screen.

ItemHasChildren

bool ItemHasChildren ( wxTreeItemId $item )

Returns true if the item has children.

PrependItem

wxTreeItemId PrependItem ( wxTreeItemId $parent, string $text, integer $image=-1, integer $selImage=-1, wxTreeItemData &$data=NULL )

Appends an item as the first child of parent, return a new item id.

ScrollTo

ScrollTo ( wxTreeItemId $item )

Scrolls the specified item into view.

SelectChildren

SelectChildren ( wxTreeItemId $parent )

Select all the immediate children of the given parent.

SelectItem

SelectItem ( wxTreeItemId $item, bool $select=true )

Selects the given item.

SetFocusedItem

SetFocusedItem ( wxTreeItemId $item )

Sets the currently focused item.

SetImageList

SetImageList ( wxImageList &$imageList )

Sets the normal image list.

SetIndent

SetIndent ( integer $indent )

Sets the indentation for the tree control.

SetItemBackgroundColour

SetItemBackgroundColour ( wxTreeItemId $item, wxColour $col )

Sets the colour of the item's background.

SetItemBold

SetItemBold ( wxTreeItemId $item, bool $bold=true )

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

SetItemData

SetItemData ( wxTreeItemId $item, wxTreeItemData &$data )

Sets the item client data.

SetItemDropHighlight

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

SetItemFont

SetItemFont ( wxTreeItemId $item, wxFont $font )

Sets the item's font.

SetItemHasChildren

SetItemHasChildren ( wxTreeItemId $item, bool $hasChildren=true )

Force appearance of the button next to the item.

SetItemImage

SetItemImage ( wxTreeItemId $item, integer $image, wxTreeItemIcon $which=wxTreeItemIcon_Normal )

Sets the specified item's image.

SetItemState

SetItemState ( wxTreeItemId $item, integer $state )

Sets the specified item state.

SetItemText

SetItemText ( wxTreeItemId $item, string $text )

Sets the item label.

SetItemTextColour

SetItemTextColour ( wxTreeItemId $item, wxColour $col )

Sets the colour of the item's text.

SetQuickBestSize

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.

SetStateImageList

SetStateImageList ( wxImageList &$imageList )

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

SetWindowStyle

SetWindowStyle ( integer $styles )

Sets the mode flags associated with the display of the tree control.

SortChildren

SortChildren ( wxTreeItemId $item )

Sorts the children of the given item using OnCompareItems().

Toggle

Toggle ( wxTreeItemId $item )

Toggles the given item between collapsed and expanded states.

ToggleItemSelection

ToggleItemSelection ( wxTreeItemId $item )

Toggles the given item between selected and unselected states.

Unselect

Unselect ( )

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

UnselectAll

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.

UnselectItem

UnselectItem ( wxTreeItemId $item )

Unselects the given item.