introduced a common base class for both MSW and generic wxTreeCtrl implementations

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

diff --git a/include/wx/msw/treectrl.h b/include/wx/msw/treectrl.h
index c4c0fb04982916da379ae88d3609df418a0cbd3a..645731106babe0ff0c54e31c8ec3d1070bec0840 100644 (file)
--- a/include/wx/msw/treectrl.h
+++ b/include/wx/msw/treectrl.h
@@ -49,7 +49,7 @@ WX_DECLARE_EXPORTED_VOIDPTR_HASH_MAP(wxTreeItemAttr *, wxMapTreeAttr);
 // wxTreeCtrl
 // ----------------------------------------------------------------------------
 
 // wxTreeCtrl
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxTreeCtrl : public wxControl
+class WXDLLEXPORT wxTreeCtrl : public wxTreeCtrlBase

 {
 public:
     // creation
 {
 public:
     // creation


@@ -75,285 +75,114 @@ public:
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxTreeCtrlNameStr);
 
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxTreeCtrlNameStr);
 

-    // accessors
-    // ---------
-
-        // get the total number of items in the control
-    size_t GetCount() const;
-
-        // indent is the number of pixels the children are indented relative to
-        // the parents position. SetIndent() also redraws the control
-        // immediately.
-    unsigned int GetIndent() const;
-    void SetIndent(unsigned int indent);
-
-    // spacing is the number of pixels between the start and the Text
-        // not implemented under wxMSW
-    unsigned int GetSpacing() const { return 18; } // return wxGTK default
-    void SetSpacing(unsigned int WXUNUSED(spacing)) { }
-
-        // image list: these functions allow to associate an image list with
-        // the control and retrieve it. Note that the control does _not_ delete
-        // the associated image list when it's deleted in order to allow image
-        // lists to be shared between different controls.
-        //
-        // The normal image list is for the icons which correspond to the
-        // normal tree item state (whether it is selected or not).
-        // 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.
-    virtual wxImageList *GetImageList() const;
-    virtual wxImageList *GetStateImageList() const;
+    // implement base class pure virtuals
+    // ----------------------------------

 
 

-    virtual void SetImageList(wxImageList *imageList);
-    virtual void SetStateImageList(wxImageList *imageList);
-    virtual void AssignImageList(wxImageList *imageList);
-    virtual void AssignStateImageList(wxImageList *imageList);
+    virtual size_t GetCount() const;

 
 

-    // Functions to work with tree ctrl items. Unfortunately, they can _not_ be
-    // member functions of wxTreeItem because they must know the tree the item
-    // belongs to for Windows implementation and storing the pointer to
-    // wxTreeCtrl in each wxTreeItem is just too much waste.
+    virtual unsigned int GetIndent() const;
+    virtual void SetIndent(unsigned int indent);

 
 

-    // accessors
-    // ---------
+    virtual void SetImageList(wxImageList *imageList);
+    virtual void SetStateImageList(wxImageList *imageList);

 
 

-        // retrieve items label
-    wxString GetItemText(const wxTreeItemId& item) const;
-        // get one of the images associated with the item (normal by default)
+    virtual wxString GetItemText(const wxTreeItemId& item) const;

     virtual 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;
-
-        // 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;
+                        wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
+    virtual wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
+    virtual wxColour GetItemTextColour(const wxTreeItemId& item) const;
+    virtual wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
+    virtual wxFont GetItemFont(const wxTreeItemId& item) const;

 
 

-    // modifiers
-    // ---------
-
-        // set items label
-    void SetItemText(const wxTreeItemId& item, const wxString& text);
-        // get one of the images associated with the item (normal by default)
+    virtual void SetItemText(const wxTreeItemId& item, const wxString& text);

     virtual void SetItemImage(const wxTreeItemId& item, int image,
                       wxTreeItemIcon which = wxTreeItemIcon_Normal);
     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);
-
-        // force appearance of [+] button near the item. This is useful to
-        // 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);
-
-        // the item will be shown in bold
-    void SetItemBold(const wxTreeItemId& item, bool bold = 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);
+    virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
+    virtual void SetItemHasChildren(const wxTreeItemId& item, bool has = true);
+    virtual void SetItemBold(const wxTreeItemId& item, bool bold = true);
+    virtual void SetItemDropHighlight(const wxTreeItemId& item,
+                                      bool highlight = true);
+    virtual void SetItemTextColour(const wxTreeItemId& item,
+                                   const wxColour& col);
+    virtual void SetItemBackgroundColour(const wxTreeItemId& item,
+                                         const wxColour& col);
+    virtual void SetItemFont(const wxTreeItemId& item, const wxFont& font);

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

