include/wx/treebase.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        treebase.h
   3 // Purpose:     wxTreeCtrl base classes and types
   4 // Author:      Julian Smart et al
   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 _WX_TREEBASE_H_
  13 #define _WX_TREEBASE_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "treebase.h"
  17 #endif
  18
  19 // ----------------------------------------------------------------------------
  20 // headers
  21 // ----------------------------------------------------------------------------
  22
  23 #if wxUSE_TREECTRL
  24
  25 #include "wx/window.h"  // for wxClientData
  26 #include "wx/event.h"
  27 #include "wx/dynarray.h"
  28
  29 // ----------------------------------------------------------------------------
  30 // wxTreeItemId identifies an element of the tree. In this implementation, it's
  31 // just a trivial wrapper around Win32 HTREEITEM or a pointer to some private
  32 // data structure in the generic version. It's opaque for the application and
  33 // the only method which can be used by user code is IsOk().
  34 // ----------------------------------------------------------------------------
  35
  36 // Using this typedef removes an ambiguity when calling Remove()
  37 typedef void *wxTreeItemIdValue;
  38
  39 class WXDLLEXPORT wxTreeItemId
  40 {
  41     friend bool operator==(const wxTreeItemId&, const wxTreeItemId&);
  42 public:
  43     // ctors
  44         // 0 is invalid value for HTREEITEM
  45     wxTreeItemId() { m_pItem = 0; }
  46
  47         // construct wxTreeItemId from the native item id
  48     wxTreeItemId(void *pItem) { m_pItem = pItem; }
  49
  50         // default copy ctor/assignment operator are ok for us
  51
  52     // accessors
  53         // is this a valid tree item?
  54     bool IsOk() const { return m_pItem != 0; }
  55         // return true if this item is not valid
  56     bool operator!() const { return !IsOk(); }
  57
  58     // operations
  59         // invalidate the item
  60     void Unset() { m_pItem = 0; }
  61
  62 #if WXWIN_COMPATIBILITY_2_4
  63     // deprecated: only for compatibility, don't work on 64 bit archs
  64     wxTreeItemId(long item) { m_pItem = wxUIntToPtr(item); }
  65     operator long() const { return (long)wxPtrToUInt(m_pItem); }
  66 #else // !WXWIN_COMPATIBILITY_2_4
  67     operator bool() const { return IsOk(); }
  68 #endif // WXWIN_COMPATIBILITY_2_4/!WXWIN_COMPATIBILITY_2_4
  69
  70     wxTreeItemIdValue m_pItem;
  71 };
  72
  73 inline bool operator==(const wxTreeItemId& i1, const wxTreeItemId& i2)
  74 {
  75     return i1.m_pItem == i2.m_pItem;
  76 }
  77
  78 inline bool operator!=(const wxTreeItemId& i1, const wxTreeItemId& i2)
  79 {
  80     return i1.m_pItem != i2.m_pItem;
  81 }
  82
  83 // ----------------------------------------------------------------------------
  84 // wxTreeItemData is some (arbitrary) user class associated with some item. The
  85 // main advantage of having this class (compared to old untyped interface) is
  86 // that wxTreeItemData's are destroyed automatically by the tree and, as this
  87 // class has virtual dtor, it means that the memory will be automatically
  88 // freed. OTOH, we don't just use wxObject instead of wxTreeItemData because
  89 // the size of this class is critical: in any real application, each tree leaf
  90 // will have wxTreeItemData associated with it and number of leaves may be
  91 // quite big.
  92 //
  93 // Because the objects of this class are deleted by the tree, they should
  94 // always be allocated on the heap!
  95 // ----------------------------------------------------------------------------
  96
  97 class WXDLLEXPORT wxTreeItemData: public wxClientData
  98 {
  99 friend class WXDLLEXPORT wxTreeCtrl;
 100 friend class WXDLLEXPORT wxGenericTreeCtrl;
 101 public:
 102     // creation/destruction
 103     // --------------------
 104         // default ctor
 105     wxTreeItemData() { }
 106
 107         // default copy ctor/assignment operator are ok
 108
 109     // accessor: get the item associated with us
 110     const wxTreeItemId& GetId() const { return m_pItem; }
 111     void SetId(const wxTreeItemId& id) { m_pItem = id; }
 112
 113 protected:
 114     wxTreeItemId m_pItem;
 115 };
 116
 117 WX_DEFINE_EXPORTED_ARRAY_PTR(wxTreeItemIdValue, wxArrayTreeItemIdsBase);
 118
 119 class WXDLLEXPORT wxArrayTreeItemIds : public wxArrayTreeItemIdsBase
 120 {
 121 public:
 122     void Add(const wxTreeItemId& id)
 123         { wxArrayTreeItemIdsBase::Add(id.m_pItem); }
 124 };
 125
 126 // ----------------------------------------------------------------------------
 127 // constants
 128 // ----------------------------------------------------------------------------
 129
 130 // enum for different images associated with a treectrl item
 131 enum wxTreeItemIcon
 132 {
 133     wxTreeItemIcon_Normal,              // not selected, not expanded
 134     wxTreeItemIcon_Selected,            //     selected, not expanded
 135     wxTreeItemIcon_Expanded,            // not selected,     expanded
 136     wxTreeItemIcon_SelectedExpanded,    //     selected,     expanded
 137     wxTreeItemIcon_Max
 138 };
 139
 140 // ----------------------------------------------------------------------------
 141 // wxTreeCtrl flags
 142 // ----------------------------------------------------------------------------
 143
 144 #define wxTR_NO_BUTTONS              0x0000     // for convenience
 145 #define wxTR_HAS_BUTTONS             0x0001     // draw collapsed/expanded btns
 146 #define wxTR_NO_LINES                0x0004     // don't draw lines at all
 147 #define wxTR_LINES_AT_ROOT           0x0008     // connect top-level nodes
 148 #define wxTR_TWIST_BUTTONS           0x0010     // still used by wxTreeListCtrl
 149
 150 #define wxTR_SINGLE                  0x0000     // for convenience
 151 #define wxTR_MULTIPLE                0x0020     // can select multiple items
 152 #define wxTR_EXTENDED                0x0040     // TODO: allow extended selection
 153 #define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080     // what it says
 154
 155 #define wxTR_EDIT_LABELS             0x0200     // can edit item labels
 156 #define wxTR_ROW_LINES               0x0400     // put border around items
 157 #define wxTR_HIDE_ROOT               0x0800     // don't display root node
 158
 159 #define wxTR_FULL_ROW_HIGHLIGHT      0x2000     // highlight full horz space
 160
 161 #ifdef __WXGTK20__
 162 #define wxTR_DEFAULT_STYLE           (wxTR_HAS_BUTTONS | wxTR_NO_LINES)
 163 #else
 164 #define wxTR_DEFAULT_STYLE           (wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT)
 165 #endif
 166
 167 // deprecated, don't use
 168 #define wxTR_MAC_BUTTONS             0
 169 #define wxTR_AQUA_BUTTONS            0
 170
 171
 172 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
 173 // where exactly the specified point is situated:
 174
 175 static const int wxTREE_HITTEST_ABOVE            = 0x0001;
 176 static const int wxTREE_HITTEST_BELOW            = 0x0002;
 177 static const int wxTREE_HITTEST_NOWHERE          = 0x0004;
 178     // on the button associated with an item.
 179 static const int wxTREE_HITTEST_ONITEMBUTTON     = 0x0008;
 180     // on the bitmap associated with an item.
 181 static const int wxTREE_HITTEST_ONITEMICON       = 0x0010;
 182     // on the indent associated with an item.
 183 static const int wxTREE_HITTEST_ONITEMINDENT     = 0x0020;
 184     // on the label (string) associated with an item.
 185 static const int wxTREE_HITTEST_ONITEMLABEL      = 0x0040;
 186     // on the right of the label associated with an item.
 187 static const int wxTREE_HITTEST_ONITEMRIGHT      = 0x0080;
 188     // on the label (string) associated with an item.
 189 static const int wxTREE_HITTEST_ONITEMSTATEICON  = 0x0100;
 190     // on the left of the wxTreeCtrl.
 191 static const int wxTREE_HITTEST_TOLEFT           = 0x0200;
 192     // on the right of the wxTreeCtrl.
 193 static const int wxTREE_HITTEST_TORIGHT          = 0x0400;
 194     // on the upper part (first half) of the item.
 195 static const int wxTREE_HITTEST_ONITEMUPPERPART  = 0x0800;
 196     // on the lower part (second half) of the item.
 197 static const int wxTREE_HITTEST_ONITEMLOWERPART  = 0x1000;
 198
 199     // anywhere on the item
 200 static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
 201                                           wxTREE_HITTEST_ONITEMLABEL;
 202
 203 // tree ctrl default name
 204 extern WXDLLEXPORT_DATA(const wxChar*) wxTreeCtrlNameStr;
 205
 206 // ----------------------------------------------------------------------------
 207 // wxTreeItemAttr: a structure containing the visual attributes of an item
 208 // ----------------------------------------------------------------------------
 209
 210 class WXDLLEXPORT wxTreeItemAttr
 211 {
 212 public:
 213     // ctors
 214     wxTreeItemAttr() { }
 215     wxTreeItemAttr(const wxColour& colText,
 216                    const wxColour& colBack,
 217                    const wxFont& font)
 218         : m_colText(colText), m_colBack(colBack), m_font(font) { }
 219
 220     // setters
 221     void SetTextColour(const wxColour& colText) { m_colText = colText; }
 222     void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
 223     void SetFont(const wxFont& font) { m_font = font; }
 224
 225     // accessors
 226     bool HasTextColour() const { return m_colText.Ok(); }
 227     bool HasBackgroundColour() const { return m_colBack.Ok(); }
 228     bool HasFont() const { return m_font.Ok(); }
 229
 230     const wxColour& GetTextColour() const { return m_colText; }
 231     const wxColour& GetBackgroundColour() const { return m_colBack; }
 232     const wxFont& GetFont() const { return m_font; }
 233
 234 private:
 235     wxColour m_colText,
 236              m_colBack;
 237     wxFont   m_font;
 238 };
 239
 240 // ----------------------------------------------------------------------------
 241 // wxTreeEvent is a special class for all events associated with tree controls
 242 //
 243 // NB: note that not all accessors make sense for all events, see the event
 244 //     descriptions below
 245 // ----------------------------------------------------------------------------
 246
 247 class WXDLLEXPORT wxTreeEvent : public wxNotifyEvent
 248 {
 249 public:
 250     wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 251     wxTreeEvent(const wxTreeEvent & event);
 252
 253     virtual wxEvent *Clone() const { return new wxTreeEvent(*this); }
 254
 255     // accessors
 256         // get the item on which the operation was performed or the newly
 257         // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
 258     wxTreeItemId GetItem() const { return m_item; }
 259     void SetItem(const wxTreeItemId& item) { m_item = item; }
 260
 261         // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
 262         // selected item
 263     wxTreeItemId GetOldItem() const { return m_itemOld; }
 264     void SetOldItem(const wxTreeItemId& item) { m_itemOld = item; }
 265
 266         // the point where the mouse was when the drag operation started (for
 267         // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only) or click position
 268     wxPoint GetPoint() const { return m_pointDrag; }
 269     void SetPoint(const wxPoint& pt) { m_pointDrag = pt; }
 270
 271         // keyboard data (for wxEVT_COMMAND_TREE_KEY_DOWN only)
 272     const wxKeyEvent& GetKeyEvent() const { return m_evtKey; }
 273     int GetKeyCode() const { return m_evtKey.GetKeyCode(); }
 274     void SetKeyEvent(const wxKeyEvent& evt) { m_evtKey = evt; }
 275
 276         // label (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
 277     const wxString& GetLabel() const { return m_label; }
 278     void SetLabel(const wxString& label) { m_label = label; }
 279
 280         // edit cancel flag (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
 281     bool IsEditCancelled() const { return m_editCancelled; }
 282     void SetEditCanceled(bool editCancelled) { m_editCancelled = editCancelled; }
 283
 284         // Set the tooltip for the item (for EVT\_TREE\_ITEM\_GETTOOLTIP events)
 285     void SetToolTip(const wxString& toolTip) { m_label = toolTip; }
 286
 287 #if WXWIN_COMPATIBILITY_2_2
 288     // for compatibility only, don't use
 289     wxDEPRECATED( int GetCode() const);
 290 #endif // WXWIN_COMPATIBILITY_2_2
 291
 292 private:
 293     // not all of the members are used (or initialized) for all events
 294     wxKeyEvent    m_evtKey;
 295     wxTreeItemId  m_item,
 296                   m_itemOld;
 297     wxPoint       m_pointDrag;
 298     wxString      m_label;
 299     bool          m_editCancelled;
 300
 301     friend class WXDLLEXPORT wxTreeCtrl;
 302     friend class WXDLLEXPORT wxGenericTreeCtrl;
 303
 304     DECLARE_DYNAMIC_CLASS(wxTreeEvent)
 305 };
 306
 307 typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
 308
 309 // ----------------------------------------------------------------------------
 310 // tree control events and macros for handling them
 311 // ----------------------------------------------------------------------------
 312
 313 BEGIN_DECLARE_EVENT_TYPES()
 314     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_DRAG, 600)
 315     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_RDRAG, 601)
 316     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, 602)
 317     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_LABEL_EDIT, 603)
 318     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_DELETE_ITEM, 604)
 319     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_GET_INFO, 605)
 320     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SET_INFO, 606)
 321     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDED, 607)
 322     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDING, 608)
 323     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSED, 609)
 324     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSING, 610)
 325     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGED, 611)
 326     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGING, 612)
 327     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_KEY_DOWN, 613)
 328     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_ACTIVATED, 614)
 329     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, 615)
 330     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, 616)
 331     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_DRAG, 617)
 332     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, 618)
 333     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP, 619)
 334     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_MENU, 620)
 335 END_DECLARE_EVENT_TYPES()
 336
 337 #define wxTreeEventHandler(func) \
 338     (wxObjectEventFunction)wxStaticCastEvent(wxTreeEventFunction, &func)
 339
 340 #define wx__DECLARE_TREEEVT(evt, id, fn) \
 341     wx__DECLARE_EVT1(wxEVT_COMMAND_TREE_ ## evt, id, wxTreeEventHandler(fn))
 342
 343 // GetItem() returns the item being dragged, GetPoint() the mouse coords
 344 //
 345 // if you call event.Allow(), the drag operation will start and a
 346 // EVT_TREE_END_DRAG event will be sent when the drag is over.
 347 #define EVT_TREE_BEGIN_DRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_DRAG, id, fn)
 348 #define EVT_TREE_BEGIN_RDRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_RDRAG, id, fn)
 349
 350 // GetItem() is the item on which the drop occured (if any) and GetPoint() the
 351 // current mouse coords
 352 #define EVT_TREE_END_DRAG(id, fn) wx__DECLARE_TREEEVT(END_DRAG, id, fn)
 353
 354 // GetItem() returns the itme whose label is being edited, GetLabel() returns
 355 // the current item label for BEGIN and the would be new one for END.
 356 //
 357 // Vetoing BEGIN event means that label editing won't happen at all,
 358 // vetoing END means that the new value is discarded and the old one kept
 359 #define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) wx__DECLARE_TREEEVT(BEGIN_LABEL_EDIT, id, fn)
 360 #define EVT_TREE_END_LABEL_EDIT(id, fn) wx__DECLARE_TREEEVT(END_LABEL_EDIT, id, fn)
 361
 362 // provide/update information about GetItem() item
 363 #define EVT_TREE_GET_INFO(id, fn) wx__DECLARE_TREEEVT(GET_INFO, id, fn)
 364 #define EVT_TREE_SET_INFO(id, fn) wx__DECLARE_TREEEVT(SET_INFO, id, fn)
 365
 366 // GetItem() is the item being expanded/collapsed, the "ING" versions can use
 367 #define EVT_TREE_ITEM_EXPANDED(id, fn) wx__DECLARE_TREEEVT(ITEM_EXPANDED, id, fn)
 368 #define EVT_TREE_ITEM_EXPANDING(id, fn) wx__DECLARE_TREEEVT(ITEM_EXPANDING, id, fn)
 369 #define EVT_TREE_ITEM_COLLAPSED(id, fn) wx__DECLARE_TREEEVT(ITEM_COLLAPSED, id, fn)
 370 #define EVT_TREE_ITEM_COLLAPSING(id, fn) wx__DECLARE_TREEEVT(ITEM_COLLAPSING, id, fn)
 371
 372 // GetOldItem() is the item which had the selection previously, GetItem() is
 373 // the item which acquires selection
 374 #define EVT_TREE_SEL_CHANGED(id, fn) wx__DECLARE_TREEEVT(SEL_CHANGED, id, fn)
 375 #define EVT_TREE_SEL_CHANGING(id, fn) wx__DECLARE_TREEEVT(SEL_CHANGING, id, fn)
 376
 377 // GetKeyCode() returns the key code
 378 // NB: this is the only message for which GetItem() is invalid (you may get the
 379 //     item from GetSelection())
 380 #define EVT_TREE_KEY_DOWN(id, fn) wx__DECLARE_TREEEVT(KEY_DOWN, id, fn)
 381
 382 // GetItem() returns the item being deleted, the associated data (if any) will
 383 // be deleted just after the return of this event handler (if any)
 384 #define EVT_TREE_DELETE_ITEM(id, fn) wx__DECLARE_TREEEVT(DELETE_ITEM, id, fn)
 385
 386 // GetItem() returns the item that was activated (double click, enter, space)
 387 #define EVT_TREE_ITEM_ACTIVATED(id, fn) wx__DECLARE_TREEEVT(ITEM_ACTIVATED, id, fn)
 388
 389 // GetItem() returns the item for which the context menu shall be shown
 390 #define EVT_TREE_ITEM_MENU(id, fn) wx__DECLARE_TREEEVT(ITEM_MENU, id, fn)
 391
 392 // GetItem() returns the item that was clicked on
 393 #define EVT_TREE_ITEM_RIGHT_CLICK(id, fn) wx__DECLARE_TREEEVT(ITEM_RIGHT_CLICK, id, fn)
 394 #define EVT_TREE_ITEM_MIDDLE_CLICK(id, fn) wx__DECLARE_TREEEVT(ITEM_MIDDLE_CLICK, id, fn)
 395
 396 // GetItem() returns the item whose state image was clicked on
 397 #define EVT_TREE_STATE_IMAGE_CLICK(id, fn) wx__DECLARE_TREEEVT(STATE_IMAGE_CLICK, id, fn)
 398
 399 // GetItem() is the item for which the tooltip is being requested
 400 #define EVT_TREE_ITEM_GETTOOLTIP(id, fn) wx__DECLARE_TREEEVT(ITEM_GETTOOLTIP, id, fn)
 401
 402 #endif // wxUSE_TREECTRL
 403
 404 #endif // _WX_TREEBASE_H_
 405