Unselect all wxDataViewCtrl items when clicking outside of the item area.

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

diff --git a/include/wx/treebase.h b/include/wx/treebase.h
index 51c4249027979916bc2bd6a5ab18ceda3b42064b..4a6063c2f680d0d4d33409b1aafd6db42dd0d5a8 100644 (file)
--- a/include/wx/treebase.h
+++ b/include/wx/treebase.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        treebase.h
+// Name:        wx/treebase.h

 // Purpose:     wxTreeCtrl base classes and types
 // Author:      Julian Smart et al
 // Modified by:
 // Purpose:     wxTreeCtrl base classes and types
 // Author:      Julian Smart et al
 // Modified by:


@@ -12,73 +12,45 @@
 #ifndef _WX_TREEBASE_H_
 #define _WX_TREEBASE_H_
 
 #ifndef _WX_TREEBASE_H_
 #define _WX_TREEBASE_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "treebase.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 

+#include "wx/defs.h"
+

 #if wxUSE_TREECTRL
 
 #include "wx/window.h"  // for wxClientData
 #include "wx/event.h"
 #include "wx/dynarray.h"
 #if wxUSE_TREECTRL
 
 #include "wx/window.h"  // for wxClientData
 #include "wx/event.h"
 #include "wx/dynarray.h"

+#include "wx/itemid.h"

 
 

-// ----------------------------------------------------------------------------
-// wxTreeItemId identifies an element of the tree. In this implementation, it's
-// 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()
-typedef void *wxTreeItemIdValue;
+#if WXWIN_COMPATIBILITY_2_6

 
 

-class WXDLLEXPORT wxTreeItemId
+// flags for deprecated `Expand(int action)', will be removed in next versions
+enum

 {
 {

-    friend bool operator==(const wxTreeItemId&, const wxTreeItemId&);
-public:
-    // ctors
-        // 0 is invalid value for HTREEITEM
-    wxTreeItemId() { m_pItem = 0; }
-
-        // construct wxTreeItemId from the native item id
-    wxTreeItemId(void *pItem) { m_pItem = pItem; }
-
-        // default copy ctor/assignment operator are ok for us
-
-    // accessors
-        // is this a valid tree item?
-    bool IsOk() const { return m_pItem != 0; }
-        // return true if this item is not valid
-    bool operator!() const { return !IsOk(); }
-
-    // operations
-        // invalidate the item
-    void Unset() { m_pItem = 0; }
-
-#if WXWIN_COMPATIBILITY_2_4
-    // deprecated: only for compatibility, don't work on 64 bit archs
-    wxTreeItemId(long item) { m_pItem = wxUIntToPtr(item); }
-    operator long() const { return (long)wxPtrToUInt(m_pItem); }
-#else // !WXWIN_COMPATIBILITY_2_4
-    operator bool() const { return IsOk(); }
-#endif // WXWIN_COMPATIBILITY_2_4/!WXWIN_COMPATIBILITY_2_4
-
-    wxTreeItemIdValue m_pItem;
+    wxTREE_EXPAND_EXPAND,
+    wxTREE_EXPAND_COLLAPSE,
+    wxTREE_EXPAND_COLLAPSE_RESET,
+    wxTREE_EXPAND_TOGGLE

 };
 
 };
 

-inline bool operator==(const wxTreeItemId& i1, const wxTreeItemId& i2)
-{
-    return i1.m_pItem == i2.m_pItem;
-}
+#endif // WXWIN_COMPATIBILITY_2_6

 
 

-inline bool operator!=(const wxTreeItemId& i1, const wxTreeItemId& i2)
+// ----------------------------------------------------------------------------
+// wxTreeItemId identifies an element of the tree. It's opaque for the
+// application and the only method which can be used by user code is IsOk().
+// ----------------------------------------------------------------------------
+
+// This is a class and not a typedef because existing code may forward declare
+// wxTreeItemId as a class and we don't want to break it without good reason.
+class wxTreeItemId : public wxItemId<void*>

 {
 {

-    return i1.m_pItem != i2.m_pItem;
-}
+public:
+    wxTreeItemId() : wxItemId<void*>() { }
+    wxTreeItemId(void* pItem) : wxItemId<void*>(pItem) { }
+};

 
 // ----------------------------------------------------------------------------
 // wxTreeItemData is some (arbitrary) user class associated with some item. The
 
 // ----------------------------------------------------------------------------
 // wxTreeItemData is some (arbitrary) user class associated with some item. The


