1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxTreeCtrl base classes and types
4 // Author: Julian Smart et al
8 // Copyright: (c) 1997,1998 Robert Roebling
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_TREEBASE_H_
13 #define _WX_TREEBASE_H_
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "treebase.h"
19 // ----------------------------------------------------------------------------
21 // ----------------------------------------------------------------------------
25 #include "wx/window.h" // for wxClientData
27 #include "wx/dynarray.h"
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 // ----------------------------------------------------------------------------
36 // Using this typedef removes an ambiguity when calling Remove()
37 typedef void *wxTreeItemIdValue
;
39 class WXDLLEXPORT wxTreeItemId
41 friend bool operator==(const wxTreeItemId
&, const wxTreeItemId
&);
44 // 0 is invalid value for HTREEITEM
45 wxTreeItemId() { m_pItem
= 0; }
47 // construct wxTreeItemId from the native item id
48 wxTreeItemId(void *pItem
) { m_pItem
= pItem
; }
50 // default copy ctor/assignment operator are ok for us
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(); }
59 // invalidate the item
60 void Unset() { m_pItem
= 0; }
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
70 wxTreeItemIdValue m_pItem
;
73 inline bool operator==(const wxTreeItemId
& i1
, const wxTreeItemId
& i2
)
75 return i1
.m_pItem
== i2
.m_pItem
;
78 inline bool operator!=(const wxTreeItemId
& i1
, const wxTreeItemId
& i2
)
80 return i1
.m_pItem
!= i2
.m_pItem
;
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
93 // Because the objects of this class are deleted by the tree, they should
94 // always be allocated on the heap!
95 // ----------------------------------------------------------------------------
97 class WXDLLEXPORT wxTreeItemData
: public wxClientData
99 friend class WXDLLEXPORT wxTreeCtrl
;
100 friend class WXDLLEXPORT wxGenericTreeCtrl
;
102 // creation/destruction
103 // --------------------
107 // default copy ctor/assignment operator are ok
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
; }
114 wxTreeItemId m_pItem
;
117 WX_DEFINE_EXPORTED_ARRAY_PTR(wxTreeItemIdValue
, wxArrayTreeItemIdsBase
);
119 class WXDLLEXPORT wxArrayTreeItemIds
: public wxArrayTreeItemIdsBase
122 void Add(const wxTreeItemId
& id
)
123 { wxArrayTreeItemIdsBase::Add(id
.m_pItem
); }
126 // ----------------------------------------------------------------------------
128 // ----------------------------------------------------------------------------
130 // enum for different images associated with a treectrl item
133 wxTreeItemIcon_Normal
, // not selected, not expanded
134 wxTreeItemIcon_Selected
, // selected, not expanded
135 wxTreeItemIcon_Expanded
, // not selected, expanded
136 wxTreeItemIcon_SelectedExpanded
, // selected, expanded
140 // ----------------------------------------------------------------------------
142 // ----------------------------------------------------------------------------
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
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
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
159 #define wxTR_FULL_ROW_HIGHLIGHT 0x2000 // highlight full horz space
162 #define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS | wxTR_NO_LINES)
164 #define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT)
167 // deprecated, don't use
168 #define wxTR_MAC_BUTTONS 0
169 #define wxTR_AQUA_BUTTONS 0
172 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
173 // where exactly the specified point is situated:
175 static const int wxTREE_HITTEST_ABOVE
= 0x0001;
176 static const int wxTREE_HITTEST_BELOW
= 0x0002;
177 static const int wxTREE_HITTEST_NOWHERE
= 0x0004;
178 // on the button associated with an item.
179 static const int wxTREE_HITTEST_ONITEMBUTTON
= 0x0008;
180 // on the bitmap associated with an item.
181 static const int wxTREE_HITTEST_ONITEMICON
= 0x0010;
182 // on the indent associated with an item.
183 static const int wxTREE_HITTEST_ONITEMINDENT
= 0x0020;
184 // on the label (string) associated with an item.
185 static const int wxTREE_HITTEST_ONITEMLABEL
= 0x0040;
186 // on the right of the label associated with an item.
187 static const int wxTREE_HITTEST_ONITEMRIGHT
= 0x0080;
188 // on the label (string) associated with an item.
189 static const int wxTREE_HITTEST_ONITEMSTATEICON
= 0x0100;
190 // on the left of the wxTreeCtrl.
191 static const int wxTREE_HITTEST_TOLEFT
= 0x0200;
192 // on the right of the wxTreeCtrl.
193 static const int wxTREE_HITTEST_TORIGHT
= 0x0400;
194 // on the upper part (first half) of the item.
195 static const int wxTREE_HITTEST_ONITEMUPPERPART
= 0x0800;
196 // on the lower part (second half) of the item.
197 static const int wxTREE_HITTEST_ONITEMLOWERPART
= 0x1000;
199 // anywhere on the item
200 static const int wxTREE_HITTEST_ONITEM
= wxTREE_HITTEST_ONITEMICON
|
201 wxTREE_HITTEST_ONITEMLABEL
;
203 // tree ctrl default name
204 WXDLLEXPORT_DATA(extern const wxChar
*) wxTreeCtrlNameStr
;
206 // ----------------------------------------------------------------------------
207 // wxTreeItemAttr: a structure containing the visual attributes of an item
208 // ----------------------------------------------------------------------------
210 class WXDLLEXPORT wxTreeItemAttr
215 wxTreeItemAttr(const wxColour
& colText
,
216 const wxColour
& colBack
,
218 : m_colText(colText
), m_colBack(colBack
), m_font(font
) { }
221 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; }
222 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; }
223 void SetFont(const wxFont
& font
) { m_font
= font
; }
226 bool HasTextColour() const { return m_colText
.Ok(); }
227 bool HasBackgroundColour() const { return m_colBack
.Ok(); }
228 bool HasFont() const { return m_font
.Ok(); }
230 const wxColour
& GetTextColour() const { return m_colText
; }
231 const wxColour
& GetBackgroundColour() const { return m_colBack
; }
232 const wxFont
& GetFont() const { return m_font
; }
240 // ----------------------------------------------------------------------------
241 // wxTreeEvent is a special class for all events associated with tree controls
243 // NB: note that not all accessors make sense for all events, see the event
244 // descriptions below
245 // ----------------------------------------------------------------------------
247 class WXDLLEXPORT wxTreeEvent
: public wxNotifyEvent
250 wxTreeEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0);
251 wxTreeEvent(const wxTreeEvent
& event
);
253 virtual wxEvent
*Clone() const { return new wxTreeEvent(*this); }
256 // get the item on which the operation was performed or the newly
257 // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
258 wxTreeItemId
GetItem() const { return m_item
; }
259 void SetItem(const wxTreeItemId
& item
) { m_item
= item
; }
261 // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
263 wxTreeItemId
GetOldItem() const { return m_itemOld
; }
264 void SetOldItem(const wxTreeItemId
& item
) { m_itemOld
= item
; }
266 // the point where the mouse was when the drag operation started (for
267 // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only) or click position
268 wxPoint
GetPoint() const { return m_pointDrag
; }
269 void SetPoint(const wxPoint
& pt
) { m_pointDrag
= pt
; }
271 // keyboard data (for wxEVT_COMMAND_TREE_KEY_DOWN only)
272 const wxKeyEvent
& GetKeyEvent() const { return m_evtKey
; }
273 int GetKeyCode() const { return m_evtKey
.GetKeyCode(); }
274 void SetKeyEvent(const wxKeyEvent
& evt
) { m_evtKey
= evt
; }
276 // label (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
277 const wxString
& GetLabel() const { return m_label
; }
278 void SetLabel(const wxString
& label
) { m_label
= label
; }
280 // edit cancel flag (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
281 bool IsEditCancelled() const { return m_editCancelled
; }
282 void SetEditCanceled(bool editCancelled
) { m_editCancelled
= editCancelled
; }
284 // Set the tooltip for the item (for EVT\_TREE\_ITEM\_GETTOOLTIP events)
285 void SetToolTip(const wxString
& toolTip
) { m_label
= toolTip
; }
287 #if WXWIN_COMPATIBILITY_2_2
288 // for compatibility only, don't use
289 wxDEPRECATED( int GetCode() const);
290 #endif // WXWIN_COMPATIBILITY_2_2
293 // not all of the members are used (or initialized) for all events
299 bool m_editCancelled
;
301 friend class WXDLLEXPORT wxTreeCtrl
;
302 friend class WXDLLEXPORT wxGenericTreeCtrl
;
304 DECLARE_DYNAMIC_CLASS(wxTreeEvent
)
307 typedef void (wxEvtHandler::*wxTreeEventFunction
)(wxTreeEvent
&);
309 // ----------------------------------------------------------------------------
310 // tree control events and macros for handling them
311 // ----------------------------------------------------------------------------
313 BEGIN_DECLARE_EVENT_TYPES()
314 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_DRAG
, 600)
315 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_RDRAG
, 601)
316 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT
, 602)
317 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_LABEL_EDIT
, 603)
318 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_DELETE_ITEM
, 604)
319 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_GET_INFO
, 605)
320 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SET_INFO
, 606)
321 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDED
, 607)
322 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDING
, 608)
323 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSED
, 609)
324 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSING
, 610)
325 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGED
, 611)
326 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGING
, 612)
327 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_KEY_DOWN
, 613)
328 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, 614)
329 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK
, 615)
330 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK
, 616)
331 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_DRAG
, 617)
332 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK
, 618)
333 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP
, 619)
334 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_MENU
, 620)
335 END_DECLARE_EVENT_TYPES()
337 // GetItem() returns the item being dragged, GetPoint() the mouse coords
339 // if you call event.Allow(), the drag operation will start and a
340 // EVT_TREE_END_DRAG event will be sent when the drag is over.
341 #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 ),
342 #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 ),
344 // GetItem() is the item on which the drop occured (if any) and GetPoint() the
345 // current mouse coords
346 #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 ),
348 // GetItem() returns the itme whose label is being edited, GetLabel() returns
349 // the current item label for BEGIN and the would be new one for END.
351 // Vetoing BEGIN event means that label editing won't happen at all,
352 // vetoing END means that the new value is discarded and the old one kept
353 #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 ),
354 #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 ),
356 // provide/update information about GetItem() item
357 #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 ),
358 #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 ),
360 // GetItem() is the item being expanded/collapsed, the "ING" versions can use
361 #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 ),
362 #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 ),
363 #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 ),
364 #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 ),
366 // GetOldItem() is the item which had the selection previously, GetItem() is
367 // the item which acquires selection
368 #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 ),
369 #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 ),
371 // GetKeyCode() returns the key code
372 // NB: this is the only message for which GetItem() is invalid (you may get the
373 // item from GetSelection())
374 #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 ),
376 // GetItem() returns the item being deleted, the associated data (if any) will
377 // be deleted just after the return of this event handler (if any)
378 #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 ),
380 // GetItem() returns the item that was activated (double click, enter, space)
381 #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 ),
383 // GetItem() returns the item for which the context menu shall be shown
384 #define EVT_TREE_ITEM_MENU(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_MENU, id, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxTreeEventFunction, & fn ), (wxObject *) NULL ),
386 // GetItem() returns the item that was clicked on
387 #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 ),
388 #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 ),
390 // GetItem() returns the item whose state image was clicked on
391 #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 ),
393 // GetItem() is the item for which the tooltip is being requested
394 #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 ),
396 #endif // wxUSE_TREECTRL
398 #endif // _WX_TREEBASE_H_