]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/treectrl.h
activating DrawRectangle optimization
[wxWidgets.git] / include / wx / msw / treectrl.h
index 905c330c7f2ee9b1b73d661d729afd8c4a4400a8..2be605fa2f7ea87448ec3d4f9dc0dbcc55995bb3 100644 (file)
@@ -30,9 +30,9 @@
 #endif // Cygwin
 
 // fwd decl
 #endif // Cygwin
 
 // fwd decl
-class  WXDLLEXPORT wxImageList;
-class  WXDLLEXPORT wxDragImage;
-struct WXDLLEXPORT wxTreeViewItem;
+class  WXDLLIMPEXP_FWD_CORE wxImageList;
+class  WXDLLIMPEXP_FWD_CORE wxDragImage;
+struct WXDLLIMPEXP_FWD_CORE wxTreeViewItem;
 
 #if WXWIN_COMPATIBILITY_2_6
     // NB: all the following flags are for compatbility only and will be removed in the
 
 #if WXWIN_COMPATIBILITY_2_6
     // NB: all the following flags are for compatbility only and will be removed in the
@@ -50,7 +50,7 @@ WX_DECLARE_EXPORTED_VOIDPTR_HASH_MAP(wxTreeItemAttr *, wxMapTreeAttr);
 // wxTreeCtrl
 // ----------------------------------------------------------------------------
 
 // wxTreeCtrl
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxTreeCtrl : public wxTreeCtrlBase
+class WXDLLIMPEXP_CORE wxTreeCtrl : public wxTreeCtrlBase
 {
 public:
     // creation
 {
 public:
     // creation
@@ -127,6 +127,11 @@ public:
     virtual wxTreeItemId GetRootItem() const;
     virtual wxTreeItemId GetSelection() const;
     virtual size_t GetSelections(wxArrayTreeItemIds& selections) const;
     virtual wxTreeItemId GetRootItem() const;
     virtual wxTreeItemId GetSelection() const;
     virtual size_t GetSelections(wxArrayTreeItemIds& selections) const;
+    virtual wxTreeItemId GetFocusedItem() const;
+
+    virtual void ClearFocusedItem();
+    virtual void SetFocusedItem(const wxTreeItemId& item);
+
 
     virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
     virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
 
     virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
     virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
@@ -161,12 +166,13 @@ public:
     virtual void Unselect();
     virtual void UnselectAll();
     virtual void SelectItem(const wxTreeItemId& item, bool select = true);
     virtual void Unselect();
     virtual void UnselectAll();
     virtual void SelectItem(const wxTreeItemId& item, bool select = true);
+    virtual void SelectChildren(const wxTreeItemId& parent);
 
     virtual void EnsureVisible(const wxTreeItemId& item);
     virtual void ScrollTo(const wxTreeItemId& item);
 
     virtual 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 = wxCLASSINFO(wxTextCtrl));
     virtual wxTextCtrl *GetEditControl() const;
     virtual void EndEditLabel(const wxTreeItemId& WXUNUSED(item),
                               bool discardChanges = false)
     virtual wxTextCtrl *GetEditControl() const;
     virtual void EndEditLabel(const wxTreeItemId& WXUNUSED(item),
                               bool discardChanges = false)
@@ -202,15 +208,14 @@ public:
     virtual bool SetBackgroundColour(const wxColour &colour);
     virtual bool SetForegroundColour(const wxColour &colour);
 
     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);
-
-    // 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);
+    // returns true if the platform should explicitly apply a theme border
+    virtual bool CanApplyThemeBorder() const { return false; }
 
 protected:
 
 protected:
+    // Implement "update locking" in a custom way for this control.
+    virtual void DoFreeze();
+    virtual void DoThaw();
+
     // SetImageList helper
     void SetAnyImageList(wxImageList *imageList, int which);
 
     // SetImageList helper
     void SetAnyImageList(wxImageList *imageList, int which);
 
@@ -220,6 +225,9 @@ protected:
     // end edit label
     void DoEndEditLabel(bool discardChanges = false);
 
     // end edit label
     void DoEndEditLabel(bool discardChanges = false);
 
+    virtual int DoGetItemState(const wxTreeItemId& item) const;
+    virtual void DoSetItemState(const wxTreeItemId& item, int state);
+
     virtual wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
                                       size_t pos,
                                       const wxString& text,
     virtual wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
                                       size_t pos,
                                       const wxString& text,
@@ -235,6 +243,28 @@ protected:
     // obtain the user data for the lParam member of TV_ITEM
     class wxTreeItemParam *GetItemParam(const wxTreeItemId& item) const;
 
     // obtain the user data for the lParam member of TV_ITEM
     class wxTreeItemParam *GetItemParam(const wxTreeItemId& item) const;
 
