include/wx/treebase.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        treectrl.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 #include "wx/control.h"
  24 #include "wx/event.h"
  25
  26 // ----------------------------------------------------------------------------
  27 // wxTreeItemId identifies an element of the tree. In this implementation, it's
  28 // just a trivial wrapper around Win32 HTREEITEM. It's opaque for the
  29 // application.
  30 // ----------------------------------------------------------------------------
  31
  32 // Using this typedef removes an ambiguity when calling Remove()
  33 typedef unsigned long wxTreeItemIdValue;
  34
  35 class WXDLLEXPORT wxTreeItemId
  36 {
  37 friend class WXDLLEXPORT wxTreeCtrl;
  38 friend class WXDLLEXPORT wxGenericTreeCtrl;
  39 friend class WXDLLEXPORT wxTreeEvent;
  40 public:
  41     // ctors
  42         // 0 is invalid value for HTREEITEM
  43     wxTreeItemId() { m_pItem = 0; }
  44
  45         // default copy ctor/assignment operator are ok for us
  46
  47     // accessors
  48         // is this a valid tree item?
  49     bool IsOk() const { return m_pItem != 0; }
  50
  51     // deprecated: only for compatibility
  52     wxTreeItemId(long itemId) { m_pItem = itemId; }
  53     //operator long() const { return m_pItem; }
  54     operator wxTreeItemIdValue() const { return m_pItem; }
  55
  56     void operator=(long item) { m_pItem = item; }
  57
  58     wxTreeItemId(void *pItem) { m_pItem = (long) 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
 114 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
 115 // where exactly the specified point is situated:
 116
 117 static const int wxTREE_HITTEST_ABOVE            = 0x0001;
 118 static const int wxTREE_HITTEST_BELOW            = 0x0002;
 119 static const int wxTREE_HITTEST_NOWHERE          = 0x0004;
 120     // on the button associated with an item.
 121 static const int wxTREE_HITTEST_ONITEMBUTTON     = 0x0008;
 122     // on the bitmap associated with an item.
 123 static const int wxTREE_HITTEST_ONITEMICON       = 0x0010;
 124     // on the indent associated with an item.
 125 static const int wxTREE_HITTEST_ONITEMINDENT     = 0x0020;
 126     // on the label (string) associated with an item.
 127 static const int wxTREE_HITTEST_ONITEMLABEL      = 0x0040;
 128     // on the right of the label associated with an item.
 129 static const int wxTREE_HITTEST_ONITEMRIGHT      = 0x0080;
 130     // on the label (string) associated with an item.
 131 static const int wxTREE_HITTEST_ONITEMSTATEICON  = 0x0100;
 132     // on the left of the wxTreeCtrl.
 133 static const int wxTREE_HITTEST_TOLEFT           = 0x0200;
 134     // on the right of the wxTreeCtrl.
 135 static const int wxTREE_HITTEST_TORIGHT          = 0x0400;
 136     // on the upper part (first half) of the item.
 137 static const int wxTREE_HITTEST_ONITEMUPPERPART  = 0x0800;
 138     // on the lower part (second half) of the item.
 139 static const int wxTREE_HITTEST_ONITEMLOWERPART  = 0x1000;
 140
 141     // anywhere on the item
 142 static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
 143                                           wxTREE_HITTEST_ONITEMLABEL;
 144
 145 // tree ctrl default name
 146 WXDLLEXPORT_DATA(extern const char*) wxTreeCtrlNameStr;
 147
 148 // ----------------------------------------------------------------------------
 149 // wxTreeItemAttr: a structure containing the visual attributes of an item
 150 // ----------------------------------------------------------------------------
 151
 152 class WXDLLEXPORT wxTreeItemAttr
 153 {
 154 public:
 155     // ctors
 156     wxTreeItemAttr() { }
 157     wxTreeItemAttr(const wxColour& colText,
 158                    const wxColour& colBack,
 159                    const wxFont& font)
 160         : m_colText(colText), m_colBack(colBack), m_font(font) { }
 161
 162     // setters
 163     void SetTextColour(const wxColour& colText) { m_colText = colText; }
 164     void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
 165     void SetFont(const wxFont& font) { m_font = font; }
 166
 167     // accessors
 168     bool HasTextColour() const { return m_colText.Ok(); }
 169     bool HasBackgroundColour() const { return m_colBack.Ok(); }
 170     bool HasFont() const { return m_font.Ok(); }
 171
 172     const wxColour& GetTextColour() const { return m_colText; }
 173     const wxColour& GetBackgroundColour() const { return m_colBack; }
 174     const wxFont& GetFont() const { return m_font; }
 175
 176 private:
 177     wxColour m_colText,
 178              m_colBack;
 179     wxFont   m_font;
 180 };
 181
 182 // ----------------------------------------------------------------------------
 183 // wxTreeEvent is a special class for all events associated with tree controls
 184 //
 185 // NB: note that not all accessors make sense for all events, see the event
 186 //     descriptions below
 187 // ----------------------------------------------------------------------------
 188
 189 class WXDLLEXPORT wxTreeEvent : public wxNotifyEvent
 190 {
 191     friend class WXDLLEXPORT wxTreeCtrl;
 192     friend class WXDLLEXPORT wxGenericTreeCtrl;
 193
 194 public:
 195     wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 196
 197     // accessors
 198         // get the item on which the operation was performed or the newly
 199         // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
 200     wxTreeItemId GetItem() const { return m_item; }
 201
 202         // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
 203         // selected item
 204     wxTreeItemId GetOldItem() const { return m_itemOld; }
 205
 206         // the point where the mouse was when the drag operation started (for
 207         // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only)
 208     wxPoint GetPoint() const { return m_pointDrag; }
 209
 210         // keyboard code (for wxEVT_COMMAND_TREE_KEY_DOWN only)
 211     int GetCode() const { return m_code; }
 212
 213         // label (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
 214     const wxString& GetLabel() const { return m_label; }
 215
 216 private:
 217     // we could probably save some space by using union here
 218     int           m_code;
 219     wxTreeItemId  m_item,
 220                   m_itemOld;
 221     wxPoint       m_pointDrag;
 222     wxString      m_label;
 223
 224     DECLARE_DYNAMIC_CLASS(wxTreeEvent)
 225 };
 226
 227 typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
 228
 229 // ----------------------------------------------------------------------------
 230 // macros for handling tree control events
 231 // ----------------------------------------------------------------------------
 232
 233 // GetItem() returns the item being dragged, GetPoint() the mouse coords
 234 //
 235 // if you call event.Allow(), the drag operation will start and a
 236 // EVT_TREE_END_DRAG event will be sent when the drag is over.
 237 #define EVT_TREE_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 238 #define EVT_TREE_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 239
 240 // GetItem() is the item on which the drop occured (if any) and GetPoint() the
 241 // current mouse coords
 242 #define EVT_TREE_END_DRAG(id, fn) { wxEVT_COMMAND_TREE_END_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 243
 244 // GetItem() returns the itme whose label is being edited, GetLabel() returns
 245 // the current item label for BEGIN and the would be new one for END.
 246 //
 247 // Vetoing BEGIN event means that label editing won't happen at all,
 248 // vetoing END means that the new value is discarded and the old one kept
 249 #define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 250 #define EVT_TREE_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 251
 252 // provide/update information about GetItem() item
 253 #define EVT_TREE_GET_INFO(id, fn) { wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 254 #define EVT_TREE_SET_INFO(id, fn) { wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 255
 256 // GetItem() is the item being expanded/collapsed, the "ING" versions can use
 257 #define EVT_TREE_ITEM_EXPANDED(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 258 #define EVT_TREE_ITEM_EXPANDING(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 259 #define EVT_TREE_ITEM_COLLAPSED(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 260 #define EVT_TREE_ITEM_COLLAPSING(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 261
 262 // GetOldItem() is the item which had the selection previously, GetItem() is
 263 // the item which acquires selection
 264 #define EVT_TREE_SEL_CHANGED(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 265 #define EVT_TREE_SEL_CHANGING(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 266
 267 // GetCode() returns the key code
 268 // NB: this is the only message for which GetItem() is invalid (you may get the
 269 //     item from GetSelection())
 270 #define EVT_TREE_KEY_DOWN(id, fn) { wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 271
 272 // GetItem() returns the item being deleted, the associated data (if any) will
 273 // be deleted just after the return of this event handler (if any)
 274 #define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
 275
 276 // GetItem() returns the item that was activated (double click, enter, space)
 277 #define EVT_TREE_ITEM_ACTIVATED(id, fn) { wxEVT_COMMAND_TREE_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 278
 279 // GetItem() returns the item that was clicked on
 280 #define EVT_TREE_ITEM_RIGHT_CLICK(id, fn) { wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 281 #define EVT_TREE_ITEM_MIDDLE_CLICK(id, fn) { wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 282
 283 #endif
 284     // _WX_TREEBASE_H_
 285
 286