1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxTreeCtrl class
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin to be less MSW-specific on 10/10/98
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_TREECTRL_H_
13 #define _WX_TREECTRL_H_
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
19 #pragma interface "treectrl.h"
22 #include "wx/control.h"
25 // the type for "untyped" data
26 typedef long wxDataType
;
29 class WXDLLEXPORT wxImageList
;
30 struct WXDLLEXPORT wxTreeViewItem
;
32 // a callback function used for sorting tree items, it should return -1 if the
33 // first item precedes the second, +1 if the second precedes the first or 0 if
36 typedef int (*wxTreeItemCmpFunc
)(wxTreeItemData
*item1
, wxTreeItemData
*item2
);
38 // ----------------------------------------------------------------------------
40 // ----------------------------------------------------------------------------
42 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
43 // where exactly the specified point is situated:
44 // above the client area.
45 static const int wxTREE_HITTEST_ABOVE
= 0x0001;
46 // below the client area.
47 static const int wxTREE_HITTEST_BELOW
= 0x0002;
48 // in the client area but below the last item.
49 static const int wxTREE_HITTEST_NOWHERE
= 0x0004;
50 // on the button associated with an item.
51 static const int wxTREE_HITTEST_ONITEMBUTTON
= 0x0010;
52 // on the bitmap associated with an item.
53 static const int wxTREE_HITTEST_ONITEMICON
= 0x0020;
54 // in the indentation associated with an item.
55 static const int wxTREE_HITTEST_ONITEMINDENT
= 0x0040;
56 // on the label (string) associated with an item.
57 static const int wxTREE_HITTEST_ONITEMLABEL
= 0x0080;
58 // in the area to the right of an item.
59 static const int wxTREE_HITTEST_ONITEMRIGHT
= 0x0100;
60 // on the state icon for a tree view item that is in a user-defined state.
61 static const int wxTREE_HITTEST_ONITEMSTATEICON
= 0x0200;
62 // to the right of the client area.
63 static const int wxTREE_HITTEST_TOLEFT
= 0x0400;
64 // to the left of the client area.
65 static const int wxTREE_HITTEST_TORIGHT
= 0x0800;
66 // anywhere on the item
67 static const int wxTREE_HITTEST_ONITEM
= wxTREE_HITTEST_ONITEMICON
|
68 wxTREE_HITTEST_ONITEMLABEL
|
69 wxTREE_HITTEST_ONITEMSTATEICON
;
71 // NB: all the following flags are for compatbility only and will be removed in the
74 // flags for deprecated `Expand(int action)'
78 wxTREE_EXPAND_COLLAPSE
,
79 wxTREE_EXPAND_COLLAPSE_RESET
,
83 // flags for deprecated InsertItem() variant
84 #define wxTREE_INSERT_FIRST 0xFFFF0001
85 #define wxTREE_INSERT_LAST 0xFFFF0002
87 // ----------------------------------------------------------------------------
88 // wxTreeItemId identifies an element of the tree. In this implementation, it's
89 // just a trivial wrapper around Win32 HTREEITEM. It's opaque for the
91 // ----------------------------------------------------------------------------
92 class WXDLLEXPORT wxTreeItemId
96 // 0 is invalid value for HTREEITEM
97 wxTreeItemId() { m_itemId
= 0; }
99 // default copy ctor/assignment operator are ok for us
102 // is this a valid tree item?
103 bool IsOk() const { return m_itemId
!= 0; }
105 // conversion to/from either real (system-dependent) tree item id or
106 // to "long" which used to be the type for tree item ids in previous
107 // versions of wxWindows
109 // for wxTreeCtrl usage only
110 wxTreeItemId(WXHTREEITEM itemId
) { m_itemId
= (long)itemId
; }
111 operator WXHTREEITEM() const { return (WXHTREEITEM
)m_itemId
; }
113 void operator =(WXHTREEITEM item
) { m_itemId
= (long) item
; }
115 // wxTreeItemId(long itemId) { m_itemId = itemId; }
121 // ----------------------------------------------------------------------------
122 // wxTreeItemData is some (arbitrary) user class associated with some item. The
123 // main advantage of having this class (compared to old untyped interface) is
124 // that wxTreeItemData's are destroyed automatically by the tree and, as this
125 // class has virtual dtor, it means that the memory will be automatically
126 // freed. OTOH, we don't just use wxObject instead of wxTreeItemData because
127 // the size of this class is critical: in any real application, each tree leaf
128 // will have wxTreeItemData associated with it and number of leaves may be
131 // Because the objects of this class are deleted by the tree, they should
132 // always be allocated on the heap!
133 // ----------------------------------------------------------------------------
134 class WXDLLEXPORT wxTreeItemData
136 friend class wxTreeCtrl
;
138 // creation/destruction
139 // --------------------
143 // default copy ctor/assignment operator are ok
145 // dtor is virtual and all the items are deleted by the tree control
146 // when it's deleted, so you normally don't have to care about freeing
147 // memory allocated in your wxTreeItemData-derived class
148 virtual ~wxTreeItemData() { }
150 // accessor: get the item associated with us
151 const wxTreeItemId
& GetItemId() const { return m_itemId
; }
154 wxTreeItemId m_itemId
;
157 // ----------------------------------------------------------------------------
159 // ----------------------------------------------------------------------------
160 class WXDLLEXPORT wxTreeCtrl
: public wxControl
165 wxTreeCtrl() { Init(); }
167 wxTreeCtrl(wxWindow
*parent
, wxWindowID id
= -1,
168 const wxPoint
& pos
= wxDefaultPosition
,
169 const wxSize
& size
= wxDefaultSize
,
170 long style
= wxTR_HAS_BUTTONS
| wxTR_LINES_AT_ROOT
,
171 const wxValidator
& validator
= wxDefaultValidator
,
172 const wxString
& name
= "wxTreeCtrl")
174 Create(parent
, id
, pos
, size
, style
, validator
, name
);
177 virtual ~wxTreeCtrl();
179 bool Create(wxWindow
*parent
, wxWindowID id
= -1,
180 const wxPoint
& pos
= wxDefaultPosition
,
181 const wxSize
& size
= wxDefaultSize
,
182 long style
= wxTR_HAS_BUTTONS
| wxTR_LINES_AT_ROOT
,
183 const wxValidator
& validator
= wxDefaultValidator
,
184 const wxString
& name
= "wxTreeCtrl");
189 // get the total number of items in the control
190 size_t GetCount() const;
192 // indent is the number of pixels the children are indented relative to
193 // the parents position. SetIndent() also redraws the control
195 unsigned int GetIndent() const;
196 void SetIndent(unsigned int indent
);
198 // image list: these functions allow to associate an image list with
199 // the control and retrieve it. Note that the control does _not_ delete
200 // the associated image list when it's deleted in order to allow image
201 // lists to be shared between different controls.
203 // The normal image list is for the icons which correspond to the
204 // normal tree item state (whether it is selected or not).
205 // Additionally, the application might choose to show a state icon
206 // which corresponds to an app-defined item state (for example,
207 // checked/unchecked) which are taken from the state image list.
208 wxImageList
*GetImageList() const;
209 wxImageList
*GetStateImageList() const;
211 void SetImageList(wxImageList
*imageList
);
212 void SetStateImageList(wxImageList
*imageList
);
214 // Functions to work with tree ctrl items. Unfortunately, they can _not_ be
215 // member functions of wxTreeItem because they must know the tree the item
216 // belongs to for Windows implementation and storing the pointer to
217 // wxTreeCtrl in each wxTreeItem is just too much waste.
222 // retrieve items label
223 wxString
GetItemText(const wxTreeItemId
& item
) const;
224 // get the normal item image
225 int GetItemImage(const wxTreeItemId
& item
) const;
226 // get the selected item image
227 int GetItemSelectedImage(const wxTreeItemId
& item
) const;
228 // get the data associated with the item
229 wxTreeItemData
*GetItemData(const wxTreeItemId
& item
) const;
235 void SetItemText(const wxTreeItemId
& item
, const wxString
& text
);
236 // set the normal item image
237 void SetItemImage(const wxTreeItemId
& item
, int image
);
238 // set the selected item image
239 void SetItemSelectedImage(const wxTreeItemId
& item
, int image
);
240 // associate some data with the item
241 void SetItemData(const wxTreeItemId
& item
, wxTreeItemData
*data
);
243 // item status inquiries
244 // ---------------------
246 // is the item visible (it might be outside the view or not expanded)?
247 bool IsVisible(const wxTreeItemId
& item
) const;
248 // does the item has any children?
249 bool ItemHasChildren(const wxTreeItemId
& item
) const;
250 // is the item expanded (only makes sense if HasChildren())?
251 bool IsExpanded(const wxTreeItemId
& item
) const;
252 // is this item currently selected (the same as has focus)?
253 bool IsSelected(const wxTreeItemId
& item
) const;
258 // wxTreeItemId.IsOk() will return FALSE if there is no such item
260 // get the root tree item
261 wxTreeItemId
GetRootItem() const;
263 // get the item currently selected (may return NULL if no selection)
264 wxTreeItemId
GetSelection() const;
266 // get the parent of this item (may return NULL if root)
267 wxTreeItemId
GetParent(const wxTreeItemId
& item
) const;
269 // for this enumeration function you must pass in a "cookie" parameter
270 // which is opaque for the application but is necessary for the library
271 // to make these functions reentrant (i.e. allow more than one
272 // enumeration on one and the same object simultaneously). Of course,
273 // the "cookie" passed to GetFirstChild() and GetNextChild() should be
276 // get the first child of this item
277 wxTreeItemId
GetFirstChild(const wxTreeItemId
& item
, long& _cookie
) const;
278 // get the next child
279 wxTreeItemId
GetNextChild(const wxTreeItemId
& item
, long& _cookie
) const;
281 // get the next sibling of this item
282 wxTreeItemId
GetNextSibling(const wxTreeItemId
& item
) const;
283 // get the previous sibling
284 wxTreeItemId
GetPrevSibling(const wxTreeItemId
& item
) const;
286 // get first visible item
287 wxTreeItemId
GetFirstVisibleItem() const;
288 // get the next visible item: item must be visible itself!
289 // see IsVisible() and wxTreeCtrl::GetFirstVisibleItem()
290 wxTreeItemId
GetNextVisible(const wxTreeItemId
& item
) const;
291 // get the previous visible item: item must be visible itself!
292 wxTreeItemId
GetPrevVisible(const wxTreeItemId
& item
) const;
297 // add the root node to the tree
298 wxTreeItemId
AddRoot(const wxString
& text
,
299 int image
= -1, int selectedImage
= -1,
300 wxTreeItemData
*data
= NULL
);
302 // insert a new item in as the first child of the parent
303 wxTreeItemId
PrependItem(const wxTreeItemId
& parent
,
304 const wxString
& text
,
305 int image
= -1, int selectedImage
= -1,
306 wxTreeItemData
*data
= NULL
);
308 // insert a new item after a given one
309 wxTreeItemId
InsertItem(const wxTreeItemId
& parent
,
310 const wxTreeItemId
& idPrevious
,
311 const wxString
& text
,
312 int image
= -1, int selectedImage
= -1,
313 wxTreeItemData
*data
= NULL
);
315 // insert a new item in as the last child of the parent
316 wxTreeItemId
AppendItem(const wxTreeItemId
& parent
,
317 const wxString
& text
,
318 int image
= -1, int selectedImage
= -1,
319 wxTreeItemData
*data
= NULL
);
321 // delete this item and associated data if any
322 void Delete(const wxTreeItemId
& item
);
323 // delete all items from the tree
324 void DeleteAllItems();
327 void Expand(const wxTreeItemId
& item
);
328 // collapse the item without removing its children
329 void Collapse(const wxTreeItemId
& item
);
330 // collapse the item and remove all children
331 void CollapseAndReset(const wxTreeItemId
& item
);
332 // toggles the current state
333 void Toggle(const wxTreeItemId
& item
);
335 // remove the selection from currently selected item (if any)
338 void SelectItem(const wxTreeItemId
& item
);
339 // make sure this item is visible (expanding the parent item and/or
340 // scrolling to this item if necessary)
341 void EnsureVisible(const wxTreeItemId
& item
);
342 // scroll to this item (but don't expand its parent)
343 void ScrollTo(const wxTreeItemId
& item
);
345 // start editing the item label: this (temporarily) replaces the item
346 // with a one line edit control. The item will be selected if it hadn't
347 // been before. textCtrlClass parameter allows you to create an edit
348 // control of arbitrary user-defined class deriving from wxTextCtrl.
349 wxTextCtrl
* EditLabel(const wxTreeItemId
& item
,
350 wxClassInfo
* textCtrlClass
= CLASSINFO(wxTextCtrl
));
351 // returns the same pointer as StartEdit() if the item is being edited,
352 // NULL otherwise (it's assumed that no more than one item may be
353 // edited simultaneously)
354 wxTextCtrl
* GetEditControl() const;
355 // end editing and accept or discard the changes to item label
356 void EndEditLabel(const wxTreeItemId
& item
, bool discardChanges
= FALSE
);
358 // sort the children of this item using the specified callback function
359 // (it should return -1, 0 or +1 as usual), if it's not specified
360 // alphabetical comparaison is performed.
362 // NB: this function is not reentrant!
363 void SortChildren(const wxTreeItemId
& item
,
364 wxTreeItemCmpFunc
*cmpFunction
= NULL
);
369 // @@@ do we really need to expose these functions to the application?
371 // get the bounding rectangle of the item (or of its label only)
372 void GetBoundingRect(const wxTreeItemId
& item
,
374 bool textOnly
= FALSE
) const;
376 // determine to which item (if any) belongs the given point (the
377 // coordinates specified are relative to the client area of tree ctrl)
378 // and fill the flags parameter with a bitmask of wxTREE_HITTEST_xxx
380 wxTreeItemId
HitTest(const wxPoint
& point
, int& flags
);
385 // these methods are deprecated and will be removed in future versions of
386 // wxWindows, they're here for compatibility only, don't use them in new
387 // code (the comments indicate why these methods are now useless and how to
390 // use Expand, Collapse, CollapseAndReset or Toggle
391 void ExpandItem(const wxTreeItemId
& item
, int action
);
393 // use AddRoot, PrependItem or AppendItem
394 wxTreeItemId
InsertItem(const wxTreeItemId
& parent
,
395 const wxString
& text
,
396 int image
= -1, int selImage
= -1,
397 long insertAfter
= wxTREE_INSERT_LAST
);
399 // use Set/GetImageList and Set/GetStateImageList
400 wxImageList
*GetImageList(int) const
401 { return GetImageList(); }
402 void SetImageList(wxImageList
*imageList
, int)
403 { SetImageList(imageList
); }
407 void Command(wxCommandEvent
& event
) { ProcessCommand(event
); };
408 bool MSWCommand(WXUINT param
, WXWORD id
);
409 bool MSWNotify(WXWPARAM wParam
, WXLPARAM lParam
);
412 // SetImageList helper
413 void SetAnyImageList(wxImageList
*imageList
, int which
);
415 wxTextCtrl
* m_textCtrl
; // used while editing the item label
416 wxImageList
*m_imageListNormal
, // images for tree elements
417 *m_imageListState
; // special images for app defined states
420 // the common part of all ctors
424 inline bool DoGetItem(wxTreeViewItem
*tvItem
) const;
425 inline void DoSetItem(wxTreeViewItem
*tvItem
);
427 inline void DoExpand(const wxTreeItemId
& item
, int flag
);
429 wxTreeItemId
DoInsertItem(const wxTreeItemId
& parent
,
430 wxTreeItemId hInsertAfter
,
431 const wxString
& text
,
432 int image
, int selectedImage
,
433 wxTreeItemData
*data
);
435 void DeleteTextCtrl();
437 DECLARE_DYNAMIC_CLASS(wxTreeCtrl
)
440 // ----------------------------------------------------------------------------
441 // wxTreeEvent is a special class for all events associated with tree controls
443 // NB: note that not all accessors make sense for all events, see the event
444 // descriptions below
445 // ----------------------------------------------------------------------------
446 class WXDLLEXPORT wxTreeEvent
: public wxCommandEvent
450 wxTreeEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0);
453 // get the item on which the operation was performed or the newly
454 // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
455 wxTreeItemId
GetItem() const { return m_item
; }
457 // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
459 wxTreeItemId
GetOldItem() const { return m_itemOld
; }
461 // the point where the mouse was when the drag operation started (for
462 // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only)
463 wxPoint
GetPoint() const { return m_pointDrag
; }
465 // keyboard code (for wxEVT_COMMAND_TREE_KEY_DOWN only)
466 int GetCode() const { return m_code
; }
468 // set return code for wxEVT_COMMAND_TREE_ITEM_{EXPAND|COLLAPS}ING events
469 // call this to forbid the change in item status
470 void Veto() { m_code
= TRUE
; }
473 // @@ we could save some space by using union here
479 DECLARE_DYNAMIC_CLASS(wxTreeEvent
)
482 typedef void (wxEvtHandler::*wxTreeEventFunction
)(wxTreeEvent
&);
484 // ----------------------------------------------------------------------------
485 // macros for handling tree control events
486 // ----------------------------------------------------------------------------
488 // GetItem() returns the item being dragged, GetPoint() the mouse coords
489 #define EVT_TREE_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
490 #define EVT_TREE_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
492 // GetItem() returns the itme whose label is being edited
493 #define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
494 #define EVT_TREE_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
496 // provide/update information about GetItem() item
497 #define EVT_TREE_GET_INFO(id, fn) { wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
498 #define EVT_TREE_SET_INFO(id, fn) { wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
500 // GetItem() is the item being expanded/collapsed, the "ING" versions can use
501 #define EVT_TREE_ITEM_EXPANDED(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
502 #define EVT_TREE_ITEM_EXPANDING(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
503 #define EVT_TREE_ITEM_COLLAPSED(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
504 #define EVT_TREE_ITEM_COLLAPSING(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
506 // GetOldItem() is the item which had the selection previously, GetItem() is
507 // the item which acquires selection
508 #define EVT_TREE_SEL_CHANGED(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
509 #define EVT_TREE_SEL_CHANGING(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
511 // GetCode() returns the key code
512 // NB: this is the only message for which GetItem() is invalid (you may get the
513 // item from GetSelection())
514 #define EVT_TREE_KEY_DOWN(id, fn) { wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
516 // GetItem() returns the item being deleted, the associated data (if any) will
517 // be deleted just after the return of this event handler (if any)
518 #define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },