Initial import of wxWebKitCtrl sources and htmlctrl (right now wxWebKit) sample.

[wxWidgets.git] / include / wx / msw / treectrl.h

diff --git a/include/wx/msw/treectrl.h b/include/wx/msw/treectrl.h
index 48881c46f617e0eb63cc059aa087c5069335d22d..f95ddf6f964ebde7129f878a34cff3fed87cf46b 100644 (file)
--- a/include/wx/msw/treectrl.h
+++ b/include/wx/msw/treectrl.h
@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        treectrl.h
+// Name:        wx/msw/treectrl.h

 // Purpose:     wxTreeCtrl class
 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin to be less MSW-specific on 10/10/98
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     wxTreeCtrl class
 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin to be less MSW-specific on 10/10/98
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TREECTRL_H_
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TREECTRL_H_


@@ -16,12 +16,16 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

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

     #pragma interface "treectrl.h"
 #endif
 
     #pragma interface "treectrl.h"
 #endif
 

+#if wxUSE_TREECTRL
+

 #include "wx/textctrl.h"
 #include "wx/dynarray.h"
 #include "wx/textctrl.h"
 #include "wx/dynarray.h"

+#include "wx/treebase.h"
+#include "wx/hashmap.h"

 
 #ifdef __GNUWIN32__
     // Cygwin windows.h defines these identifiers
 
 #ifdef __GNUWIN32__
     // Cygwin windows.h defines these identifiers


@@ -29,51 +33,11 @@
     #undef GetNextSibling
 #endif // Cygwin
 
     #undef GetNextSibling
 #endif // Cygwin
 

-// the type for "untyped" data
-typedef long wxDataType;
-

 // fwd decl
 class  WXDLLEXPORT wxImageList;
 // fwd decl
 class  WXDLLEXPORT wxImageList;

+class  WXDLLEXPORT wxDragImage;

 struct WXDLLEXPORT wxTreeViewItem;
 
 struct WXDLLEXPORT wxTreeViewItem;
 

-// a callback function used for sorting tree items, it should return -1 if the
-// first item precedes the second, +1 if the second precedes the first or 0 if
-// they're equivalent
-class wxTreeItemData;
-
-// ----------------------------------------------------------------------------
-// constants
-// ----------------------------------------------------------------------------
-
-// values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
-// where exactly the specified point is situated:
-    // above the client area.
-static const int wxTREE_HITTEST_ABOVE            = 0x0001;
-    // below the client area.
-static const int wxTREE_HITTEST_BELOW            = 0x0002;
-    // in the client area but below the last item.
-static const int wxTREE_HITTEST_NOWHERE          = 0x0004;
-    // on the button associated with an item.
-static const int wxTREE_HITTEST_ONITEMBUTTON     = 0x0010;
-    // on the bitmap associated with an item.
-static const int wxTREE_HITTEST_ONITEMICON       = 0x0020;
-    // in the indentation associated with an item.
-static const int wxTREE_HITTEST_ONITEMINDENT     = 0x0040;
-    // on the label (string) associated with an item.
-static const int wxTREE_HITTEST_ONITEMLABEL      = 0x0080;
-    // in the area to the right of an item.
-static const int wxTREE_HITTEST_ONITEMRIGHT      = 0x0100;
-    // on the state icon for a tree view item that is in a user-defined state.
-static const int wxTREE_HITTEST_ONITEMSTATEICON  = 0x0200;
-    // to the right of the client area.
-static const int wxTREE_HITTEST_TOLEFT           = 0x0400;
-    // to the left of the client area.
-static const int wxTREE_HITTEST_TORIGHT          = 0x0800;
-    // anywhere on the item
-static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
-                                          wxTREE_HITTEST_ONITEMLABEL |
-                                          wxTREE_HITTEST_ONITEMSTATEICON;
-

 // NB: all the following flags are for compatbility only and will be removed in the
 //     next versions
 
 // NB: all the following flags are for compatbility only and will be removed in the
 //     next versions
 


