IS_HATCH macro replaced with wxBrush::IsHatch() + source and docs little cleaning.

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

diff --git a/include/wx/msw/treectrl.h b/include/wx/msw/treectrl.h
index 2d2e4ff563ff62e6f1612bd3045ed2d9257e0fec..9667717cefe26e78be360ab1b046e19e0fac87d5 100644 (file)
--- a/include/wx/msw/treectrl.h
+++ b/include/wx/msw/treectrl.h
@@ -16,7 +16,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

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

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


@@ -25,6 +25,7 @@
 #include "wx/textctrl.h"
 #include "wx/dynarray.h"
 #include "wx/treebase.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


@@ -32,19 +33,11 @@
     #undef GetNextSibling
 #endif // Cygwin
 
     #undef GetNextSibling
 #endif // Cygwin
 

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

 // fwd decl
 class  WXDLLEXPORT wxImageList;
 class  WXDLLEXPORT wxDragImage;
 struct WXDLLEXPORT wxTreeViewItem;
 
 // fwd decl
 class  WXDLLEXPORT wxImageList;
 class  WXDLLEXPORT wxDragImage;
 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;
-

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


@@ -57,13 +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
 

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


@@ -71,7 +69,7 @@ public:
     // --------
     wxTreeCtrl() { Init(); }
 
     // --------
     wxTreeCtrl() { Init(); }
 

-    wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
+    wxTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,

                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,


@@ -83,7 +81,7 @@ public:
 
     virtual ~wxTreeCtrl();
 
 
     virtual ~wxTreeCtrl();
 

-    bool Create(wxWindow *parent, wxWindowID id = -1,
+    bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,


@@ -117,13 +115,13 @@ public:
         // Additionally, the application might choose to show a state icon
         // which corresponds to an app-defined item state (for example,
         // checked/unchecked) which are taken from the state image list.
         // Additionally, the application might choose to show a state icon
         // which corresponds to an app-defined item state (for example,
         // checked/unchecked) which are taken from the state image list.

-    wxImageList *GetImageList() const;
-    wxImageList *GetStateImageList() const;
+    virtual wxImageList *GetImageList() const;
+    virtual wxImageList *GetStateImageList() const;

 
 

-    void SetImageList(wxImageList *imageList);
-    void SetStateImageList(wxImageList *imageList);
-    void AssignImageList(wxImageList *imageList);
-    void AssignStateImageList(wxImageList *imageList);
+    virtual void SetImageList(wxImageList *imageList);
+    virtual void SetStateImageList(wxImageList *imageList);
+    virtual void AssignImageList(wxImageList *imageList);
+    virtual 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


@@ -136,7 +134,7 @@ public:
         // retrieve items label
     wxString GetItemText(const wxTreeItemId& item) const;
         // get one of the images associated with the item (normal by default)
         // retrieve items label
     wxString GetItemText(const wxTreeItemId& item) const;
         // get one of the images associated with the item (normal by default)

-    int GetItemImage(const wxTreeItemId& item,
+    virtual int GetItemImage(const wxTreeItemId& item,

                      wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
         // get the data associated with the item
     wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
                      wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
         // get the data associated with the item
     wxTreeItemData *GetItemData(const wxTreeItemId& item) const;


@@ -156,7 +154,7 @@ public:
         // set items label
     void SetItemText(const wxTreeItemId& item, const wxString& text);
         // get one of the images associated with the item (normal by default)
         // set items label
     void SetItemText(const wxTreeItemId& item, const wxString& text);
         // get one of the images associated with the item (normal by default)

-    void SetItemImage(const wxTreeItemId& item, int image,
+    virtual void SetItemImage(const wxTreeItemId& item, int image,

                       wxTreeItemIcon which = wxTreeItemIcon_Normal);
         // associate some data with the item
     void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
                       wxTreeItemIcon which = wxTreeItemIcon_Normal);
         // associate some data with the item
     void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);


@@ -165,13 +163,13 @@ public:
         // allow the user to expand the items which don't have any children now
         // - but instead add them only when needed, thus minimizing memory
         // usage and loading time.
         // allow the user to expand the items which don't have any children now
         // - but instead add them only when needed, thus minimizing memory
         // usage and loading time.

-    void SetItemHasChildren(const wxTreeItemId& item, bool has = TRUE);
+    void SetItemHasChildren(const wxTreeItemId& item, bool has = true);

 
         // the item will be shown in bold
 
         // the item will be shown in bold

-    void SetItemBold(const wxTreeItemId& item, bool bold = TRUE);
+    void SetItemBold(const wxTreeItemId& item, bool bold = true);

 
         // the item will be shown with a drop highlight
 
         // the item will be shown with a drop highlight

-    void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = TRUE);
+    void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = true);

 
         // set the items text colour
     void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
 
         // set the items text colour
     void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);


