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