@@ -94,10 +66,10 @@ inline bool operator!=(const wxTreeItemId& i1, const wxTreeItemId& i2)
 // always be allocated on the heap!
 // ----------------------------------------------------------------------------
 
 // always be allocated on the heap!
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxTreeItemData: public wxClientData
+class WXDLLIMPEXP_CORE wxTreeItemData: public wxClientData

 {
 {

-friend class WXDLLEXPORT wxTreeCtrl;
-friend class WXDLLEXPORT wxGenericTreeCtrl;
+friend class WXDLLIMPEXP_FWD_CORE wxTreeCtrl;
+friend class WXDLLIMPEXP_FWD_CORE wxGenericTreeCtrl;

 public:
     // creation/destruction
     // --------------------
 public:
     // creation/destruction
     // --------------------


@@ -114,13 +86,23 @@ protected:
     wxTreeItemId m_pItem;
 };
 
     wxTreeItemId m_pItem;
 };
 

+typedef void *wxTreeItemIdValue;
+

 WX_DEFINE_EXPORTED_ARRAY_PTR(wxTreeItemIdValue, wxArrayTreeItemIdsBase);
 
 WX_DEFINE_EXPORTED_ARRAY_PTR(wxTreeItemIdValue, wxArrayTreeItemIdsBase);
 

-class WXDLLEXPORT wxArrayTreeItemIds : public wxArrayTreeItemIdsBase
+// this is a wrapper around the array class defined above which allow to wok
+// with values of natural wxTreeItemId type instead of using wxTreeItemIdValue
+// and does it without any loss of efficiency
+class WXDLLIMPEXP_CORE wxArrayTreeItemIds : public wxArrayTreeItemIdsBase

 {
 public:
     void Add(const wxTreeItemId& id)
         { wxArrayTreeItemIdsBase::Add(id.m_pItem); }
 {
 public:
     void Add(const wxTreeItemId& id)
         { wxArrayTreeItemIdsBase::Add(id.m_pItem); }

+    void Insert(const wxTreeItemId& id, size_t pos)
+        { wxArrayTreeItemIdsBase::Insert(id.m_pItem, pos); }
+    wxTreeItemId Item(size_t i) const
+        { return wxTreeItemId(wxArrayTreeItemIdsBase::Item(i)); }
+    wxTreeItemId operator[](size_t i) const { return Item(i); }

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -137,6 +119,11 @@ enum wxTreeItemIcon
     wxTreeItemIcon_Max
 };
 
     wxTreeItemIcon_Max
 };
 

+// special values for the 'state' parameter of wxTreeCtrl::SetItemState()
+static const int wxTREE_ITEMSTATE_NONE  = -1;   // not state (no display state image)
+static const int wxTREE_ITEMSTATE_NEXT  = -2;   // cycle to the next state
+static const int wxTREE_ITEMSTATE_PREV  = -3;   // cycle to the previous state
+

 // ----------------------------------------------------------------------------
 // wxTreeCtrl flags
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxTreeCtrl flags
 // ----------------------------------------------------------------------------


@@ -149,7 +136,11 @@ enum wxTreeItemIcon
 
 #define wxTR_SINGLE                  0x0000     // for convenience
 #define wxTR_MULTIPLE                0x0020     // can select multiple items
 
 #define wxTR_SINGLE                  0x0000     // for convenience
 #define wxTR_MULTIPLE                0x0020     // can select multiple items

