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 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     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 WXDLLEXPORT 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 WXDLLEXPORT 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 // ----------------------------------------------------------------------------
 154 // wxTreeCtrl flags
 155 // ----------------------------------------------------------------------------
 156
 157 #define wxTR_NO_BUTTONS              0x0000     // for convenience
 158 #define wxTR_HAS_BUTTONS             0x0001     // draw collapsed/expanded btns
 159 #define wxTR_NO_LINES                0x0004     // don't draw lines at all
 160 #define wxTR_LINES_AT_ROOT           0x0008     // connect top-level nodes
 161 #define wxTR_TWIST_BUTTONS           0x0010     // still used by wxTreeListCtrl
 162
 163 #define wxTR_SINGLE                  0x0000     // for convenience
 164 #define wxTR_MULTIPLE                0x0020     // can select multiple items
 165
 166 #if WXWIN_COMPATIBILITY_2_8
 167     #define wxTR_EXTENDED            0x0040     // deprecated, don't use
 168 #endif // WXWIN_COMPATIBILITY_2_8
 169
 170 #define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080     // what it says
 171
 172 #define wxTR_EDIT_LABELS             0x0200     // can edit item labels
 173 #define wxTR_ROW_LINES               0x0400     // put border around items
 174 #define wxTR_HIDE_ROOT               0x0800     // don't display root node
 175
 176 #define wxTR_FULL_ROW_HIGHLIGHT      0x2000     // highlight full horz space
 177
 178 // make the default control appearance look more native-like depending on the
 179 // platform
 180 #if defined(__WXGTK20__)
 181     #define wxTR_DEFAULT_STYLE       (wxTR_HAS_BUTTONS | wxTR_NO_LINES)
 182 #elif defined(__WXMAC__)
 183     #define wxTR_DEFAULT_STYLE \
 184         (wxTR_HAS_BUTTONS | wxTR_NO_LINES | wxTR_FULL_ROW_HIGHLIGHT)
 185 #else
 186     #define wxTR_DEFAULT_STYLE       (wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT)
 187 #endif
 188
 189 #if WXWIN_COMPATIBILITY_2_6
 190 // deprecated, don't use
 191 #define wxTR_MAC_BUTTONS             0
 192 #define wxTR_AQUA_BUTTONS            0
 193 #endif // WXWIN_COMPATIBILITY_2_6
 194
 195
 196 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
 197 // where exactly the specified point is situated:
 198
 199 static const int wxTREE_HITTEST_ABOVE            = 0x0001;
 200 static const int wxTREE_HITTEST_BELOW            = 0x0002;
 201 static const int wxTREE_HITTEST_NOWHERE          = 0x0004;
 202     // on the button associated with an item.
 203 static const int wxTREE_HITTEST_ONITEMBUTTON     = 0x0008;
 204     // on the bitmap associated with an item.
 205 static const int wxTREE_HITTEST_ONITEMICON       = 0x0010;
 206     // on the indent associated with an item.
 207 static const int wxTREE_HITTEST_ONITEMINDENT     = 0x0020;
 208     // on the label (string) associated with an item.
 209 static const int wxTREE_HITTEST_ONITEMLABEL      = 0x0040;
 210     // on the right of the label associated with an item.
 211 static const int wxTREE_HITTEST_ONITEMRIGHT      = 0x0080;
 212     // on the label (string) associated with an item.
 213 static const int wxTREE_HITTEST_ONITEMSTATEICON  = 0x0100;
 214     // on the left of the wxTreeCtrl.
 215 static const int wxTREE_HITTEST_TOLEFT           = 0x0200;
 216     // on the right of the wxTreeCtrl.
 217 static const int wxTREE_HITTEST_TORIGHT          = 0x0400;
 218     // on the upper part (first half) of the item.
 219 static const int wxTREE_HITTEST_ONITEMUPPERPART  = 0x0800;
 220     // on the lower part (second half) of the item.
 221 static const int wxTREE_HITTEST_ONITEMLOWERPART  = 0x1000;
 222
 223     // anywhere on the item
 224 static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
 225                                           wxTREE_HITTEST_ONITEMLABEL;
 226
 227 // tree ctrl default name
 228 extern WXDLLEXPORT_DATA(const char) wxTreeCtrlNameStr[];
 229
 230 // ----------------------------------------------------------------------------
 231 // wxTreeItemAttr: a structure containing the visual attributes of an item
 232 // ----------------------------------------------------------------------------
 233
 234 class WXDLLEXPORT wxTreeItemAttr
 235 {
 236 public:
 237     // ctors
 238     wxTreeItemAttr() { }
 239     wxTreeItemAttr(const wxColour& colText,
 240                    const wxColour& colBack,
 241                    const wxFont& font)
 242         : m_colText(colText), m_colBack(colBack), m_font(font) { }
 243
 244     // setters
 245     void SetTextColour(const wxColour& colText) { m_colText = colText; }
 246     void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
 247     void SetFont(const wxFont& font) { m_font = font; }
 248
 249     // accessors
 250     bool HasTextColour() const { return m_colText.Ok(); }
 251     bool HasBackgroundColour() const { return m_colBack.Ok(); }
 252     bool HasFont() const { return m_font.Ok(); }
 253
 254     const wxColour& GetTextColour() const { return m_colText; }
 255     const wxColour& GetBackgroundColour() const { return m_colBack; }
 256     const wxFont& GetFont() const { return m_font; }
 257
 258 private:
 259     wxColour m_colText,
 260              m_colBack;
 261     wxFont   m_font;
 262 };
 263
 264 // ----------------------------------------------------------------------------
 265 // wxTreeEvent is a special class for all events associated with tree controls
 266 //
 267 // NB: note that not all accessors make sense for all events, see the event
 268 //     descriptions below
 269 // ----------------------------------------------------------------------------
 270
 271 class WXDLLIMPEXP_FWD_CORE wxTreeCtrlBase;
 272
 273 class WXDLLEXPORT wxTreeEvent : public wxNotifyEvent
 274 {
 275 public:
 276     wxTreeEvent(wxEventType commandType,
 277                 wxTreeCtrlBase *tree,
 278                 const wxTreeItemId &item = wxTreeItemId());
 279     wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 280     wxTreeEvent(const wxTreeEvent& event);
 281
 282     virtual wxEvent *Clone() const { return new wxTreeEvent(*this); }
 283
 284     // accessors
 285         // get the item on which the operation was performed or the newly
 286         // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
 287     wxTreeItemId GetItem() const { return m_item; }
 288     void SetItem(const wxTreeItemId& item) { m_item = item; }
 289
 290         // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
 291         // selected item
 292     wxTreeItemId GetOldItem() const { return m_itemOld; }
 293     void SetOldItem(const wxTreeItemId& item) { m_itemOld = item; }
 294
 295         // the point where the mouse was when the drag operation started (for
 296         // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only) or click position
 297     wxPoint GetPoint() const { return m_pointDrag; }
 298     void SetPoint(const wxPoint& pt) { m_pointDrag = pt; }
 299
 300         // keyboard data (for wxEVT_COMMAND_TREE_KEY_DOWN only)
 301     const wxKeyEvent& GetKeyEvent() const { return m_evtKey; }
 302     int GetKeyCode() const { return m_evtKey.GetKeyCode(); }
 303     void SetKeyEvent(const wxKeyEvent& evt) { m_evtKey = evt; }
 304
 305         // label (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
 306     const wxString& GetLabel() const { return m_label; }
 307     void SetLabel(const wxString& label) { m_label = label; }
 308
 309         // edit cancel flag (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
 310     bool IsEditCancelled() const { return m_editCancelled; }
 311     void SetEditCanceled(bool editCancelled) { m_editCancelled = editCancelled; }
 312
 313         // Set the tooltip for the item (for EVT\_TREE\_ITEM\_GETTOOLTIP events)
 314     void SetToolTip(const wxString& toolTip) { m_label = toolTip; }
 315     wxString GetToolTip() { return m_label; }
 316
 317 private:
 318     // not all of the members are used (or initialized) for all events
 319     wxKeyEvent    m_evtKey;
 320     wxTreeItemId  m_item,
 321                   m_itemOld;
 322     wxPoint       m_pointDrag;
 323     wxString      m_label;
 324     bool          m_editCancelled;
 325
 326     friend class WXDLLIMPEXP_FWD_CORE wxTreeCtrl;
 327     friend class WXDLLIMPEXP_FWD_CORE wxGenericTreeCtrl;
 328
 329     DECLARE_DYNAMIC_CLASS(wxTreeEvent)
 330 };
 331
 332 typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
 333
 334 // ----------------------------------------------------------------------------
 335 // tree control events and macros for handling them
 336 // ----------------------------------------------------------------------------
 337
 338 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_BEGIN_DRAG;
 339 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_BEGIN_RDRAG;
 340 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT;
 341 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_END_LABEL_EDIT;
 342 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_DELETE_ITEM;
 343 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_GET_INFO;
 344 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_SET_INFO;
 345 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDED;
 346 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDING;
 347 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSED;
 348 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSING;
 349 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGED;
 350 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGING;
 351 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_KEY_DOWN;
 352 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_ACTIVATED;
 353 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK;
 354 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK;
 355 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_END_DRAG;
 356 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK;
 357 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP;
 358 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_MENU;
 359
 360 #define wxTreeEventHandler(func) \
 361     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTreeEventFunction, &func)
 362
 363 #define wx__DECLARE_TREEEVT(evt, id, fn) \
 364     wx__DECLARE_EVT1(wxEVT_COMMAND_TREE_ ## evt, id, wxTreeEventHandler(fn))
 365
 366 // GetItem() returns the item being dragged, GetPoint() the mouse coords
 367 //
 368 // if you call event.Allow(), the drag operation will start and a
 369 // EVT_TREE_END_DRAG event will be sent when the drag is over.
 370 #define EVT_TREE_BEGIN_DRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_DRAG, id, fn)
 371 #define EVT_TREE_BEGIN_RDRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_RDRAG, id, fn)
 372
 373 // GetItem() is the item on which the drop occurred (if any) and GetPoint() the
 374 // current mouse coords
 375 #define EVT_TREE_END_DRAG(id, fn) wx__DECLARE_TREEEVT(END_DRAG, id, fn)
 376
 377 // GetItem() returns the itme whose label is being edited, GetLabel() returns
 378 // the current item label for BEGIN and the would be new one for END.
 379 //
 380 // Vetoing BEGIN event means that label editing won't happen at all,
 381 // vetoing END means that the new value is discarded and the old one kept
 382 #define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) wx__DECLARE_TREEEVT(BEGIN_LABEL_EDIT, id, fn)
 383 #define EVT_TREE_END_LABEL_EDIT(id, fn) wx__DECLARE_TREEEVT(END_LABEL_EDIT, id, fn)
 384
 385 // provide/update information about GetItem() item
 386 #define EVT_TREE_GET_INFO(id, fn) wx__DECLARE_TREEEVT(GET_INFO, id, fn)
 387 #define EVT_TREE_SET_INFO(id, fn) wx__DECLARE_TREEEVT(SET_INFO, id, fn)
 388
 389 // GetItem() is the item being expanded/collapsed, the "ING" versions can use
 390 #define EVT_TREE_ITEM_EXPANDED(id, fn) wx__DECLARE_TREEEVT(ITEM_EXPANDED, id, fn)
 391 #define EVT_TREE_ITEM_EXPANDING(id, fn) wx__DECLARE_TREEEVT(ITEM_EXPANDING, id, fn)
 392 #define EVT_TREE_ITEM_COLLAPSED(id, fn) wx__DECLARE_TREEEVT(ITEM_COLLAPSED, id, fn)
 393 #define EVT_TREE_ITEM_COLLAPSING(id, fn) wx__DECLARE_TREEEVT(ITEM_COLLAPSING, id, fn)
 394
 395 // GetOldItem() is the item which had the selection previously, GetItem() is
 396 // the item which acquires selection
 397 #define EVT_TREE_SEL_CHANGED(id, fn) wx__DECLARE_TREEEVT(SEL_CHANGED, id, fn)
 398 #define EVT_TREE_SEL_CHANGING(id, fn) wx__DECLARE_TREEEVT(SEL_CHANGING, id, fn)
 399
 400 // GetKeyCode() returns the key code
 401 // NB: this is the only message for which GetItem() is invalid (you may get the
 402 //     item from GetSelection())
 403 #define EVT_TREE_KEY_DOWN(id, fn) wx__DECLARE_TREEEVT(KEY_DOWN, id, fn)
 404
 405 // GetItem() returns the item being deleted, the associated data (if any) will
 406 // be deleted just after the return of this event handler (if any)
 407 #define EVT_TREE_DELETE_ITEM(id, fn) wx__DECLARE_TREEEVT(DELETE_ITEM, id, fn)
 408
 409 // GetItem() returns the item that was activated (double click, enter, space)
 410 #define EVT_TREE_ITEM_ACTIVATED(id, fn) wx__DECLARE_TREEEVT(ITEM_ACTIVATED, id, fn)
 411
 412 // GetItem() returns the item for which the context menu shall be shown
 413 #define EVT_TREE_ITEM_MENU(id, fn) wx__DECLARE_TREEEVT(ITEM_MENU, id, fn)
 414
 415 // GetItem() returns the item that was clicked on
 416 #define EVT_TREE_ITEM_RIGHT_CLICK(id, fn) wx__DECLARE_TREEEVT(ITEM_RIGHT_CLICK, id, fn)
 417 #define EVT_TREE_ITEM_MIDDLE_CLICK(id, fn) wx__DECLARE_TREEEVT(ITEM_MIDDLE_CLICK, id, fn)
 418
 419 // GetItem() returns the item whose state image was clicked on
 420 #define EVT_TREE_STATE_IMAGE_CLICK(id, fn) wx__DECLARE_TREEEVT(STATE_IMAGE_CLICK, id, fn)
 421
 422 // GetItem() is the item for which the tooltip is being requested
 423 #define EVT_TREE_ITEM_GETTOOLTIP(id, fn) wx__DECLARE_TREEEVT(ITEM_GETTOOLTIP, id, fn)
 424
 425 #endif // wxUSE_TREECTRL
 426
 427 #endif // _WX_TREEBASE_H_