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