-#define wxTR_EXTENDED                0x0040     // TODO: allow extended selection
+
+#if WXWIN_COMPATIBILITY_2_8
+    #define wxTR_EXTENDED            0x0040     // deprecated, don't use
+#endif // WXWIN_COMPATIBILITY_2_8
+

 #define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080     // what it says
 
 #define wxTR_EDIT_LABELS             0x0200     // can edit item labels
 #define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080     // what it says
 
 #define wxTR_EDIT_LABELS             0x0200     // can edit item labels


@@ -158,15 +149,22 @@ enum wxTreeItemIcon
 
 #define wxTR_FULL_ROW_HIGHLIGHT      0x2000     // highlight full horz space
 
 
 #define wxTR_FULL_ROW_HIGHLIGHT      0x2000     // highlight full horz space
 

-#ifdef __WXGTK20__
-#define wxTR_DEFAULT_STYLE           (wxTR_HAS_BUTTONS | wxTR_NO_LINES)
+// make the default control appearance look more native-like depending on the
+// platform
+#if defined(__WXGTK20__)
+    #define wxTR_DEFAULT_STYLE       (wxTR_HAS_BUTTONS | wxTR_NO_LINES)
+#elif defined(__WXMAC__)
+    #define wxTR_DEFAULT_STYLE \
+        (wxTR_HAS_BUTTONS | wxTR_NO_LINES | wxTR_FULL_ROW_HIGHLIGHT)

 #else
 #else

-#define wxTR_DEFAULT_STYLE           (wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT)
+    #define wxTR_DEFAULT_STYLE       (wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT)

 #endif
 
 #endif
 

+#if WXWIN_COMPATIBILITY_2_6

 // deprecated, don't use
 #define wxTR_MAC_BUTTONS             0
 #define wxTR_AQUA_BUTTONS            0
 // deprecated, don't use
 #define wxTR_MAC_BUTTONS             0
 #define wxTR_AQUA_BUTTONS            0

+#endif // WXWIN_COMPATIBILITY_2_6

 
 
 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
 
 
 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine


@@ -201,13 +199,13 @@ static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
                                           wxTREE_HITTEST_ONITEMLABEL;
 
 // tree ctrl default name
                                           wxTREE_HITTEST_ONITEMLABEL;
 
 // tree ctrl default name

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

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

-class WXDLLEXPORT wxTreeItemAttr
+class WXDLLIMPEXP_CORE wxTreeItemAttr

 {
 public:
     // ctors
 {
 public:
     // ctors


@@ -223,9 +221,9 @@ public:
     void SetFont(const wxFont& font) { m_font = font; }
 
     // accessors
     void SetFont(const wxFont& font) { m_font = font; }
 
     // accessors

-    bool HasTextColour() const { return m_colText.Ok(); }
-    bool HasBackgroundColour() const { return m_colBack.Ok(); }
-    bool HasFont() const { return m_font.Ok(); }
+    bool HasTextColour() const { return m_colText.IsOk(); }
+    bool HasBackgroundColour() const { return m_colBack.IsOk(); }
+    bool HasFont() const { return m_font.IsOk(); }

 
     const wxColour& GetTextColour() const { return m_colText; }
     const wxColour& GetBackgroundColour() const { return m_colBack; }
 
     const wxColour& GetTextColour() const { return m_colText; }
     const wxColour& GetBackgroundColour() const { return m_colBack; }


@@ -244,11 +242,16 @@ private:
 //     descriptions below
 // ----------------------------------------------------------------------------
 
 //     descriptions below
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxTreeEvent : public wxNotifyEvent
+class WXDLLIMPEXP_FWD_CORE wxTreeCtrlBase;
+
+class WXDLLIMPEXP_CORE wxTreeEvent : public wxNotifyEvent

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

-    wxTreeEvent(const wxTreeEvent & event);
+    wxTreeEvent(wxEventType commandType,
+                wxTreeCtrlBase *tree,
+                const wxTreeItemId &item = wxTreeItemId());
+    wxTreeEvent(const wxTreeEvent& event);

 
     virtual wxEvent *Clone() const { return new wxTreeEvent(*this); }
 
 
     virtual wxEvent *Clone() const { return new wxTreeEvent(*this); }
 


@@ -285,11 +288,6 @@ public:
     void SetToolTip(const wxString& toolTip) { m_label = toolTip; }
     wxString GetToolTip() { return m_label; }
 
     void SetToolTip(const wxString& toolTip) { m_label = toolTip; }
     wxString GetToolTip() { return m_label; }
 

-#if WXWIN_COMPATIBILITY_2_2
-    // for compatibility only, don't use
-    wxDEPRECATED( int GetCode() const);
-#endif // WXWIN_COMPATIBILITY_2_2
-

 private:
     // not all of the members are used (or initialized) for all events
     wxKeyEvent    m_evtKey;
 private:
     // not all of the members are used (or initialized) for all events
     wxKeyEvent    m_evtKey;


@@ -299,8 +297,8 @@ private:
     wxString      m_label;
     bool          m_editCancelled;
 
     wxString      m_label;
     bool          m_editCancelled;
 

-    friend class WXDLLEXPORT wxTreeCtrl;
-    friend class WXDLLEXPORT wxGenericTreeCtrl;
+    friend class WXDLLIMPEXP_FWD_CORE wxTreeCtrl;
+    friend class WXDLLIMPEXP_FWD_CORE wxGenericTreeCtrl;

 
     DECLARE_DYNAMIC_CLASS(wxTreeEvent)
 };
 
     DECLARE_DYNAMIC_CLASS(wxTreeEvent)
 };


