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