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 // TODO: maybe renumber these?
 129 #define wxTR_NO_BUTTONS              0x0000     // for convenience
 130 #define wxTR_HAS_BUTTONS             0x0001     // generates a +/- button
 131 #define wxTR_TWIST_BUTTONS           0x0002     // generates a twister button
 132 #define wxTR_NO_LINES                0x0004     // don't generate level connectors
 133 #define wxTR_LINES_AT_ROOT           0x0008     // connect top-level nodes
 134 #define wxTR_MAC_BUTTONS             wxTR_TWIST_BUTTONS // backward compatibility
 135 #define wxTR_AQUA_BUTTONS            0x0010     // used internally
 136
 137 #define wxTR_SINGLE                  0x0000     // for convenience
 138 #define wxTR_MULTIPLE                0x0020     // can select multiple items
 139 #define wxTR_EXTENDED                0x0040     // TODO: allow extended selection
 140 #define wxTR_FULL_ROW_HIGHLIGHT      0x2000     // highlight full horizontal space
 141
 142 #define wxTR_EDIT_LABELS             0x0200     // can edit item labels
 143 #define wxTR_ROW_LINES               0x0400     // put border around items
 144 #define wxTR_HIDE_ROOT               0x0800     // don't display root node
 145 #define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080     // what it says
 146
 147 // TODO: different default styles for wxGTK, wxMotif, whatever?
 148 #ifdef __WXMAC__
 149     #define wxTR_DEFAULT_STYLE (wxTR_TWIST_BUTTONS|wxTR_NO_LINES|wxTR_ROW_LINES)
 150 #else
 151     #define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS|wxTR_LINES_AT_ROOT)
 152 #endif
 153
 154 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
 155 // where exactly the specified point is situated:
 156
 157 static const int wxTREE_HITTEST_ABOVE            = 0x0001;
 158 static const int wxTREE_HITTEST_BELOW            = 0x0002;
 159 static const int wxTREE_HITTEST_NOWHERE          = 0x0004;
 160     // on the button associated with an item.
 161 static const int wxTREE_HITTEST_ONITEMBUTTON     = 0x0008;
 162     // on the bitmap associated with an item.
 163 static const int wxTREE_HITTEST_ONITEMICON       = 0x0010;
 164     // on the indent associated with an item.
 165 static const int wxTREE_HITTEST_ONITEMINDENT     = 0x0020;
 166     // on the label (string) associated with an item.
 167 static const int wxTREE_HITTEST_ONITEMLABEL      = 0x0040;
 168     // on the right of the label associated with an item.
 169 static const int wxTREE_HITTEST_ONITEMRIGHT      = 0x0080;
 170     // on the label (string) associated with an item.
 171 static const int wxTREE_HITTEST_ONITEMSTATEICON  = 0x0100;
 172     // on the left of the wxTreeCtrl.
 173 static const int wxTREE_HITTEST_TOLEFT           = 0x0200;
 174     // on the right of the wxTreeCtrl.
 175 static const int wxTREE_HITTEST_TORIGHT          = 0x0400;
 176     // on the upper part (first half) of the item.
 177 static const int wxTREE_HITTEST_ONITEMUPPERPART  = 0x0800;
 178     // on the lower part (second half) of the item.
 179 static const int wxTREE_HITTEST_ONITEMLOWERPART  = 0x1000;
 180
 181     // anywhere on the item
 182 static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
 183                                           wxTREE_HITTEST_ONITEMLABEL;
 184
 185 // tree ctrl default name
 186 WXDLLEXPORT_DATA(extern const wxChar*) wxTreeCtrlNameStr;
 187
 188 // ----------------------------------------------------------------------------
 189 // wxTreeItemAttr: a structure containing the visual attributes of an item
 190 // ----------------------------------------------------------------------------
 191
 192 class WXDLLEXPORT wxTreeItemAttr
 193 {
 194 public:
 195     // ctors
 196     wxTreeItemAttr() { }
 197     wxTreeItemAttr(const wxColour& colText,
 198                    const wxColour& colBack,
 199                    const wxFont& font)
 200         : m_colText(colText), m_colBack(colBack), m_font(font) { }
 201
 202     // setters
 203     void SetTextColour(const wxColour& colText) { m_colText = colText; }
 204     void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
 205     void SetFont(const wxFont& font) { m_font = font; }
 206
 207     // accessors
 208     bool HasTextColour() const { return m_colText.Ok(); }
 209     bool HasBackgroundColour() const { return m_colBack.Ok(); }
 210     bool HasFont() const { return m_font.Ok(); }
 211
 212     const wxColour& GetTextColour() const { return m_colText; }
 213     const wxColour& GetBackgroundColour() const { return m_colBack; }
 214     const wxFont& GetFont() const { return m_font; }
 215
 216 private:
 217     wxColour m_colText,
 218              m_colBack;
 219     wxFont   m_font;
 220 };
 221
 222 // ----------------------------------------------------------------------------
 223 // wxTreeEvent is a special class for all events associated with tree controls
 224 //
 225 // NB: note that not all accessors make sense for all events, see the event
 226 //     descriptions below
 227 // ----------------------------------------------------------------------------
 228
 229 class WXDLLEXPORT wxTreeEvent : public wxNotifyEvent
 230 {
 231 public:
 232     wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 233
 234     // accessors
 235         // get the item on which the operation was performed or the newly
 236         // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
 237     wxTreeItemId GetItem() const { return m_item; }
 238     void SetItem(const wxTreeItemId& item) { m_item = item; }
 239
 240         // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
 241         // selected item
 242     wxTreeItemId GetOldItem() const { return m_itemOld; }
 243     void SetOldItem(const wxTreeItemId& item) { m_itemOld = item; }
 244
 245         // the point where the mouse was when the drag operation started (for
 246         // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only) or click position
 247     wxPoint GetPoint() const { return m_pointDrag; }
 248     void SetPoint(const wxPoint& pt) { m_pointDrag = pt; }
 249
 250         // keyboard data (for wxEVT_COMMAND_TREE_KEY_DOWN only)
 251     const wxKeyEvent& GetKeyEvent() const { return m_evtKey; }
 252     int GetKeyCode() const { return m_evtKey.GetKeyCode(); }
 253     void SetKeyEvent(const wxKeyEvent& evt) { m_evtKey = evt; }
 254
 255         // label (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
 256     const wxString& GetLabel() const { return m_label; }
 257     void SetLabel(const wxString& label) { m_label = label; }
 258
 259         // edit cancel flag (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
 260     bool IsEditCancelled() const { return m_editCancelled; }
 261     void SetEditCanceled(bool editCancelled) { m_editCancelled = editCancelled; }
 262
 263 #if WXWIN_COMPATIBILITY_2_2
 264     // for compatibility only, don't use
 265     int GetCode() const { return m_evtKey.GetKeyCode(); }
 266 #endif // WXWIN_COMPATIBILITY_2_2
 267
 268 private:
 269     // not all of the members are used (or initialized) for all events
 270     wxKeyEvent    m_evtKey;
 271     wxTreeItemId  m_item,
 272                   m_itemOld;
 273     wxPoint       m_pointDrag;
 274     wxString      m_label;
 275     bool          m_editCancelled;
 276
 277     friend class WXDLLEXPORT wxTreeCtrl;
 278     friend class WXDLLEXPORT wxGenericTreeCtrl;
 279
 280     DECLARE_DYNAMIC_CLASS(wxTreeEvent);
 281 };
 282
 283 typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
 284
 285 // ----------------------------------------------------------------------------
 286 // tree control events and macros for handling them
 287 // ----------------------------------------------------------------------------
 288
 289 BEGIN_DECLARE_EVENT_TYPES()
 290     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_DRAG, 600)
 291     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_RDRAG, 601)
 292     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, 602)
 293     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_LABEL_EDIT, 603)
 294     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_DELETE_ITEM, 604)
 295     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_GET_INFO, 605)
 296     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SET_INFO, 606)
 297     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDED, 607)
 298     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDING, 608)
 299     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSED, 609)
 300     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSING, 610)
 301     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGED, 611)
 302     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGING, 612)
 303     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_KEY_DOWN, 613)
 304     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_ACTIVATED, 614)
 305     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, 615)
 306     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, 616)
 307     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_DRAG, 617)
 308     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, 618)
 309 END_DECLARE_EVENT_TYPES()
 310
 311 // GetItem() returns the item being dragged, GetPoint() the mouse coords
 312 //
 313 // if you call event.Allow(), the drag operation will start and a
 314 // EVT_TREE_END_DRAG event will be sent when the drag is over.
 315 #define EVT_TREE_BEGIN_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
 316 #define EVT_TREE_BEGIN_RDRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
 317
 318 // GetItem() is the item on which the drop occured (if any) and GetPoint() the
 319 // current mouse coords
 320 #define EVT_TREE_END_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_END_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
 321
 322 // GetItem() returns the itme whose label is being edited, GetLabel() returns
 323 // the current item label for BEGIN and the would be new one for END.
 324 //
 325 // Vetoing BEGIN event means that label editing won't happen at all,
 326 // vetoing END means that the new value is discarded and the old one kept
 327 #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 ),
 328 #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 ),
 329
 330 // provide/update information about GetItem() item
 331 #define EVT_TREE_GET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
 332 #define EVT_TREE_SET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
 333
 334 // GetItem() is the item being expanded/collapsed, the "ING" versions can use
 335 #define EVT_TREE_ITEM_EXPANDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
 336 #define EVT_TREE_ITEM_EXPANDING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
 337 #define EVT_TREE_ITEM_COLLAPSED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
 338 #define EVT_TREE_ITEM_COLLAPSING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
 339
 340 // GetOldItem() is the item which had the selection previously, GetItem() is
 341 // the item which acquires selection
 342 #define EVT_TREE_SEL_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
 343 #define EVT_TREE_SEL_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
 344
 345 // GetKeyCode() returns the key code
 346 // NB: this is the only message for which GetItem() is invalid (you may get the
 347 //     item from GetSelection())
 348 #define EVT_TREE_KEY_DOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
 349
 350 // GetItem() returns the item being deleted, the associated data (if any) will
 351 // be deleted just after the return of this event handler (if any)
 352 #define EVT_TREE_DELETE_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
 353
 354 // GetItem() returns the item that was activated (double click, enter, space)
 355 #define EVT_TREE_ITEM_ACTIVATED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
 356
 357 // GetItem() returns the item that was clicked on
 358 #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 ),
 359 #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 ),
 360
 361 // GetItem() returns the item whose state image was clicked on
 362 #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 ),
 363
 364 #endif // wxUSE_TREECTRL
 365
 366 #endif // _WX_TREEBASE_H_
 367