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
: private wxTreeItemId
137 // default ctor/copy ctor/assignment operator are ok
139 // dtor is virtual and all the items are deleted by the tree control when
140 // it's deleted, so you normally don't have to care about freeing memory
141 // allocated in your wxTreeItemData-derived class
142 virtual ~wxTreeItemData() { }
144 // accessors: set/get the item associated with this node
145 void SetId(const wxTreeItemId
& id
) { m_itemId
= id
; }
146 const wxTreeItemId
& GetId() const { return (wxTreeItemId
&) m_itemId
; }
149 // ----------------------------------------------------------------------------
151 // ----------------------------------------------------------------------------
152 class WXDLLEXPORT wxTreeCtrl
: public wxControl
157 wxTreeCtrl() { Init(); }
159 wxTreeCtrl(wxWindow
*parent
, wxWindowID id
= -1,
160 const wxPoint
& pos
= wxDefaultPosition
,
161 const wxSize
& size
= wxDefaultSize
,
162 long style
= wxTR_HAS_BUTTONS
| wxTR_LINES_AT_ROOT
,
163 const wxValidator
& validator
= wxDefaultValidator
,
164 const wxString
& name
= "wxTreeCtrl")
166 Create(parent
, id
, pos
, size
, style
, validator
, name
);
169 virtual ~wxTreeCtrl();
171 bool Create(wxWindow
*parent
, wxWindowID id
= -1,
172 const wxPoint
& pos
= wxDefaultPosition
,
173 const wxSize
& size
= wxDefaultSize
,
174 long style
= wxTR_HAS_BUTTONS
| wxTR_LINES_AT_ROOT
,
175 const wxValidator
& validator
= wxDefaultValidator
,
176 const wxString
& name
= "wxTreeCtrl");
181 // get the total number of items in the control
182 size_t GetCount() const;
184 // indent is the number of pixels the children are indented relative to
185 // the parents position. SetIndent() also redraws the control
187 unsigned int GetIndent() const;
188 void SetIndent(unsigned int indent
);
190 // image list: these functions allow to associate an image list with
191 // the control and retrieve it. Note that the control does _not_ delete
192 // the associated image list when it's deleted in order to allow image
193 // lists to be shared between different controls.
195 // The normal image list is for the icons which correspond to the
196 // normal tree item state (whether it is selected or not).
197 // Additionally, the application might choose to show a state icon
198 // which corresponds to an app-defined item state (for example,
199 // checked/unchecked) which are taken from the state image list.
200 wxImageList
*GetImageList() const;
201 wxImageList
*GetStateImageList() const;
203 void SetImageList(wxImageList
*imageList
);
204 void SetStateImageList(wxImageList
*imageList
);
206 // Functions to work with tree ctrl items. Unfortunately, they can _not_ be
207 // member functions of wxTreeItem because they must know the tree the item
208 // belongs to for Windows implementation and storing the pointer to
209 // wxTreeCtrl in each wxTreeItem is just too much waste.
214 // retrieve items label
215 wxString
GetItemText(const wxTreeItemId
& item
) const;
216 // get the normal item image
217 int GetItemImage(const wxTreeItemId
& item
) const;
218 // get the selected item image
219 int GetItemSelectedImage(const wxTreeItemId
& item
) const;
220 // get the data associated with the item
221 wxTreeItemData
*GetItemData(const wxTreeItemId
& item
) const;
227 void SetItemText(const wxTreeItemId
& item
, const wxString
& text
);
228 // set the normal item image
229 void SetItemImage(const wxTreeItemId
& item
, int image
);
230 // set the selected item image
231 void SetItemSelectedImage(const wxTreeItemId
& item
, int image
);
232 // associate some data with the item
233 void SetItemData(const wxTreeItemId
& item
, wxTreeItemData
*data
);
235 // force appearance of [+] button near the item. This is useful to
236 // allow the user to expand the items which don't have any children now
237 // - but instead add them only when needed, thus minimizing memory
238 // usage and loading time.
239 void SetItemHasChildren(const wxTreeItemId
& item
, bool has
= TRUE
);
241 // item status inquiries
242 // ---------------------
244 // is the item visible (it might be outside the view or not expanded)?
245 bool IsVisible(const wxTreeItemId
& item
) const;
246 // does the item has any children?
247 bool ItemHasChildren(const wxTreeItemId
& item
) const;
248 // is the item expanded (only makes sense if HasChildren())?
249 bool IsExpanded(const wxTreeItemId
& item
) const;
250 // is this item currently selected (the same as has focus)?
251 bool IsSelected(const wxTreeItemId
& item
) const;
253 // number of children
254 // ------------------
256 // if 'recursively' is FALSE, only immediate children count, otherwise
257 // the returned number is the number of all items in this branch
258 size_t GetChildrenCount(const wxTreeItemId
& item
, bool recursively
= TRUE
);
263 // wxTreeItemId.IsOk() will return FALSE if there is no such item
265 // get the root tree item
266 wxTreeItemId
GetRootItem() const;
268 // get the item currently selected (may return NULL if no selection)
269 wxTreeItemId
GetSelection() const;
271 // get the parent of this item (may return NULL if root)
272 wxTreeItemId
GetParent(const wxTreeItemId
& item
) const;
274 // for this enumeration function you must pass in a "cookie" parameter
275 // which is opaque for the application but is necessary for the library
276 // to make these functions reentrant (i.e. allow more than one
277 // enumeration on one and the same object simultaneously). Of course,
278 // the "cookie" passed to GetFirstChild() and GetNextChild() should be
281 // get the first child of this item
282 wxTreeItemId
GetFirstChild(const wxTreeItemId
& item
, long& _cookie
) const;
283 // get the next child
284 wxTreeItemId
GetNextChild(const wxTreeItemId
& item
, long& _cookie
) const;
286 // get the next sibling of this item
287 wxTreeItemId
GetNextSibling(const wxTreeItemId
& item
) const;
288 // get the previous sibling
289 wxTreeItemId
GetPrevSibling(const wxTreeItemId
& item
) const;
291 // get first visible item
292 wxTreeItemId
GetFirstVisibleItem() const;
293 // get the next visible item: item must be visible itself!
294 // see IsVisible() and wxTreeCtrl::GetFirstVisibleItem()
295 wxTreeItemId
GetNextVisible(const wxTreeItemId
& item
) const;
296 // get the previous visible item: item must be visible itself!
297 wxTreeItemId
GetPrevVisible(const wxTreeItemId
& item
) const;
302 // add the root node to the tree
303 wxTreeItemId
AddRoot(const wxString
& text
,
304 int image
= -1, int selectedImage
= -1,
305 wxTreeItemData
*data
= NULL
);
307 // insert a new item in as the first child of the parent
308 wxTreeItemId
PrependItem(const wxTreeItemId
& parent
,
309 const wxString
& text
,
310 int image
= -1, int selectedImage
= -1,
311 wxTreeItemData
*data
= NULL
);
313 // insert a new item after a given one
314 wxTreeItemId
InsertItem(const wxTreeItemId
& parent
,
315 const wxTreeItemId
& idPrevious
,
316 const wxString
& text
,
317 int image
= -1, int selectedImage
= -1,
318 wxTreeItemData
*data
= NULL
);
320 // insert a new item in as the last child of the parent
321 wxTreeItemId
AppendItem(const wxTreeItemId
& parent
,
322 const wxString
& text
,
323 int image
= -1, int selectedImage
= -1,
324 wxTreeItemData
*data
= NULL
);
326 // delete this item and associated data if any
327 void Delete(const wxTreeItemId
& item
);
328 // delete all items from the tree
329 void DeleteAllItems();
332 void Expand(const wxTreeItemId
& item
);
333 // collapse the item without removing its children
334 void Collapse(const wxTreeItemId
& item
);
335 // collapse the item and remove all children
336 void CollapseAndReset(const wxTreeItemId
& item
);
337 // toggles the current state
338 void Toggle(const wxTreeItemId
& item
);
340 // remove the selection from currently selected item (if any)
343 void SelectItem(const wxTreeItemId
& item
);
344 // make sure this item is visible (expanding the parent item and/or
345 // scrolling to this item if necessary)
346 void EnsureVisible(const wxTreeItemId
& item
);
347 // scroll to this item (but don't expand its parent)
348 void ScrollTo(const wxTreeItemId
& item
);
350 // start editing the item label: this (temporarily) replaces the item
351 // with a one line edit control. The item will be selected if it hadn't
352 // been before. textCtrlClass parameter allows you to create an edit
353 // control of arbitrary user-defined class deriving from wxTextCtrl.
354 wxTextCtrl
* EditLabel(const wxTreeItemId
& item
,
355 wxClassInfo
* textCtrlClass
= CLASSINFO(wxTextCtrl
));
356 // returns the same pointer as StartEdit() if the item is being edited,
357 // NULL otherwise (it's assumed that no more than one item may be
358 // edited simultaneously)
359 wxTextCtrl
* GetEditControl() const;
360 // end editing and accept or discard the changes to item label
361 void EndEditLabel(const wxTreeItemId
& item
, bool discardChanges
= FALSE
);
363 // sort the children of this item using the specified callback function
364 // (it should return -1, 0 or +1 as usual), if it's not specified
365 // alphabetical comparaison is performed.
367 // NB: this function is not reentrant!
368 void SortChildren(const wxTreeItemId
& item
,
369 wxTreeItemCmpFunc
*cmpFunction
= NULL
);
374 // @@@ do we really need to expose these functions to the application?
376 // get the bounding rectangle of the item (or of its label only)
377 void GetBoundingRect(const wxTreeItemId
& item
,
379 bool textOnly
= FALSE
) const;
381 // determine to which item (if any) belongs the given point (the
382 // coordinates specified are relative to the client area of tree ctrl)
383 // and fill the flags parameter with a bitmask of wxTREE_HITTEST_xxx
385 wxTreeItemId
HitTest(const wxPoint
& point
, int& flags
);
390 // these methods are deprecated and will be removed in future versions of
391 // wxWindows, they're here for compatibility only, don't use them in new
392 // code (the comments indicate why these methods are now useless and how to
395 // use Expand, Collapse, CollapseAndReset or Toggle
396 void ExpandItem(const wxTreeItemId
& item
, int action
);
398 // use AddRoot, PrependItem or AppendItem
399 wxTreeItemId
InsertItem(const wxTreeItemId
& parent
,
400 const wxString
& text
,
401 int image
= -1, int selImage
= -1,
402 long insertAfter
= wxTREE_INSERT_LAST
);
404 // use Set/GetImageList and Set/GetStateImageList
405 wxImageList
*GetImageList(int) const
406 { return GetImageList(); }
407 void SetImageList(wxImageList
*imageList
, int)
408 { SetImageList(imageList
); }
412 void Command(wxCommandEvent
& event
) { ProcessCommand(event
); };
413 bool MSWCommand(WXUINT param
, WXWORD id
);
414 bool MSWNotify(WXWPARAM wParam
, WXLPARAM lParam
);
417 // SetImageList helper
418 void SetAnyImageList(wxImageList
*imageList
, int which
);
420 wxTextCtrl
* m_textCtrl
; // used while editing the item label
421 wxImageList
*m_imageListNormal
, // images for tree elements
422 *m_imageListState
; // special images for app defined states
425 // the common part of all ctors
429 inline bool DoGetItem(wxTreeViewItem
*tvItem
) const;
430 inline void DoSetItem(wxTreeViewItem
*tvItem
);
432 inline void DoExpand(const wxTreeItemId
& item
, int flag
);
434 wxTreeItemId
DoInsertItem(const wxTreeItemId
& parent
,
435 wxTreeItemId hInsertAfter
,
436 const wxString
& text
,
437 int image
, int selectedImage
,
438 wxTreeItemData
*data
);
440 void DeleteTextCtrl();
442 DECLARE_DYNAMIC_CLASS(wxTreeCtrl
)
445 // ----------------------------------------------------------------------------
446 // wxTreeEvent is a special class for all events associated with tree controls
448 // NB: note that not all accessors make sense for all events, see the event
449 // descriptions below
450 // ----------------------------------------------------------------------------
451 class WXDLLEXPORT wxTreeEvent
: public wxCommandEvent
455 wxTreeEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0);
458 // get the item on which the operation was performed or the newly
459 // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
460 wxTreeItemId
GetItem() const { return m_item
; }
462 // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
464 wxTreeItemId
GetOldItem() const { return m_itemOld
; }
466 // the point where the mouse was when the drag operation started (for
467 // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only)
468 wxPoint
GetPoint() const { return m_pointDrag
; }
470 // keyboard code (for wxEVT_COMMAND_TREE_KEY_DOWN only)
471 int GetCode() const { return m_code
; }
473 // set return code for wxEVT_COMMAND_TREE_ITEM_{EXPAND|COLLAPS}ING events
474 // call this to forbid the change in item status
475 void Veto() { m_code
= TRUE
; }
478 // @@ we could save some space by using union here
484 DECLARE_DYNAMIC_CLASS(wxTreeEvent
)
487 typedef void (wxEvtHandler::*wxTreeEventFunction
)(wxTreeEvent
&);
489 // ----------------------------------------------------------------------------
490 // macros for handling tree control events
491 // ----------------------------------------------------------------------------
493 // GetItem() returns the item being dragged, GetPoint() the mouse coords
494 #define EVT_TREE_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
495 #define EVT_TREE_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
497 // GetItem() returns the itme whose label is being edited
498 #define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
499 #define EVT_TREE_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
501 // provide/update information about GetItem() item
502 #define EVT_TREE_GET_INFO(id, fn) { wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
503 #define EVT_TREE_SET_INFO(id, fn) { wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
505 // GetItem() is the item being expanded/collapsed, the "ING" versions can use
506 #define EVT_TREE_ITEM_EXPANDED(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
507 #define EVT_TREE_ITEM_EXPANDING(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
508 #define EVT_TREE_ITEM_COLLAPSED(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
509 #define EVT_TREE_ITEM_COLLAPSING(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
511 // GetOldItem() is the item which had the selection previously, GetItem() is
512 // the item which acquires selection
513 #define EVT_TREE_SEL_CHANGED(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
514 #define EVT_TREE_SEL_CHANGING(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
516 // GetCode() returns the key code
517 // NB: this is the only message for which GetItem() is invalid (you may get the
518 // item from GetSelection())
519 #define EVT_TREE_KEY_DOWN(id, fn) { wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
521 // GetItem() returns the item being deleted, the associated data (if any) will
522 // be deleted just after the return of this event handler (if any)
523 #define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },