Don't send event from wxMSW::wxListCtrl::DeleteAllItems() if it did nothing.

[wxWidgets.git] / interface / wx / treectrl.h

diff --git a/interface/wx/treectrl.h b/interface/wx/treectrl.h
index 3a38670fcf9d061d15d45d759117a39cbcd08987..e152cca20876957b49bdb9ce116bbc7f41bacbd9 100644 (file)
--- a/interface/wx/treectrl.h
+++ b/interface/wx/treectrl.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxTreeItemData
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxTreeItemData
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 


@@ -60,11 +60,15 @@
         for a particular toolkit.
     @endStyleTable
 
         for a particular toolkit.
     @endStyleTable
 

-    @beginEventTable{wxTreeEvent}
+    @beginEventEmissionTable{wxTreeEvent}

     @event{EVT_TREE_BEGIN_DRAG(id, func)}
           Begin dragging with the left mouse button.
     @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.

     @event{EVT_TREE_BEGIN_RDRAG(id, func)}
           Begin dragging with the right mouse button.
     @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.

     @event{EVT_TREE_END_DRAG(id, func)}
           End dragging with the left or right mouse button.
     @event{EVT_TREE_BEGIN_LABEL_EDIT(id, func)}
     @event{EVT_TREE_END_DRAG(id, func)}
           End dragging with the left or right mouse button.
     @event{EVT_TREE_BEGIN_LABEL_EDIT(id, func)}


@@ -78,7 +82,8 @@
     @event{EVT_TREE_SET_INFO(id, func)}
           Information is being supplied.
     @event{EVT_TREE_ITEM_ACTIVATED(id, func)}
     @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.
+          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)}
     @event{EVT_TREE_ITEM_COLLAPSED(id, func)}
           The item has been collapsed.
     @event{EVT_TREE_ITEM_COLLAPSING(id, func)}


@@ -98,9 +103,11 @@
     @event{EVT_TREE_KEY_DOWN(id, func)}
           A key has been pressed.
     @event{EVT_TREE_ITEM_GETTOOLTIP(id, func)}
     @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.
+          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)}
     @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.

     @event{EVT_TREE_STATE_IMAGE_CLICK(id, func)}
           The state image has been clicked. Windows only.
     @endEventTable
     @event{EVT_TREE_STATE_IMAGE_CLICK(id, func)}
           The state image has been clicked. Windows only.
     @endEventTable


@@ -123,8 +130,8 @@
     @category{ctrl}
     @appearance{treectrl.png}
 
     @category{ctrl}
     @appearance{treectrl.png}
 

-    @see wxDataViewTreeCtrl, wxTreeEvent, wxTreeItemData, @ref overview_treectrl, wxListBox,
-         wxListCtrl, wxImageList
+    @see wxDataViewTreeCtrl, wxTreeEvent, wxTreeItemData, @ref overview_treectrl,
+         wxListBox, wxListCtrl, wxImageList

 */
 class wxTreeCtrl : public wxControl
 {
 */
 class wxTreeCtrl : public wxControl
 {


@@ -143,9 +150,10 @@ public:
             Window identifier. The value @c wxID_ANY indicates a default value.
         @param pos
             Window position.
             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
         @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
         @param style
             Window style. See wxTreeCtrl.
         @param validator


@@ -155,12 +163,12 @@ public:
 
         @see Create(), wxValidator
     */
 
         @see Create(), wxValidator
     */

-    wxTreeCtrl(wxWindow* parent, wxWindowID id,
+    wxTreeCtrl(wxWindow* parent, wxWindowID id = wxID_ANY,

                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,

-               long style = wxTR_HAS_BUTTONS,
+               long style = wxTR_DEFAULT_STYLE,

                const wxValidator& validator = wxDefaultValidator,
                const wxValidator& validator = wxDefaultValidator,

-               const wxString& name = "treeCtrl");
+               const wxString& name = wxTreeCtrlNameStr);

 
 
     /**
 
 
     /**


@@ -253,18 +261,18 @@ public:
     virtual void CollapseAndReset(const wxTreeItemId& item);
 
     /**
     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,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,

-                long style = wxTR_HAS_BUTTONS,
+                long style = wxTR_DEFAULT_STYLE,

                 const wxValidator& validator = wxDefaultValidator,
                 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.
         generated.
 
         This function may cause a subsequent call to GetNextChild() to fail.


@@ -273,7 +281,7 @@ public:
 
     /**
         Deletes all items in the control. Note that this may not generate
 
     /**
         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();
         normally such event is generated for each removed item.
     */
     virtual void DeleteAllItems();


@@ -289,16 +297,17 @@ public:
 
     /**
         Starts editing the label of the given @a item. This function generates a
 
     /**
         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
         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
     */
         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));

 
     /**
         Ends label editing. If @a cancelEdit is @true, the edit will be
 
     /**
         Ends label editing. If @a cancelEdit is @true, the edit will be


@@ -309,7 +318,7 @@ public:
 
         @see EditLabel()
     */
 
         @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.
 
     /**
         Scrolls and/or expands items to ensure that the given item is visible.


@@ -349,6 +358,11 @@ public:
         textOnly parameters. The return value is either a wxRect object or @c
         None.
         @endWxPythonOnly
         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;
     */
     virtual bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect,
                                  bool textOnly = false) const;


