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