@@ -86,75 +50,18 @@ enum
     wxTREE_EXPAND_TOGGLE
 };
 
     wxTREE_EXPAND_TOGGLE
 };
 

-// flags for deprecated InsertItem() variant
+// flags for deprecated InsertItem() variant (their values are the same as of
+// TVI_FIRST and TVI_LAST)

 #define wxTREE_INSERT_FIRST 0xFFFF0001
 #define wxTREE_INSERT_LAST  0xFFFF0002
 
 #define wxTREE_INSERT_FIRST 0xFFFF0001
 #define wxTREE_INSERT_LAST  0xFFFF0002
 

-// ----------------------------------------------------------------------------
-// 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.
-// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxTreeItemId
-{
-public:
-    // ctors
-        // 0 is invalid value for HTREEITEM
-    wxTreeItemId() { m_itemId = 0; }
-
-        // default copy ctor/assignment operator are ok for us
-
-    // accessors
-        // is this a valid tree item?
-    bool IsOk() const { return m_itemId != 0; }
-
-    // conversion to/from either real (system-dependent) tree item id or
-    // to "long" which used to be the type for tree item ids in previous
-    // versions of wxWindows
-
-    // for wxTreeCtrl usage only
-    wxTreeItemId(WXHTREEITEM itemId) { m_itemId = (long)itemId; }
-    operator WXHTREEITEM() const { return (WXHTREEITEM)m_itemId; }
-
-    void operator=(WXHTREEITEM item) { m_itemId = (long) item; }
-
-protected:
-    long m_itemId;
-};
-
-WX_DEFINE_EXPORTED_ARRAY(WXHTREEITEM, wxArrayTreeItemIds);
-
-// ----------------------------------------------------------------------------
-// wxTreeItemData is some (arbitrary) user class associated with some item. The
-// main advantage of having this class (compared to old untyped interface) is
-// that wxTreeItemData's are destroyed automatically by the tree and, as this
-// class has virtual dtor, it means that the memory will be automatically
-// freed. OTOH, we don't just use wxObject instead of wxTreeItemData because
-// the size of this class is critical: in any real application, each tree leaf
-// will have wxTreeItemData associated with it and number of leaves may be
-// quite big.
-//
-// Because the objects of this class are deleted by the tree, they should
-// always be allocated on the heap!
-// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxTreeItemData : private wxTreeItemId
-{
-public:
-    // default ctor/copy ctor/assignment operator are ok
-
-    // dtor is virtual and all the items are deleted by the tree control when
-    // it's deleted, so you normally don't have to care about freeing memory
-    // allocated in your wxTreeItemData-derived class
-    virtual ~wxTreeItemData() { }
-
-    // accessors: set/get the item associated with this node
-    void SetId(const wxTreeItemId& id) { m_itemId = id; }
-    const wxTreeItemId GetId() const { return *this; }
-};
+// hash storing attributes for our items
+WX_DECLARE_EXPORTED_VOIDPTR_HASH_MAP(wxTreeItemAttr *, wxMapTreeAttr);

 
 // ----------------------------------------------------------------------------
 // wxTreeCtrl
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxTreeCtrl
 // ----------------------------------------------------------------------------

+

 class WXDLLEXPORT wxTreeCtrl : public wxControl
 {
 public:
 class WXDLLEXPORT wxTreeCtrl : public wxControl
 {
 public:


@@ -167,7 +74,7 @@ public:
                const wxSize& size = wxDefaultSize,
                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
                const wxValidator& validator = wxDefaultValidator,
                const wxSize& size = wxDefaultSize,
                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
                const wxValidator& validator = wxDefaultValidator,

-               const wxString& name = "wxTreeCtrl")
+               const wxString& name = wxTreeCtrlNameStr)

     {
         Create(parent, id, pos, size, style, validator, name);
     }
     {
         Create(parent, id, pos, size, style, validator, name);
     }


@@ -179,7 +86,7 @@ public:
                 const wxSize& size = wxDefaultSize,
                 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxSize& size = wxDefaultSize,
                 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString& name = "wxTreeCtrl");
