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