added interface headers with latest discussed changes

[wxWidgets.git] / interface / treebase.h

diff --git a/interface/treebase.h b/interface/treebase.h
new file mode 100644 (file)
index 0000000..02618e8
--- /dev/null
+++ b/interface/treebase.h
@@ -0,0 +1,45 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        treebase.h
+// Purpose:     documentation for wxTreeItemId class
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @class wxTreeItemId
+    @wxheader{treebase.h}
+    
+    An opaque reference to a tree item.
+    
+    @library{wxcore}
+    @category{FIXME}
+    
+    @seealso
+    wxTreeCtrl, wxTreeItemData, @ref overview_wxtreectrloverview "wxTreeCtrl
+    overview"
+*/
+class wxTreeItemId 
+{
+public:
+    /**
+        Default constructor. wxTreemItemIds are not meant to be constructed explicitly
+        by
+        the user; they are returned by the wxTreeCtrl functions instead.
+    */
+    wxTreeItemId();
+
+    /**
+        Returns @true if this instance is referencing a valid tree item.
+    */
+#define bool IsOk()     /* implementation is private */
+
+    //@{
+    /**
+        Operators for comparison between wxTreeItemId objects.
+    */
+    void operator !();
+        bool operator ==(const wxTreeItemId& item);
+        bool operator !=(const wxTreeItemId& item);
+    //@}
+};