@@ -199,15 +197,15 @@ public:
     // number of children
     // ------------------
 
     // number of children
     // ------------------
 

-        // if 'recursively' is FALSE, only immediate children count, otherwise
+        // if 'recursively' is false, only immediate children count, otherwise

         // the returned number is the number of all items in this branch
     size_t GetChildrenCount(const wxTreeItemId& item,
         // the returned number is the number of all items in this branch
     size_t GetChildrenCount(const wxTreeItemId& item,

-                            bool recursively = TRUE) const;
+                            bool recursively = true) const;

 
     // navigation
     // ----------
 
 
     // navigation
     // ----------
 

-    // wxTreeItemId.IsOk() will return FALSE if there is no such item
+    // wxTreeItemId.IsOk() will return false if there is no such item

 
         // get the root tree item
     wxTreeItemId GetRootItem() const;
 
         // get the root tree item
     wxTreeItemId GetRootItem() const;


@@ -227,9 +225,9 @@ public:
 #if WXWIN_COMPATIBILITY_2_2
         // deprecated:  Use GetItemParent instead.
     wxTreeItemId GetParent(const wxTreeItemId& item) const
 #if WXWIN_COMPATIBILITY_2_2
         // deprecated:  Use GetItemParent instead.
     wxTreeItemId GetParent(const wxTreeItemId& item) const

-       { return GetItemParent( item ); }
+        { return GetItemParent( item ); }

 
 

-       // Expose the base class method hidden by the one above.
+        // Expose the base class method hidden by the one above.

     wxWindow *GetParent() const { return wxControl::GetParent(); }
 #endif  // WXWIN_COMPATIBILITY_2_2
 
     wxWindow *GetParent() const { return wxControl::GetParent(); }
 #endif  // WXWIN_COMPATIBILITY_2_2
 


@@ -241,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;
 


@@ -264,32 +264,32 @@ public:
     // ----------
 
         // add the root node to the tree
     // ----------
 
         // add the root node to the tree

-    wxTreeItemId AddRoot(const wxString& text,
+    virtual wxTreeItemId AddRoot(const wxString& text,

                          int image = -1, int selectedImage = -1,
                          wxTreeItemData *data = NULL);
 
         // insert a new item in as the first child of the parent
                          int image = -1, int selectedImage = -1,
                          wxTreeItemData *data = NULL);
 
         // insert a new item in as the first child of the parent

-    wxTreeItemId PrependItem(const wxTreeItemId& parent,
+    virtual wxTreeItemId PrependItem(const wxTreeItemId& parent,

                              const wxString& text,
                              int image = -1, int selectedImage = -1,
                              wxTreeItemData *data = NULL);
 
         // insert a new item after a given one
                              const wxString& text,
                              int image = -1, int selectedImage = -1,
                              wxTreeItemData *data = NULL);
 
         // insert a new item after a given one

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

                             const wxTreeItemId& idPrevious,
                             const wxString& text,
                             int image = -1, int selectedImage = -1,
                             wxTreeItemData *data = NULL);
 
         // insert a new item before the one with the given index
                             const wxTreeItemId& idPrevious,
                             const wxString& text,
                             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,