-        // is the item visible (it might be outside the view or not expanded)?
-    bool IsVisible(const wxTreeItemId& item) const;
-        // does the item has any children?
-    bool ItemHasChildren(const wxTreeItemId& item) const;
-        // is the item expanded (only makes sense if HasChildren())?
-    bool IsExpanded(const wxTreeItemId& item) const;
-        // is this item currently selected (the same as has focus)?
-    bool IsSelected(const wxTreeItemId& item) const;
-        // is item text in bold font?
-    bool IsBold(const wxTreeItemId& item) const;
-
-    // number of children
-    // ------------------
-
-        // 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,
-                            bool recursively = true) const;
+    virtual bool IsVisible(const wxTreeItemId& item) const;
+    virtual bool ItemHasChildren(const wxTreeItemId& item) const;
+    virtual bool IsExpanded(const wxTreeItemId& item) const;
+    virtual bool IsSelected(const wxTreeItemId& item) const;
+    virtual bool IsBold(const wxTreeItemId& item) const;
+
+    virtual size_t GetChildrenCount(const wxTreeItemId& item,
+                                    bool recursively = true) const;

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

-    // wxTreeItemId.IsOk() will return false if there is no such item
-
-        // get the root tree item
-    wxTreeItemId GetRootItem() const;
-
-        // get the item currently selected (may return NULL if no selection)
-    wxTreeItemId GetSelection() const;
-
-        // get the items currently selected, return the number of such item
-        //
-        // NB: this operation is expensive and can take a long time for a
-        //     control with a lot of items (~ O(number of items)).
-    size_t GetSelections(wxArrayTreeItemIds& selections) const;
-
-        // get the parent of this item (may return NULL if root)
-    wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
-
-        // for this enumeration function you must pass in a "cookie" parameter
-        // which is opaque for the application but is necessary for the library
-        // to make these functions reentrant (i.e. allow more than one
-        // enumeration on one and the same object simultaneously). Of course,
-        // the "cookie" passed to GetFirstChild() and GetNextChild() should be
-        // the same!
-
-        // get the first child of this item
-    wxTreeItemId GetFirstChild(const wxTreeItemId& item,
-                               wxTreeItemIdValue& cookie) const;
-        // get the next child
-    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 next sibling of this item
-    wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
-        // get the previous sibling
-    wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
-
-        // get first visible item
-    wxTreeItemId GetFirstVisibleItem() const;
-        // get the next visible item: item must be visible itself!
-        // see IsVisible() and wxTreeCtrl::GetFirstVisibleItem()
-    wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
-        // get the previous visible item: item must be visible itself!
-    wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
+    virtual wxTreeItemId GetRootItem() const;
+    virtual wxTreeItemId GetSelection() const;
+    virtual size_t GetSelections(wxArrayTreeItemIds& selections) const;
+
+    virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
+    virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
+                                       wxTreeItemIdValue& cookie) const;
+    virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,
+                                      wxTreeItemIdValue& cookie) const;
+    virtual wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
+
+    virtual wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
+    virtual wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
+
+    virtual wxTreeItemId GetFirstVisibleItem() const;
+    virtual wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
+    virtual wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;

 
     // operations
     // ----------
 
 
     // operations
     // ----------
 

-        // add the root node to the tree

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

+    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 in as the first child of the parent
-    virtual wxTreeItemId PrependItem(const wxTreeItemId& parent,
-                             const wxString& text,
-                             int image = -1, int selectedImage = -1,
-                             wxTreeItemData *data = NULL);
+    virtual void Delete(const wxTreeItemId& item);
+    virtual void DeleteChildren(const wxTreeItemId& item);
+    virtual void DeleteAllItems();

 
 

-        // insert a new item after a given one
-    virtual wxTreeItemId InsertItem(const wxTreeItemId& parent,
-                            const wxTreeItemId& idPrevious,
-                            const wxString& text,
-                            int image = -1, int selectedImage = -1,
-                            wxTreeItemData *data = NULL);
+    virtual void Expand(const wxTreeItemId& item);
+    virtual void Collapse(const wxTreeItemId& item);
+    virtual void CollapseAndReset(const wxTreeItemId& item);
+    virtual void Toggle(const wxTreeItemId& item);

 
 

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

 
 

