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