corrected comment

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

diff --git a/include/wx/treebase.h b/include/wx/treebase.h
index 74dfe8715758c687b45b5b3ca0ea15c37f924eb6..af9c822f9ee820a29ed501910554d6cbbcef3839 100644 (file)
--- a/include/wx/treebase.h
+++ b/include/wx/treebase.h
@@ -20,16 +20,16 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-// Not defined in setup.h so removing for now
-// #if wxUSE_TREECTRL
+#if wxUSE_TREECTRL

 
 

-#include "wx/control.h"
+#include "wx/window.h"  // for wxClientData

 #include "wx/event.h"
 
 // ----------------------------------------------------------------------------
 // wxTreeItemId identifies an element of the tree. In this implementation, it's
 #include "wx/event.h"
 
 // ----------------------------------------------------------------------------
 // wxTreeItemId identifies an element of the tree. In this implementation, it's

-// just a trivial wrapper around Win32 HTREEITEM. It's opaque for the
-// application.
+// just a trivial wrapper around Win32 HTREEITEM or a pointer to some private
+// data structure in the generic version. It's opaque for the application and
+// the only method which can be used by user code is IsOk().

 // ----------------------------------------------------------------------------
 
 // Using this typedef removes an ambiguity when calling Remove()
 // ----------------------------------------------------------------------------
 
 // Using this typedef removes an ambiguity when calling Remove()


@@ -37,14 +37,17 @@ typedef unsigned long wxTreeItemIdValue;
 
 class WXDLLEXPORT wxTreeItemId
 {
 
 class WXDLLEXPORT wxTreeItemId
 {

-friend class WXDLLEXPORT wxTreeCtrl;
-friend class WXDLLEXPORT wxGenericTreeCtrl;
-friend class WXDLLEXPORT wxTreeEvent;

 public:
     // ctors
         // 0 is invalid value for HTREEITEM
     wxTreeItemId() { m_pItem = 0; }
 
 public:
     // ctors
         // 0 is invalid value for HTREEITEM
     wxTreeItemId() { m_pItem = 0; }
 

+        // this one is used in the generic version
+    wxTreeItemId(void *pItem) { m_pItem = (long) pItem; }
+
+        // and this one under MSW
+    wxTreeItemId(long lItem) { m_pItem = lItem; }
+

         // default copy ctor/assignment operator are ok for us
 
     // accessors
         // default copy ctor/assignment operator are ok for us
 
     // accessors


@@ -52,14 +55,8 @@ public:
     bool IsOk() const { return m_pItem != 0; }
 
     // deprecated: only for compatibility
     bool IsOk() const { return m_pItem != 0; }
 
     // deprecated: only for compatibility

-    wxTreeItemId(long itemId) { m_pItem = itemId; }
-    //operator long() const { return m_pItem; }

     operator wxTreeItemIdValue() const { return m_pItem; }
 
     operator wxTreeItemIdValue() const { return m_pItem; }
 

-    void operator=(long item) { m_pItem = item; }
-
-    wxTreeItemId(void *pItem) { m_pItem = (long) pItem; }
-

     wxTreeItemIdValue m_pItem;
 };
 
     wxTreeItemIdValue m_pItem;
 };
 


@@ -113,6 +110,40 @@ enum wxTreeItemIcon
     wxTreeItemIcon_Max
 };
 
     wxTreeItemIcon_Max
 };
 

