X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b19b28c8fca9815949753ed0c68097efe8943b18..7344108e8a129a3f9b4df5ab0f98a1713db03b89:/interface/wx/treectrl.h?ds=inline diff --git a/interface/wx/treectrl.h b/interface/wx/treectrl.h index 55b34394ae..8327401803 100644 --- a/interface/wx/treectrl.h +++ b/interface/wx/treectrl.h @@ -3,7 +3,7 @@ // Purpose: interface of wxTreeItemData // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -15,7 +15,7 @@ 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 @@ -29,6 +29,14 @@ 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} @@ -64,52 +72,74 @@ @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 explicitely call wxTreeEvent::Allow(), as it's vetoed by default. + and explicitly call wxTreeEvent::Allow(), as it's vetoed by default. + Processes a @c wxEVT_COMMAND_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 explicitely call wxTreeEvent::Allow(), as it's vetoed by default. + and explicitly call wxTreeEvent::Allow(), as it's vetoed by default. + Processes a @c wxEVT_COMMAND_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_COMMAND_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_COMMAND_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_COMMAND_TREE_END_LABEL_EDIT event type. @event{EVT_TREE_DELETE_ITEM(id, func)} An item was deleted. + Processes a @c wxEVT_COMMAND_TREE_DELETE_ITEM event type. @event{EVT_TREE_GET_INFO(id, func)} Request information from the application. + Processes a @c wxEVT_COMMAND_TREE_GET_INFO event type. @event{EVT_TREE_SET_INFO(id, func)} Information is being supplied. + Processes a @c wxEVT_COMMAND_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. + Processes a @c wxEVT_COMMAND_TREE_ITEM_ACTIVATED event type. @event{EVT_TREE_ITEM_COLLAPSED(id, func)} The item has been collapsed. + Processes a @c wxEVT_COMMAND_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_COMMAND_TREE_ITEM_COLLAPSING event type. @event{EVT_TREE_ITEM_EXPANDED(id, func)} The item has been expanded. + Processes a @c wxEVT_COMMAND_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_COMMAND_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_COMMAND_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_COMMAND_TREE_ITEM_MIDDLE_CLICK event type. @event{EVT_TREE_SEL_CHANGED(id, func)} Selection has changed. + Processes a @c wxEVT_COMMAND_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_COMMAND_TREE_SEL_CHANGING event type. @event{EVT_TREE_KEY_DOWN(id, func)} A key has been pressed. + Processes a @c wxEVT_COMMAND_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. + Processes a @c wxEVT_COMMAND_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. + Processes a @c wxEVT_COMMAND_TREE_ITEM_MENU event type. @event{EVT_TREE_STATE_IMAGE_CLICK(id, func)} The state image has been clicked. Windows only. + Processes a @c wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK event type. @endEventTable @@ -353,12 +383,6 @@ public: 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). @@ -408,11 +432,6 @@ public: 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). @@ -475,12 +494,6 @@ public: @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 @@ -548,11 +561,6 @@ public: 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. @@ -627,11 +635,6 @@ public: 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. @@ -663,10 +666,6 @@ public: - @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). @@ -699,10 +698,6 @@ public: 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, @@ -782,9 +777,14 @@ public: 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_COMMAND_TREE_SEL_CHANGING and @c wxEVT_COMMAND_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); @@ -840,11 +840,6 @@ public: multiple times for the same item will result in memory leaks unless you delete the old item data pointer yourself. - @beginWxPythonOnly - - @b SetPyData( @a item, @c obj): Associate the given Python Object with - the wxTreeItemData for the given item Id. - @endWxPythonOnly - @beginWxPerlOnly wxPerl provides the following shortcut method: - SetPlData(item, data): sets the Perl data @@ -997,13 +992,13 @@ public: @beginEventTable{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 explicitely call + 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. If you want to enable - right-dragging you need to intercept this event and explicitely call + 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. @@ -1111,3 +1106,27 @@ public: */ void SetToolTip(const wxString& tooltip); }; + + +wxEventType wxEVT_COMMAND_TREE_BEGIN_DRAG; +wxEventType wxEVT_COMMAND_TREE_BEGIN_RDRAG; +wxEventType wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT; +wxEventType wxEVT_COMMAND_TREE_END_LABEL_EDIT; +wxEventType wxEVT_COMMAND_TREE_DELETE_ITEM; +wxEventType wxEVT_COMMAND_TREE_GET_INFO; +wxEventType wxEVT_COMMAND_TREE_SET_INFO; +wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDED; +wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDING; +wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSED; +wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSING; +wxEventType wxEVT_COMMAND_TREE_SEL_CHANGED; +wxEventType wxEVT_COMMAND_TREE_SEL_CHANGING; +wxEventType wxEVT_COMMAND_TREE_KEY_DOWN; +wxEventType wxEVT_COMMAND_TREE_ITEM_ACTIVATED; +wxEventType wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK; +wxEventType wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK; +wxEventType wxEVT_COMMAND_TREE_END_DRAG; +wxEventType wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK; +wxEventType wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP; +wxEventType wxEVT_COMMAND_TREE_ITEM_MENU; +