]> git.saurik.com Git - wxWidgets.git/blame - include/wx/treebase.h
VC5 didn't support partial specialization either, check for VC>=7
[wxWidgets.git] / include / wx / treebase.h
CommitLineData
484523cf 1/////////////////////////////////////////////////////////////////////////////
40ff126a 2// Name: wx/treebase.h
484523cf
JS
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
65571936 9// Licence: wxWindows licence
484523cf
JS
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_TREEBASE_H_
13#define _WX_TREEBASE_H_
14
484523cf
JS
15// ----------------------------------------------------------------------------
16// headers
17// ----------------------------------------------------------------------------
18
2ecf902b
WS
19#include "wx/defs.h"
20
1e6feb95 21#if wxUSE_TREECTRL
33737618 22
618a5e38 23#include "wx/window.h" // for wxClientData
484523cf 24#include "wx/event.h"
ed39ff57 25#include "wx/dynarray.h"
484523cf 26
40ff126a
WS
27#if WXWIN_COMPATIBILITY_2_6
28
e2effeb9
WS
29// flags for deprecated `Expand(int action)', will be removed in next versions
30enum
31{
32 wxTREE_EXPAND_EXPAND,
33 wxTREE_EXPAND_COLLAPSE,
34 wxTREE_EXPAND_COLLAPSE_RESET,
35 wxTREE_EXPAND_TOGGLE
36};
37
40ff126a
WS
38#endif // WXWIN_COMPATIBILITY_2_6
39
484523cf
JS
40// ----------------------------------------------------------------------------
41// wxTreeItemId identifies an element of the tree. In this implementation, it's
2f3dcbbf
VZ
42// just a trivial wrapper around Win32 HTREEITEM or a pointer to some private
43// data structure in the generic version. It's opaque for the application and
44// the only method which can be used by user code is IsOk().
484523cf
JS
45// ----------------------------------------------------------------------------
46
47// Using this typedef removes an ambiguity when calling Remove()
ee4b2721 48typedef void *wxTreeItemIdValue;
484523cf
JS
49
50class WXDLLEXPORT wxTreeItemId
51{
a9711a4d 52 friend bool operator==(const wxTreeItemId&, const wxTreeItemId&);
484523cf
JS
53public:
54 // ctors
55 // 0 is invalid value for HTREEITEM
56 wxTreeItemId() { m_pItem = 0; }
57
ee4b2721
VZ
58 // construct wxTreeItemId from the native item id
59 wxTreeItemId(void *pItem) { m_pItem = pItem; }
2f3dcbbf 60
484523cf
JS
61 // default copy ctor/assignment operator are ok for us
62
63 // accessors
64 // is this a valid tree item?
65 bool IsOk() const { return m_pItem != 0; }
c89d4160
VZ
66 // return true if this item is not valid
67 bool operator!() const { return !IsOk(); }
484523cf 68
f888d614
VZ
69 // operations
70 // invalidate the item
71 void Unset() { m_pItem = 0; }
72
a9711a4d
MB
73 operator bool() const { return IsOk(); }
74
c89d4160 75 wxTreeItemIdValue m_pItem;
484523cf
JS
76};
77
a9711a4d
MB
78inline bool operator==(const wxTreeItemId& i1, const wxTreeItemId& i2)
79{
80 return i1.m_pItem == i2.m_pItem;
81}
82
e066bd13
VS
83inline bool operator!=(const wxTreeItemId& i1, const wxTreeItemId& i2)
84{
85 return i1.m_pItem != i2.m_pItem;
86}
87
484523cf
JS
88// ----------------------------------------------------------------------------
89// wxTreeItemData is some (arbitrary) user class associated with some item. The
90// main advantage of having this class (compared to old untyped interface) is
91// that wxTreeItemData's are destroyed automatically by the tree and, as this
92// class has virtual dtor, it means that the memory will be automatically
93// freed. OTOH, we don't just use wxObject instead of wxTreeItemData because
94// the size of this class is critical: in any real application, each tree leaf
95// will have wxTreeItemData associated with it and number of leaves may be
96// quite big.
97//
98// Because the objects of this class are deleted by the tree, they should
99// always be allocated on the heap!
100// ----------------------------------------------------------------------------
101
102class WXDLLEXPORT wxTreeItemData: public wxClientData
103{
b5dbe15d
VS
104friend class WXDLLIMPEXP_FWD_CORE wxTreeCtrl;
105friend class WXDLLIMPEXP_FWD_CORE wxGenericTreeCtrl;
484523cf
JS
106public:
107 // creation/destruction
108 // --------------------
109 // default ctor
110 wxTreeItemData() { }
111
112 // default copy ctor/assignment operator are ok
113
114 // accessor: get the item associated with us
115 const wxTreeItemId& GetId() const { return m_pItem; }
116 void SetId(const wxTreeItemId& id) { m_pItem = id; }
117
118protected:
119 wxTreeItemId m_pItem;
120};
121
d5d29b8a 122WX_DEFINE_EXPORTED_ARRAY_PTR(wxTreeItemIdValue, wxArrayTreeItemIdsBase);
f888d614 123
14ba002a
VZ
124// this is a wrapper around the array class defined above which allow to wok
125// with vaue of natural wxTreeItemId type instead of using wxTreeItemIdValue
126// and does it without any loss of efficiency
f888d614
VZ
127class WXDLLEXPORT wxArrayTreeItemIds : public wxArrayTreeItemIdsBase
128{
129public:
130 void Add(const wxTreeItemId& id)
131 { wxArrayTreeItemIdsBase::Add(id.m_pItem); }
14ba002a
VZ
132 void Insert(const wxTreeItemId& id, size_t pos)
133 { wxArrayTreeItemIdsBase::Insert(id.m_pItem, pos); }
134 wxTreeItemId Item(size_t i) const
135 { return wxTreeItemId(wxArrayTreeItemIdsBase::Item(i)); }
136 wxTreeItemId operator[](size_t i) const { return Item(i); }
f888d614 137};
484523cf
JS
138
139// ----------------------------------------------------------------------------
140// constants
141// ----------------------------------------------------------------------------
142
143// enum for different images associated with a treectrl item
144enum wxTreeItemIcon
145{
146 wxTreeItemIcon_Normal, // not selected, not expanded
147 wxTreeItemIcon_Selected, // selected, not expanded
148 wxTreeItemIcon_Expanded, // not selected, expanded
149 wxTreeItemIcon_SelectedExpanded, // selected, expanded
150 wxTreeItemIcon_Max
151};
152
9c7f49f5
VZ
153// ----------------------------------------------------------------------------
154// wxTreeCtrl flags
155// ----------------------------------------------------------------------------
156
c6f4913a 157#define wxTR_NO_BUTTONS 0x0000 // for convenience
9c7f49f5
VZ
158#define wxTR_HAS_BUTTONS 0x0001 // draw collapsed/expanded btns
159#define wxTR_NO_LINES 0x0004 // don't draw lines at all
c6f4913a 160#define wxTR_LINES_AT_ROOT 0x0008 // connect top-level nodes
99cea4b3 161#define wxTR_TWIST_BUTTONS 0x0010 // still used by wxTreeListCtrl
c6f4913a
VS
162
163#define wxTR_SINGLE 0x0000 // for convenience
164#define wxTR_MULTIPLE 0x0020 // can select multiple items
d642a722
VZ
165
166#if WXWIN_COMPATIBILITY_2_8
167 #define wxTR_EXTENDED 0x0040 // deprecated, don't use
168#endif // WXWIN_COMPATIBILITY_2_8
169
9c7f49f5 170#define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080 // what it says
c6f4913a
VS
171
172#define wxTR_EDIT_LABELS 0x0200 // can edit item labels
173#define wxTR_ROW_LINES 0x0400 // put border around items
174#define wxTR_HIDE_ROOT 0x0800 // don't display root node
618a5e38 175
9c7f49f5
VZ
176#define wxTR_FULL_ROW_HIGHLIGHT 0x2000 // highlight full horz space
177
c7f73af4
RR
178#ifdef __WXGTK20__
179#define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS | wxTR_NO_LINES)
180#else
9c7f49f5 181#define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT)
c7f73af4 182#endif
9c7f49f5 183
40ff126a 184#if WXWIN_COMPATIBILITY_2_6
9c7f49f5 185// deprecated, don't use
9c7f49f5
VZ
186#define wxTR_MAC_BUTTONS 0
187#define wxTR_AQUA_BUTTONS 0
40ff126a 188#endif // WXWIN_COMPATIBILITY_2_6
9c7f49f5 189
484523cf
JS
190
191// values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
192// where exactly the specified point is situated:
193
194static const int wxTREE_HITTEST_ABOVE = 0x0001;
195static const int wxTREE_HITTEST_BELOW = 0x0002;
196static const int wxTREE_HITTEST_NOWHERE = 0x0004;
197 // on the button associated with an item.
198static const int wxTREE_HITTEST_ONITEMBUTTON = 0x0008;
199 // on the bitmap associated with an item.
200static const int wxTREE_HITTEST_ONITEMICON = 0x0010;
201 // on the indent associated with an item.
202static const int wxTREE_HITTEST_ONITEMINDENT = 0x0020;
203 // on the label (string) associated with an item.
204static const int wxTREE_HITTEST_ONITEMLABEL = 0x0040;
205 // on the right of the label associated with an item.
206static const int wxTREE_HITTEST_ONITEMRIGHT = 0x0080;
207 // on the label (string) associated with an item.
208static const int wxTREE_HITTEST_ONITEMSTATEICON = 0x0100;
209 // on the left of the wxTreeCtrl.
210static const int wxTREE_HITTEST_TOLEFT = 0x0200;
211 // on the right of the wxTreeCtrl.
212static const int wxTREE_HITTEST_TORIGHT = 0x0400;
213 // on the upper part (first half) of the item.
214static const int wxTREE_HITTEST_ONITEMUPPERPART = 0x0800;
215 // on the lower part (second half) of the item.
216static const int wxTREE_HITTEST_ONITEMLOWERPART = 0x1000;
217
218 // anywhere on the item
219static const int wxTREE_HITTEST_ONITEM = wxTREE_HITTEST_ONITEMICON |
220 wxTREE_HITTEST_ONITEMLABEL;
221
222// tree ctrl default name
f36e602b 223extern WXDLLEXPORT_DATA(const char) wxTreeCtrlNameStr[];
484523cf
JS
224
225// ----------------------------------------------------------------------------
226// wxTreeItemAttr: a structure containing the visual attributes of an item
227// ----------------------------------------------------------------------------
228
229class WXDLLEXPORT wxTreeItemAttr
230{
231public:
232 // ctors
233 wxTreeItemAttr() { }
234 wxTreeItemAttr(const wxColour& colText,
235 const wxColour& colBack,
236 const wxFont& font)
237 : m_colText(colText), m_colBack(colBack), m_font(font) { }
238
239 // setters
240 void SetTextColour(const wxColour& colText) { m_colText = colText; }
241 void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
242 void SetFont(const wxFont& font) { m_font = font; }
243
244 // accessors
245 bool HasTextColour() const { return m_colText.Ok(); }
246 bool HasBackgroundColour() const { return m_colBack.Ok(); }
247 bool HasFont() const { return m_font.Ok(); }
248
249 const wxColour& GetTextColour() const { return m_colText; }
250 const wxColour& GetBackgroundColour() const { return m_colBack; }
251 const wxFont& GetFont() const { return m_font; }
252
253private:
254 wxColour m_colText,
255 m_colBack;
256 wxFont m_font;
257};
258
259// ----------------------------------------------------------------------------
260// wxTreeEvent is a special class for all events associated with tree controls
261//
262// NB: note that not all accessors make sense for all events, see the event
263// descriptions below
264// ----------------------------------------------------------------------------
265
b5dbe15d 266class WXDLLIMPEXP_FWD_CORE wxTreeCtrlBase;
2388d9b3 267
484523cf
JS
268class WXDLLEXPORT wxTreeEvent : public wxNotifyEvent
269{
484523cf 270public:
2388d9b3
VZ
271 wxTreeEvent(wxEventType commandType,
272 wxTreeCtrlBase *tree,
273 const wxTreeItemId &item = wxTreeItemId());
49b6ebb7 274 wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
2388d9b3 275 wxTreeEvent(const wxTreeEvent& event);
0cd936a4
WS
276
277 virtual wxEvent *Clone() const { return new wxTreeEvent(*this); }
484523cf
JS
278
279 // accessors
280 // get the item on which the operation was performed or the newly
281 // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
282 wxTreeItemId GetItem() const { return m_item; }
8adb5d45 283 void SetItem(const wxTreeItemId& item) { m_item = item; }
484523cf
JS
284
285 // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
286 // selected item
287 wxTreeItemId GetOldItem() const { return m_itemOld; }
8adb5d45 288 void SetOldItem(const wxTreeItemId& item) { m_itemOld = item; }
484523cf
JS
289
290 // the point where the mouse was when the drag operation started (for
33737618 291 // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only) or click position
484523cf 292 wxPoint GetPoint() const { return m_pointDrag; }
8adb5d45 293 void SetPoint(const wxPoint& pt) { m_pointDrag = pt; }
484523cf 294
b09bda68
VZ
295 // keyboard data (for wxEVT_COMMAND_TREE_KEY_DOWN only)
296 const wxKeyEvent& GetKeyEvent() const { return m_evtKey; }
1944ad76 297 int GetKeyCode() const { return m_evtKey.GetKeyCode(); }
8adb5d45 298 void SetKeyEvent(const wxKeyEvent& evt) { m_evtKey = evt; }
484523cf
JS
299
300 // label (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
301 const wxString& GetLabel() const { return m_label; }
8adb5d45 302 void SetLabel(const wxString& label) { m_label = label; }
484523cf 303
dd23c25c
JS
304 // edit cancel flag (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
305 bool IsEditCancelled() const { return m_editCancelled; }
8adb5d45 306 void SetEditCanceled(bool editCancelled) { m_editCancelled = editCancelled; }
dd23c25c 307
156194e1
JS
308 // Set the tooltip for the item (for EVT\_TREE\_ITEM\_GETTOOLTIP events)
309 void SetToolTip(const wxString& toolTip) { m_label = toolTip; }
3dd67a18 310 wxString GetToolTip() { return m_label; }
8bc3ec1f 311
484523cf 312private:
b09bda68
VZ
313 // not all of the members are used (or initialized) for all events
314 wxKeyEvent m_evtKey;
484523cf
JS
315 wxTreeItemId m_item,
316 m_itemOld;
317 wxPoint m_pointDrag;
318 wxString m_label;
dd23c25c 319 bool m_editCancelled;
b09bda68 320
b5dbe15d
VS
321 friend class WXDLLIMPEXP_FWD_CORE wxTreeCtrl;
322 friend class WXDLLIMPEXP_FWD_CORE wxGenericTreeCtrl;
b09bda68 323
0cd936a4 324 DECLARE_DYNAMIC_CLASS(wxTreeEvent)
484523cf
JS
325};
326
327typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
328
329// ----------------------------------------------------------------------------
2e4df4bf 330// tree control events and macros for handling them
484523cf
JS
331// ----------------------------------------------------------------------------
332
c058cafa
VZ
333extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_BEGIN_DRAG;
334extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_BEGIN_RDRAG;
335extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT;
336extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_END_LABEL_EDIT;
337extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_DELETE_ITEM;
338extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_GET_INFO;
339extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_SET_INFO;
340extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDED;
341extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDING;
342extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSED;
343extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSING;
344extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGED;
345extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGING;
346extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_KEY_DOWN;
347extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_ACTIVATED;
348extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK;
349extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK;
350extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_END_DRAG;
351extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK;
352extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP;
353extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_MENU;
2e4df4bf 354
7fa03f04 355#define wxTreeEventHandler(func) \
8bc3ec1f 356 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTreeEventFunction, &func)
7fa03f04
VZ
357
358#define wx__DECLARE_TREEEVT(evt, id, fn) \
359 wx__DECLARE_EVT1(wxEVT_COMMAND_TREE_ ## evt, id, wxTreeEventHandler(fn))
360
484523cf
JS
361// GetItem() returns the item being dragged, GetPoint() the mouse coords
362//
363// if you call event.Allow(), the drag operation will start and a
364// EVT_TREE_END_DRAG event will be sent when the drag is over.
7fa03f04
VZ
365#define EVT_TREE_BEGIN_DRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_DRAG, id, fn)
366#define EVT_TREE_BEGIN_RDRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_RDRAG, id, fn)
484523cf 367
3103e8a9 368// GetItem() is the item on which the drop occurred (if any) and GetPoint() the
484523cf 369// current mouse coords
7fa03f04 370#define EVT_TREE_END_DRAG(id, fn) wx__DECLARE_TREEEVT(END_DRAG, id, fn)
484523cf
JS
371
372// GetItem() returns the itme whose label is being edited, GetLabel() returns
373// the current item label for BEGIN and the would be new one for END.
374//
375// Vetoing BEGIN event means that label editing won't happen at all,
376// vetoing END means that the new value is discarded and the old one kept
7fa03f04
VZ
377#define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) wx__DECLARE_TREEEVT(BEGIN_LABEL_EDIT, id, fn)
378#define EVT_TREE_END_LABEL_EDIT(id, fn) wx__DECLARE_TREEEVT(END_LABEL_EDIT, id, fn)
484523cf
JS
379
380// provide/update information about GetItem() item
7fa03f04
VZ
381#define EVT_TREE_GET_INFO(id, fn) wx__DECLARE_TREEEVT(GET_INFO, id, fn)
382#define EVT_TREE_SET_INFO(id, fn) wx__DECLARE_TREEEVT(SET_INFO, id, fn)
484523cf
JS
383
384// GetItem() is the item being expanded/collapsed, the "ING" versions can use
7fa03f04
VZ
385#define EVT_TREE_ITEM_EXPANDED(id, fn) wx__DECLARE_TREEEVT(ITEM_EXPANDED, id, fn)
386#define EVT_TREE_ITEM_EXPANDING(id, fn) wx__DECLARE_TREEEVT(ITEM_EXPANDING, id, fn)
387#define EVT_TREE_ITEM_COLLAPSED(id, fn) wx__DECLARE_TREEEVT(ITEM_COLLAPSED, id, fn)
388#define EVT_TREE_ITEM_COLLAPSING(id, fn) wx__DECLARE_TREEEVT(ITEM_COLLAPSING, id, fn)
484523cf
JS
389
390// GetOldItem() is the item which had the selection previously, GetItem() is
391// the item which acquires selection
7fa03f04
VZ
392#define EVT_TREE_SEL_CHANGED(id, fn) wx__DECLARE_TREEEVT(SEL_CHANGED, id, fn)
393#define EVT_TREE_SEL_CHANGING(id, fn) wx__DECLARE_TREEEVT(SEL_CHANGING, id, fn)
484523cf 394
1944ad76 395// GetKeyCode() returns the key code
484523cf
JS
396// NB: this is the only message for which GetItem() is invalid (you may get the
397// item from GetSelection())
7fa03f04 398#define EVT_TREE_KEY_DOWN(id, fn) wx__DECLARE_TREEEVT(KEY_DOWN, id, fn)
484523cf
JS
399
400// GetItem() returns the item being deleted, the associated data (if any) will
401// be deleted just after the return of this event handler (if any)
7fa03f04 402#define EVT_TREE_DELETE_ITEM(id, fn) wx__DECLARE_TREEEVT(DELETE_ITEM, id, fn)
484523cf
JS
403
404// GetItem() returns the item that was activated (double click, enter, space)
7fa03f04 405#define EVT_TREE_ITEM_ACTIVATED(id, fn) wx__DECLARE_TREEEVT(ITEM_ACTIVATED, id, fn)
484523cf 406
f7c6f947 407// GetItem() returns the item for which the context menu shall be shown
7fa03f04 408#define EVT_TREE_ITEM_MENU(id, fn) wx__DECLARE_TREEEVT(ITEM_MENU, id, fn)
f7c6f947 409
484523cf 410// GetItem() returns the item that was clicked on
7fa03f04
VZ
411#define EVT_TREE_ITEM_RIGHT_CLICK(id, fn) wx__DECLARE_TREEEVT(ITEM_RIGHT_CLICK, id, fn)
412#define EVT_TREE_ITEM_MIDDLE_CLICK(id, fn) wx__DECLARE_TREEEVT(ITEM_MIDDLE_CLICK, id, fn)
484523cf 413
ae8c4b33 414// GetItem() returns the item whose state image was clicked on
7fa03f04 415#define EVT_TREE_STATE_IMAGE_CLICK(id, fn) wx__DECLARE_TREEEVT(STATE_IMAGE_CLICK, id, fn)
ae8c4b33 416
156194e1 417// GetItem() is the item for which the tooltip is being requested
7fa03f04 418#define EVT_TREE_ITEM_GETTOOLTIP(id, fn) wx__DECLARE_TREEEVT(ITEM_GETTOOLTIP, id, fn)
156194e1 419
1e6feb95 420#endif // wxUSE_TREECTRL
33737618 421
618a5e38 422#endif // _WX_TREEBASE_H_