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