Merged GSOC Ribbon work from SOC2009_RIBBON branch into trunk.

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

diff --git a/interface/wx/treebase.h b/interface/wx/treebase.h
index e1122c9c293e98ffa862ae2ac40f093a3b3dcf46..e9eaf7da5d6bef9d45db4980749828dcb576f79f 100644 (file)
--- a/interface/wx/treebase.h
+++ b/interface/wx/treebase.h
@@ -12,7 +12,7 @@
     An opaque reference to a tree item.
 
     @library{wxcore}
-    @category{misc}
+    @category{data}
 
     @see wxTreeCtrl, wxTreeItemData, @ref overview_treectrl
 */
@@ -83,22 +83,28 @@ public:
     /**
         Virtual destructor.
     */
-    ~wxTreeItemData();
+    virtual ~wxTreeItemData();
 
     /**
         Returns the item associated with this node.
     */
-    const wxTreeItemId GetId();
+    const wxTreeItemId& GetId() const;
 
     /**
         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);
 };
 
 /**
     Indicates which type to associate an image with a wxTreeCtrl item.
-    
+
     @see wxTreeCtrl::GetItemImage(), wxTreeCtrl::SetItemImage()
 */
 enum wxTreeItemIcon