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