// Name: treectrl.h
// Purpose: interface of wxTreeItemData
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
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
+ A similar control with a fully native implementation for GTK+ and OS X
as well is wxDataViewTreeCtrl.
To intercept events from a tree control, use the event table macros
For convenience to document that no buttons are to be drawn.
@style{wxTR_HAS_BUTTONS}
Use this style to show + and - buttons to the left of parent items.
+ @style{wxTR_TWIST_BUTTONS}
+ Selects alternative style of @c +/@c - buttons and shows rotating
+ ("twisting") arrows instead. Currently this style is only implemented
+ under Microsoft Windows Vista and later Windows versions and is ignored
+ under the other platforms. Notice that under Vista this style results
+ in the same appearance as used by the tree control in Explorer and
+ other built-in programs and so using it may be preferable to the
+ default style.
@style{wxTR_NO_LINES}
Use this style to hide vertical level connectors.
@style{wxTR_FULL_ROW_HIGHLIGHT}
for a particular toolkit.
@endStyleTable
- @beginEventTable{wxTreeEvent}
+ @beginEventEmissionTable{wxTreeEvent}
@event{EVT_TREE_BEGIN_DRAG(id, func)}
Begin dragging with the left mouse button.
+ If you want to enable left-dragging you need to intercept this event
+ and explicitly call wxTreeEvent::Allow(), as it's vetoed by default.
+ Processes a @c wxEVT_TREE_BEGIN_DRAG event type.
@event{EVT_TREE_BEGIN_RDRAG(id, func)}
Begin dragging with the right mouse button.
+ If you want to enable right-dragging you need to intercept this event
+ and explicitly call wxTreeEvent::Allow(), as it's vetoed by default.
+ Processes a @c wxEVT_TREE_BEGIN_RDRAG event type.
@event{EVT_TREE_END_DRAG(id, func)}
End dragging with the left or right mouse button.
+ Processes a @c wxEVT_TREE_END_DRAG event type.
@event{EVT_TREE_BEGIN_LABEL_EDIT(id, func)}
Begin editing a label. This can be prevented by calling Veto().
+ Processes a @c wxEVT_TREE_BEGIN_LABEL_EDIT event type.
@event{EVT_TREE_END_LABEL_EDIT(id, func)}
Finish editing a label. This can be prevented by calling Veto().
+ Processes a @c wxEVT_TREE_END_LABEL_EDIT event type.
@event{EVT_TREE_DELETE_ITEM(id, func)}
An item was deleted.
+ Processes a @c wxEVT_TREE_DELETE_ITEM event type.
@event{EVT_TREE_GET_INFO(id, func)}
Request information from the application.
+ Processes a @c wxEVT_TREE_GET_INFO event type.
@event{EVT_TREE_SET_INFO(id, func)}
Information is being supplied.
+ Processes a @c wxEVT_TREE_SET_INFO event type.
@event{EVT_TREE_ITEM_ACTIVATED(id, func)}
- The item has been activated, i.e. chosen by double clicking it with mouse or from keyboard.
+ The item has been activated, i.e. chosen by double clicking it with
+ mouse or from keyboard.
+ Processes a @c wxEVT_TREE_ITEM_ACTIVATED event type.
@event{EVT_TREE_ITEM_COLLAPSED(id, func)}
The item has been collapsed.
+ Processes a @c wxEVT_TREE_ITEM_COLLAPSED event type.
@event{EVT_TREE_ITEM_COLLAPSING(id, func)}
The item is being collapsed. This can be prevented by calling Veto().
+ Processes a @c wxEVT_TREE_ITEM_COLLAPSING event type.
@event{EVT_TREE_ITEM_EXPANDED(id, func)}
The item has been expanded.
+ Processes a @c wxEVT_TREE_ITEM_EXPANDED event type.
@event{EVT_TREE_ITEM_EXPANDING(id, func)}
The item is being expanded. This can be prevented by calling Veto().
+ Processes a @c wxEVT_TREE_ITEM_EXPANDING event type.
@event{EVT_TREE_ITEM_RIGHT_CLICK(id, func)}
The user has clicked the item with the right mouse button.
+ Processes a @c wxEVT_TREE_ITEM_RIGHT_CLICK event type.
@event{EVT_TREE_ITEM_MIDDLE_CLICK(id, func)}
- The user has clicked the item with the middle mouse button.
+ The user has clicked the item with the middle mouse button. This is
+ only supported by the generic control.
+ Processes a @c wxEVT_TREE_ITEM_MIDDLE_CLICK event type.
@event{EVT_TREE_SEL_CHANGED(id, func)}
Selection has changed.
+ Processes a @c wxEVT_TREE_SEL_CHANGED event type.
@event{EVT_TREE_SEL_CHANGING(id, func)}
Selection is changing. This can be prevented by calling Veto().
+ Processes a @c wxEVT_TREE_SEL_CHANGING event type.
@event{EVT_TREE_KEY_DOWN(id, func)}
A key has been pressed.
+ Processes a @c wxEVT_TREE_KEY_DOWN event type.
@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.
+ The opportunity to set the item tooltip is being given to the application
+ (call wxTreeEvent::SetToolTip). Windows only.
+ Processes a @c wxEVT_TREE_ITEM_GETTOOLTIP event type.
@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.
+ The context menu for the selected item has been requested, either by a
+ right click or by using the menu key.
+ Processes a @c wxEVT_TREE_ITEM_MENU event type.
@event{EVT_TREE_STATE_IMAGE_CLICK(id, func)}
- The state image has been clicked. Windows only.
+ The state image has been clicked.
+ Processes a @c wxEVT_TREE_STATE_IMAGE_CLICK event type.
@endEventTable
@library{wxcore}
@category{ctrl}
- @appearance{treectrl.png}
+ @appearance{treectrl}
- @see wxDataViewTreeCtrl, wxTreeEvent, wxTreeItemData, @ref overview_treectrl, wxListBox,
- wxListCtrl, wxImageList
+ @see wxDataViewTreeCtrl, wxTreeEvent, wxTreeItemData, @ref overview_treectrl,
+ wxListBox, wxListCtrl, wxImageList
*/
class wxTreeCtrl : public wxControl
{
Window identifier. The value @c wxID_ANY indicates a default value.
@param pos
Window position.
+ If ::wxDefaultPosition is specified then a default position is chosen.
@param size
- Window size. If wxDefaultSize is specified then the window is sized
- appropriately.
+ Window size.
+ If ::wxDefaultSize is specified then the window is sized appropriately.
@param style
Window style. See wxTreeCtrl.
@param validator
@see Create(), wxValidator
*/
- wxTreeCtrl(wxWindow* parent, wxWindowID id,
+ wxTreeCtrl(wxWindow* parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = wxTR_HAS_BUTTONS,
+ long style = wxTR_DEFAULT_STYLE,
const wxValidator& validator = wxDefaultValidator,
- const wxString& name = "treeCtrl");
+ const wxString& name = wxTreeCtrlNameStr);
/**
virtual void CollapseAndReset(const wxTreeItemId& item);
/**
- Creates the tree control. See wxTreeCtrl::wxTreeCtrl() for further
- details.
+ Creates the tree control.
+ See wxTreeCtrl::wxTreeCtrl() for further details.
*/
- bool Create(wxWindow* parent, wxWindowID id,
+ bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = wxTR_HAS_BUTTONS,
+ long style = wxTR_DEFAULT_STYLE,
const wxValidator& validator = wxDefaultValidator,
- const wxString& name = "treeCtrl");
+ const wxString& name = wxTreeCtrlNameStr);
/**
- Deletes the specified item. A EVT_TREE_DELETE_ITEM() event will be
+ Deletes the specified item. A @c EVT_TREE_DELETE_ITEM event will be
generated.
This function may cause a subsequent call to GetNextChild() to fail.
/**
Deletes all items in the control. Note that this may not generate
- EVT_TREE_DELETE_ITEM() events under some Windows versions although
+ @c EVT_TREE_DELETE_ITEM events under some Windows versions although
normally such event is generated for each removed item.
*/
virtual void DeleteAllItems();
/**
Starts editing the label of the given @a item. This function generates a
- EVT_TREE_BEGIN_LABEL_EDIT() event which can be vetoed so that no text
+ @c 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
+ text control without changes, a @c EVT_TREE_END_LABEL_EDIT event will be
sent which can be vetoed as well.
@see EndEditLabel(), wxTreeEvent
*/
- void EditLabel(const wxTreeItemId& item);
+ virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
+ wxClassInfo* textCtrlClass = wxCLASSINFO(wxTextCtrl));
+
+ /**
+ Enable or disable a beep if there is no match for the currently
+ entered text when searching for the item from keyboard.
+
+ The default is to not beep in this case except in wxMSW where the
+ beep is always generated by the native control and cannot be disabled,
+ i.e. calls to this function do nothing there.
+
+ @since 2.9.5
+ */
+ void EnableBellOnNoMatch(bool on = true);
/**
Ends label editing. If @a cancelEdit is @true, the edit will be
@see EditLabel()
*/
- void EndEditLabel(bool cancelEdit);
+ virtual void EndEditLabel(const wxTreeItemId& item, bool discardChanges = false);
/**
Scrolls and/or expands items to ensure that the given item is visible.
So, for example, the x coordinate may be negative if the tree has a
horizontal scrollbar and its position is not 0.
- @beginWxPythonOnly
- The wxPython version of this method requires only the @a item and @a
- textOnly parameters. The return value is either a wxRect object or @c
- None.
- @endWxPythonOnly
+ @beginWxPerlOnly
+ In wxPerl this method only takes the @a item and
+ @a textOnly parameters and returns a @c Wx::Rect (or @c undef).
+ @endWxPerlOnly
*/
virtual bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect,
bool textOnly = false) const;
returns the total number of descendants, otherwise only one level of
children is counted.
*/
- unsigned int GetChildrenCount(const wxTreeItemId& item,
- bool recursively = true) const;
+ virtual size_t GetChildrenCount(const wxTreeItemId& item,
+ bool recursively = true) const;
/**
Returns the number of items in the control.
Returns an invalid tree item (i.e. wxTreeItemId::IsOk() returns @false)
if there are no further children.
- @beginWxPythonOnly
- In wxPython the returned wxTreeItemId and the new cookie value are both
- returned as a tuple containing the two values.
- @endWxPythonOnly
+ @beginWxPerlOnly
+ In wxPerl this method only takes the @a item parameter, and
+ returns a 2-element list (item, cookie).
+ @endWxPerlOnly
@see GetNextChild(), GetNextSibling()
*/
*/
virtual wxTreeItemId GetFirstVisibleItem() const;
+ /**
+ Returns the item last clicked or otherwise selected.
+ Unlike GetSelection(), it can be used whether or not
+ the control has the @c wxTR_MULTIPLE style.
+
+ @since 2.9.1
+ */
+ virtual wxTreeItemId GetFocusedItem() const;
+
+
+ /**
+ Clears the currently focused item
+
+ @since 2.9.1
+ */
+ virtual void ClearFocusedItem();
+
+ /**
+ Sets the currently focused item.
+
+ @param item
+ The item to make the current one. It must be valid.
+ @since 2.9.1
+ */
+ virtual void SetFocusedItem(const wxTreeItemId& item);
+
+
/**
Returns the normal image list.
*/
/**
Returns the current tree control indentation.
*/
- int GetIndent() const;
+ virtual unsigned int GetIndent() const;
/**
Returns the background colour of the item.
@see wxTreeItemData
- @beginWxPythonOnly
- wxPython provides the following shortcut method:
- @li GetPyData(item): Returns the Python Object associated with the
- wxTreeItemData for the given item Id.
- @endWxPythonOnly
+ @beginWxPerlOnly
+ 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().
+ @endWxPerlOnly
*/
virtual wxTreeItemData* GetItemData(const wxTreeItemId& item) const;
/**
Returns the font of the item label.
+
+ If the font hadn't been explicitly set for the specified @a item with
+ SetItemFont(), returns an invalid ::wxNullFont font. GetFont() can be
+ used to retrieve the global tree control font used for the items
+ without any specific font.
*/
virtual wxFont GetItemFont(const wxTreeItemId& item) const;
*/
virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
- /**
- Gets the selected item image (this function is obsolete, use @ref
- GetItemImage() "GetItemImage"( @a item, ::wxTreeItemIcon_Selected)
- instead).
- */
- int GetItemSelectedImage(const wxTreeItemId& item) const;
-
/**
Gets the specified item state.
*/
Returns an invalid tree item if there are no further children.
- @beginWxPythonOnly
- In wxPython the returned wxTreeItemId and the new cookie value are both
- returned as a tuple containing the two values.
- @endWxPythonOnly
+ @beginWxPerlOnly
+ In wxPerl this method returns a 2-element list
+ (item, cookie) instead of modifying its parameters.
+ @endWxPerlOnly
@see GetFirstChild()
*/
/**
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.
+ use GetSelections() for the controls which do have this style
+ or, if a single item is wanted, use GetFocusedItem().
*/
virtual wxTreeItemId GetSelection() const;
Returns the number of selected items.
- @beginWxPythonOnly
- The wxPython version of this method accepts no parameters and returns a
- Python list of @ref wxTreeItemId "wxTreeItemId"s.
- @endWxPythonOnly
+ @beginWxPerlOnly
+ In wxPerl this method takes no parameters and returns a list of
+ @c Wx::TreeItemId.
+ @endWxPerlOnly
*/
- unsigned int GetSelections(wxArrayTreeItemIds& selection) const;
+ virtual size_t GetSelections(wxArrayTreeItemIds& selection) const;
/**
Returns the state image list (from which application-defined state
- @c wxTREE_HITTEST_NOWHERE: In the client area but below the last item.
- @c wxTREE_HITTEST_ONITEMBUTTON: On the button associated with an item.
- @c wxTREE_HITTEST_ONITEMICON: On the bitmap associated with an item.
- - @c wxTREE_HITTEST_ONITEMINDENT: In the indentation associated with an
- item.
- - @c wxTREE_HITTEST_ONITEMLABEL: On the label (string) associated with
- an item.
+ - @c wxTREE_HITTEST_ONITEMINDENT: In the indentation associated with an item.
+ - @c wxTREE_HITTEST_ONITEMLABEL: On the label (string) associated with an item.
- @c wxTREE_HITTEST_ONITEMRIGHT: In the area to the right of an item.
- @c wxTREE_HITTEST_ONITEMSTATEICON: On the state icon for a tree view
- item that is in a user-defined state.
+ item that is in a user-defined state.
- @c wxTREE_HITTEST_TOLEFT: To the right of the client area.
- @c wxTREE_HITTEST_TORIGHT: To the left of the client area.
- @beginWxPythonOnly
- In wxPython both the wxTreeItemId and the flags are returned as a tuple.
- @endWxPythonOnly
+ @beginWxPerlOnly
+ In wxPerl this method only takes the @a point parameter
+ and returns a 2-element list (item, flags).
+ @endWxPerlOnly
*/
wxTreeItemId HitTest(const wxPoint& point, int& flags) const;
/**
Inserts an item before one identified
- by its position (@a before). @a before must be less than the number of
- children.
+ by its position (@a pos). @a pos must be less than or equal to
+ the number of children.
The @a image and @a selImage parameters are an index within the normal
image list specifying the image to use for unselected and selected
items, respectively. If @a image -1 and @a selImage is -1, the same
image is used for both selected and unselected items.
-
- @beginWxPythonOnly
- In wxPython, this form of this method is called @c InsertItemBefore().
- @endWxPythonOnly
*/
wxTreeItemId InsertItem(const wxTreeItemId& parent,
- size_t before,
+ size_t pos,
const wxString& text,
int image = -1,
int selImage = -1,
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 control is empty (i.e.\ has no items, even no root
one).
*/
bool IsEmpty() const;
zero or positive value if the first item is less than, equal to or
greater than the second one.
- Please note that you @b must use wxRTTI macros DECLARE_DYNAMIC_CLASS()
- and IMPLEMENT_DYNAMIC_CLASS() if you override this function because
+ Please note that you @b must use wxRTTI macros wxDECLARE_DYNAMIC_CLASS()
+ and wxIMPLEMENT_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.
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.
+ 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.
+
+ Notice that calling this method will generate
+ @c wxEVT_TREE_SEL_CHANGING and @c wxEVT_TREE_SEL_CHANGED
+ events and that the change could be vetoed by the former event handler.
*/
virtual void SelectItem(const wxTreeItemId& item, bool select = true);
/**
Sets the indentation for the tree control.
*/
- void SetIndent(int indent);
+ virtual void SetIndent(unsigned int indent);
/**
Sets the colour of the item's background.
/**
Sets the item client data.
- @beginWxPythonOnly
- - @b SetPyData( @a item, @c obj): Associate the given Python Object with
- the wxTreeItemData for the given item Id.
- @endWxPythonOnly
+ Notice that the client data previously associated with the @a item (if
+ any) is @em not freed by this function and so calling this function
+ multiple times for the same item will result in memory leaks unless you
+ delete the old item data pointer yourself.
+ @beginWxPerlOnly
+ wxPerl provides the following shortcut method:
+ - SetPlData(item, data): sets the Perl data
+ associated with the @c Wx::TreeItemData. It is just the same as
+ tree->GetItemData(item)->SetData(data).
+ @endWxPerlOnly
*/
virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData* data);
virtual void SetItemImage(const wxTreeItemId& item, int image,
wxTreeItemIcon which = wxTreeItemIcon_Normal);
- /**
- Sets the selected item image (this function is obsolete, use @ref
- SetItemImage() "SetItemImage"( @a item, ::wxTreeItemIcon_Selected )
- instead).
- */
- void SetItemSelectedImage(const wxTreeItemId& item, int selImage);
-
/**
Sets the specified item state. The value of @a state may be:
- @c wxTREE_ITEMSTATE_NONE: to disable the item state (the state image will
Unselects the given item. This works in multiselection controls only.
*/
void UnselectItem(const wxTreeItemId& item);
+
+ /**
+ Select all the immediate children of the given parent.
+
+ This function can be used with multiselection controls only.
+
+ @since 2.9.1
+ */
+ virtual void SelectChildren(const wxTreeItemId& parent);
};
@beginEventTable{wxTreeEvent}
@event{EVT_TREE_BEGIN_DRAG(id, func)}
- Begin dragging with the left mouse button.
+ Begin dragging with the left mouse button. If you want to enable
+ left-dragging you need to intercept this event and explicitly call
+ wxTreeEvent::Allow(), as it's vetoed by default. Also notice that the
+ control must have an associated image list (see SetImageList()) to
+ drag its items under MSW.
@event{EVT_TREE_BEGIN_RDRAG(id, func)}
- Begin dragging with the right mouse button.
+ Begin dragging with the right mouse button. If you want to enable
+ right-dragging you need to intercept this event and explicitly call
+ wxTreeEvent::Allow(), as it's vetoed by default.
@event{EVT_TREE_END_DRAG(id, func)}
End dragging with the left or right mouse button.
@event{EVT_TREE_BEGIN_LABEL_EDIT(id, func)}
The state image has been clicked.
@endEventTable
- @library{wxbase}
+ @library{wxcore}
@category{events}
@see wxTreeCtrl
/**
Constructor, used by wxWidgets itself only.
*/
- wxTreeEvent(wxEventType commandType, wxTreeCtrl* tree);
+ wxTreeEvent(wxEventType commandType, wxTreeCtrl* tree,
+ const wxTreeItemId& item = wxTreeItemId());
/**
Returns the item (valid for all events).
int GetKeyCode() const;
/**
- Returns the key event for EVT_TREE_KEY_DOWN() events.
+ Returns the key event for @c EVT_TREE_KEY_DOWN events.
*/
- const wxKeyEvent GetKeyEvent() const;
+ const wxKeyEvent& GetKeyEvent() const;
/**
Returns the label if the event is a begin or end edit label event.
*/
- const wxString GetLabel() const;
+ const wxString& GetLabel() const;
/**
- Returns the old item index (valid for EVT_TREE_ITEM_CHANGING() and
- EVT_TREE_ITEM_CHANGED() events).
+ Returns the old item index (valid for @c EVT_TREE_ITEM_CHANGING and
+ @c EVT_TREE_ITEM_CHANGED events).
*/
wxTreeItemId GetOldItem() const;
/**
Returns @true if the label edit was cancelled. This should be called
- from within an EVT_TREE_END_LABEL_EDIT() handler.
+ from within an @c EVT_TREE_END_LABEL_EDIT handler.
*/
bool IsEditCancelled() const;
/**
- Set the tooltip for the item (valid for EVT_TREE_ITEM_GETTOOLTIP()
+ Set the tooltip for the item (valid for @c EVT_TREE_ITEM_GETTOOLTIP
events). Windows only.
*/
void SetToolTip(const wxString& tooltip);
};
+
+
+wxEventType wxEVT_TREE_BEGIN_DRAG;
+wxEventType wxEVT_TREE_BEGIN_RDRAG;
+wxEventType wxEVT_TREE_BEGIN_LABEL_EDIT;
+wxEventType wxEVT_TREE_END_LABEL_EDIT;
+wxEventType wxEVT_TREE_DELETE_ITEM;
+wxEventType wxEVT_TREE_GET_INFO;
+wxEventType wxEVT_TREE_SET_INFO;
+wxEventType wxEVT_TREE_ITEM_EXPANDED;
+wxEventType wxEVT_TREE_ITEM_EXPANDING;
+wxEventType wxEVT_TREE_ITEM_COLLAPSED;
+wxEventType wxEVT_TREE_ITEM_COLLAPSING;
+wxEventType wxEVT_TREE_SEL_CHANGED;
+wxEventType wxEVT_TREE_SEL_CHANGING;
+wxEventType wxEVT_TREE_KEY_DOWN;
+wxEventType wxEVT_TREE_ITEM_ACTIVATED;
+wxEventType wxEVT_TREE_ITEM_RIGHT_CLICK;
+wxEventType wxEVT_TREE_ITEM_MIDDLE_CLICK;
+wxEventType wxEVT_TREE_END_DRAG;
+wxEventType wxEVT_TREE_STATE_IMAGE_CLICK;
+wxEventType wxEVT_TREE_ITEM_GETTOOLTIP;
+wxEventType wxEVT_TREE_ITEM_MENU;
+
projects / wxWidgets.git / blobdiff