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 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
23 #include "wx/window.h" // for wxClientData
25 #include "wx/dynarray.h"
26 #include "wx/itemid.h"
28 #if WXWIN_COMPATIBILITY_2_6
30 // flags for deprecated `Expand(int action)', will be removed in next versions
34 wxTREE_EXPAND_COLLAPSE
,
35 wxTREE_EXPAND_COLLAPSE_RESET
,
39 #endif // WXWIN_COMPATIBILITY_2_6
41 // ----------------------------------------------------------------------------
42 // wxTreeItemId identifies an element of the tree. It's opaque for the
43 // application and the only method which can be used by user code is IsOk().
44 // ----------------------------------------------------------------------------
46 // This is a class and not a typedef because existing code may forward declare
47 // wxTreeItemId as a class and we don't want to break it without good reason.
48 class wxTreeItemId
: public wxItemId
<void*>
51 wxTreeItemId() : wxItemId
<void*>() { }
52 wxTreeItemId(void* pItem
) : wxItemId
<void*>(pItem
) { }
55 // ----------------------------------------------------------------------------
56 // wxTreeItemData is some (arbitrary) user class associated with some item. The
57 // main advantage of having this class (compared to old untyped interface) is
58 // that wxTreeItemData's are destroyed automatically by the tree and, as this
59 // class has virtual dtor, it means that the memory will be automatically
60 // freed. OTOH, we don't just use wxObject instead of wxTreeItemData because
61 // the size of this class is critical: in any real application, each tree leaf
62 // will have wxTreeItemData associated with it and number of leaves may be
65 // Because the objects of this class are deleted by the tree, they should
66 // always be allocated on the heap!
67 // ----------------------------------------------------------------------------
69 class WXDLLIMPEXP_CORE wxTreeItemData
: public wxClientData
71 friend class WXDLLIMPEXP_FWD_CORE wxTreeCtrl
;
72 friend class WXDLLIMPEXP_FWD_CORE wxGenericTreeCtrl
;
74 // creation/destruction
75 // --------------------
79 // default copy ctor/assignment operator are ok
81 // accessor: get the item associated with us
82 const wxTreeItemId
& GetId() const { return m_pItem
; }
83 void SetId(const wxTreeItemId
& id
) { m_pItem
= id
; }
89 typedef void *wxTreeItemIdValue
;
91 WX_DEFINE_EXPORTED_ARRAY_PTR(wxTreeItemIdValue
, wxArrayTreeItemIdsBase
);
93 // this is a wrapper around the array class defined above which allow to wok
94 // with values of natural wxTreeItemId type instead of using wxTreeItemIdValue
95 // and does it without any loss of efficiency
96 class WXDLLIMPEXP_CORE wxArrayTreeItemIds
: public wxArrayTreeItemIdsBase
99 void Add(const wxTreeItemId
& id
)
100 { wxArrayTreeItemIdsBase::Add(id
.m_pItem
); }
101 void Insert(const wxTreeItemId
& id
, size_t pos
)
102 { wxArrayTreeItemIdsBase::Insert(id
.m_pItem
, pos
); }
103 wxTreeItemId
Item(size_t i
) const
104 { return wxTreeItemId(wxArrayTreeItemIdsBase::Item(i
)); }
105 wxTreeItemId
operator[](size_t i
) const { return Item(i
); }
108 // ----------------------------------------------------------------------------
110 // ----------------------------------------------------------------------------
112 // enum for different images associated with a treectrl item
115 wxTreeItemIcon_Normal
, // not selected, not expanded
116 wxTreeItemIcon_Selected
, // selected, not expanded
117 wxTreeItemIcon_Expanded
, // not selected, expanded
118 wxTreeItemIcon_SelectedExpanded
, // selected, expanded
122 // special values for the 'state' parameter of wxTreeCtrl::SetItemState()
123 static const int wxTREE_ITEMSTATE_NONE
= -1; // not state (no display state image)
124 static const int wxTREE_ITEMSTATE_NEXT
= -2; // cycle to the next state
125 static const int wxTREE_ITEMSTATE_PREV
= -3; // cycle to the previous state
127 // ----------------------------------------------------------------------------
129 // ----------------------------------------------------------------------------
131 #define wxTR_NO_BUTTONS 0x0000 // for convenience
132 #define wxTR_HAS_BUTTONS 0x0001 // draw collapsed/expanded btns
133 #define wxTR_NO_LINES 0x0004 // don't draw lines at all
134 #define wxTR_LINES_AT_ROOT 0x0008 // connect top-level nodes
135 #define wxTR_TWIST_BUTTONS 0x0010 // still used by wxTreeListCtrl
137 #define wxTR_SINGLE 0x0000 // for convenience
138 #define wxTR_MULTIPLE 0x0020 // can select multiple items
140 #if WXWIN_COMPATIBILITY_2_8
141 #define wxTR_EXTENDED 0x0040 // deprecated, don't use
142 #endif // WXWIN_COMPATIBILITY_2_8
144 #define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080 // what it says
146 #define wxTR_EDIT_LABELS 0x0200 // can edit item labels
147 #define wxTR_ROW_LINES 0x0400 // put border around items
148 #define wxTR_HIDE_ROOT 0x0800 // don't display root node
150 #define wxTR_FULL_ROW_HIGHLIGHT 0x2000 // highlight full horz space
152 // make the default control appearance look more native-like depending on the
154 #if defined(__WXGTK20__)
155 #define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS | wxTR_NO_LINES)
156 #elif defined(__WXMAC__)
157 #define wxTR_DEFAULT_STYLE \
158 (wxTR_HAS_BUTTONS | wxTR_NO_LINES | wxTR_FULL_ROW_HIGHLIGHT)
160 #define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT)
163 #if WXWIN_COMPATIBILITY_2_6
164 // deprecated, don't use
165 #define wxTR_MAC_BUTTONS 0
166 #define wxTR_AQUA_BUTTONS 0
167 #endif // WXWIN_COMPATIBILITY_2_6
170 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
171 // where exactly the specified point is situated:
173 static const int wxTREE_HITTEST_ABOVE
= 0x0001;
174 static const int wxTREE_HITTEST_BELOW
= 0x0002;
175 static const int wxTREE_HITTEST_NOWHERE
= 0x0004;
176 // on the button associated with an item.
177 static const int wxTREE_HITTEST_ONITEMBUTTON
= 0x0008;
178 // on the bitmap associated with an item.
179 static const int wxTREE_HITTEST_ONITEMICON
= 0x0010;
180 // on the indent associated with an item.
181 static const int wxTREE_HITTEST_ONITEMINDENT
= 0x0020;
182 // on the label (string) associated with an item.
183 static const int wxTREE_HITTEST_ONITEMLABEL
= 0x0040;
184 // on the right of the label associated with an item.
185 static const int wxTREE_HITTEST_ONITEMRIGHT
= 0x0080;
186 // on the label (string) associated with an item.
187 static const int wxTREE_HITTEST_ONITEMSTATEICON
= 0x0100;
188 // on the left of the wxTreeCtrl.
189 static const int wxTREE_HITTEST_TOLEFT
= 0x0200;
190 // on the right of the wxTreeCtrl.
191 static const int wxTREE_HITTEST_TORIGHT
= 0x0400;
192 // on the upper part (first half) of the item.
193 static const int wxTREE_HITTEST_ONITEMUPPERPART
= 0x0800;
194 // on the lower part (second half) of the item.
195 static const int wxTREE_HITTEST_ONITEMLOWERPART
= 0x1000;
197 // anywhere on the item
198 static const int wxTREE_HITTEST_ONITEM
= wxTREE_HITTEST_ONITEMICON
|
199 wxTREE_HITTEST_ONITEMLABEL
;
201 // tree ctrl default name
202 extern WXDLLIMPEXP_DATA_CORE(const char) wxTreeCtrlNameStr
[];
204 // ----------------------------------------------------------------------------
205 // wxTreeItemAttr: a structure containing the visual attributes of an item
206 // ----------------------------------------------------------------------------
208 class WXDLLIMPEXP_CORE wxTreeItemAttr
213 wxTreeItemAttr(const wxColour
& colText
,
214 const wxColour
& colBack
,
216 : m_colText(colText
), m_colBack(colBack
), m_font(font
) { }
219 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; }
220 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; }
221 void SetFont(const wxFont
& font
) { m_font
= font
; }
224 bool HasTextColour() const { return m_colText
.IsOk(); }
225 bool HasBackgroundColour() const { return m_colBack
.IsOk(); }
226 bool HasFont() const { return m_font
.IsOk(); }
228 const wxColour
& GetTextColour() const { return m_colText
; }
229 const wxColour
& GetBackgroundColour() const { return m_colBack
; }
230 const wxFont
& GetFont() const { return m_font
; }
238 // ----------------------------------------------------------------------------
239 // wxTreeEvent is a special class for all events associated with tree controls
241 // NB: note that not all accessors make sense for all events, see the event
242 // descriptions below
243 // ----------------------------------------------------------------------------
245 class WXDLLIMPEXP_FWD_CORE wxTreeCtrlBase
;
247 class WXDLLIMPEXP_CORE wxTreeEvent
: public wxNotifyEvent
250 wxTreeEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0);
251 wxTreeEvent(wxEventType commandType
,
252 wxTreeCtrlBase
*tree
,
253 const wxTreeItemId
&item
= wxTreeItemId());
254 wxTreeEvent(const wxTreeEvent
& event
);
256 virtual wxEvent
*Clone() const { return new wxTreeEvent(*this); }
259 // get the item on which the operation was performed or the newly
260 // selected item for wxEVT_TREE_SEL_CHANGED/ING events
261 wxTreeItemId
GetItem() const { return m_item
; }
262 void SetItem(const wxTreeItemId
& item
) { m_item
= item
; }
264 // for wxEVT_TREE_SEL_CHANGED/ING events, get the previously
266 wxTreeItemId
GetOldItem() const { return m_itemOld
; }
267 void SetOldItem(const wxTreeItemId
& item
) { m_itemOld
= item
; }
269 // the point where the mouse was when the drag operation started (for
270 // wxEVT_TREE_BEGIN_(R)DRAG events only) or click position
271 wxPoint
GetPoint() const { return m_pointDrag
; }
272 void SetPoint(const wxPoint
& pt
) { m_pointDrag
= pt
; }
274 // keyboard data (for wxEVT_TREE_KEY_DOWN only)
275 const wxKeyEvent
& GetKeyEvent() const { return m_evtKey
; }
276 int GetKeyCode() const { return m_evtKey
.GetKeyCode(); }
277 void SetKeyEvent(const wxKeyEvent
& evt
) { m_evtKey
= evt
; }
279 // label (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
280 const wxString
& GetLabel() const { return m_label
; }
281 void SetLabel(const wxString
& label
) { m_label
= label
; }
283 // edit cancel flag (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
284 bool IsEditCancelled() const { return m_editCancelled
; }
285 void SetEditCanceled(bool editCancelled
) { m_editCancelled
= editCancelled
; }
287 // Set the tooltip for the item (for EVT\_TREE\_ITEM\_GETTOOLTIP events)
288 void SetToolTip(const wxString
& toolTip
) { m_label
= toolTip
; }
289 wxString
GetToolTip() { return m_label
; }
292 // not all of the members are used (or initialized) for all events
298 bool m_editCancelled
;
300 friend class WXDLLIMPEXP_FWD_CORE wxTreeCtrl
;
301 friend class WXDLLIMPEXP_FWD_CORE wxGenericTreeCtrl
;
303 DECLARE_DYNAMIC_CLASS(wxTreeEvent
)
306 typedef void (wxEvtHandler::*wxTreeEventFunction
)(wxTreeEvent
&);
308 // ----------------------------------------------------------------------------
309 // tree control events and macros for handling them
310 // ----------------------------------------------------------------------------
312 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_BEGIN_DRAG
, wxTreeEvent
);
313 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_BEGIN_RDRAG
, wxTreeEvent
);
314 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_BEGIN_LABEL_EDIT
, wxTreeEvent
);
315 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_END_LABEL_EDIT
, wxTreeEvent
);
316 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_DELETE_ITEM
, wxTreeEvent
);
317 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_GET_INFO
, wxTreeEvent
);
318 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_SET_INFO
, wxTreeEvent
);
319 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_ITEM_EXPANDED
, wxTreeEvent
);
320 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_ITEM_EXPANDING
, wxTreeEvent
);
321 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_ITEM_COLLAPSED
, wxTreeEvent
);
322 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_ITEM_COLLAPSING
, wxTreeEvent
);
323 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_SEL_CHANGED
, wxTreeEvent
);
324 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_SEL_CHANGING
, wxTreeEvent
);
325 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_KEY_DOWN
, wxTreeEvent
);
326 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_ITEM_ACTIVATED
, wxTreeEvent
);
327 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_ITEM_RIGHT_CLICK
, wxTreeEvent
);
328 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_ITEM_MIDDLE_CLICK
, wxTreeEvent
);
329 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_END_DRAG
, wxTreeEvent
);
330 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_STATE_IMAGE_CLICK
, wxTreeEvent
);
331 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_ITEM_GETTOOLTIP
, wxTreeEvent
);
332 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_TREE_ITEM_MENU
, wxTreeEvent
);
334 #define wxTreeEventHandler(func) \
335 wxEVENT_HANDLER_CAST(wxTreeEventFunction, func)
337 #define wx__DECLARE_TREEEVT(evt, id, fn) \
338 wx__DECLARE_EVT1(wxEVT_TREE_ ## evt, id, wxTreeEventHandler(fn))
340 // GetItem() returns the item being dragged, GetPoint() the mouse coords
342 // if you call event.Allow(), the drag operation will start and a
343 // EVT_TREE_END_DRAG event will be sent when the drag is over.
344 #define EVT_TREE_BEGIN_DRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_DRAG, id, fn)
345 #define EVT_TREE_BEGIN_RDRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_RDRAG, id, fn)
347 // GetItem() is the item on which the drop occurred (if any) and GetPoint() the
348 // current mouse coords
349 #define EVT_TREE_END_DRAG(id, fn) wx__DECLARE_TREEEVT(END_DRAG, id, fn)
351 // GetItem() returns the itme whose label is being edited, GetLabel() returns
352 // the current item label for BEGIN and the would be new one for END.
354 // Vetoing BEGIN event means that label editing won't happen at all,
355 // vetoing END means that the new value is discarded and the old one kept
356 #define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) wx__DECLARE_TREEEVT(BEGIN_LABEL_EDIT, id, fn)
357 #define EVT_TREE_END_LABEL_EDIT(id, fn) wx__DECLARE_TREEEVT(END_LABEL_EDIT, id, fn)
359 // provide/update information about GetItem() item
360 #define EVT_TREE_GET_INFO(id, fn) wx__DECLARE_TREEEVT(GET_INFO, id, fn)
361 #define EVT_TREE_SET_INFO(id, fn) wx__DECLARE_TREEEVT(SET_INFO, id, fn)
363 // GetItem() is the item being expanded/collapsed, the "ING" versions can use
364 #define EVT_TREE_ITEM_EXPANDED(id, fn) wx__DECLARE_TREEEVT(ITEM_EXPANDED, id, fn)
365 #define EVT_TREE_ITEM_EXPANDING(id, fn) wx__DECLARE_TREEEVT(ITEM_EXPANDING, id, fn)
366 #define EVT_TREE_ITEM_COLLAPSED(id, fn) wx__DECLARE_TREEEVT(ITEM_COLLAPSED, id, fn)
367 #define EVT_TREE_ITEM_COLLAPSING(id, fn) wx__DECLARE_TREEEVT(ITEM_COLLAPSING, id, fn)
369 // GetOldItem() is the item which had the selection previously, GetItem() is
370 // the item which acquires selection
371 #define EVT_TREE_SEL_CHANGED(id, fn) wx__DECLARE_TREEEVT(SEL_CHANGED, id, fn)
372 #define EVT_TREE_SEL_CHANGING(id, fn) wx__DECLARE_TREEEVT(SEL_CHANGING, id, fn)
374 // GetKeyCode() returns the key code
375 // NB: this is the only message for which GetItem() is invalid (you may get the
376 // item from GetSelection())
377 #define EVT_TREE_KEY_DOWN(id, fn) wx__DECLARE_TREEEVT(KEY_DOWN, id, fn)
379 // GetItem() returns the item being deleted, the associated data (if any) will
380 // be deleted just after the return of this event handler (if any)
381 #define EVT_TREE_DELETE_ITEM(id, fn) wx__DECLARE_TREEEVT(DELETE_ITEM, id, fn)
383 // GetItem() returns the item that was activated (double click, enter, space)
384 #define EVT_TREE_ITEM_ACTIVATED(id, fn) wx__DECLARE_TREEEVT(ITEM_ACTIVATED, id, fn)
386 // GetItem() returns the item for which the context menu shall be shown
387 #define EVT_TREE_ITEM_MENU(id, fn) wx__DECLARE_TREEEVT(ITEM_MENU, id, fn)
389 // GetItem() returns the item that was clicked on
390 #define EVT_TREE_ITEM_RIGHT_CLICK(id, fn) wx__DECLARE_TREEEVT(ITEM_RIGHT_CLICK, id, fn)
391 #define EVT_TREE_ITEM_MIDDLE_CLICK(id, fn) wx__DECLARE_TREEEVT(ITEM_MIDDLE_CLICK, id, fn)
393 // GetItem() returns the item whose state image was clicked on
394 #define EVT_TREE_STATE_IMAGE_CLICK(id, fn) wx__DECLARE_TREEEVT(STATE_IMAGE_CLICK, id, fn)
396 // GetItem() is the item for which the tooltip is being requested
397 #define EVT_TREE_ITEM_GETTOOLTIP(id, fn) wx__DECLARE_TREEEVT(ITEM_GETTOOLTIP, id, fn)
399 // old wxEVT_COMMAND_* constants
400 #define wxEVT_COMMAND_TREE_BEGIN_DRAG wxEVT_TREE_BEGIN_DRAG
401 #define wxEVT_COMMAND_TREE_BEGIN_RDRAG wxEVT_TREE_BEGIN_RDRAG
402 #define wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT wxEVT_TREE_BEGIN_LABEL_EDIT
403 #define wxEVT_COMMAND_TREE_END_LABEL_EDIT wxEVT_TREE_END_LABEL_EDIT
404 #define wxEVT_COMMAND_TREE_DELETE_ITEM wxEVT_TREE_DELETE_ITEM
405 #define wxEVT_COMMAND_TREE_GET_INFO wxEVT_TREE_GET_INFO
406 #define wxEVT_COMMAND_TREE_SET_INFO wxEVT_TREE_SET_INFO
407 #define wxEVT_COMMAND_TREE_ITEM_EXPANDED wxEVT_TREE_ITEM_EXPANDED
408 #define wxEVT_COMMAND_TREE_ITEM_EXPANDING wxEVT_TREE_ITEM_EXPANDING
409 #define wxEVT_COMMAND_TREE_ITEM_COLLAPSED wxEVT_TREE_ITEM_COLLAPSED
410 #define wxEVT_COMMAND_TREE_ITEM_COLLAPSING wxEVT_TREE_ITEM_COLLAPSING
411 #define wxEVT_COMMAND_TREE_SEL_CHANGED wxEVT_TREE_SEL_CHANGED
412 #define wxEVT_COMMAND_TREE_SEL_CHANGING wxEVT_TREE_SEL_CHANGING
413 #define wxEVT_COMMAND_TREE_KEY_DOWN wxEVT_TREE_KEY_DOWN
414 #define wxEVT_COMMAND_TREE_ITEM_ACTIVATED wxEVT_TREE_ITEM_ACTIVATED
415 #define wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK wxEVT_TREE_ITEM_RIGHT_CLICK
416 #define wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK wxEVT_TREE_ITEM_MIDDLE_CLICK
417 #define wxEVT_COMMAND_TREE_END_DRAG wxEVT_TREE_END_DRAG
418 #define wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK wxEVT_TREE_STATE_IMAGE_CLICK
419 #define wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP wxEVT_TREE_ITEM_GETTOOLTIP
420 #define wxEVT_COMMAND_TREE_ITEM_MENU wxEVT_TREE_ITEM_MENU
422 #endif // wxUSE_TREECTRL
424 #endif // _WX_TREEBASE_H_