+                const wxString& name = wxTreeCtrlNameStr);

 
     // accessors
     // ---------
 
     // accessors
     // ---------


@@ -213,6 +120,8 @@ public:
 
     void SetImageList(wxImageList *imageList);
     void SetStateImageList(wxImageList *imageList);
 
     void SetImageList(wxImageList *imageList);
     void SetStateImageList(wxImageList *imageList);

+    void AssignImageList(wxImageList *imageList);
+    void AssignStateImageList(wxImageList *imageList);

 
     // Functions to work with tree ctrl items. Unfortunately, they can _not_ be
     // member functions of wxTreeItem because they must know the tree the item
 
     // Functions to work with tree ctrl items. Unfortunately, they can _not_ be
     // member functions of wxTreeItem because they must know the tree the item


@@ -230,6 +139,15 @@ public:
         // get the data associated with the item
     wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
 
         // get the data associated with the item
     wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
 

+        // get the item's text colour
+    wxColour GetItemTextColour(const wxTreeItemId& item) const;
+
+        // get the item's background colour
+    wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
+
+        // get the item's font
+    wxFont GetItemFont(const wxTreeItemId& item) const;
+

     // modifiers
     // ---------
 
     // modifiers
     // ---------
 


@@ -253,6 +171,15 @@ public:
         // the item will be shown with a drop highlight
     void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = TRUE);
 
         // the item will be shown with a drop highlight
     void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = TRUE);
 

+        // set the items text colour
+    void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
+
+        // set the items background colour
+    void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
+
+        // set the items font (should be of the same height for all items)
+    void SetItemFont(const wxTreeItemId& item, const wxFont& font);
+

     // item status inquiries
     // ---------------------
 
     // item status inquiries
     // ---------------------
 


@@ -293,7 +220,16 @@ public:
     size_t GetSelections(wxArrayTreeItemIds& selections) const;
 
         // get the parent of this item (may return NULL if root)
     size_t GetSelections(wxArrayTreeItemIds& selections) const;
 
         // get the parent of this item (may return NULL if root)

-    wxTreeItemId GetParent(const wxTreeItemId& item) const;
+    wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
+
+#if WXWIN_COMPATIBILITY_2_2
+        // deprecated:  Use GetItemParent instead.
+    wxTreeItemId GetParent(const wxTreeItemId& item) const
+       { return GetItemParent( item ); }
+
+       // Expose the base class method hidden by the one above.
+    wxWindow *GetParent() const { return wxControl::GetParent(); }
+#endif  // WXWIN_COMPATIBILITY_2_2

 
         // for this enumeration function you must pass in a "cookie" parameter
         // which is opaque for the application but is necessary for the library
 
         // for this enumeration function you must pass in a "cookie" parameter
         // which is opaque for the application but is necessary for the library


@@ -303,9 +239,11 @@ public:
         // the same!
 
         // get the first child of this item
         // the same!
 
         // get the first child of this item

-    wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& _cookie) const;
+    wxTreeItemId GetFirstChild(const wxTreeItemId& item,
+                               wxTreeItemIdValue& cookie) const;

         // get the next child
         // get the next child

-    wxTreeItemId GetNextChild(const wxTreeItemId& item, long& _cookie) const;
+    wxTreeItemId GetNextChild(const wxTreeItemId& item,
+                              wxTreeItemIdValue& cookie) const;

         // get the last child of this item - this method doesn't use cookies
     wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
 
         // get the last child of this item - this method doesn't use cookies
     wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
 


@@ -343,6 +281,13 @@ public:
                             int image = -1, int selectedImage = -1,
                             wxTreeItemData *data = NULL);
 
                             int image = -1, int selectedImage = -1,
                             wxTreeItemData *data = NULL);
 

