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