///////////////////////////////////////////////////////////////////////////// // 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$ // Copyright: (c) Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_TREECTRL_H_ #define _WX_TREECTRL_H_ // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- #if wxUSE_TREECTRL #include "wx/textctrl.h" #include "wx/dynarray.h" #include "wx/treebase.h" #include "wx/hashmap.h" #ifdef __GNUWIN32__ // Cygwin windows.h defines these identifiers #undef GetFirstChild #undef GetNextSibling #endif // Cygwin // fwd decl class WXDLLEXPORT wxImageList; class WXDLLEXPORT wxDragImage; struct WXDLLEXPORT wxTreeViewItem; #if WXWIN_COMPATIBILITY_2_6 // NB: all the following flags are for compatbility only and will be removed in the // next versions // 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 #endif // hash storing attributes for our items WX_DECLARE_EXPORTED_VOIDPTR_HASH_MAP(wxTreeItemAttr *, wxMapTreeAttr); // ---------------------------------------------------------------------------- // wxTreeCtrl // ---------------------------------------------------------------------------- class WXDLLEXPORT wxTreeCtrl : public wxTreeCtrlBase { public: // creation // -------- wxTreeCtrl() { Init(); } 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 wxValidator& validator = wxDefaultValidator, const wxString& name = wxTreeCtrlNameStr) { Create(parent, id, pos, size, style, validator, name); } virtual ~wxTreeCtrl(); 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 wxValidator& validator = wxDefaultValidator, const wxString& name = wxTreeCtrlNameStr); // implement base class pure virtuals // ---------------------------------- virtual unsigned int GetCount() const; virtual unsigned int GetIndent() const; virtual void SetIndent(unsigned int indent); virtual void SetImageList(wxImageList *imageList); virtual void SetStateImageList(wxImageList *imageList); virtual wxString GetItemText(const wxTreeItemId& item) const; virtual int GetItemImage(const wxTreeItemId& item, 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; virtual void SetItemText(const wxTreeItemId& item, const wxString& text); virtual void SetItemImage(const wxTreeItemId& item, int image, wxTreeItemIcon which = wxTreeItemIcon_Normal); 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 // --------------------- 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 // ---------- 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 // ---------- virtual wxTreeItemId AddRoot(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(); virtual void Expand(const wxTreeItemId& item); virtual void Collapse(const wxTreeItemId& item); virtual void CollapseAndReset(const wxTreeItemId& item); virtual void Toggle(const wxTreeItemId& item); virtual void Unselect(); virtual void UnselectAll(); virtual void SelectItem(const wxTreeItemId& item, bool select = true); virtual void EnsureVisible(const wxTreeItemId& item); virtual void ScrollTo(const wxTreeItemId& item); virtual wxTextCtrl *EditLabel(const wxTreeItemId& item, wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl)); virtual wxTextCtrl *GetEditControl() const; virtual void EndEditLabel(const wxTreeItemId& WXUNUSED(item), bool discardChanges = false) { DoEndEditLabel(discardChanges); } virtual void SortChildren(const wxTreeItemId& item); virtual bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect, bool textOnly = false) const; // deprecated // ---------- #if WXWIN_COMPATIBILITY_2_4 // these methods are deprecated and will be removed in future versions of // 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 wxDEPRECATED( void ExpandItem(const wxTreeItemId& item, int action) ); // use Set/GetImageList and Set/GetStateImageList // Use base class GetImageList() wxDEPRECATED( void SetImageList(wxImageList *imageList, int) ); // use Set/GetItemImage directly wxDEPRECATED( int GetItemSelectedImage(const wxTreeItemId& item) const ); wxDEPRECATED( void SetItemSelectedImage(const wxTreeItemId& item, int image) ); // 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 // -------------- 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 WXLRESULT MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); 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); // 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); // refresh a single item void RefreshItem(const wxTreeItemId& item); // end edit label void DoEndEditLabel(bool discardChanges = false); // 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 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 DoTreeHitTest(const wxPoint& point, int& flags); private: // the common part of all ctors void Init(); // helper functions inline bool DoGetItem(wxTreeViewItem *tvItem) const; inline void DoSetItem(wxTreeViewItem *tvItem); inline void DoExpand(const wxTreeItemId& item, int flag); int DoGetItemImageFromData(const wxTreeItemId& item, wxTreeItemIcon which) const; void DoSetItemImageFromData(const wxTreeItemId& item, int image, wxTreeItemIcon which) const; void DoSetItemImages(const wxTreeItemId& item, int image, int imageSel); void DeleteTextCtrl(); // support for additional item images which we implement using // wxTreeItemIndirectData technique - see the comments in msw/treectrl.cpp void SetIndirectItemData(const wxTreeItemId& item, class wxTreeItemIndirectData *data); 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; // Virtual root item, if wxTR_HIDE_ROOT is set. void* m_pVirtualRoot; // the starting item for selection with Shift wxTreeItemId m_htSelStart, m_htClickedItem; wxPoint m_ptClick; friend class wxTreeItemIndirectData; friend class wxTreeSortHelper; DECLARE_DYNAMIC_CLASS(wxTreeCtrl) DECLARE_NO_COPY_CLASS(wxTreeCtrl) }; #endif // wxUSE_TREECTRL #endif // _WX_TREECTRL_H_