From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sun, 5 Apr 2009 13:07:24 +0000 (+0000)
Subject: improve wxTreeItemData documentation (closes #10662)
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/727539d8bba443aace946ac3a414127dbfa8a730

improve wxTreeItemData documentation (closes #10662)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@60031 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wx/treebase.h b/interface/wx/treebase.h
index 4961f66781..e9eaf7da5d 100644
--- a/interface/wx/treebase.h
+++ b/interface/wx/treebase.h
@@ -92,6 +92,12 @@ public:
 
     /**
         Sets the item associated with this node.
+
+        Notice that this function is automatically called by wxTreeCtrl methods
+        associating an object of this class with a tree control item such as
+        wxTreeCtrl::AppendItem(), wxTreeCtrl::InsertItem() and
+        wxTreeCtrl::SetItemData() so there is usually no need to call it
+        yourself.
     */
     void SetId(const wxTreeItemId& id);
 };
diff --git a/interface/wx/treectrl.h b/interface/wx/treectrl.h
index 9e43955598..d4da034876 100644
--- a/interface/wx/treectrl.h
+++ b/interface/wx/treectrl.h
@@ -774,6 +774,11 @@ public:
     /**
         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.