updated Joystick demo, is now wxDesigner-less

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

diff --git a/include/wx/treebase.h b/include/wx/treebase.h
index af9c822f9ee820a29ed501910554d6cbbcef3839..42477df701ac84eac9a78416a6692aa626863f05 100644 (file)
--- a/include/wx/treebase.h
+++ b/include/wx/treebase.h
@@ -12,7 +12,7 @@
 #ifndef _WX_TREEBASE_H_
 #define _WX_TREEBASE_H_
 
 #ifndef _WX_TREEBASE_H_
 #define _WX_TREEBASE_H_
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "treebase.h"
 #endif
 
     #pragma interface "treebase.h"
 #endif
 


@@ -24,6 +24,7 @@
 
 #include "wx/window.h"  // for wxClientData
 #include "wx/event.h"
 
 #include "wx/window.h"  // for wxClientData
 #include "wx/event.h"

+#include "wx/dynarray.h"

 
 // ----------------------------------------------------------------------------
 // wxTreeItemId identifies an element of the tree. In this implementation, it's
 
 // ----------------------------------------------------------------------------
 // wxTreeItemId identifies an element of the tree. In this implementation, it's


@@ -33,33 +34,52 @@
 // ----------------------------------------------------------------------------
 
 // Using this typedef removes an ambiguity when calling Remove()
 // ----------------------------------------------------------------------------
 
 // Using this typedef removes an ambiguity when calling Remove()

-typedef unsigned long wxTreeItemIdValue;
+typedef void *wxTreeItemIdValue;

 
 class WXDLLEXPORT wxTreeItemId
 {
 
 class WXDLLEXPORT wxTreeItemId
 {

+    friend bool operator==(const wxTreeItemId&, const wxTreeItemId&);

 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; }
+        // 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; }
 
         // 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; }

 
 

-    // deprecated: only for compatibility
-    operator wxTreeItemIdValue() const { return m_pItem; }
+#if WXWIN_COMPATIBILITY_2_4
+    // deprecated: only for compatibility, don't work on 64 bit archs
+    wxTreeItemId(long item) { m_pItem = (wxTreeItemIdValue)item; }
+    operator long() const { return (long)m_pItem; }
+#else // !WXWIN_COMPATIBILITY_2_4
+    operator bool() const { return IsOk(); }
+#endif // WXWIN_COMPATIBILITY_2_4/!WXWIN_COMPATIBILITY_2_4

 
     wxTreeItemIdValue m_pItem;
 };
 
 
     wxTreeItemIdValue m_pItem;
 };
 

+inline bool operator==(const wxTreeItemId& i1, const wxTreeItemId& i2)
+{
+    return i1.m_pItem == i2.m_pItem;
+}
+
+inline bool operator!=(const wxTreeItemId& i1, const wxTreeItemId& i2)
+{
+    return i1.m_pItem != i2.m_pItem;
+}
+

 // ----------------------------------------------------------------------------
 // wxTreeItemData is some (arbitrary) user class associated with some item. The
 // main advantage of having this class (compared to old untyped interface) is
 // ----------------------------------------------------------------------------
 // wxTreeItemData is some (arbitrary) user class associated with some item. The
 // main advantage of having this class (compared to old untyped interface) is


@@ -94,7 +114,14 @@ protected:
     wxTreeItemId m_pItem;
 };
 
     wxTreeItemId m_pItem;
 };
 

-WX_DEFINE_EXPORTED_ARRAY(wxTreeItemId, wxArrayTreeItemIds);
+WX_DEFINE_EXPORTED_ARRAY_PTR(wxTreeItemIdValue, wxArrayTreeItemIdsBase);
+
+class WXDLLEXPORT wxArrayTreeItemIds : public wxArrayTreeItemIdsBase
+{
+public:
+    void Add(const wxTreeItemId& id)
+        { wxArrayTreeItemIdsBase::Add(id.m_pItem); }
+};

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -110,40 +137,33 @@ 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
+// ----------------------------------------------------------------------------
+
+#define wxTR_NO_BUTTONS              0x0000     // for convenience
+#define wxTR_HAS_BUTTONS             0x0001     // draw collapsed/expanded btns
+#define wxTR_NO_LINES                0x0004     // don't draw lines at all
+#define wxTR_LINES_AT_ROOT           0x0008     // connect top-level nodes
+
+#define wxTR_SINGLE                  0x0000     // for convenience
+#define wxTR_MULTIPLE                0x0020     // can select multiple items
+#define wxTR_EXTENDED                0x0040     // TODO: allow extended selection
+#define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080     // what it says
+
+#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_FULL_ROW_HIGHLIGHT      0x2000     // highlight full horz space
+
+#define wxTR_DEFAULT_STYLE           (wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT)
+
+// deprecated, don't use
+#define wxTR_TWIST_BUTTONS           0
+#define wxTR_MAC_BUTTONS             0
+#define wxTR_AQUA_BUTTONS            0

 
 