+    virtual 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
                             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,
+    virtual wxTreeItemId AppendItem(const wxTreeItemId& parent,

                             const wxString& text,
                             int image = -1, int selectedImage = -1,
                             wxTreeItemData *data = NULL);
                             const wxString& text,
                             int image = -1, int selectedImage = -1,
                             wxTreeItemData *data = NULL);


@@ -317,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);


@@ -335,7 +340,7 @@ public:
         // edited simultaneously)
     wxTextCtrl* GetEditControl() const;
         // end editing and accept or discard the changes to item label
         // edited simultaneously)
     wxTextCtrl* GetEditControl() const;
         // end editing and accept or discard the changes to item label

-    void EndEditLabel(const wxTreeItemId& item, bool discardChanges = FALSE);
+    void EndEditLabel(const wxTreeItemId& item, bool discardChanges = false);

 
     // sorting
         // this function is called to compare 2 items and should return -1, 0
 
     // sorting
         // this function is called to compare 2 items and should return -1, 0


@@ -366,43 +371,59 @@ public:
         // get the bounding rectangle of the item (or of its label only)
     bool GetBoundingRect(const wxTreeItemId& item,
                          wxRect& rect,
         // get the bounding rectangle of the item (or of its label only)
     bool GetBoundingRect(const wxTreeItemId& item,
                          wxRect& rect,

-                         bool textOnly = FALSE) const;
+                         bool textOnly = false) const;

 
     // deprecated
     // ----------
 
 
     // deprecated
     // ----------
 

+#if WXWIN_COMPATIBILITY_2_4

     // these methods are deprecated and will be removed in future versions of
     // 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
+    // wxWidgets, 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
     // 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 long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+    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);
 


@@ -412,7 +433,11 @@ public:
 
     // get/set the check state for the item (only for wxTR_MULTIPLE)
     bool IsItemChecked(const wxTreeItemId& item) const;
 
     // 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);
+    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
 
 protected:
     // SetImageList helper


@@ -421,10 +446,14 @@ protected:
     // refresh a single item
     void RefreshItem(const wxTreeItemId& item);
 
     // refresh a single item
     void RefreshItem(const wxTreeItemId& item);
 

-    wxTextCtrl  *m_textCtrl;        // used while editing the item label
+    // data used only while editing the item label:
+    wxTextCtrl  *m_textCtrl;        // text control in which it is edited
+    wxTreeItemId m_idEdited;        // the item being edited
+

     wxImageList *m_imageListNormal, // images for tree elements
                 *m_imageListState;  // special images for app defined states
     wxImageList *m_imageListNormal, // images for tree elements
                 *m_imageListState;  // special images for app defined states

-    bool         m_ownsImageListNormal, m_ownsImageListState;
+    bool         m_ownsImageListNormal,
+                 m_ownsImageListState;

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


@@ -459,10 +488,10 @@ private:
     bool IsDataIndirect(wxTreeItemData *data) const
         { return data && data->GetId().m_pItem == 0; }
 
     bool IsDataIndirect(wxTreeItemData *data) const
         { return data && data->GetId().m_pItem == 0; }
 

-    // the hash storing the items attributes (indexed by items ids)
-    wxHashTable m_attrs;
+    // the hash storing the items attributes (indexed by item ids)
+    wxMapTreeAttr m_attrs;

 
 

-    // TRUE if the hash above is not empty
+    // true if the hash above is not empty

     bool m_hasAnyAttr;
 
     // used for dragging
     bool m_hasAnyAttr;
 
     // used for dragging


@@ -472,7 +501,7 @@ private:
     void* m_pVirtualRoot;
 
     // the starting item for selection with Shift
     void* m_pVirtualRoot;
 
     // the starting item for selection with Shift

-    WXHTREEITEM m_htSelStart;
+    wxTreeItemId m_htSelStart;

 
     friend class wxTreeItemIndirectData;
     friend class wxTreeSortHelper;
 
     friend class wxTreeItemIndirectData;
     friend class wxTreeSortHelper;