+        // insert a new item before the one with the given index
+    wxTreeItemId InsertItem(const wxTreeItemId& parent,
+                            size_t index,
+                            const wxString& text,
+                            int image = -1, int selectedImage = -1,
+                            wxTreeItemData *data = NULL);
+

         // insert a new item in as the last child of the parent
     wxTreeItemId AppendItem(const wxTreeItemId& parent,
                             const wxString& text,
         // insert a new item in as the last child of the parent
     wxTreeItemId AppendItem(const wxTreeItemId& parent,
                             const wxString& text,


@@ -372,7 +317,12 @@ public:
         // unselect all items (only makes sense for multiple selection control)
     void UnselectAll();
         // select this item
         // unselect all items (only makes sense for multiple selection control)
     void UnselectAll();
         // select this item

-    void SelectItem(const wxTreeItemId& item);
+    void SelectItem(const wxTreeItemId& item, bool select = true);
+        // unselect this item
+    void UnselectItem(const wxTreeItemId& item);
+        // toggle item selection
+    void ToggleItemSelection(const wxTreeItemId& item);
+

         // make sure this item is visible (expanding the parent item and/or
         // scrolling to this item if necessary)
     void EnsureVisible(const wxTreeItemId& item);
         // make sure this item is visible (expanding the parent item and/or
         // scrolling to this item if necessary)
     void EnsureVisible(const wxTreeItemId& item);


@@ -426,50 +376,80 @@ public:
     // deprecated
     // ----------
 
     // deprecated
     // ----------
 

+#if WXWIN_COMPATIBILITY_2_4

     // these methods are deprecated and will be removed in future versions of
     // wxWindows, they're here for compatibility only, don't use them in new
     // code (the comments indicate why these methods are now useless and how to
     // replace them)
 
         // use Expand, Collapse, CollapseAndReset or Toggle
     // these methods are deprecated and will be removed in future versions of
     // wxWindows, they're here for compatibility only, don't use them in new
     // code (the comments indicate why these methods are now useless and how to
     // replace them)
 
         // use Expand, Collapse, CollapseAndReset or Toggle

-    void ExpandItem(const wxTreeItemId& item, int action);
+    wxDEPRECATED( void ExpandItem(const wxTreeItemId& item, int action) );

 
         // use AddRoot, PrependItem or AppendItem
 
         // use AddRoot, PrependItem or AppendItem

-    wxTreeItemId InsertItem(const wxTreeItemId& parent,
+    wxDEPRECATED( wxTreeItemId InsertItem(const wxTreeItemId& parent,

                             const wxString& text,
                             int image = -1, int selImage = -1,
                             const wxString& text,
                             int image = -1, int selImage = -1,

-                            long insertAfter = wxTREE_INSERT_LAST);
+                            long insertAfter = wxTREE_INSERT_LAST) );

 
         // use Set/GetImageList and Set/GetStateImageList
 
         // use Set/GetImageList and Set/GetStateImageList

-    wxImageList *GetImageList(int) const
-        { return GetImageList(); }
-    void SetImageList(wxImageList *imageList, int)
-        { SetImageList(imageList); }
+    wxImageList *GetImageList(int) const { return GetImageList(); }
+    void SetImageList(wxImageList *imageList, int) { SetImageList(imageList); }

 
     // use Set/GetItemImage directly
 
     // use Set/GetItemImage directly

-        // get the selected item image

     int GetItemSelectedImage(const wxTreeItemId& item) const
         { return GetItemImage(item, wxTreeItemIcon_Selected); }
     int GetItemSelectedImage(const wxTreeItemId& item) const
         { return GetItemImage(item, wxTreeItemIcon_Selected); }

-        // set the selected item image

     void SetItemSelectedImage(const wxTreeItemId& item, int image)
         { SetItemImage(item, image, wxTreeItemIcon_Selected); }
 
     void SetItemSelectedImage(const wxTreeItemId& item, int image)
         { SetItemImage(item, image, wxTreeItemIcon_Selected); }
 

+    // use the versions taking wxTreeItemIdValue cookies
+    wxDEPRECATED( wxTreeItemId GetFirstChild(const wxTreeItemId& item,
+                                             long& cookie) const );
+    wxDEPRECATED( wxTreeItemId GetNextChild(const wxTreeItemId& item,
+                                            long& cookie) const );
+#endif // WXWIN_COMPATIBILITY_2_4
+
+

     // implementation
     // --------------
     // implementation
     // --------------

+
+    virtual bool ShouldInheritColours() const { return false; }
+
+    virtual wxVisualAttributes GetDefaultAttributes() const
+    {
+        return GetClassDefaultAttributes(GetWindowVariant());
+    }
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
+
+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);

     virtual bool MSWCommand(WXUINT param, WXWORD id);
     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 
     virtual bool MSWCommand(WXUINT param, WXWORD id);
     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 

+    // override some base class virtuals
+    virtual bool SetBackgroundColour(const wxColour &colour);
+    virtual bool SetForegroundColour(const wxColour &colour);
+

     // get/set the check state for the item (only for wxTR_MULTIPLE)
     bool IsItemChecked(const wxTreeItemId& item) const;
     void SetItemCheck(const wxTreeItemId& item, bool check = TRUE);
 
     // get/set the check state for the item (only for wxTR_MULTIPLE)
     bool IsItemChecked(const wxTreeItemId& item) const;
     void SetItemCheck(const wxTreeItemId& item, bool check = TRUE);
 

+    // set/get the item state.image (state == -1 means cycle to the next one)
+    void SetState(const wxTreeItemId& node, int state);
+    int GetState(const wxTreeItemId& node);
+

 protected:
     // SetImageList helper
     void SetAnyImageList(wxImageList *imageList, int which);
 
 protected:
     // SetImageList helper
     void SetAnyImageList(wxImageList *imageList, int which);
 

+    // refresh a single item
+    void RefreshItem(const wxTreeItemId& item);
+

     wxTextCtrl  *m_textCtrl;        // used while editing the item label
     wxImageList *m_imageListNormal, // images for tree elements
                 *m_imageListState;  // special images for app defined states
     wxTextCtrl  *m_textCtrl;        // used while editing the item label
     wxImageList *m_imageListNormal, // images for tree elements
                 *m_imageListState;  // special images for app defined states

+    bool         m_ownsImageListNormal, m_ownsImageListState;

 
 private:
     // the common part of all ctors
 
 private:
     // the common part of all ctors


@@ -496,16 +476,37 @@ private:
 
     void DeleteTextCtrl();
 
 
     void DeleteTextCtrl();
 

-    // support for additional item images
-    friend class wxTreeItemIndirectData;
+    // support for additional item images which we implement using
+    // wxTreeItemIndirectData technique - see the comments in msw/treectrl.cpp

     void SetIndirectItemData(const wxTreeItemId& item,
     void SetIndirectItemData(const wxTreeItemId& item,

-                             wxTreeItemIndirectData *data);
+                             class wxTreeItemIndirectData *data);

     bool HasIndirectData(const wxTreeItemId& item) const;
     bool HasIndirectData(const wxTreeItemId& item) const;

+    bool IsDataIndirect(wxTreeItemData *data) const
+        { return data && data->GetId().m_pItem == 0; }
+
+    // the hash storing the items attributes (indexed by item ids)
+    wxMapTreeAttr m_attrs;
+
+    // TRUE if the hash above is not empty
+    bool m_hasAnyAttr;
+
+    // used for dragging
+    wxDragImage *m_dragImage;

 
 

-    wxArrayTreeItemIds m_itemsWithIndirectData;
+    // Virtual root item, if wxTR_HIDE_ROOT is set.
+    void* m_pVirtualRoot;
+
+    // the starting item for selection with Shift
+    wxTreeItemId m_htSelStart;
+
+    friend class wxTreeItemIndirectData;
+    friend class wxTreeSortHelper;

 
     DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
 
     DECLARE_DYNAMIC_CLASS(wxTreeCtrl)

+    DECLARE_NO_COPY_CLASS(wxTreeCtrl)

 };
 
 };
 

+#endif // wxUSE_TREECTRL
+

 #endif
     // _WX_TREECTRL_H_
 #endif
     // _WX_TREECTRL_H_