-/*
- * 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:


@@ -229,21 +249,38 @@ public:
         // get the item on which the operation was performed or the newly
         // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
     wxTreeItemId GetItem() const { return m_item; }
         // get the item on which the operation was performed or the newly
         // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
     wxTreeItemId GetItem() const { return m_item; }

+    void SetItem(const wxTreeItemId& item) { m_item = item; }

 
         // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
         // selected item
     wxTreeItemId GetOldItem() const { return m_itemOld; }
 
         // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
         // selected item
     wxTreeItemId GetOldItem() const { return m_itemOld; }

+    void SetOldItem(const wxTreeItemId& item) { m_itemOld = item; }

 
         // the point where the mouse was when the drag operation started (for
         // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only) or click position
     wxPoint GetPoint() const { return m_pointDrag; }
 
         // the point where the mouse was when the drag operation started (for
         // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only) or click position
     wxPoint GetPoint() const { return m_pointDrag; }

+    void SetPoint(const wxPoint& pt) { m_pointDrag = pt; }

 
         // keyboard data (for wxEVT_COMMAND_TREE_KEY_DOWN only)
     const wxKeyEvent& GetKeyEvent() const { return m_evtKey; }
 
         // keyboard data (for wxEVT_COMMAND_TREE_KEY_DOWN only)
     const wxKeyEvent& GetKeyEvent() const { return m_evtKey; }

-    int GetCode() const { return m_evtKey.GetKeyCode(); }
+    int GetKeyCode() const { return m_evtKey.GetKeyCode(); }
+    void SetKeyEvent(const wxKeyEvent& evt) { m_evtKey = evt; }

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

+    void SetLabel(const wxString& label) { m_label = label; }
+
+        // edit cancel flag (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
+    bool IsEditCancelled() const { return m_editCancelled; }
+    void SetEditCanceled(bool editCancelled) { m_editCancelled = editCancelled; }
+
+        // Set the tooltip for the item (for EVT\_TREE\_ITEM\_GETTOOLTIP events)
+    void SetToolTip(const wxString& toolTip) { m_label = toolTip; }
+
+#if WXWIN_COMPATIBILITY_2_2
+    // for compatibility only, don't use
+    int GetCode() const { return m_evtKey.GetKeyCode(); }
+#endif // WXWIN_COMPATIBILITY_2_2

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


@@ -252,11 +289,12 @@ private:
                   m_itemOld;
     wxPoint       m_pointDrag;
     wxString      m_label;
                   m_itemOld;
     wxPoint       m_pointDrag;
     wxString      m_label;

+    bool          m_editCancelled;

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

-    DECLARE_DYNAMIC_CLASS(wxTreeEvent);
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxTreeEvent)

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


@@ -284,6 +322,8 @@ BEGIN_DECLARE_EVENT_TYPES()
     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_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)

 END_DECLARE_EVENT_TYPES()
 
 // GetItem() returns the item being dragged, GetPoint() the mouse coords
 END_DECLARE_EVENT_TYPES()
 
 // GetItem() returns the item being dragged, GetPoint() the mouse coords


@@ -320,7 +360,7 @@ END_DECLARE_EVENT_TYPES()
 #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 ),
 
 #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
+// GetKeyCode() 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) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
 // 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) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),


@@ -336,6 +376,12 @@ 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 ),
 

+// GetItem() returns the item whose state image was clicked on
+#define EVT_TREE_STATE_IMAGE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
+
+// GetItem() is the item for which the tooltip is being requested
+#define EVT_TREE_ITEM_GETTOOLTIP(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
+

 #endif // wxUSE_TREECTRL
 
 #endif // _WX_TREEBASE_H_
 #endif // wxUSE_TREECTRL
 
 #endif // _WX_TREEBASE_H_