for a particular toolkit.
@endStyleTable
+ @beginEventTable{wxTreeEvent}
+ @event{EVT_TREE_BEGIN_DRAG(id, func)}
+ Begin dragging with the left mouse button.
+ @event{EVT_TREE_BEGIN_RDRAG(id, func)}
+ Begin dragging with the right mouse button.
+ @event{EVT_TREE_END_DRAG(id, func)}
+ End dragging with the left or right mouse button.
+ @event{EVT_TREE_BEGIN_LABEL_EDIT(id, func)}
+ Begin editing a label. This can be prevented by calling Veto().
+ @event{EVT_TREE_END_LABEL_EDIT(id, func)}
+ Finish editing a label. This can be prevented by calling Veto().
+ @event{EVT_TREE_DELETE_ITEM(id, func)}
+ An item was deleted.
+ @event{EVT_TREE_GET_INFO(id, func)}
+ Request information from the application.
+ @event{EVT_TREE_SET_INFO(id, func)}
+ Information is being supplied.
+ @event{EVT_TREE_ITEM_ACTIVATED(id, func)}
+ The item has been activated, i.e. chosen by double clicking it with mouse or from keyboard.
+ @event{EVT_TREE_ITEM_COLLAPSED(id, func)}
+ The item has been collapsed.
+ @event{EVT_TREE_ITEM_COLLAPSING(id, func)}
+ The item is being collapsed. This can be prevented by calling Veto().
+ @event{EVT_TREE_ITEM_EXPANDED(id, func)}
+ The item has been expanded.
+ @event{EVT_TREE_ITEM_EXPANDING(id, func)}
+ The item is being expanded. This can be prevented by calling Veto().
+ @event{EVT_TREE_ITEM_RIGHT_CLICK(id, func)}
+ The user has clicked the item with the right mouse button.
+ @event{EVT_TREE_ITEM_MIDDLE_CLICK(id, func)}
+ The user has clicked the item with the middle mouse button.
+ @event{EVT_TREE_SEL_CHANGED(id, func)}
+ Selection has changed.
+ @event{EVT_TREE_SEL_CHANGING(id, func)}
+ Selection is changing. This can be prevented by calling Veto().
+ @event{EVT_TREE_KEY_DOWN(id, func)}
+ A key has been pressed.
+ @event{EVT_TREE_ITEM_GETTOOLTIP(id, func)}
+ The opportunity to set the item tooltip is being given to the application (call wxTreeEvent::SetToolTip). Windows only.
+ @event{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.
+ @event{EVT_TREE_STATE_IMAGE_CLICK(id, func)}
+ The state image has been clicked. Windows only.
+ @endEventTable
+
+
See also @ref overview_windowstyles.
@b Win32 @b notes:
/**
Destructor, destroying the tree control.
*/
- ~wxTreeCtrl();
+ virtual ~wxTreeCtrl();
/**
Adds the root node to the tree, returning the new item.
items, respectively. If @a image -1 and @a selImage is -1, the same
image is used for both selected and unselected items.
*/
- wxTreeItemId AddRoot(const wxString& text, int image = -1,
- int selImage = -1,
- wxTreeItemData* data = NULL);
+ virtual wxTreeItemId AddRoot(const wxString& text, int image = -1,
+ int selImage = -1,
+ wxTreeItemData* data = NULL);
/**
Appends an item to the end of the branch identified by @a parent, return
/**
Collapses the given item.
*/
- void Collapse(const wxTreeItemId& item);
+ virtual void Collapse(const wxTreeItemId& item);
/**
Collapses the root item.
/**
Collapses the given item and removes all children.
*/
- void CollapseAndReset(const wxTreeItemId& item);
+ virtual void CollapseAndReset(const wxTreeItemId& item);
/**
Creates the tree control. See wxTreeCtrl::wxTreeCtrl() for further
This function may cause a subsequent call to GetNextChild() to fail.
*/
- void Delete(const wxTreeItemId& item);
+ virtual void Delete(const wxTreeItemId& item);
/**
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.
*/
- void DeleteAllItems();
+ virtual void DeleteAllItems();
/**
Deletes all children of the given item (but not the item itself). Note
If you have called SetItemHasChildren(), you may need to call it again
since DeleteChildren() does not automatically clear the setting.
*/
- void DeleteChildren(const wxTreeItemId& item);
+ virtual void DeleteChildren(const wxTreeItemId& item);
/**
Starts editing the label of the given @a item. This function generates a
/**
Scrolls and/or expands items to ensure that the given item is visible.
*/
- void EnsureVisible(const wxTreeItemId& item);
+ virtual void EnsureVisible(const wxTreeItemId& item);
/**
Expands the given item.
*/
- void Expand(const wxTreeItemId& item);
+ virtual void Expand(const wxTreeItemId& item);
/**
Expands all items in the tree.
/**
Returns the number of items in the control.
*/
- unsigned int GetCount() const;
+ virtual unsigned int GetCount() const;
/**
Returns the edit control being currently used to edit a label. Returns
@note This is currently only implemented for wxMSW.
*/
- wxTextCtrl* GetEditControl() const;
+ virtual wxTextCtrl* GetEditControl() const;
/**
Returns the first child; call GetNextChild() for the next child.
/**
Returns the first visible item.
*/
- wxTreeItemId GetFirstVisibleItem() const;
+ virtual wxTreeItemId GetFirstVisibleItem() const;
/**
Returns the normal image list.
/**
Returns the background colour of the item.
*/
- wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
+ virtual wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
/**
Returns the tree item data associated with the item.
wxTreeItemData for the given item Id.
@endWxPythonOnly
*/
- wxTreeItemData* GetItemData(const wxTreeItemId& item) const;
+ virtual wxTreeItemData* GetItemData(const wxTreeItemId& item) const;
/**
Returns the font of the item label.
*/
- wxFont GetItemFont(const wxTreeItemId& item) const;
+ virtual wxFont GetItemFont(const wxTreeItemId& item) const;
/**
Gets the specified item image. The value of @a which may be:
/**
Returns the item's parent.
*/
- wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
+ virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
/**
Gets the selected item image (this function is obsolete, use @ref
/**
Returns the item label.
*/
- wxString GetItemText(const wxTreeItemId& item) const;
+ virtual wxString GetItemText(const wxTreeItemId& item) const;
/**
Returns the colour of the item label.
*/
- wxColour GetItemTextColour(const wxTreeItemId& item) const;
+ virtual wxColour GetItemTextColour(const wxTreeItemId& item) const;
/**
Returns the last child of the item (or an invalid tree item if this item
@see GetFirstChild(), GetNextSibling(), GetLastChild()
*/
- wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
+ virtual wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
/**
Returns the next child; call GetFirstChild() for the first child. For
@see GetPrevSibling()
*/
- wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
+ virtual wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
/**
Returns the next visible item or an invalid item if this item is the
@note The @a item itself must be visible.
*/
- wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
+ virtual wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
/**
Returns the previous sibling of the specified item; call
@see GetNextSibling()
*/
- wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
+ virtual wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
/**
Returns the previous visible item or an invalid item if this item is the
@note The @a item itself must be visible.
*/
- wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
+ virtual wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
/**
Returns @true if the control will use a quick calculation for the best
/**
Returns the root item for the tree control.
*/
- wxTreeItemId GetRootItem() const;
+ virtual wxTreeItemId GetRootItem() const;
/**
Returns the selection, or an invalid item if there is no selection. This
function only works with the controls without @c wxTR_MULTIPLE style,
use GetSelections() for the controls which do have this style.
*/
- wxTreeItemId GetSelection() const;
+ virtual wxTreeItemId GetSelection() const;
/**
Fills the array of tree items passed in with the currently selected
@see SetItemBold()
*/
- bool IsBold(const wxTreeItemId& item) const;
+ virtual bool IsBold(const wxTreeItemId& item) const;
/**
Returns @true if the control is empty (i.e. has no items, even no root
Returns @true if the item is expanded (only makes sense if it has
children).
*/
- bool IsExpanded(const wxTreeItemId& item) const;
+ virtual bool IsExpanded(const wxTreeItemId& item) const;
/**
Returns @true if the item is selected.
*/
- bool IsSelected(const wxTreeItemId& item) const;
+ virtual bool IsSelected(const wxTreeItemId& item) const;
/**
Returns @true if the item is visible on the screen.
*/
- bool IsVisible(const wxTreeItemId& item) const;
+ virtual bool IsVisible(const wxTreeItemId& item) const;
/**
Returns @true if the item has children.
*/
- bool ItemHasChildren(const wxTreeItemId& item) const;
+ virtual bool ItemHasChildren(const wxTreeItemId& item) const;
/**
Override this function in the derived class to change the sort order of
/**
Scrolls the specified item into view.
*/
- void ScrollTo(const wxTreeItemId& item);
+ virtual void ScrollTo(const wxTreeItemId& item);
/**
Selects the given item. In multiple selection controls, can be also used
to deselect a currently selected item if the value of @a select is
@false.
*/
- void SelectItem(const wxTreeItemId& item, bool select = true);
+ virtual void SelectItem(const wxTreeItemId& item, bool select = true);
/**
Sets the buttons image list (from which application-defined button
@see AssignImageList().
*/
- void SetImageList(wxImageList* imageList);
+ virtual void SetImageList(wxImageList* imageList);
/**
Sets the indentation for the tree control.
@see IsBold()
*/
- void SetItemBold(const wxTreeItemId& item, bool bold = true);
+ virtual void SetItemBold(const wxTreeItemId& item, bool bold = true);
/**
Sets the item client data.
@endWxPythonOnly
*/
- void SetItemData(const wxTreeItemId& item, wxTreeItemData* data);
+ virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData* data);
/**
@see SetItemBold()
*/
- void SetItemFont(const wxTreeItemId& item, const wxFont& font);
+ virtual void SetItemFont(const wxTreeItemId& item, const wxFont& font);
/**
Force appearance of the button next to the item. This is useful to
/**
Sets the item label.
*/
- void SetItemText(const wxTreeItemId& item, const wxString& text);
+ virtual void SetItemText(const wxTreeItemId& item, const wxString& text);
/**
Sets the colour of the item's text.
@see AssignStateImageList().
*/
- void SetStateImageList(wxImageList* imageList);
+ virtual void SetStateImageList(wxImageList* imageList);
/**
Sets the mode flags associated with the display of the tree control. The
@see wxTreeItemData, OnCompareItems()
*/
- void SortChildren(const wxTreeItemId& item);
+ virtual void SortChildren(const wxTreeItemId& item);
/**
Toggles the given item between collapsed and expanded states.
*/
- void Toggle(const wxTreeItemId& item);
+ virtual void Toggle(const wxTreeItemId& item);
/**
Toggles the given item between selected and unselected states. For
/**
Removes the selection from the currently selected item (if any).
*/
- void Unselect();
+ virtual void Unselect();
/**
This function either behaves the same as Unselect() if the control
doesn't have @c wxTR_MULTIPLE style, or removes the selection from all
items if it does have this style.
*/
- void UnselectAll();
+ virtual void UnselectAll();
/**
Unselects the given item. This works in multiselection controls only.
projects / wxWidgets.git / blobdiff