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"
27 #if WXWIN_COMPATIBILITY_2_6
29 // flags for deprecated `Expand(int action)', will be removed in next versions
33 wxTREE_EXPAND_COLLAPSE
,
34 wxTREE_EXPAND_COLLAPSE_RESET
,
38 #endif // WXWIN_COMPATIBILITY_2_6
40 // ----------------------------------------------------------------------------
41 // wxTreeItemId identifies an element of the tree. In this implementation, it's
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().
45 // ----------------------------------------------------------------------------
47 // Using this typedef removes an ambiguity when calling Remove()
48 typedef void *wxTreeItemIdValue
;
50 class WXDLLIMPEXP_CORE wxTreeItemId
52 friend bool operator==(const wxTreeItemId
&, const wxTreeItemId
&);
55 // 0 is invalid value for HTREEITEM
56 wxTreeItemId() { m_pItem
= 0; }
58 // construct wxTreeItemId from the native item id
59 wxTreeItemId(void *pItem
) { m_pItem
= pItem
; }
61 // default copy ctor/assignment operator are ok for us
64 // is this a valid tree item?
65 bool IsOk() const { return m_pItem
!= 0; }
66 // return true if this item is not valid
67 bool operator!() const { return !IsOk(); }
70 // invalidate the item
71 void Unset() { m_pItem
= 0; }
73 operator bool() const { return IsOk(); }
75 wxTreeItemIdValue m_pItem
;
78 inline bool operator==(const wxTreeItemId
& i1
, const wxTreeItemId
& i2
)
80 return i1
.m_pItem
== i2
.m_pItem
;
83 inline bool operator!=(const wxTreeItemId
& i1
, const wxTreeItemId
& i2
)
85 return i1
.m_pItem
!= i2
.m_pItem
;
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
98 // Because the objects of this class are deleted by the tree, they should
99 // always be allocated on the heap!
100 // ----------------------------------------------------------------------------
102 class WXDLLIMPEXP_CORE wxTreeItemData
: public wxClientData
104 friend class WXDLLIMPEXP_FWD_CORE wxTreeCtrl
;
105 friend class WXDLLIMPEXP_FWD_CORE wxGenericTreeCtrl
;
107 // creation/destruction
108 // --------------------
112 // default copy ctor/assignment operator are ok
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
; }
119 wxTreeItemId m_pItem
;
122 WX_DEFINE_EXPORTED_ARRAY_PTR(wxTreeItemIdValue
, wxArrayTreeItemIdsBase
);
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
127 class WXDLLIMPEXP_CORE wxArrayTreeItemIds
: public wxArrayTreeItemIdsBase
130 void Add(const wxTreeItemId
& id
)
131 { wxArrayTreeItemIdsBase::Add(id
.m_pItem
); }
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
); }
139 // ----------------------------------------------------------------------------
141 // ----------------------------------------------------------------------------
143 // enum for different images associated with a treectrl item
146 wxTreeItemIcon_Normal
, // not selected, not expanded
147 wxTreeItemIcon_Selected
, // selected, not expanded
148 wxTreeItemIcon_Expanded
, // not selected, expanded
149 wxTreeItemIcon_SelectedExpanded
, // selected, expanded
153 // special values for the 'state' parameter of wxTreeCtrl::SetItemState()
154 static const int wxTREE_ITEMSTATE_NONE
= -1; // not state (no display state image)
155 static const int wxTREE_ITEMSTATE_NEXT
= -2; // cycle to the next state
156 static const int wxTREE_ITEMSTATE_PREV
= -3; // cycle to the previous state
158 // ----------------------------------------------------------------------------
160 // ----------------------------------------------------------------------------
162 #define wxTR_NO_BUTTONS 0x0000 // for convenience
163 #define wxTR_HAS_BUTTONS 0x0001 // draw collapsed/expanded btns
164 #define wxTR_NO_LINES 0x0004 // don't draw lines at all
165 #define wxTR_LINES_AT_ROOT 0x0008 // connect top-level nodes
166 #define wxTR_TWIST_BUTTONS 0x0010 // still used by wxTreeListCtrl
168 #define wxTR_SINGLE 0x0000 // for convenience
169 #define wxTR_MULTIPLE 0x0020 // can select multiple items
171 #if WXWIN_COMPATIBILITY_2_8
172 #define wxTR_EXTENDED 0x0040 // deprecated, don't use
173 #endif // WXWIN_COMPATIBILITY_2_8
175 #define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080 // what it says
177 #define wxTR_EDIT_LABELS 0x0200 // can edit item labels
178 #define wxTR_ROW_LINES 0x0400 // put border around items
179 #define wxTR_HIDE_ROOT 0x0800 // don't display root node
181 #define wxTR_FULL_ROW_HIGHLIGHT 0x2000 // highlight full horz space
183 // make the default control appearance look more native-like depending on the
185 #if defined(__WXGTK20__)
186 #define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS | wxTR_NO_LINES)
187 #elif defined(__WXMAC__)
188 #define wxTR_DEFAULT_STYLE \
189 (wxTR_HAS_BUTTONS | wxTR_NO_LINES | wxTR_FULL_ROW_HIGHLIGHT)
191 #define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT)
194 #if WXWIN_COMPATIBILITY_2_6
195 // deprecated, don't use
196 #define wxTR_MAC_BUTTONS 0
197 #define wxTR_AQUA_BUTTONS 0
198 #endif // WXWIN_COMPATIBILITY_2_6
201 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
202 // where exactly the specified point is situated:
204 static const int wxTREE_HITTEST_ABOVE
= 0x0001;
205 static const int wxTREE_HITTEST_BELOW
= 0x0002;
206 static const int wxTREE_HITTEST_NOWHERE
= 0x0004;
207 // on the button associated with an item.
208 static const int wxTREE_HITTEST_ONITEMBUTTON
= 0x0008;
209 // on the bitmap associated with an item.
210 static const int wxTREE_HITTEST_ONITEMICON
= 0x0010;
211 // on the indent associated with an item.
212 static const int wxTREE_HITTEST_ONITEMINDENT
= 0x0020;
213 // on the label (string) associated with an item.
214 static const int wxTREE_HITTEST_ONITEMLABEL
= 0x0040;
215 // on the right of the label associated with an item.
216 static const int wxTREE_HITTEST_ONITEMRIGHT
= 0x0080;
217 // on the label (string) associated with an item.
218 static const int wxTREE_HITTEST_ONITEMSTATEICON
= 0x0100;
219 // on the left of the wxTreeCtrl.
220 static const int wxTREE_HITTEST_TOLEFT
= 0x0200;
221 // on the right of the wxTreeCtrl.
222 static const int wxTREE_HITTEST_TORIGHT
= 0x0400;
223 // on the upper part (first half) of the item.
224 static const int wxTREE_HITTEST_ONITEMUPPERPART
= 0x0800;
225 // on the lower part (second half) of the item.
226 static const int wxTREE_HITTEST_ONITEMLOWERPART
= 0x1000;
228 // anywhere on the item
229 static const int wxTREE_HITTEST_ONITEM
= wxTREE_HITTEST_ONITEMICON
|
230 wxTREE_HITTEST_ONITEMLABEL
;
232 // tree ctrl default name
233 extern WXDLLIMPEXP_DATA_CORE(const char) wxTreeCtrlNameStr
[];
235 // ----------------------------------------------------------------------------
236 // wxTreeItemAttr: a structure containing the visual attributes of an item
237 // ----------------------------------------------------------------------------
239 class WXDLLIMPEXP_CORE wxTreeItemAttr
244 wxTreeItemAttr(const wxColour
& colText
,
245 const wxColour
& colBack
,
247 : m_colText(colText
), m_colBack(colBack
), m_font(font
) { }
250 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; }
251 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; }
252 void SetFont(const wxFont
& font
) { m_font
= font
; }
255 bool HasTextColour() const { return m_colText
.Ok(); }
256 bool HasBackgroundColour() const { return m_colBack
.Ok(); }
257 bool HasFont() const { return m_font
.Ok(); }
259 const wxColour
& GetTextColour() const { return m_colText
; }
260 const wxColour
& GetBackgroundColour() const { return m_colBack
; }
261 const wxFont
& GetFont() const { return m_font
; }
269 // ----------------------------------------------------------------------------
270 // wxTreeEvent is a special class for all events associated with tree controls
272 // NB: note that not all accessors make sense for all events, see the event
273 // descriptions below
274 // ----------------------------------------------------------------------------
276 class WXDLLIMPEXP_FWD_CORE wxTreeCtrlBase
;
278 class WXDLLIMPEXP_CORE wxTreeEvent
: public wxNotifyEvent
281 wxTreeEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0);
282 wxTreeEvent(wxEventType commandType
,
283 wxTreeCtrlBase
*tree
,
284 const wxTreeItemId
&item
= wxTreeItemId());
285 wxTreeEvent(const wxTreeEvent
& event
);
287 virtual wxEvent
*Clone() const { return new wxTreeEvent(*this); }
290 // get the item on which the operation was performed or the newly
291 // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
292 wxTreeItemId
GetItem() const { return m_item
; }
293 void SetItem(const wxTreeItemId
& item
) { m_item
= item
; }
295 // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
297 wxTreeItemId
GetOldItem() const { return m_itemOld
; }
298 void SetOldItem(const wxTreeItemId
& item
) { m_itemOld
= item
; }
300 // the point where the mouse was when the drag operation started (for
301 // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only) or click position
302 wxPoint
GetPoint() const { return m_pointDrag
; }
303 void SetPoint(const wxPoint
& pt
) { m_pointDrag
= pt
; }
305 // keyboard data (for wxEVT_COMMAND_TREE_KEY_DOWN only)
306 const wxKeyEvent
& GetKeyEvent() const { return m_evtKey
; }
307 int GetKeyCode() const { return m_evtKey
.GetKeyCode(); }
308 void SetKeyEvent(const wxKeyEvent
& evt
) { m_evtKey
= evt
; }
310 // label (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
311 const wxString
& GetLabel() const { return m_label
; }
312 void SetLabel(const wxString
& label
) { m_label
= label
; }
314 // edit cancel flag (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
315 bool IsEditCancelled() const { return m_editCancelled
; }
316 void SetEditCanceled(bool editCancelled
) { m_editCancelled
= editCancelled
; }
318 // Set the tooltip for the item (for EVT\_TREE\_ITEM\_GETTOOLTIP events)
319 void SetToolTip(const wxString
& toolTip
) { m_label
= toolTip
; }
320 wxString
GetToolTip() { return m_label
; }
323 // not all of the members are used (or initialized) for all events
329 bool m_editCancelled
;
331 friend class WXDLLIMPEXP_FWD_CORE wxTreeCtrl
;
332 friend class WXDLLIMPEXP_FWD_CORE wxGenericTreeCtrl
;
334 DECLARE_DYNAMIC_CLASS(wxTreeEvent
)
337 typedef void (wxEvtHandler::*wxTreeEventFunction
)(wxTreeEvent
&);
339 // ----------------------------------------------------------------------------
340 // tree control events and macros for handling them
341 // ----------------------------------------------------------------------------
343 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_BEGIN_DRAG
, wxTreeEvent
);
344 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_BEGIN_RDRAG
, wxTreeEvent
);
345 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT
, wxTreeEvent
);
346 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_END_LABEL_EDIT
, wxTreeEvent
);
347 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_DELETE_ITEM
, wxTreeEvent
);
348 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_GET_INFO
, wxTreeEvent
);
349 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_SET_INFO
, wxTreeEvent
);
350 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_ITEM_EXPANDED
, wxTreeEvent
);
351 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_ITEM_EXPANDING
, wxTreeEvent
);
352 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_ITEM_COLLAPSED
, wxTreeEvent
);
353 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_ITEM_COLLAPSING
, wxTreeEvent
);
354 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_SEL_CHANGED
, wxTreeEvent
);
355 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_SEL_CHANGING
, wxTreeEvent
);
356 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_KEY_DOWN
, wxTreeEvent
);
357 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, wxTreeEvent
);
358 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK
, wxTreeEvent
);
359 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK
, wxTreeEvent
);
360 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_END_DRAG
, wxTreeEvent
);
361 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK
, wxTreeEvent
);
362 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP
, wxTreeEvent
);
363 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE
, wxEVT_COMMAND_TREE_ITEM_MENU
, wxTreeEvent
);
365 #define wxTreeEventHandler(func) \
366 wxEVENT_HANDLER_CAST(wxTreeEventFunction, func)
368 #define wx__DECLARE_TREEEVT(evt, id, fn) \
369 wx__DECLARE_EVT1(wxEVT_COMMAND_TREE_ ## evt, id, wxTreeEventHandler(fn))
371 // GetItem() returns the item being dragged, GetPoint() the mouse coords
373 // if you call event.Allow(), the drag operation will start and a
374 // EVT_TREE_END_DRAG event will be sent when the drag is over.
375 #define EVT_TREE_BEGIN_DRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_DRAG, id, fn)
376 #define EVT_TREE_BEGIN_RDRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_RDRAG, id, fn)
378 // GetItem() is the item on which the drop occurred (if any) and GetPoint() the
379 // current mouse coords
380 #define EVT_TREE_END_DRAG(id, fn) wx__DECLARE_TREEEVT(END_DRAG, id, fn)
382 // GetItem() returns the itme whose label is being edited, GetLabel() returns
383 // the current item label for BEGIN and the would be new one for END.
385 // Vetoing BEGIN event means that label editing won't happen at all,
386 // vetoing END means that the new value is discarded and the old one kept
387 #define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) wx__DECLARE_TREEEVT(BEGIN_LABEL_EDIT, id, fn)
388 #define EVT_TREE_END_LABEL_EDIT(id, fn) wx__DECLARE_TREEEVT(END_LABEL_EDIT, id, fn)
390 // provide/update information about GetItem() item
391 #define EVT_TREE_GET_INFO(id, fn) wx__DECLARE_TREEEVT(GET_INFO, id, fn)
392 #define EVT_TREE_SET_INFO(id, fn) wx__DECLARE_TREEEVT(SET_INFO, id, fn)
394 // GetItem() is the item being expanded/collapsed, the "ING" versions can use
395 #define EVT_TREE_ITEM_EXPANDED(id, fn) wx__DECLARE_TREEEVT(ITEM_EXPANDED, id, fn)
396 #define EVT_TREE_ITEM_EXPANDING(id, fn) wx__DECLARE_TREEEVT(ITEM_EXPANDING, id, fn)
397 #define EVT_TREE_ITEM_COLLAPSED(id, fn) wx__DECLARE_TREEEVT(ITEM_COLLAPSED, id, fn)
398 #define EVT_TREE_ITEM_COLLAPSING(id, fn) wx__DECLARE_TREEEVT(ITEM_COLLAPSING, id, fn)
400 // GetOldItem() is the item which had the selection previously, GetItem() is
401 // the item which acquires selection
402 #define EVT_TREE_SEL_CHANGED(id, fn) wx__DECLARE_TREEEVT(SEL_CHANGED, id, fn)
403 #define EVT_TREE_SEL_CHANGING(id, fn) wx__DECLARE_TREEEVT(SEL_CHANGING, id, fn)
405 // GetKeyCode() returns the key code
406 // NB: this is the only message for which GetItem() is invalid (you may get the
407 // item from GetSelection())
408 #define EVT_TREE_KEY_DOWN(id, fn) wx__DECLARE_TREEEVT(KEY_DOWN, id, fn)
410 // GetItem() returns the item being deleted, the associated data (if any) will
411 // be deleted just after the return of this event handler (if any)
412 #define EVT_TREE_DELETE_ITEM(id, fn) wx__DECLARE_TREEEVT(DELETE_ITEM, id, fn)
414 // GetItem() returns the item that was activated (double click, enter, space)
415 #define EVT_TREE_ITEM_ACTIVATED(id, fn) wx__DECLARE_TREEEVT(ITEM_ACTIVATED, id, fn)
417 // GetItem() returns the item for which the context menu shall be shown
418 #define EVT_TREE_ITEM_MENU(id, fn) wx__DECLARE_TREEEVT(ITEM_MENU, id, fn)
420 // GetItem() returns the item that was clicked on
421 #define EVT_TREE_ITEM_RIGHT_CLICK(id, fn) wx__DECLARE_TREEEVT(ITEM_RIGHT_CLICK, id, fn)
422 #define EVT_TREE_ITEM_MIDDLE_CLICK(id, fn) wx__DECLARE_TREEEVT(ITEM_MIDDLE_CLICK, id, fn)
424 // GetItem() returns the item whose state image was clicked on
425 #define EVT_TREE_STATE_IMAGE_CLICK(id, fn) wx__DECLARE_TREEEVT(STATE_IMAGE_CLICK, id, fn)
427 // GetItem() is the item for which the tooltip is being requested
428 #define EVT_TREE_ITEM_GETTOOLTIP(id, fn) wx__DECLARE_TREEEVT(ITEM_GETTOOLTIP, id, fn)
430 #endif // wxUSE_TREECTRL
432 #endif // _WX_TREEBASE_H_