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