added UMAHideControl again

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

diff --git a/include/wx/treebase.h b/include/wx/treebase.h
index ed6d9236b99f68332f2199a08ce8bad719c2dc2b..7a78957235b1c69d0cc1a59a343405e6222abe9e 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,34 @@ enum wxTreeItemIcon
     wxTreeItemIcon_Max
 };
 
     wxTreeItemIcon_Max
 };
 

+/*
+ * wxTreeCtrl flags
+ */
+// TODO: maybe renumber these?
+#define wxTR_NO_BUTTONS              0x0000     // for convenience
+#define wxTR_HAS_BUTTONS             0x0001     // generates a +/- button
+#define wxTR_TWIST_BUTTONS           0x0002     // generates a twister button
+#define wxTR_NO_LINES                0x0004     // don't generate level connectors
+#define wxTR_LINES_AT_ROOT           0x0008     // connect top-level nodes
+#define wxTR_MAC_BUTTONS             wxTR_TWIST_BUTTONS // backward compatibility
+#define wxTR_AQUA_BUTTONS            0x0010     // used internally
+
+#define wxTR_SINGLE                  0x0000     // for convenience
+#define wxTR_MULTIPLE                0x0020     // can select multiple items
+#define wxTR_EXTENDED                0x0040     // TODO: allow extended selection
+#define wxTR_FULL_ROW_HIGHLIGHT      0x2000     // highlight full horizontal space
+
+#define wxTR_EDIT_LABELS             0x0200     // can edit item labels
+#define wxTR_ROW_LINES               0x0400     // put border around items
+#define wxTR_HIDE_ROOT               0x0800     // don't display root node
+#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 +171,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 +216,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,82 +232,105 @@ 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&);
 
 // ----------------------------------------------------------------------------

-// macros for handling tree control events
+// tree control events and macros for handling them

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

+BEGIN_DECLARE_EVENT_TYPES()
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_DRAG, 600)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_RDRAG, 601)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, 602)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_LABEL_EDIT, 603)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_DELETE_ITEM, 604)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_GET_INFO, 605)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SET_INFO, 606)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDED, 607)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDING, 608)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSED, 609)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSING, 610)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGED, 611)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGING, 612)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_KEY_DOWN, 613)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_ACTIVATED, 614)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, 615)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, 616)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_DRAG, 617)
+END_DECLARE_EVENT_TYPES()
+

 // GetItem() returns the item being dragged, GetPoint() the mouse coords
 //
 // if you call event.Allow(), the drag operation will start and a
 // EVT_TREE_END_DRAG event will be sent when the drag is over.
 // GetItem() returns the item being dragged, GetPoint() the mouse coords
 //
 // if you call event.Allow(), the drag operation will start and a
 // EVT_TREE_END_DRAG event will be sent when the drag is over.

-#define EVT_TREE_BEGIN_DRAG(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
-#define EVT_TREE_BEGIN_RDRAG(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_TREE_BEGIN_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_TREE_BEGIN_RDRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),

 
 // GetItem() is the item on which the drop occured (if any) and GetPoint() the
 // current mouse coords
 
 // GetItem() is the item on which the drop occured (if any) and GetPoint() the
 // current mouse coords

-#define EVT_TREE_END_DRAG(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_END_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_TREE_END_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_END_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),

 
 // GetItem() returns the itme whose label is being edited, GetLabel() returns
 // the current item label for BEGIN and the would be new one for END.
 //
 // Vetoing BEGIN event means that label editing won't happen at all,
 // vetoing END means that the new value is discarded and the old one kept
 
 // GetItem() returns the itme whose label is being edited, GetLabel() returns
 // the current item label for BEGIN and the would be new one for END.
 //
 // Vetoing BEGIN event means that label editing won't happen at all,
 // vetoing END means that the new value is discarded and the old one kept

-#define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
-#define EVT_TREE_END_LABEL_EDIT(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_TREE_END_LABEL_EDIT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),

 
 // provide/update information about GetItem() item
 
 // provide/update information about GetItem() item

-#define EVT_TREE_GET_INFO(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
-#define EVT_TREE_SET_INFO(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_TREE_GET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_TREE_SET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),

 
 // GetItem() is the item being expanded/collapsed, the "ING" versions can use
 
 // GetItem() is the item being expanded/collapsed, the "ING" versions can use

-#define EVT_TREE_ITEM_EXPANDED(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
-#define EVT_TREE_ITEM_EXPANDING(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
-#define EVT_TREE_ITEM_COLLAPSED(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
-#define EVT_TREE_ITEM_COLLAPSING(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
+#define EVT_TREE_ITEM_EXPANDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_TREE_ITEM_EXPANDING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_TREE_ITEM_COLLAPSED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_TREE_ITEM_COLLAPSING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),

 
 // GetOldItem() is the item which had the selection previously, GetItem() is
 // the item which acquires selection
 
 // GetOldItem() is the item which had the selection previously, GetItem() is
 // the item which acquires selection

-#define EVT_TREE_SEL_CHANGED(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
-#define EVT_TREE_SEL_CHANGING(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
+#define EVT_TREE_SEL_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
+#define EVT_TREE_SEL_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),

 
 // GetCode() returns the key code
 // NB: this is the only message for which GetItem() is invalid (you may get the
 //     item from GetSelection())
 
 // GetCode() returns the key code
 // NB: this is the only message for which GetItem() is invalid (you may get the
 //     item from GetSelection())

-#define EVT_TREE_KEY_DOWN(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
+#define EVT_TREE_KEY_DOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),

 
 // GetItem() returns the item being deleted, the associated data (if any) will
 // be deleted just after the return of this event handler (if any)
 
 // GetItem() returns the item being deleted, the associated data (if any) will
 // be deleted just after the return of this event handler (if any)

-#define EVT_TREE_DELETE_ITEM(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_TREE_DELETE_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),

 
 // GetItem() returns the item that was activated (double click, enter, space)
 
 // GetItem() returns the item that was activated (double click, enter, space)

-#define EVT_TREE_ITEM_ACTIVATED(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
+#define EVT_TREE_ITEM_ACTIVATED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),

 
 // GetItem() returns the item that was clicked on
 
 // GetItem() returns the item that was clicked on

-#define EVT_TREE_ITEM_RIGHT_CLICK(id, fn) wxEventTableEntry( wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
-#define EVT_TREE_ITEM_MIDDLE_CLICK(id, fn) wxEventTableEntry( 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_