include/wx/treebase.h

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