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