include/wx/msw/treectrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/treectrl.h
   3 // Purpose:     wxTreeCtrl class
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin to be less MSW-specific on 10/10/98
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_TREECTRL_H_
  13 #define _WX_TREECTRL_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #if wxUSE_TREECTRL
  20
  21 #include "wx/textctrl.h"
  22 #include "wx/dynarray.h"
  23 #include "wx/treebase.h"
  24 #include "wx/hashmap.h"
  25
  26 #ifdef __GNUWIN32__
  27     // Cygwin windows.h defines these identifiers
  28     #undef GetFirstChild
  29     #undef GetNextSibling
  30 #endif // Cygwin
  31
  32 // fwd decl
  33 class  WXDLLEXPORT wxImageList;
  34 class  WXDLLEXPORT wxDragImage;
  35 struct WXDLLEXPORT wxTreeViewItem;
  36
  37 // NB: all the following flags are for compatbility only and will be removed in the
  38 //     next versions
  39
  40 // flags for deprecated InsertItem() variant (their values are the same as of
  41 // TVI_FIRST and TVI_LAST)
  42 #define wxTREE_INSERT_FIRST 0xFFFF0001
  43 #define wxTREE_INSERT_LAST  0xFFFF0002
  44
  45 // hash storing attributes for our items
  46 WX_DECLARE_EXPORTED_VOIDPTR_HASH_MAP(wxTreeItemAttr *, wxMapTreeAttr);
  47
  48 // ----------------------------------------------------------------------------
  49 // wxTreeCtrl
  50 // ----------------------------------------------------------------------------
  51
  52 class WXDLLEXPORT wxTreeCtrl : public wxTreeCtrlBase
  53 {
  54 public:
  55     // creation
  56     // --------
  57     wxTreeCtrl() { Init(); }
  58
  59     wxTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
  60                const wxPoint& pos = wxDefaultPosition,
  61                const wxSize& size = wxDefaultSize,
  62                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
  63                const wxValidator& validator = wxDefaultValidator,
  64                const wxString& name = wxTreeCtrlNameStr)
  65     {
  66         Create(parent, id, pos, size, style, validator, name);
  67     }
  68
  69     virtual ~wxTreeCtrl();
  70
  71     bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
  72                 const wxPoint& pos = wxDefaultPosition,
  73                 const wxSize& size = wxDefaultSize,
  74                 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
  75                 const wxValidator& validator = wxDefaultValidator,
  76                 const wxString& name = wxTreeCtrlNameStr);
  77
  78     // implement base class pure virtuals
  79     // ----------------------------------
  80
  81     virtual size_t GetCount() const;
  82
  83     virtual unsigned int GetIndent() const;
  84     virtual void SetIndent(unsigned int indent);
  85
  86     virtual void SetImageList(wxImageList *imageList);
  87     virtual void SetStateImageList(wxImageList *imageList);
  88
  89     virtual wxString GetItemText(const wxTreeItemId& item) const;
  90     virtual int GetItemImage(const wxTreeItemId& item,
  91                         wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
  92     virtual wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
  93     virtual wxColour GetItemTextColour(const wxTreeItemId& item) const;
  94     virtual wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
  95     virtual wxFont GetItemFont(const wxTreeItemId& item) const;
  96
  97     virtual void SetItemText(const wxTreeItemId& item, const wxString& text);
  98     virtual void SetItemImage(const wxTreeItemId& item, int image,
  99                       wxTreeItemIcon which = wxTreeItemIcon_Normal);
 100     virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
 101     virtual void SetItemHasChildren(const wxTreeItemId& item, bool has = true);
 102     virtual void SetItemBold(const wxTreeItemId& item, bool bold = true);
 103     virtual void SetItemDropHighlight(const wxTreeItemId& item,
 104                                       bool highlight = true);
 105     virtual void SetItemTextColour(const wxTreeItemId& item,
 106                                    const wxColour& col);
 107     virtual void SetItemBackgroundColour(const wxTreeItemId& item,
 108                                          const wxColour& col);
 109     virtual void SetItemFont(const wxTreeItemId& item, const wxFont& font);
 110
 111     // item status inquiries
 112     // ---------------------
 113
 114     virtual bool IsVisible(const wxTreeItemId& item) const;
 115     virtual bool ItemHasChildren(const wxTreeItemId& item) const;
 116     virtual bool IsExpanded(const wxTreeItemId& item) const;
 117     virtual bool IsSelected(const wxTreeItemId& item) const;
 118     virtual bool IsBold(const wxTreeItemId& item) const;
 119
 120     virtual size_t GetChildrenCount(const wxTreeItemId& item,
 121                                     bool recursively = true) const;
 122
 123     // navigation
 124     // ----------
 125
 126     virtual wxTreeItemId GetRootItem() const;
 127     virtual wxTreeItemId GetSelection() const;
 128     virtual size_t GetSelections(wxArrayTreeItemIds& selections) const;
 129
 130     virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
 131     virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
 132                                        wxTreeItemIdValue& cookie) const;
 133     virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,
 134                                       wxTreeItemIdValue& cookie) const;
 135     virtual wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
 136
 137     virtual wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
 138     virtual wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
 139
 140     virtual wxTreeItemId GetFirstVisibleItem() const;
 141     virtual wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
 142     virtual wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
 143
 144     // operations
 145     // ----------
 146
 147     virtual wxTreeItemId AddRoot(const wxString& text,
 148                          int image = -1, int selectedImage = -1,
 149                          wxTreeItemData *data = NULL);
 150     virtual wxTreeItemId InsertItem(const wxTreeItemId& parent,
 151                                     const wxTreeItemId& idPrevious,
 152                                     const wxString& text,
 153                                     int image = -1, int selectedImage = -1,
 154                                     wxTreeItemData *data = NULL);
 155
 156     virtual void Delete(const wxTreeItemId& item);
 157     virtual void DeleteChildren(const wxTreeItemId& item);
 158     virtual void DeleteAllItems();
 159
 160     virtual void Expand(const wxTreeItemId& item);
 161     virtual void Collapse(const wxTreeItemId& item);
 162     virtual void CollapseAndReset(const wxTreeItemId& item);
 163     virtual void Toggle(const wxTreeItemId& item);
 164
 165     virtual void Unselect();
 166     virtual void UnselectAll();
 167     virtual void SelectItem(const wxTreeItemId& item, bool select = true);
 168
 169     virtual void EnsureVisible(const wxTreeItemId& item);
 170     virtual void ScrollTo(const wxTreeItemId& item);
 171
 172     virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
 173                           wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
 174     virtual wxTextCtrl *GetEditControl() const;
 175     virtual void EndEditLabel(const wxTreeItemId& WXUNUSED(item),
 176                               bool discardChanges = false)
 177     {
 178         DoEndEditLabel(discardChanges);
 179     }
 180
 181     virtual void SortChildren(const wxTreeItemId& item);
 182
 183     virtual bool GetBoundingRect(const wxTreeItemId& item,
 184                                  wxRect& rect,
 185                                  bool textOnly = false) const;
 186
 187     // deprecated
 188     // ----------
 189
 190 #if WXWIN_COMPATIBILITY_2_4
 191     // these methods are deprecated and will be removed in future versions of
 192     // wxWidgets, they're here for compatibility only, don't use them in new
 193     // code (the comments indicate why these methods are now useless and how to
 194     // replace them)
 195
 196         // use Expand, Collapse, CollapseAndReset or Toggle
 197     wxDEPRECATED( void ExpandItem(const wxTreeItemId& item, int action) );
 198
 199         // use AddRoot, PrependItem or AppendItem
 200     wxDEPRECATED( wxTreeItemId InsertItem(const wxTreeItemId& parent,
 201                             const wxString& text,
 202                             int image = -1, int selImage = -1,
 203                             long insertAfter = wxTREE_INSERT_LAST) );
 204
 205         // use Set/GetImageList and Set/GetStateImageList
 206     wxDEPRECATED( wxImageList *GetImageList(int) const );
 207     wxDEPRECATED( void SetImageList(wxImageList *imageList, int) );
 208
 209     // use Set/GetItemImage directly
 210     wxDEPRECATED( int GetItemSelectedImage(const wxTreeItemId& item) const );
 211     wxDEPRECATED( void SetItemSelectedImage(const wxTreeItemId& item, int image) );
 212
 213     // use the versions taking wxTreeItemIdValue cookies
 214     wxDEPRECATED( wxTreeItemId GetFirstChild(const wxTreeItemId& item,
 215                                              long& cookie) const );
 216     wxDEPRECATED( wxTreeItemId GetNextChild(const wxTreeItemId& item,
 217                                             long& cookie) const );
 218 #endif // WXWIN_COMPATIBILITY_2_4
 219
 220
 221     // implementation
 222     // --------------
 223
 224     virtual wxVisualAttributes GetDefaultAttributes() const
 225     {
 226         return GetClassDefaultAttributes(GetWindowVariant());
 227     }
 228
 229     static wxVisualAttributes
 230     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 231
 232
 233     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 234     virtual WXLRESULT MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 235     virtual bool MSWCommand(WXUINT param, WXWORD id);
 236     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 237
 238     // override some base class virtuals
 239     virtual bool SetBackgroundColour(const wxColour &colour);
 240     virtual bool SetForegroundColour(const wxColour &colour);
 241
 242     // get/set the check state for the item (only for wxTR_MULTIPLE)
 243     bool IsItemChecked(const wxTreeItemId& item) const;
 244     void SetItemCheck(const wxTreeItemId& item, bool check = true);
 245
 246     // set/get the item state.image (state == -1 means cycle to the next one)
 247     void SetState(const wxTreeItemId& node, int state);
 248     int GetState(const wxTreeItemId& node);
 249
 250 protected:
 251     // SetImageList helper
 252     void SetAnyImageList(wxImageList *imageList, int which);
 253
 254     // refresh a single item
 255     void RefreshItem(const wxTreeItemId& item);
 256
 257     // end edit label
 258     void DoEndEditLabel(bool discardChanges = false);
 259
 260
 261     // data used only while editing the item label:
 262     wxTextCtrl  *m_textCtrl;        // text control in which it is edited
 263     wxTreeItemId m_idEdited;        // the item being edited
 264
 265     wxImageList *m_imageListNormal, // images for tree elements
 266                 *m_imageListState;  // special images for app defined states
 267     bool         m_ownsImageListNormal,
 268                  m_ownsImageListState;
 269
 270 private:
 271     // the common part of all ctors
 272     void Init();
 273
 274     // helper functions
 275     inline bool DoGetItem(wxTreeViewItem *tvItem) const;
 276     inline void DoSetItem(wxTreeViewItem *tvItem);
 277
 278     inline void DoExpand(const wxTreeItemId& item, int flag);
 279
 280     virtual wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
 281                                       size_t pos,
 282                                       const wxString& text,
 283                                       int image, int selectedImage,
 284                                       wxTreeItemData *data);
 285     virtual wxTreeItemId DoInsertAfter(const wxTreeItemId& parent,
 286                                        const wxTreeItemId& idPrevious,
 287                                        const wxString& text,
 288                                        int image = -1, int selImage = -1,
 289                                        wxTreeItemData *data = NULL);
 290     virtual wxTreeItemId DoHitTest(const wxPoint& point, int& flags);
 291
 292     int DoGetItemImageFromData(const wxTreeItemId& item,
 293                                wxTreeItemIcon which) const;
 294     void DoSetItemImageFromData(const wxTreeItemId& item,
 295                                 int image,
 296                                 wxTreeItemIcon which) const;
 297     void DoSetItemImages(const wxTreeItemId& item, int image, int imageSel);
 298
 299     void DeleteTextCtrl();
 300
 301     // support for additional item images which we implement using
 302     // wxTreeItemIndirectData technique - see the comments in msw/treectrl.cpp
 303     void SetIndirectItemData(const wxTreeItemId& item,
 304                              class wxTreeItemIndirectData *data);
 305     bool HasIndirectData(const wxTreeItemId& item) const;
 306     bool IsDataIndirect(wxTreeItemData *data) const
 307         { return data && data->GetId().m_pItem == 0; }
 308
 309     // the hash storing the items attributes (indexed by item ids)
 310     wxMapTreeAttr m_attrs;
 311
 312     // true if the hash above is not empty
 313     bool m_hasAnyAttr;
 314
 315     // used for dragging
 316     wxDragImage *m_dragImage;
 317
 318     // Virtual root item, if wxTR_HIDE_ROOT is set.
 319     void* m_pVirtualRoot;
 320
 321     // the starting item for selection with Shift
 322     wxTreeItemId m_htSelStart, m_htClickedItem;
 323     wxPoint m_ptClick;
 324
 325     friend class wxTreeItemIndirectData;
 326     friend class wxTreeSortHelper;
 327
 328     DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
 329     DECLARE_NO_COPY_CLASS(wxTreeCtrl)
 330 };
 331
 332 #endif // wxUSE_TREECTRL
 333
 334 #endif
 335     // _WX_TREECTRL_H_