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