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