include/wx/generic/treectrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        treectrl.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 license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _GENERIC_TREECTRL_H_
  13 #define _GENERIC_TREECTRL_H_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "treectrl.h"
  17 #endif
  18
  19 #ifdef __WXMSW__
  20 WXDLLEXPORT_DATA(extern const char*) wxTreeCtrlNameStr;
  21 #else
  22 #define wxTreeCtrlNameStr "wxTreeCtrl"
  23 #endif
  24
  25 #include "wx/defs.h"
  26 #include "wx/string.h"
  27 #include "wx/object.h"
  28 #include "wx/event.h"
  29 #include "wx/scrolwin.h"
  30 #include "wx/textctrl.h"
  31 #include "wx/pen.h"
  32 #include "wx/dynarray.h"
  33 #include "wx/timer.h"
  34
  35 //those defines should only be done in generic/treectrl.h,
  36 //because wxMSW doesn't allow mutiple selection
  37
  38 #ifndef wxTR_SINGLE
  39 #define wxTR_SINGLE                 0x0000
  40 #define wxTR_MULTIPLE               0x0020
  41 #define wxTR_EXTENDED               0x0040
  42 #define wxTR_HAS_VARIABLE_ROW_HIGHT 0x0080
  43 #endif
  44
  45 // -----------------------------------------------------------------------------
  46 // constants
  47 // -----------------------------------------------------------------------------
  48
  49 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
  50 // where exactly the specified point is situated:
  51
  52 static const int wxTREE_HITTEST_ABOVE            = 0x0001;
  53 static const int wxTREE_HITTEST_BELOW            = 0x0002;
  54 static const int wxTREE_HITTEST_NOWHERE          = 0x0004;
  55     // on the button associated with an item.
  56 static const int wxTREE_HITTEST_ONITEMBUTTON     = 0x0008;
  57     // on the bitmap associated with an item.
  58 static const int wxTREE_HITTEST_ONITEMICON       = 0x0010;
  59     // on the ident associated with an item.
  60 static const int wxTREE_HITTEST_ONITEMIDENT      = 0x0020;
  61     // on the label (string) associated with an item.
  62 static const int wxTREE_HITTEST_ONITEMLABEL      = 0x0040;
  63     // on the right of the label associated with an item.
  64 static const int wxTREE_HITTEST_ONITEMRIGHT      = 0x0080;
  65     // on the label (string) associated with an item.
  66 //static const int wxTREE_HITTEST_ONITEMSTATEICON  = 0x0100;
  67     // on the left of the wxTreeCtrl.
  68 static const int wxTREE_HITTEST_TOLEFT           = 0x0200;
  69     // on the right of the wxTreeCtrl.
  70 static const int wxTREE_HITTEST_TORIGHT          = 0x0400;
  71     // on the upper part (first half) of the item.
  72 static const int wxTREE_HITTEST_ONITEMUPPERPART  = 0x0800;
  73     // on the lower part (second half) of the item.
  74 static const int wxTREE_HITTEST_ONITEMLOWERPART  = 0x1000;
  75
  76     // anywhere on the item
  77 static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
  78                                           wxTREE_HITTEST_ONITEMLABEL;
  79
  80 // -----------------------------------------------------------------------------
  81 // forward declaration
  82 // -----------------------------------------------------------------------------
  83
  84 class WXDLLEXPORT wxImageList;
  85 class WXDLLEXPORT wxGenericTreeItem;
  86
  87 class WXDLLEXPORT wxTreeItemData;
  88
  89 class WXDLLEXPORT wxTreeRenameTimer;
  90 class WXDLLEXPORT wxTreeTextCtrl;
  91
  92 // -----------------------------------------------------------------------------
  93 // wxTreeItemId - unique identifier of a tree element
  94 // -----------------------------------------------------------------------------
  95
  96 class WXDLLEXPORT wxTreeItemId
  97 {
  98 friend class wxTreeCtrl;
  99 friend class wxTreeEvent;
 100 public:
 101     // ctors
 102         // 0 is invalid value for HTREEITEM
 103     wxTreeItemId() { m_pItem = 0; }
 104
 105         // default copy ctor/assignment operator are ok for us
 106
 107     // accessors
 108         // is this a valid tree item?
 109     bool IsOk() const { return m_pItem != 0; }
 110
 111     // deprecated: only for compatibility
 112     wxTreeItemId(long itemId) { m_pItem = (wxGenericTreeItem *)itemId; }
 113     operator long() const { return (long)m_pItem; }
 114
 115 //protected: // not for gcc
 116     // for wxTreeCtrl usage only
 117     wxTreeItemId(wxGenericTreeItem *pItem) { m_pItem = pItem; }
 118
 119     wxGenericTreeItem *m_pItem;
 120 };
 121
 122 WX_DECLARE_OBJARRAY(wxTreeItemId, wxArrayTreeItemIds);
 123
 124 // ----------------------------------------------------------------------------
 125 // wxTreeItemData is some (arbitrary) user class associated with some item.
 126 //
 127 // Because the objects of this class are deleted by the tree, they should
 128 // always be allocated on the heap!
 129 // ----------------------------------------------------------------------------
 130
 131 class WXDLLEXPORT wxTreeItemData: public wxClientData
 132 {
 133 friend class wxTreeCtrl;
 134 public:
 135     // creation/destruction
 136     // --------------------
 137         // default ctor
 138     wxTreeItemData() { }
 139
 140         // default copy ctor/assignment operator are ok
 141
 142     // accessor: get the item associated with us
 143     const wxTreeItemId& GetId() const { return m_pItem; }
 144     void SetId(const wxTreeItemId& id) { m_pItem = id; }
 145
 146 protected:
 147     wxTreeItemId m_pItem;
 148 };
 149
 150 //-----------------------------------------------------------------------------
 151 // wxTreeRenameTimer (internal)
 152 //-----------------------------------------------------------------------------
 153
 154 class WXDLLEXPORT wxTreeRenameTimer: public wxTimer
 155 {
 156  private:
 157    wxTreeCtrl   *m_owner;
 158
 159  public:
 160    wxTreeRenameTimer( wxTreeCtrl *owner );
 161    void Notify();
 162 };
 163
 164 //-----------------------------------------------------------------------------
 165 //  wxTreeTextCtrl (internal)
 166 //-----------------------------------------------------------------------------
 167
 168 class WXDLLEXPORT wxTreeTextCtrl: public wxTextCtrl
 169 {
 170   DECLARE_DYNAMIC_CLASS(wxTreeTextCtrl);
 171
 172   private:
 173     bool               *m_accept;
 174     wxString           *m_res;
 175     wxTreeCtrl         *m_owner;
 176     wxString            m_startValue;
 177
 178   public:
 179     wxTreeTextCtrl(void) {};
 180     wxTreeTextCtrl( wxWindow *parent, const wxWindowID id,
 181                     bool *accept, wxString *res, wxTreeCtrl *owner,
 182                     const wxString &value = wxEmptyString,
 183                     const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
 184                     int style = 0, const wxValidator& validator = wxDefaultValidator,
 185                     const wxString &name = wxTextCtrlNameStr );
 186     void OnChar( wxKeyEvent &event );
 187     void OnKillFocus( wxFocusEvent &event );
 188
 189   DECLARE_EVENT_TABLE()
 190 };
 191
 192 // -----------------------------------------------------------------------------
 193 // wxTreeCtrl - the tree control
 194 // -----------------------------------------------------------------------------
 195
 196 class WXDLLEXPORT wxTreeCtrl : public wxScrolledWindow
 197 {
 198 public:
 199     // creation
 200     // --------
 201     wxTreeCtrl() { Init(); }
 202
 203     wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
 204                const wxPoint& pos = wxDefaultPosition,
 205                const wxSize& size = wxDefaultSize,
 206                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
 207                const wxValidator &validator = wxDefaultValidator,
 208                const wxString& name = wxTreeCtrlNameStr)
 209     {
 210         Create(parent, id, pos, size, style, validator, name);
 211     }
 212
 213     virtual ~wxTreeCtrl();
 214
 215     bool Create(wxWindow *parent, wxWindowID id = -1,
 216                 const wxPoint& pos = wxDefaultPosition,
 217                 const wxSize& size = wxDefaultSize,
 218                 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
 219                 const wxValidator &validator = wxDefaultValidator,
 220                 const wxString& name = wxTreeCtrlNameStr);
 221
 222     // accessors
 223     // ---------
 224
 225         // get the total number of items in the control
 226     size_t GetCount() const;
 227
 228         // indent is the number of pixels the children are indented relative to
 229         // the parents position. SetIndent() also redraws the control
 230         // immediately.
 231     unsigned int GetIndent() const { return m_indent; }
 232     void SetIndent(unsigned int indent);
 233
 234         // spacing is the number of pixels between the start and the Text
 235     unsigned int GetSpacing() const { return m_spacing; }
 236     void SetSpacing(unsigned int spacing);
 237
 238         // image list: these functions allow to associate an image list with
 239         // the control and retrieve it. Note that the control does _not_ delete
 240         // the associated image list when it's deleted in order to allow image
 241         // lists to be shared between different controls.
 242         //
 243         // The normal image list is for the icons which correspond to the
 244         // normal tree item state (whether it is selected or not).
 245         // Additionally, the application might choose to show a state icon
 246         // which corresponds to an app-defined item state (for example,
 247         // checked/unchecked) which are taken from the state image list.
 248     wxImageList *GetImageList() const;
 249     wxImageList *GetStateImageList() const;
 250
 251     void SetImageList(wxImageList *imageList);
 252     void SetStateImageList(wxImageList *imageList);
 253
 254     // Functions to work with tree ctrl items.
 255
 256     // accessors
 257     // ---------
 258
 259         // retrieve items label
 260     wxString GetItemText(const wxTreeItemId& item) const;
 261         // get the normal item image
 262     int GetItemImage(const wxTreeItemId& item) const;
 263         // get the selected item image
 264     int GetItemSelectedImage(const wxTreeItemId& item) const;
 265         // get the data associated with the item
 266     wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
 267
 268     // modifiers
 269     // ---------
 270
 271         // set items label
 272     void SetItemText(const wxTreeItemId& item, const wxString& text);
 273         // set the normal item image
 274     void SetItemImage(const wxTreeItemId& item, int image);
 275         // set the selected item image
 276     void SetItemSelectedImage(const wxTreeItemId& item, int image);
 277         // associate some data with the item
 278     void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
 279
 280         // force appearance of [+] button near the item. This is useful to
 281         // allow the user to expand the items which don't have any children now
 282         // - but instead add them only when needed, thus minimizing memory
 283         // usage and loading time.
 284     void SetItemHasChildren(const wxTreeItemId& item, bool has = TRUE);
 285
 286         // the item will be shown in bold
 287     void SetItemBold(const wxTreeItemId& item, bool bold = TRUE);
 288
 289     // item status inquiries
 290     // ---------------------
 291
 292         // is the item visible (it might be outside the view or not expanded)?
 293     bool IsVisible(const wxTreeItemId& item) const;
 294         // does the item has any children?
 295     bool HasChildren(const wxTreeItemId& item) const
 296       { return ItemHasChildren(item); }
 297     bool ItemHasChildren(const wxTreeItemId& item) const;
 298         // is the item expanded (only makes sense if HasChildren())?
 299     bool IsExpanded(const wxTreeItemId& item) const;
 300         // is this item currently selected (the same as has focus)?
 301     bool IsSelected(const wxTreeItemId& item) const;
 302         // is item text in bold font?
 303     bool IsBold(const wxTreeItemId& item) const;
 304
 305     // number of children
 306     // ------------------
 307
 308         // if 'recursively' is FALSE, only immediate children count, otherwise
 309         // the returned number is the number of all items in this branch
 310     size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = TRUE);
 311
 312     // navigation
 313     // ----------
 314
 315     // wxTreeItemId.IsOk() will return FALSE if there is no such item
 316
 317         // get the root tree item
 318     wxTreeItemId GetRootItem() const { return m_anchor; }
 319
 320         // get the item currently selected (may return NULL if no selection)
 321     wxTreeItemId GetSelection() const { return m_current; }
 322
 323         // get the items currently selected, return the number of such item
 324     size_t GetSelections(wxArrayTreeItemIds&) const;
 325
 326         // get the parent of this item (may return NULL if root)
 327     wxTreeItemId GetParent(const wxTreeItemId& item) const;
 328
 329         // for this enumeration function you must pass in a "cookie" parameter
 330         // which is opaque for the application but is necessary for the library
 331         // to make these functions reentrant (i.e. allow more than one
 332         // enumeration on one and the same object simultaneously). Of course,
 333         // the "cookie" passed to GetFirstChild() and GetNextChild() should be
 334         // the same!
 335
 336         // get the first child of this item
 337     wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& cookie) const;
 338         // get the next child
 339     wxTreeItemId GetNextChild(const wxTreeItemId& item, long& cookie) const;
 340         // get the last child of this item - this method doesn't use cookies
 341     wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
 342
 343         // get the next sibling of this item
 344     wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
 345         // get the previous sibling
 346     wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
 347
 348         // get first visible item
 349     wxTreeItemId GetFirstVisibleItem() const;
 350         // get the next visible item: item must be visible itself!
 351         // see IsVisible() and wxTreeCtrl::GetFirstVisibleItem()
 352     wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
 353         // get the previous visible item: item must be visible itself!
 354     wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
 355
 356     // operations
 357     // ----------
 358
 359         // add the root node to the tree
 360     wxTreeItemId AddRoot(const wxString& text,
 361                          int image = -1, int selectedImage = -1,
 362                          wxTreeItemData *data = NULL);
 363
 364         // insert a new item in as the first child of the parent
 365     wxTreeItemId PrependItem(const wxTreeItemId& parent,
 366                              const wxString& text,
 367                              int image = -1, int selectedImage = -1,
 368                              wxTreeItemData *data = NULL);
 369
 370         // insert a new item after a given one
 371     wxTreeItemId InsertItem(const wxTreeItemId& parent,
 372                             const wxTreeItemId& idPrevious,
 373                             const wxString& text,
 374                             int image = -1, int selectedImage = -1,
 375                             wxTreeItemData *data = NULL);
 376
 377         // insert a new item in as the last child of the parent
 378     wxTreeItemId AppendItem(const wxTreeItemId& parent,
 379                             const wxString& text,
 380                             int image = -1, int selectedImage = -1,
 381                             wxTreeItemData *data = NULL);
 382
 383         // delete this item and associated data if any
 384     void Delete(const wxTreeItemId& item);
 385         // delete all children (but don't delete the item itself)
 386         // NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
 387     void DeleteChildren(const wxTreeItemId& item);
 388         // delete all items from the tree
 389         // NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
 390     void DeleteAllItems();
 391
 392         // expand this item
 393     void Expand(const wxTreeItemId& item);
 394         // collapse the item without removing its children
 395     void Collapse(const wxTreeItemId& item);
 396         // collapse the item and remove all children
 397     void CollapseAndReset(const wxTreeItemId& item);
 398         // toggles the current state
 399     void Toggle(const wxTreeItemId& item);
 400
 401         // remove the selection from currently selected item (if any)
 402     void Unselect();
 403     void UnselectAll();
 404         // select this item
 405     void SelectItem(const wxTreeItemId& item, bool unselect_others=TRUE, bool extended_select=FALSE);
 406         // make sure this item is visible (expanding the parent item and/or
 407         // scrolling to this item if necessary)
 408     void EnsureVisible(const wxTreeItemId& item);
 409         // scroll to this item (but don't expand its parent)
 410     void ScrollTo(const wxTreeItemId& item);
 411
 412         // The first function is more portable (because easier to implement
 413         // on other platforms), but the second one returns some extra info.
 414     wxTreeItemId HitTest(const wxPoint& point)
 415         { int dummy; return HitTest(point, dummy); }
 416     wxTreeItemId HitTest(const wxPoint& point, int& flags);
 417
 418         // Start editing the item label: this (temporarily) replaces the item
 419         // with a one line edit control. The item will be selected if it hadn't
 420         // been before.
 421     void EditLabel( const wxTreeItemId& item ) { Edit( item ); }
 422     void Edit( const wxTreeItemId& item );
 423
 424     // sorting
 425         // this function is called to compare 2 items and should return -1, 0
 426         // or +1 if the first item is less than, equal to or greater than the
 427         // second one. The base class version performs alphabetic comparaison
 428         // of item labels (GetText)
 429     virtual int OnCompareItems(const wxTreeItemId& item1,
 430                                const wxTreeItemId& item2);
 431         // sort the children of this item using OnCompareItems
 432         //
 433         // NB: this function is not reentrant and not MT-safe (FIXME)!
 434     void SortChildren(const wxTreeItemId& item);
 435
 436     // callbacks
 437     void OnPaint( wxPaintEvent &event );
 438     void OnSetFocus( wxFocusEvent &event );
 439     void OnKillFocus( wxFocusEvent &event );
 440     void OnChar( wxKeyEvent &event );
 441     void OnMouse( wxMouseEvent &event );
 442     void OnIdle( wxIdleEvent &event );
 443
 444     // implementation
 445     void SendDeleteEvent(wxGenericTreeItem *itemBeingDeleted);
 446
 447     // Draw Special Information
 448     void DrawBorder(wxTreeItemId& item);
 449     void DrawLine(wxTreeItemId& item, bool below);
 450
 451 protected:
 452     friend class wxGenericTreeItem;
 453     friend class wxTreeRenameTimer;
 454     friend class wxTreeTextCtrl;
 455
 456     wxGenericTreeItem   *m_anchor;
 457     wxGenericTreeItem   *m_current, *m_key_current, *m_currentEdit;
 458     bool                 m_hasFocus;
 459     bool                 m_dirty;
 460     int                  m_xScroll,m_yScroll;
 461     unsigned int         m_indent;
 462     unsigned int         m_spacing;
 463     int                  m_lineHeight;
 464     wxPen                m_dottedPen;
 465     wxBrush             *m_hilightBrush;
 466     wxImageList         *m_imageListNormal,
 467                         *m_imageListState;
 468     int                  m_dragCount;
 469     wxPoint              m_dragStart;
 470     wxTimer             *m_renameTimer;
 471     bool                 m_renameAccept;
 472     wxString             m_renameRes;
 473
 474     // the common part of all ctors
 475     void Init();
 476
 477     // misc helpers
 478     wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
 479                               size_t previous,
 480                               const wxString& text,
 481                               int image, int selectedImage,
 482                               wxTreeItemData *data);
 483
 484     void AdjustMyScrollbars();
 485     int  GetLineHeight(wxGenericTreeItem *item) const;
 486     void PaintLevel( wxGenericTreeItem *item, wxDC& dc, int level, int &y );
 487     void PaintItem( wxGenericTreeItem *item, wxDC& dc);
 488
 489     void CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y );
 490     void CalculatePositions();
 491     void CalculateSize( wxGenericTreeItem *item, wxDC &dc );
 492
 493     void RefreshSubtree( wxGenericTreeItem *item );
 494     void RefreshLine( wxGenericTreeItem *item );
 495
 496     void OnRenameTimer();
 497     void OnRenameAccept();
 498
 499     void FillArray(wxGenericTreeItem*, wxArrayTreeItemIds&) const;
 500     void SelectItemRange( wxGenericTreeItem *item1, wxGenericTreeItem *item2 );
 501     bool TagAllChildrenUntilLast(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select);
 502     bool TagNextChildren(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select);
 503     void UnselectAllChildren( wxGenericTreeItem *item );
 504
 505 private:
 506     DECLARE_EVENT_TABLE()
 507     DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
 508 };
 509
 510 #endif // _GENERIC_TREECTRL_H_
 511