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
  33 // -----------------------------------------------------------------------------
  34 // constants
  35 // -----------------------------------------------------------------------------
  36
  37 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
  38 // where exactly the specified point is situated:
  39 static const int wxTREE_HITTEST_NOWHERE          = 0x0004;
  40     // on the bitmap associated with an item.
  41 static const int wxTREE_HITTEST_ONITEMICON       = 0x0020;
  42     // on the label (string) associated with an item.
  43 static const int wxTREE_HITTEST_ONITEMLABEL      = 0x0080;
  44     // anywhere on the item
  45 static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
  46                                           wxTREE_HITTEST_ONITEMLABEL;
  47
  48 // -----------------------------------------------------------------------------
  49 // forward declaration
  50 // -----------------------------------------------------------------------------
  51
  52 class wxImageList;
  53 class wxGenericTreeItem;
  54
  55 class wxTreeItemData;
  56
  57 // -----------------------------------------------------------------------------
  58 // wxTreeItemId - unique identifier of a tree element
  59 // -----------------------------------------------------------------------------
  60
  61 class WXDLLEXPORT wxTreeItemId
  62 {
  63 friend class wxTreeCtrl;
  64 friend class wxTreeEvent;
  65 public:
  66     // ctors
  67         // 0 is invalid value for HTREEITEM
  68     wxTreeItemId() { m_pItem = 0; }
  69
  70         // default copy ctor/assignment operator are ok for us
  71
  72     // accessors
  73         // is this a valid tree item?
  74     bool IsOk() const { return m_pItem != 0; }
  75
  76     // deprecated: only for compatibility
  77     wxTreeItemId(long itemId) { m_pItem = (wxGenericTreeItem *)itemId; }
  78     operator long() const { return (long)m_pItem; }
  79
  80 //protected: // not for gcc
  81     // for wxTreeCtrl usage only
  82     wxTreeItemId(wxGenericTreeItem *pItem) { m_pItem = pItem; }
  83
  84     wxGenericTreeItem *m_pItem;
  85 };
  86
  87 // ----------------------------------------------------------------------------
  88 // wxTreeItemData is some (arbitrary) user class associated with some item.
  89 //
  90 // Because the objects of this class are deleted by the tree, they should
  91 // always be allocated on the heap!
  92 // ----------------------------------------------------------------------------
  93 class WXDLLEXPORT wxTreeItemData: public wxClientData
  94 {
  95 friend class wxTreeCtrl;
  96 public:
  97     // creation/destruction
  98     // --------------------
  99         // default ctor
 100     wxTreeItemData() { }
 101
 102         // default copy ctor/assignment operator are ok
 103
 104     // accessor: get the item associated with us
 105     const wxTreeItemId& GetId() const { return m_pItem; }
 106     void SetId(const wxTreeItemId& id) { m_pItem = id; }
 107
 108 protected:
 109     wxTreeItemId m_pItem;
 110 };
 111
 112 // -----------------------------------------------------------------------------
 113 // wxTreeEvent - the event generated by the tree control
 114 // -----------------------------------------------------------------------------
 115 class WXDLLEXPORT wxTreeEvent : public wxNotifyEvent
 116 {
 117 friend class wxTreeCtrl;
 118 public:
 119     wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 120
 121     // accessors
 122         // get the item on which the operation was performed or the newly
 123         // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
 124     wxTreeItemId GetItem() const { return m_item; }
 125
 126         // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
 127         // selected item
 128     wxTreeItemId GetOldItem() const { return m_itemOld; }
 129
 130         // the point where the mouse was when the drag operation started (for
 131         // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only)
 132     wxPoint GetPoint() const { return m_pointDrag; }
 133
 134         // keyboard code (for wxEVT_COMMAND_TREE_KEY_DOWN only)
 135     int GetCode() const { return m_code; }
 136
 137     // set return code for wxEVT_COMMAND_TREE_ITEM_{EXPAND|COLLAPS}ING events
 138         // call this to forbid the change in item status
 139     void Veto() { m_code = TRUE; }
 140
 141         // for implementation usage only
 142     bool WasVetoed() const { return m_code; }
 143
 144 private:
 145     // @@ we could save some space by using union here
 146     int           m_code;
 147     wxTreeItemId  m_item,
 148                   m_itemOld;
 149     wxPoint       m_pointDrag;
 150
 151     DECLARE_DYNAMIC_CLASS(wxTreeEvent)
 152 };
 153
 154 typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
 155
 156 // ----------------------------------------------------------------------------
 157 // macros for handling tree control events
 158 // ----------------------------------------------------------------------------
 159
 160 // GetItem() returns the item being dragged, GetPoint() the mouse coords
 161 #define EVT_TREE_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 162 #define EVT_TREE_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 163
 164 // GetItem() returns the itme whose label is being edited
 165 #define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 166 #define EVT_TREE_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 167
 168 // provide/update information about GetItem() item
 169 #define EVT_TREE_GET_INFO(id, fn) { wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 170 #define EVT_TREE_SET_INFO(id, fn) { wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 171
 172 // GetItem() is the item being expanded/collapsed, the "ING" versions can use
 173 #define EVT_TREE_ITEM_EXPANDED(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 174 #define EVT_TREE_ITEM_EXPANDING(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 175 #define EVT_TREE_ITEM_COLLAPSED(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 176 #define EVT_TREE_ITEM_COLLAPSING(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 177
 178 // GetOldItem() is the item which had the selection previously, GetItem() is
 179 // the item which acquires selection
 180 #define EVT_TREE_SEL_CHANGED(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 181 #define EVT_TREE_SEL_CHANGING(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 182
 183 // GetCode() returns the key code
 184 // NB: this is the only message for which GetItem() is invalid (you may get the
 185 //     item from GetSelection())
 186 #define EVT_TREE_KEY_DOWN(id, fn) { wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 187
 188 // GetItem() returns the item being deleted, the associated data (if any) will
 189 // be deleted just after the return of this event handler (if any)
 190 #define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 191
 192 // GetItem() returns the item that was activated (double click, enter, space)
 193 #define EVT_TREE_ITEM_ACTIVATED(id, fn) { wxEVT_COMMAND_TREE_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 194
 195 // -----------------------------------------------------------------------------
 196 // wxTreeCtrl - the tree control
 197 // -----------------------------------------------------------------------------
 198
 199 class WXDLLEXPORT wxTreeCtrl : public wxScrolledWindow
 200 {
 201 public:
 202     // creation
 203     // --------
 204     wxTreeCtrl() { Init(); }
 205
 206     wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
 207                const wxPoint& pos = wxDefaultPosition,
 208                const wxSize& size = wxDefaultSize,
 209                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
 210                const wxValidator &validator = wxDefaultValidator,
 211                const wxString& name = wxTreeCtrlNameStr)
 212     {
 213         Create(parent, id, pos, size, style, validator, name);
 214     }
 215
 216     virtual ~wxTreeCtrl();
 217
 218     bool Create(wxWindow *parent, wxWindowID id = -1,
 219                 const wxPoint& pos = wxDefaultPosition,
 220                 const wxSize& size = wxDefaultSize,
 221                 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
 222                 const wxValidator &validator = wxDefaultValidator,
 223                 const wxString& name = wxTreeCtrlNameStr);
 224
 225     // accessors
 226     // ---------
 227
 228         // get the total number of items in the control
 229     size_t GetCount() const;
 230
 231         // indent is the number of pixels the children are indented relative to
 232         // the parents position. SetIndent() also redraws the control
 233         // immediately.
 234     unsigned int GetIndent() const { return m_indent; }
 235     void SetIndent(unsigned int indent);
 236
 237         // spacing is the number of pixels between the start and the Text
 238     unsigned int GetSpacing() const { return m_spacing; }
 239     void SetSpacing(unsigned int spacing);
 240
 241         // image list: these functions allow to associate an image list with
 242         // the control and retrieve it. Note that the control does _not_ delete
 243         // the associated image list when it's deleted in order to allow image
 244         // lists to be shared between different controls.
 245         //
 246         // The normal image list is for the icons which correspond to the
 247         // normal tree item state (whether it is selected or not).
 248         // Additionally, the application might choose to show a state icon
 249         // which corresponds to an app-defined item state (for example,
 250         // checked/unchecked) which are taken from the state image list.
 251     wxImageList *GetImageList() const;
 252     wxImageList *GetStateImageList() const;
 253
 254     void SetImageList(wxImageList *imageList);
 255     void SetStateImageList(wxImageList *imageList);
 256
 257     // Functions to work with tree ctrl items.
 258
 259     // accessors
 260     // ---------
 261
 262         // retrieve items label
 263     wxString GetItemText(const wxTreeItemId& item) const;
 264         // get the normal item image
 265     int GetItemImage(const wxTreeItemId& item) const;
 266         // get the selected item image
 267     int GetItemSelectedImage(const wxTreeItemId& item) const;
 268         // get the data associated with the item
 269     wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
 270
 271     // modifiers
 272     // ---------
 273
 274         // set items label
 275     void SetItemText(const wxTreeItemId& item, const wxString& text);
 276         // set the normal item image
 277     void SetItemImage(const wxTreeItemId& item, int image);
 278         // set the selected item image
 279     void SetItemSelectedImage(const wxTreeItemId& item, int image);
 280         // associate some data with the item
 281     void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
 282
 283         // force appearance of [+] button near the item. This is useful to
 284         // allow the user to expand the items which don't have any children now
 285         // - but instead add them only when needed, thus minimizing memory
 286         // usage and loading time.
 287     void SetItemHasChildren(const wxTreeItemId& item, bool has = TRUE);
 288
 289         // the item will be shown in bold
 290     void SetItemBold(const wxTreeItemId& item, bool bold = TRUE);
 291
 292     // item status inquiries
 293     // ---------------------
 294
 295         // is the item visible (it might be outside the view or not expanded)?
 296     bool IsVisible(const wxTreeItemId& item) const;
 297         // does the item has any children?
 298     bool HasChildren(const wxTreeItemId& item) const
 299       { return ItemHasChildren(item); }
 300     bool ItemHasChildren(const wxTreeItemId& item) const;
 301         // is the item expanded (only makes sense if HasChildren())?
 302     bool IsExpanded(const wxTreeItemId& item) const;
 303         // is this item currently selected (the same as has focus)?
 304     bool IsSelected(const wxTreeItemId& item) const;
 305         // is item text in bold font?
 306     bool IsBold(const wxTreeItemId& item) const;
 307
 308     // number of children
 309     // ------------------
 310
 311         // if 'recursively' is FALSE, only immediate children count, otherwise
 312         // the returned number is the number of all items in this branch
 313     size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = TRUE);
 314
 315     // navigation
 316     // ----------
 317
 318     // wxTreeItemId.IsOk() will return FALSE if there is no such item
 319
 320         // get the root tree item
 321     wxTreeItemId GetRootItem() const { return m_anchor; }
 322
 323         // get the item currently selected (may return NULL if no selection)
 324     wxTreeItemId GetSelection() const { return m_current; }
 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         // select this item
 404     void SelectItem(const wxTreeItemId& item);
 405         // make sure this item is visible (expanding the parent item and/or
 406         // scrolling to this item if necessary)
 407     void EnsureVisible(const wxTreeItemId& item);
 408         // scroll to this item (but don't expand its parent)
 409     void ScrollTo(const wxTreeItemId& item);
 410
 411         // The first function is more portable (because easier to implement
 412         // on other platforms), but the second one returns some extra info.
 413     wxTreeItemId HitTest(const wxPoint& point)
 414         { int dummy; return HitTest(point, dummy); }
 415     wxTreeItemId HitTest(const wxPoint& point, int& flags);
 416
 417         // start editing the item label: this (temporarily) replaces the item
 418         // with a one line edit control. The item will be selected if it hadn't
 419         // been before. textCtrlClass parameter allows you to create an edit
 420         // control of arbitrary user-defined class deriving from wxTextCtrl.
 421     wxTextCtrl* EditLabel(const wxTreeItemId& item,
 422                           wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
 423         // returns the same pointer as StartEdit() if the item is being edited,
 424         // NULL otherwise (it's assumed that no more than one item may be
 425         // edited simultaneously)
 426     wxTextCtrl* GetEditControl() const;
 427         // end editing and accept or discard the changes to item label
 428     void EndEditLabel(const wxTreeItemId& item, bool discardChanges = FALSE);
 429
 430     // sorting
 431         // this function is called to compare 2 items and should return -1, 0
 432         // or +1 if the first item is less than, equal to or greater than the
 433         // second one. The base class version performs alphabetic comparaison
 434         // of item labels (GetText)
 435     virtual int OnCompareItems(const wxTreeItemId& item1,
 436                                const wxTreeItemId& item2);
 437         // sort the children of this item using OnCompareItems
 438         //
 439         // NB: this function is not reentrant and not MT-safe (FIXME)!
 440     void SortChildren(const wxTreeItemId& item);
 441
 442     // callbacks
 443     void OnPaint( wxPaintEvent &event );
 444     void OnSetFocus( wxFocusEvent &event );
 445     void OnKillFocus( wxFocusEvent &event );
 446     void OnChar( wxKeyEvent &event );
 447     void OnMouse( wxMouseEvent &event );
 448     void OnIdle( wxIdleEvent &event );
 449
 450     // implementation
 451     void SendDeleteEvent(wxGenericTreeItem *itemBeingDeleted);
 452
 453 protected:
 454     wxGenericTreeItem   *m_anchor;
 455     wxGenericTreeItem   *m_current;
 456     bool                 m_hasFocus;
 457     bool                 m_dirty;
 458     int                  m_xScroll,m_yScroll;
 459     unsigned int         m_indent;
 460     unsigned int         m_spacing;
 461     int                  m_lineHeight;
 462     wxPen                m_dottedPen;
 463     wxBrush             *m_hilightBrush;
 464     wxImageList         *m_imageListNormal,
 465                         *m_imageListState;
 466     int                  m_dragCount;
 467
 468     // the common part of all ctors
 469     void Init();
 470
 471     // misc helpers
 472     wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
 473                               size_t previous,
 474                               const wxString& text,
 475                               int image, int selectedImage,
 476                               wxTreeItemData *data);
 477
 478     void AdjustMyScrollbars();
 479     void PaintLevel( wxGenericTreeItem *item, wxDC& dc, int level, int &y );
 480     void PaintItem( wxGenericTreeItem *item, wxDC& dc);
 481
 482     void CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y );
 483     void CalculatePositions();
 484
 485     void RefreshSubtree( wxGenericTreeItem *item );
 486     void RefreshLine( wxGenericTreeItem *item );
 487
 488 private:
 489     DECLARE_EVENT_TABLE()
 490     DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
 491 };
 492
 493 #endif // _GENERIC_TREECTRL_H_
 494