include/wx/generic/treectlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/treectlg.h
   3 // Purpose:     wxTreeCtrl class
   4 // Author:      Robert Roebling
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1997,1998 Robert Roebling
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _GENERIC_TREECTRL_H_
  13 #define _GENERIC_TREECTRL_H_
  14
  15 #if wxUSE_TREECTRL
  16
  17 #include "wx/scrolwin.h"
  18 #include "wx/pen.h"
  19
  20 // -----------------------------------------------------------------------------
  21 // forward declaration
  22 // -----------------------------------------------------------------------------
  23
  24 class WXDLLIMPEXP_FWD_CORE wxGenericTreeItem;
  25
  26 class WXDLLIMPEXP_FWD_CORE wxTreeItemData;
  27
  28 class WXDLLIMPEXP_FWD_CORE wxTreeRenameTimer;
  29 class WXDLLIMPEXP_FWD_CORE wxTreeFindTimer;
  30 class WXDLLIMPEXP_FWD_CORE wxTreeTextCtrl;
  31 class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
  32
  33 // -----------------------------------------------------------------------------
  34 // wxGenericTreeCtrl - the tree control
  35 // -----------------------------------------------------------------------------
  36
  37 class WXDLLIMPEXP_CORE wxGenericTreeCtrl : public wxTreeCtrlBase,
  38                                       public wxScrollHelper
  39 {
  40 public:
  41     // creation
  42     // --------
  43
  44     wxGenericTreeCtrl() : wxTreeCtrlBase(), wxScrollHelper(this) { Init(); }
  45
  46     wxGenericTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
  47                const wxPoint& pos = wxDefaultPosition,
  48                const wxSize& size = wxDefaultSize,
  49                long style = wxTR_DEFAULT_STYLE,
  50                const wxValidator &validator = wxDefaultValidator,
  51                const wxString& name = wxTreeCtrlNameStr)
  52         : wxTreeCtrlBase(),
  53           wxScrollHelper(this)
  54     {
  55         Init();
  56         Create(parent, id, pos, size, style, validator, name);
  57     }
  58
  59     virtual ~wxGenericTreeCtrl();
  60
  61     bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
  62                 const wxPoint& pos = wxDefaultPosition,
  63                 const wxSize& size = wxDefaultSize,
  64                 long style = wxTR_DEFAULT_STYLE,
  65                 const wxValidator &validator = wxDefaultValidator,
  66                 const wxString& name = wxTreeCtrlNameStr);
  67
  68
  69     // implement base class pure virtuals
  70     // ----------------------------------
  71
  72     virtual unsigned int GetCount() const;
  73
  74     virtual unsigned int GetIndent() const { return m_indent; }
  75     virtual void SetIndent(unsigned int indent);
  76
  77
  78     virtual void SetImageList(wxImageList *imageList);
  79     virtual void SetStateImageList(wxImageList *imageList);
  80
  81     virtual wxString GetItemText(const wxTreeItemId& item) const;
  82     virtual int GetItemImage(const wxTreeItemId& item,
  83                      wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
  84     virtual wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
  85     virtual wxColour GetItemTextColour(const wxTreeItemId& item) const;
  86     virtual wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
  87     virtual wxFont GetItemFont(const wxTreeItemId& item) const;
  88
  89     virtual void SetItemText(const wxTreeItemId& item, const wxString& text);
  90     virtual void SetItemImage(const wxTreeItemId& item,
  91                               int image,
  92                               wxTreeItemIcon which = wxTreeItemIcon_Normal);
  93     virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
  94
  95     virtual void SetItemHasChildren(const wxTreeItemId& item, bool has = true);
  96     virtual void SetItemBold(const wxTreeItemId& item, bool bold = true);
  97     virtual void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = true);
  98     virtual void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
  99     virtual void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
 100     virtual void SetItemFont(const wxTreeItemId& item, const wxFont& font);
 101
 102     virtual bool IsVisible(const wxTreeItemId& item) const;
 103     virtual bool ItemHasChildren(const wxTreeItemId& item) const;
 104     virtual bool IsExpanded(const wxTreeItemId& item) const;
 105     virtual bool IsSelected(const wxTreeItemId& item) const;
 106     virtual bool IsBold(const wxTreeItemId& item) const;
 107
 108     virtual size_t GetChildrenCount(const wxTreeItemId& item,
 109                                     bool recursively = true) const;
 110
 111     // navigation
 112     // ----------
 113
 114     virtual wxTreeItemId GetRootItem() const { return m_anchor; }
 115     virtual wxTreeItemId GetSelection() const
 116     {
 117         wxASSERT_MSG( !HasFlag(wxTR_MULTIPLE),
 118                        wxT("must use GetSelections() with this control") );
 119
 120         return m_current;
 121     }
 122     virtual size_t GetSelections(wxArrayTreeItemIds&) const;
 123     virtual wxTreeItemId GetFocusedItem() const { return m_current; }
 124
 125     virtual void ClearFocusedItem();
 126     virtual void SetFocusedItem(const wxTreeItemId& item);
 127
 128     virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
 129     virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
 130                                        wxTreeItemIdValue& cookie) const;
 131     virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,
 132                                       wxTreeItemIdValue& cookie) const;
 133     virtual wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
 134     virtual wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
 135     virtual wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
 136
 137     virtual wxTreeItemId GetFirstVisibleItem() const;
 138     virtual wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
 139     virtual wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
 140
 141
 142     // operations
 143     // ----------
 144
 145     virtual wxTreeItemId AddRoot(const wxString& text,
 146                          int image = -1, int selectedImage = -1,
 147                          wxTreeItemData *data = NULL);
 148
 149     virtual void Delete(const wxTreeItemId& item);
 150     virtual void DeleteChildren(const wxTreeItemId& item);
 151     virtual void DeleteAllItems();
 152
 153     virtual void Expand(const wxTreeItemId& item);
 154     virtual void Collapse(const wxTreeItemId& item);
 155     virtual void CollapseAndReset(const wxTreeItemId& item);
 156     virtual void Toggle(const wxTreeItemId& item);
 157
 158     virtual void Unselect();
 159     virtual void UnselectAll();
 160     virtual void SelectItem(const wxTreeItemId& item, bool select = true);
 161     virtual void SelectChildren(const wxTreeItemId& parent);
 162
 163     virtual void EnsureVisible(const wxTreeItemId& item);
 164     virtual void ScrollTo(const wxTreeItemId& item);
 165
 166     virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
 167                           wxClassInfo* textCtrlClass = wxCLASSINFO(wxTextCtrl));
 168     virtual wxTextCtrl *GetEditControl() const;
 169     virtual void EndEditLabel(const wxTreeItemId& item,
 170                               bool discardChanges = false);
 171
 172     virtual void SortChildren(const wxTreeItemId& item);
 173
 174     // items geometry
 175     // --------------
 176
 177     virtual bool GetBoundingRect(const wxTreeItemId& item,
 178                                  wxRect& rect,
 179                                  bool textOnly = false) const;
 180
 181
 182     // this version specific methods
 183     // -----------------------------
 184
 185     wxImageList *GetButtonsImageList() const { return m_imageListButtons; }
 186     void SetButtonsImageList(wxImageList *imageList);
 187     void AssignButtonsImageList(wxImageList *imageList);
 188
 189     void SetDropEffectAboveItem( bool above = false ) { m_dropEffectAboveItem = above; }
 190     bool GetDropEffectAboveItem() const { return m_dropEffectAboveItem; }
 191
 192     wxTreeItemId GetNext(const wxTreeItemId& item) const;
 193
 194 #if WXWIN_COMPATIBILITY_2_6
 195     // use EditLabel() instead
 196     void Edit( const wxTreeItemId& item ) { EditLabel(item); }
 197 #endif // WXWIN_COMPATIBILITY_2_6
 198
 199     // implementation only from now on
 200
 201     // overridden base class virtuals
 202     virtual bool SetBackgroundColour(const wxColour& colour);
 203     virtual bool SetForegroundColour(const wxColour& colour);
 204
 205     virtual void Refresh(bool eraseBackground = true, const wxRect *rect = NULL);
 206
 207     virtual bool SetFont( const wxFont &font );
 208     virtual void SetWindowStyle(const long styles);
 209
 210     // callbacks
 211     void OnPaint( wxPaintEvent &event );
 212     void OnSetFocus( wxFocusEvent &event );
 213     void OnKillFocus( wxFocusEvent &event );
 214     void OnChar( wxKeyEvent &event );
 215     void OnMouse( wxMouseEvent &event );
 216     void OnGetToolTip( wxTreeEvent &event );
 217     void OnSize( wxSizeEvent &event );
 218     void OnInternalIdle( );
 219
 220     virtual wxVisualAttributes GetDefaultAttributes() const
 221     {
 222         return GetClassDefaultAttributes(GetWindowVariant());
 223     }
 224
 225     static wxVisualAttributes
 226     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 227
 228     // implementation helpers
 229     void AdjustMyScrollbars();
 230
 231     WX_FORWARD_TO_SCROLL_HELPER()
 232
 233 protected:
 234     friend class wxGenericTreeItem;
 235     friend class wxTreeRenameTimer;
 236     friend class wxTreeFindTimer;
 237     friend class wxTreeTextCtrl;
 238
 239     wxFont               m_normalFont;
 240     wxFont               m_boldFont;
 241
 242     wxGenericTreeItem   *m_anchor;
 243     wxGenericTreeItem   *m_current,
 244                         *m_key_current,
 245                         // A hint to select a parent item after deleting a child
 246                         *m_select_me;
 247     unsigned short       m_indent;
 248     int                  m_lineHeight;
 249     wxPen                m_dottedPen;
 250     wxBrush             *m_hilightBrush,
 251                         *m_hilightUnfocusedBrush;
 252     bool                 m_hasFocus;
 253     bool                 m_dirty;
 254     bool                 m_ownsImageListButtons;
 255     bool                 m_isDragging; // true between BEGIN/END drag events
 256     bool                 m_lastOnSame;  // last click on the same item as prev
 257     wxImageList         *m_imageListButtons;
 258
 259     int                  m_dragCount;
 260     wxPoint              m_dragStart;
 261     wxGenericTreeItem   *m_dropTarget;
 262     wxCursor             m_oldCursor;  // cursor is changed while dragging
 263     wxGenericTreeItem   *m_oldSelection;
 264     wxGenericTreeItem   *m_underMouse; // for visual effects
 265
 266     enum { NoEffect, BorderEffect, AboveEffect, BelowEffect } m_dndEffect;
 267     wxGenericTreeItem   *m_dndEffectItem;
 268
 269     wxTreeTextCtrl      *m_textCtrl;
 270
 271
 272     wxTimer             *m_renameTimer;
 273
 274     // incremental search data
 275     wxString             m_findPrefix;
 276     wxTimer             *m_findTimer;
 277
 278     bool                 m_dropEffectAboveItem;
 279
 280     // the common part of all ctors
 281     void Init();
 282
 283     // overridden wxWindow methods
 284     virtual void DoThaw();
 285
 286     // misc helpers
 287     void SendDeleteEvent(wxGenericTreeItem *itemBeingDeleted);
 288
 289     void DrawBorder(const wxTreeItemId& item);
 290     void DrawLine(const wxTreeItemId& item, bool below);
 291     void DrawDropEffect(wxGenericTreeItem *item);
 292
 293     void DoSelectItem(const wxTreeItemId& id,
 294                       bool unselect_others = true,
 295                       bool extended_select = false);
 296
 297     virtual int DoGetItemState(const wxTreeItemId& item) const;
 298     virtual void DoSetItemState(const wxTreeItemId& item, int state);
 299
 300     virtual wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
 301                                       size_t previous,
 302                                       const wxString& text,
 303                                       int image,
 304                                       int selectedImage,
 305                                       wxTreeItemData *data);
 306     virtual wxTreeItemId DoInsertAfter(const wxTreeItemId& parent,
 307                                        const wxTreeItemId& idPrevious,
 308                                        const wxString& text,
 309                                        int image = -1, int selImage = -1,
 310                                        wxTreeItemData *data = NULL);
 311     virtual wxTreeItemId DoTreeHitTest(const wxPoint& point, int& flags) const;
 312
 313     // called by wxTextTreeCtrl when it marks itself for deletion
 314     void ResetTextControl();
 315
 316     // find the first item starting with the given prefix after the given item
 317     wxTreeItemId FindItem(const wxTreeItemId& id, const wxString& prefix) const;
 318
 319     bool HasButtons() const { return HasFlag(wxTR_HAS_BUTTONS); }
 320
 321     void CalculateLineHeight();
 322     int  GetLineHeight(wxGenericTreeItem *item) const;
 323     void PaintLevel( wxGenericTreeItem *item, wxDC& dc, int level, int &y );
 324     void PaintItem( wxGenericTreeItem *item, wxDC& dc);
 325
 326     void CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y );
 327     void CalculatePositions();
 328
 329     void RefreshSubtree( wxGenericTreeItem *item );
 330     void RefreshLine( wxGenericTreeItem *item );
 331
 332     // redraw all selected items
 333     void RefreshSelected();
 334
 335     // RefreshSelected() recursive helper
 336     void RefreshSelectedUnder(wxGenericTreeItem *item);
 337
 338     void OnRenameTimer();
 339     bool OnRenameAccept(wxGenericTreeItem *item, const wxString& value);
 340     void OnRenameCancelled(wxGenericTreeItem *item);
 341
 342     void FillArray(wxGenericTreeItem*, wxArrayTreeItemIds&) const;
 343     void SelectItemRange( wxGenericTreeItem *item1, wxGenericTreeItem *item2 );
 344     bool TagAllChildrenUntilLast(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select);
 345     bool TagNextChildren(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select);
 346     void UnselectAllChildren( wxGenericTreeItem *item );
 347     void ChildrenClosing(wxGenericTreeItem* item);
 348
 349     void DoDirtyProcessing();
 350
 351     virtual wxSize DoGetBestSize() const;
 352
 353 private:
 354     DECLARE_EVENT_TABLE()
 355     DECLARE_DYNAMIC_CLASS(wxGenericTreeCtrl)
 356     wxDECLARE_NO_COPY_CLASS(wxGenericTreeCtrl);
 357 };
 358
 359 #if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
 360 /*
 361  * wxTreeCtrl has to be a real class or we have problems with
 362  * the run-time information.
 363  */
 364
 365 class WXDLLIMPEXP_CORE wxTreeCtrl: public wxGenericTreeCtrl
 366 {
 367     DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
 368
 369 public:
 370     wxTreeCtrl() {}
 371
 372     wxTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
 373                const wxPoint& pos = wxDefaultPosition,
 374                const wxSize& size = wxDefaultSize,
 375                long style = wxTR_DEFAULT_STYLE,
 376                const wxValidator &validator = wxDefaultValidator,
 377                const wxString& name = wxTreeCtrlNameStr)
 378     : wxGenericTreeCtrl(parent, id, pos, size, style, validator, name)
 379     {
 380     }
 381 };
 382 #endif // !__WXMSW__ || __WXUNIVERSAL__
 383
 384 #endif // wxUSE_TREECTRL
 385
 386 #endif // _GENERIC_TREECTRL_H_