@@ -311,32 +309,30 @@ typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
 // tree control events and macros for handling them
 // ----------------------------------------------------------------------------
 
 // 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)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, 618)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP, 619)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_MENU, 620)
-END_DECLARE_EVENT_TYPES()
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_BEGIN_DRAG, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_BEGIN_RDRAG, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_END_LABEL_EDIT, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_DELETE_ITEM, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_GET_INFO, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_SET_INFO, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_ITEM_EXPANDED, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_ITEM_EXPANDING, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_ITEM_COLLAPSED, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_ITEM_COLLAPSING, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_SEL_CHANGED, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_SEL_CHANGING, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_KEY_DOWN, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_ITEM_ACTIVATED, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_END_DRAG, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP, wxTreeEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_TREE_ITEM_MENU, wxTreeEvent );

 
 #define wxTreeEventHandler(func) \
 
 #define wxTreeEventHandler(func) \

-    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTreeEventFunction, &func)
+    wxEVENT_HANDLER_CAST(wxTreeEventFunction, func)

 
 #define wx__DECLARE_TREEEVT(evt, id, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_TREE_ ## evt, id, wxTreeEventHandler(fn))
 
 #define wx__DECLARE_TREEEVT(evt, id, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_TREE_ ## evt, id, wxTreeEventHandler(fn))


@@ -348,7 +344,7 @@ END_DECLARE_EVENT_TYPES()
 #define EVT_TREE_BEGIN_DRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_DRAG, id, fn)
 #define EVT_TREE_BEGIN_RDRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_RDRAG, id, fn)
 
 #define EVT_TREE_BEGIN_DRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_DRAG, id, fn)
 #define EVT_TREE_BEGIN_RDRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_RDRAG, id, fn)
 

-// GetItem() is the item on which the drop occured (if any) and GetPoint() the
+// GetItem() is the item on which the drop occurred (if any) and GetPoint() the

 // current mouse coords
 #define EVT_TREE_END_DRAG(id, fn) wx__DECLARE_TREEEVT(END_DRAG, id, fn)
 
 // current mouse coords
 #define EVT_TREE_END_DRAG(id, fn) wx__DECLARE_TREEEVT(END_DRAG, id, fn)
 


@@ -403,4 +399,3 @@ END_DECLARE_EVENT_TYPES()
 #endif // wxUSE_TREECTRL
 
 #endif // _WX_TREEBASE_H_
 #endif // wxUSE_TREECTRL
 
 #endif // _WX_TREEBASE_H_

-