-        // insert a new item in as the last child of the parent
-    virtual wxTreeItemId AppendItem(const wxTreeItemId& parent,
-                            const wxString& text,
-                            int image = -1, int selectedImage = -1,
-                            wxTreeItemData *data = NULL);
-
-        // delete this item and associated data if any
-    void Delete(const wxTreeItemId& item);
-        // delete all children (but don't delete the item itself)
-        // NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
-    void DeleteChildren(const wxTreeItemId& item);
-        // delete all items from the tree
-        // NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
-    void DeleteAllItems();
-
-        // expand this item
-    void Expand(const wxTreeItemId& item);
-        // collapse the item without removing its children
-    void Collapse(const wxTreeItemId& item);
-        // collapse the item and remove all children
-    void CollapseAndReset(const wxTreeItemId& item);
-        // toggles the current state
-    void Toggle(const wxTreeItemId& item);
-
-        // remove the selection from currently selected item (if any)
-    void Unselect();
-        // unselect all items (only makes sense for multiple selection control)
-    void UnselectAll();
-        // select this 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);
-        // scroll to this item (but don't expand its parent)
-    void ScrollTo(const wxTreeItemId& item);
-
-        // start editing the item label: this (temporarily) replaces the item
-        // with a one line edit control. The item will be selected if it hadn't
-        // been before. textCtrlClass parameter allows you to create an edit
-        // control of arbitrary user-defined class deriving from wxTextCtrl.
-    wxTextCtrl* EditLabel(const wxTreeItemId& item,
+    virtual void EnsureVisible(const wxTreeItemId& item);
+    virtual void ScrollTo(const wxTreeItemId& item);
+
+    virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,

                           wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
                           wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));

-        // returns the same pointer as StartEdit() if the item is being edited,
-        // NULL otherwise (it's assumed that no more than one item may be
-        // edited simultaneously)
-    wxTextCtrl* GetEditControl() const;
-        // end editing and accept or discard the changes to item label
-    void EndEditLabel(const wxTreeItemId& WXUNUSED(item),
-                      bool discardChanges = false)
+    virtual wxTextCtrl *GetEditControl() const;
+    virtual void EndEditLabel(const wxTreeItemId& WXUNUSED(item),
+                              bool discardChanges = false)

     {
         DoEndEditLabel(discardChanges);
     }
 
     {
         DoEndEditLabel(discardChanges);
     }
 

-    // sorting
-        // this function is called to compare 2 items and should return -1, 0
-        // or +1 if the first item is less than, equal to or greater than the
-        // second one. The base class version performs alphabetic comparaison
-        // of item labels (GetText)
-    virtual int OnCompareItems(const wxTreeItemId& item1,
-                               const wxTreeItemId& item2);
-        // sort the children of this item using OnCompareItems
-        //
-        // NB: this function is not reentrant and not MT-safe (FIXME)!
-    void SortChildren(const wxTreeItemId& item);
-
-    // helpers
-    // -------
-
-        // determine to which item (if any) belongs the given point (the
-        // coordinates specified are relative to the client area of tree ctrl)
-        // and fill the flags parameter with a bitmask of wxTREE_HITTEST_xxx
-        // constants.
-        //
-        // The first function is more portable (because easier to implement
-        // on other platforms), but the second one returns some extra info.
-    wxTreeItemId HitTest(const wxPoint& point)
-        { int dummy; return HitTest(point, dummy); }
-    wxTreeItemId HitTest(const wxPoint& point, int& flags);
-
-        // get the bounding rectangle of the item (or of its label only)
-    bool GetBoundingRect(const wxTreeItemId& item,
-                         wxRect& rect,
-                         bool textOnly = false) const;
+    virtual void SortChildren(const wxTreeItemId& item);
+
+    virtual bool GetBoundingRect(const wxTreeItemId& item,
+                                 wxRect& rect,
+                                 bool textOnly = false) const;

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


@@ -392,8 +221,6 @@ public:
     // implementation
     // --------------
 
     // implementation
     // --------------
 

-    virtual bool ShouldInheritColours() const { return false; }
-

     virtual wxVisualAttributes GetDefaultAttributes() const
     {
         return GetClassDefaultAttributes(GetWindowVariant());
     virtual wxVisualAttributes GetDefaultAttributes() const
     {
         return GetClassDefaultAttributes(GetWindowVariant());


@@ -421,9 +248,6 @@ public:
     int GetState(const wxTreeItemId& node);
 
 protected:
     int GetState(const wxTreeItemId& node);
 
 protected:

-    virtual wxSize DoGetBestSize() const;
-
-    

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


@@ -453,11 +277,17 @@ private:
 
     inline void DoExpand(const wxTreeItemId& item, int flag);
 
 
     inline void DoExpand(const wxTreeItemId& item, int flag);
 

-    wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
-                              wxTreeItemId hInsertAfter,
-                              const wxString& text,
-                              int image, int selectedImage,
-                              wxTreeItemData *data);
+    virtual wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
+                                      size_t pos,
+                                      const wxString& text,
+                                      int image, int selectedImage,
+                                      wxTreeItemData *data);
+    virtual wxTreeItemId DoInsertAfter(const wxTreeItemId& parent,
+                                       const wxTreeItemId& idPrevious,
+                                       const wxString& text,
+                                       int image = -1, int selImage = -1,
+                                       wxTreeItemData *data = NULL);
+    virtual wxTreeItemId DoHitTest(const wxPoint& point, int& flags);

 
     int DoGetItemImageFromData(const wxTreeItemId& item,
                                wxTreeItemIcon which) const;
 
     int DoGetItemImageFromData(const wxTreeItemId& item,
                                wxTreeItemIcon which) const;