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