@@ -366,8 +380,8 @@ public:
         returns the total number of descendants, otherwise only one level of
         children is counted.
     */
         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 the number of items in the control.


@@ -399,6 +413,11 @@ public:
         returned as a tuple containing the two values.
         @endWxPythonOnly
 
         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 GetFirstChild(const wxTreeItemId& item,
         @see GetNextChild(), GetNextSibling()
     */
     virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,


@@ -409,6 +428,33 @@ public:
     */
     virtual wxTreeItemId GetFirstVisibleItem() const;
 
     */
     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 normal image list.
     */


@@ -417,7 +463,7 @@ public:
     /**
         Returns the current tree control indentation.
     */
     /**
         Returns the current tree control indentation.
     */

-    int GetIndent() const;
+    virtual unsigned int GetIndent() const;

 
     /**
         Returns the background colour of the item.
 
     /**
         Returns the background colour of the item.


@@ -434,6 +480,13 @@ public:
         @li GetPyData(item): Returns the Python Object associated with the
             wxTreeItemData for the given item Id.
         @endWxPythonOnly
         @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;
 
     */
     virtual wxTreeItemData* GetItemData(const wxTreeItemId& item) const;
 


@@ -462,13 +515,6 @@ public:
     */
     virtual wxTreeItemId GetItemParent(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.
     */
     /**
         Gets the specified item state.
     */


@@ -507,6 +553,11 @@ public:
         returned as a tuple containing the two values.
         @endWxPythonOnly
 
         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()
     */
     virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,
         @see GetFirstChild()
     */
     virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,


@@ -564,7 +615,8 @@ public:
     /**
         Returns the selection, or an invalid item if there is no selection. This
         function only works with the controls without @c wxTR_MULTIPLE style,
     /**
         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;
 
     */
     virtual wxTreeItemId GetSelection() const;
 


@@ -579,8 +631,13 @@ public:
         The wxPython version of this method accepts no parameters and returns a
         Python list of @ref wxTreeItemId "wxTreeItemId"s.
         @endWxPythonOnly
         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
 
     /**
         Returns the state image list (from which application-defined state


@@ -598,19 +655,22 @@ public:
         - @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_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
         - @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
         - @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;
 
     */
     wxTreeItemId HitTest(const wxPoint& point, int& flags) const;
 


@@ -691,8 +751,8 @@ public:
         zero or positive value if the first item is less than, equal to or
         greater than the second one.
 
         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.
         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.


@@ -756,7 +816,7 @@ public:
     /**
         Sets the indentation for the tree control.
     */
     /**
         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 colour of the item's background.


@@ -775,11 +835,22 @@ public:
     /**
         Sets the item client data.
 
     /**
         Sets the item client data.
 

+        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.
+

         @beginWxPythonOnly
         - @b SetPyData( @a item, @c obj): Associate the given Python Object with
             the wxTreeItemData for the given item Id.
         @endWxPythonOnly
 
         @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
+          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 SetItemData(const wxTreeItemId& item, wxTreeItemData* data);
 


@@ -818,13 +889,6 @@ public:
     virtual void SetItemImage(const wxTreeItemId& item, int image,
                               wxTreeItemIcon which = wxTreeItemIcon_Normal);
 
     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
     /**
         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


@@ -908,6 +972,15 @@ public:
         Unselects the given item. This works in multiselection controls only.
     */
     void UnselectItem(const wxTreeItemId& item);
         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);

 };
 
 
 };
 
 


@@ -923,9 +996,15 @@ public:
 
     @beginEventTable{wxTreeEvent}
     @event{EVT_TREE_BEGIN_DRAG(id, func)}
 
     @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 explicitely 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)}
     @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 explicitely 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)}
     @event{EVT_TREE_END_DRAG(id, func)}
         End dragging with the left or right mouse button.
     @event{EVT_TREE_BEGIN_LABEL_EDIT(id, func)}


@@ -980,7 +1059,8 @@ public:
     /**
         Constructor, used by wxWidgets itself only.
     */
     /**
         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).
 
     /**
         Returns the item (valid for all events).


@@ -994,18 +1074,18 @@ public:
     int GetKeyCode() const;
 
     /**
     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.
     */
 
     /**
         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;
 
     */
     wxTreeItemId GetOldItem() const;
 


@@ -1021,12 +1101,12 @@ public:
 
     /**
         Returns @true if the label edit was cancelled. This should be called
 
     /**
         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;
 
     /**
     */
     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);
         events). Windows only.
     */
     void SetToolTip(const wxString& tooltip);