+enum wxButtonImage              // effectively the same as wxTreeItemIcon
+{
+    wxCLOSED_BUTTON = 0,                // closed, not selected
+    wxCLOSED_BUTTON_SELECTED,           // closed,     selected
+    wxOPEN_BUTTON,                      // open,   not selected
+    wxOPEN_BUTTON_SELECTED              // open,       selected
+};
+
+/*
+ * wxTreeCtrl flags
+ */
+// TODO: maybe renumber these?
+#define wxTR_NO_BUTTONS      0x0000     // for convenience
+#define wxTR_HAS_BUTTONS     0x0004     // generates a +/- button
+#define wxTR_TWIST_BUTTONS   0x0008     // twister buttons
+#define wxTR_NO_LINES        0x0100     // don't generate level connectors
+#define wxTR_MAC_BUTTONS     wxTR_TWIST_BUTTONS  // backward compatibility
+
+#define wxTR_SINGLE          0x0000     // for convenience
+#define wxTR_MULTIPLE        0x0020     // can select multiple items
+#define wxTR_EXTENDED        0x0040     // TODO: allow extended selection
+
+#define wxTR_EDIT_LABELS     0x0200     // can edit item labels
+#define wxTR_LINES_AT_ROOT   0x0010     // specific to wxMSW
+#define wxTR_HIDE_ROOT       0x0800     // don't display root node
+#define wxTR_ROW_LINES       0x0400     // put border around items
+#define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080 // what it says
+
+// TODO: different default styles for wxGTK, wxMotif, whatever?
+#ifdef __WXMAC__
+    #define wxTR_DEFAULT_STYLE (wxTR_TWIST_BUTTONS|wxTR_NO_LINES|wxTR_ROW_LINES)
+#else
+    #define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS|wxTR_LINES_AT_ROOT)
+#endif

 
 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
 // where exactly the specified point is situated:
 
 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
 // where exactly the specified point is situated:


@@ -146,7 +177,7 @@ static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
                                           wxTREE_HITTEST_ONITEMLABEL;
 
 // tree ctrl default name
                                           wxTREE_HITTEST_ONITEMLABEL;
 
 // tree ctrl default name

-WXDLLEXPORT_DATA(extern const char*) wxTreeCtrlNameStr;
+WXDLLEXPORT_DATA(extern const wxChar*) wxTreeCtrlNameStr;

 
 // ----------------------------------------------------------------------------
 // wxTreeItemAttr: a structure containing the visual attributes of an item
 
 // ----------------------------------------------------------------------------
 // wxTreeItemAttr: a structure containing the visual attributes of an item


@@ -191,9 +222,6 @@ private:
 
 class WXDLLEXPORT wxTreeEvent : public wxNotifyEvent
 {
 
 class WXDLLEXPORT wxTreeEvent : public wxNotifyEvent
 {

-    friend class WXDLLEXPORT wxTreeCtrl;
-    friend class WXDLLEXPORT wxGenericTreeCtrl;
-

 public:
     wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 
 public:
     wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 


@@ -210,21 +238,25 @@ public:
         // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only) or click position
     wxPoint GetPoint() const { return m_pointDrag; }
 
         // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only) or click position
     wxPoint GetPoint() const { return m_pointDrag; }
 

-        // keyboard code (for wxEVT_COMMAND_TREE_KEY_DOWN only)
-    int GetCode() const { return m_code; }
+        // keyboard data (for wxEVT_COMMAND_TREE_KEY_DOWN only)
+    const wxKeyEvent& GetKeyEvent() const { return m_evtKey; }
+    int GetCode() const { return m_evtKey.GetKeyCode(); }

 
         // label (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
     const wxString& GetLabel() const { return m_label; }
 
 private:
 
         // label (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
     const wxString& GetLabel() const { return m_label; }
 
 private:

-    // we could probably save some space by using union here
-    int           m_code;
+    // not all of the members are used (or initialized) for all events
+    wxKeyEvent    m_evtKey;

     wxTreeItemId  m_item,
                   m_itemOld;
     wxPoint       m_pointDrag;
     wxString      m_label;
 
     wxTreeItemId  m_item,
                   m_itemOld;
     wxPoint       m_pointDrag;
     wxString      m_label;
 

-    DECLARE_DYNAMIC_CLASS(wxTreeEvent)
+    friend class WXDLLEXPORT wxTreeCtrl;
+    friend class WXDLLEXPORT wxGenericTreeCtrl;
+
+    DECLARE_DYNAMIC_CLASS(wxTreeEvent);

 };
 
 typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
 };
 
 typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);


@@ -304,9 +336,7 @@ END_DECLARE_EVENT_TYPES()
 #define EVT_TREE_ITEM_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
 #define EVT_TREE_ITEM_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
 
 #define EVT_TREE_ITEM_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
 #define EVT_TREE_ITEM_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
 

-// #endif // wxUSE_TREECTRL
-
-#endif
-    // _WX_TREEBASE_H_
+#endif // wxUSE_TREECTRL

 
 

+#endif // _WX_TREEBASE_H_