Fix wxAboutDialogInfo::GetName() return type in the documentation.

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

diff --git a/interface/wx/treebase.h b/interface/wx/treebase.h
index 84ffd78598027b862e1c26260ffd45f82475f588..2b51f90fa750b978ec02a6a1afb36a34c4ff16f7 100644 (file)
--- a/interface/wx/treebase.h
+++ b/interface/wx/treebase.h
@@ -3,17 +3,16 @@
 // Purpose:     interface of wxTreeItemId
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxTreeItemId
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

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

 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxTreeItemId
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxTreeItemId

-    @wxheader{treebase.h}

 
     An opaque reference to a tree item.
 
     @library{wxcore}
 
     An opaque reference to a tree item.
 
     @library{wxcore}

-    @category{misc}
+    @category{data}

 
     @see wxTreeCtrl, wxTreeItemData, @ref overview_treectrl
 */
 
     @see wxTreeCtrl, wxTreeItemData, @ref overview_treectrl
 */


@@ -48,7 +47,6 @@ public:
 
 /**
     @class wxTreeItemData
 
 /**
     @class wxTreeItemData

-    @wxheader{treebase.h}

 
     wxTreeItemData is some (arbitrary) user class associated with some item. The
     main advantage of having this class is that wxTreeItemData objects are
 
     wxTreeItemData is some (arbitrary) user class associated with some item. The
     main advantage of having this class is that wxTreeItemData objects are


@@ -79,28 +77,41 @@ public:
         - GetData(): Returns a reference to the Python Object.
         - SetData(obj): Associates a new Python Object with the wxTreeItemData.
         @endWxPythonOnly
         - GetData(): Returns a reference to the Python Object.
         - SetData(obj): Associates a new Python Object with the wxTreeItemData.
         @endWxPythonOnly

+
+        @beginWxPerlOnly
+        In wxPerl the constructor accepts a scalar as an optional parameter
+        and stores it as client data; use
+        - GetData() to retrieve the value.
+        - SetData(data) to set it.
+        @endWxPerlOnly

     */
     wxTreeItemData();
 
     /**
         Virtual destructor.
     */
     */
     wxTreeItemData();
 
     /**
         Virtual destructor.
     */

-    ~wxTreeItemData();
+    virtual ~wxTreeItemData();

 
     /**
         Returns the item associated with this node.
     */
 
     /**
         Returns the item associated with this node.
     */

-    const wxTreeItemId GetId();
+    const wxTreeItemId& GetId() const;

 
     /**
         Sets the item associated with this node.
 
     /**
         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.
     */
     void SetId(const wxTreeItemId& id);
 };
 
 /**
     Indicates which type to associate an image with a wxTreeCtrl item.

-    
+

     @see wxTreeCtrl::GetItemImage(), wxTreeCtrl::SetItemImage()
 */
 enum wxTreeItemIcon
     @see wxTreeCtrl::GetItemImage(), wxTreeCtrl::SetItemImage()
 */
 enum wxTreeItemIcon