+    // update the event to include the items client data and pass it to
+    // HandleWindowEvent(), return true if it processed it
+    bool HandleTreeEvent(wxTreeEvent& event) const;
+
+    // pass the event to HandleTreeEvent() and return true if the event was
+    // either unprocessed or not vetoed
+    bool IsTreeEventAllowed(wxTreeEvent& event) const
+    {
+        return !HandleTreeEvent(event) || event.IsAllowed();
+    }
+
+    // generate a wxEVT_KEY_DOWN event from the specified WPARAM/LPARAM values
+    // having the same meaning as for WM_KEYDOWN, return true if it was
+    // processed
+    bool MSWHandleTreeKeyDownEvent(WXWPARAM wParam, WXLPARAM lParam);
+
+    // handle a key event in a multi-selection control, should be only called
+    // for keys which can be used to change the selection
+    //
+    // return true if the key was processed, false otherwise
+    bool MSWHandleSelectionKey(unsigned vkey);
+
 
     // data used only while editing the item label:
     wxTextCtrl  *m_textCtrl;        // text control in which it is edited
 
     // data used only while editing the item label:
     wxTextCtrl  *m_textCtrl;        // text control in which it is edited
@@ -250,6 +280,13 @@ private:
 
     void DoExpand(const wxTreeItemId& item, int flag);
 
 
     void DoExpand(const wxTreeItemId& item, int flag);
 
+    void DoSelectItem(const wxTreeItemId& item, bool select = true);
+    void DoUnselectItem(const wxTreeItemId& item);
+    void DoToggleItemSelection(const wxTreeItemId& item);
+
+    void DoUnselectAll();
+    void DoSelectChildren(const wxTreeItemId& parent);
+
     void DeleteTextCtrl();
 
     // return true if the item is the hidden root one (i.e. it's the root item
     void DeleteTextCtrl();
 
     // return true if the item is the hidden root one (i.e. it's the root item
@@ -257,14 +294,24 @@ private:
     bool IsHiddenRoot(const wxTreeItemId& item) const;
 
 
     bool IsHiddenRoot(const wxTreeItemId& item) const;
 
 
+    // check if the given flags (taken from TV_HITTESTINFO structure)
+    // indicate a position "on item": this is less trivial than just checking
+    // for TVHT_ONITEM because we consider that points to the left and right of
+    // item text are also "on item" when wxTR_FULL_ROW_HIGHLIGHT is used as the
+    // item visually spans the entire breadth of the window then
+    bool MSWIsOnItem(unsigned flags) const;
+
+
     // the hash storing the items attributes (indexed by item ids)
     wxMapTreeAttr m_attrs;
 
     // true if the hash above is not empty
     bool m_hasAnyAttr;
 
     // the hash storing the items attributes (indexed by item ids)
     wxMapTreeAttr m_attrs;
 
     // true if the hash above is not empty
     bool m_hasAnyAttr;
 
+#if wxUSE_DRAGIMAGE
     // used for dragging
     wxDragImage *m_dragImage;
     // used for dragging
     wxDragImage *m_dragImage;
+#endif
 
     // Virtual root item, if wxTR_HIDE_ROOT is set.
     void* m_pVirtualRoot;
 
     // Virtual root item, if wxTR_HIDE_ROOT is set.
     void* m_pVirtualRoot;
@@ -273,11 +320,27 @@ private:
     wxTreeItemId m_htSelStart, m_htClickedItem;
     wxPoint m_ptClick;
 
     wxTreeItemId m_htSelStart, m_htClickedItem;
     wxPoint m_ptClick;
 
+    // whether dragging has started
+    bool m_dragStarted;
+
+    // whether focus was lost between subsequent clicks of a single item
+    bool m_focusLost;
+
+    // set when we are changing selection ourselves (only used in multi
+    // selection mode)
+    bool m_changingSelection;
+
+    // whether we need to trigger a state image click event
+    bool m_triggerStateImageClick;
+
+    // whether we need to deselect other items on mouse up
+    bool m_mouseUpDeselect;
+
     friend class wxTreeItemIndirectData;
     friend class wxTreeSortHelper;
 
     DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
     friend class wxTreeItemIndirectData;
     friend class wxTreeSortHelper;
 
     DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
-    DECLARE_NO_COPY_CLASS(wxTreeCtrl)
+    wxDECLARE_NO_COPY_CLASS(wxTreeCtrl);
 };
 
 #endif // wxUSE_TREECTRL
 };
 
 #endif // wxUSE_TREECTRL