]> git.saurik.com Git - wxWidgets.git/blob - include/wx/msw/treectrl.h
some new functions:
[wxWidgets.git] / include / wx / msw / treectrl.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: treectrl.h
3 // Purpose: wxTreeCtrl class
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin to be less MSW-specific on 10/10/98
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_TREECTRL_H_
13 #define _WX_TREECTRL_H_
14
15 // ----------------------------------------------------------------------------
16 // headers
17 // ----------------------------------------------------------------------------
18 #ifdef __GNUG__
19 #pragma interface "treectrl.h"
20 #endif
21
22 #include "wx/control.h"
23 #include "wx/event.h"
24
25 // the type for "untyped" data
26 typedef long wxDataType;
27
28 // fwd decl
29 class WXDLLEXPORT wxImageList;
30 struct WXDLLEXPORT wxTreeViewItem;
31
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
34 // they're equivalent
35 class wxTreeItemData;
36 typedef int (*wxTreeItemCmpFunc)(wxTreeItemData *item1, wxTreeItemData *item2);
37
38 // ----------------------------------------------------------------------------
39 // constants
40 // ----------------------------------------------------------------------------
41
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;
70
71 // NB: all the following flags are for compatbility only and will be removed in the
72 // next versions
73
74 // flags for deprecated `Expand(int action)'
75 enum
76 {
77 wxTREE_EXPAND_EXPAND,
78 wxTREE_EXPAND_COLLAPSE,
79 wxTREE_EXPAND_COLLAPSE_RESET,
80 wxTREE_EXPAND_TOGGLE
81 };
82
83 // flags for deprecated InsertItem() variant
84 #define wxTREE_INSERT_FIRST 0xFFFF0001
85 #define wxTREE_INSERT_LAST 0xFFFF0002
86
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
90 // application.
91 // ----------------------------------------------------------------------------
92 class WXDLLEXPORT wxTreeItemId
93 {
94 public:
95 // ctors
96 // 0 is invalid value for HTREEITEM
97 wxTreeItemId() { m_itemId = 0; }
98
99 // default copy ctor/assignment operator are ok for us
100
101 // accessors
102 // is this a valid tree item?
103 bool IsOk() const { return m_itemId != 0; }
104
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
108
109 // for wxTreeCtrl usage only
110 wxTreeItemId(WXHTREEITEM itemId) { m_itemId = (long)itemId; }
111 operator WXHTREEITEM() const { return (WXHTREEITEM)m_itemId; }
112
113 void operator =(WXHTREEITEM item) { m_itemId = (long) item; }
114
115 // wxTreeItemId(long itemId) { m_itemId = itemId; }
116
117 protected:
118 long m_itemId;
119 };
120
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
129 // quite big.
130 //
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
135 {
136 public:
137 // default ctor/copy ctor/assignment operator are ok
138
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() { }
143
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 m_itemId; }
147 };
148
149 // ----------------------------------------------------------------------------
150 // wxTreeCtrl
151 // ----------------------------------------------------------------------------
152 class WXDLLEXPORT wxTreeCtrl : public wxControl
153 {
154 public:
155 // creation
156 // --------
157 wxTreeCtrl() { Init(); }
158
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")
165 {
166 Create(parent, id, pos, size, style, validator, name);
167 }
168
169 virtual ~wxTreeCtrl();
170
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");
177
178 // accessors
179 // ---------
180
181 // get the total number of items in the control
182 size_t GetCount() const;
183
184 // indent is the number of pixels the children are indented relative to
185 // the parents position. SetIndent() also redraws the control
186 // immediately.
187 unsigned int GetIndent() const;
188 void SetIndent(unsigned int indent);
189
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.
194 //
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;
202
203 void SetImageList(wxImageList *imageList);
204 void SetStateImageList(wxImageList *imageList);
205
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.
210
211 // accessors
212 // ---------
213
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;
222
223 // modifiers
224 // ---------
225
226 // set items label
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);
234
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);
240
241 // item status inquiries
242 // ---------------------
243
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;
252
253 // navigation
254 // ----------
255
256 // wxTreeItemId.IsOk() will return FALSE if there is no such item
257
258 // get the root tree item
259 wxTreeItemId GetRootItem() const;
260
261 // get the item currently selected (may return NULL if no selection)
262 wxTreeItemId GetSelection() const;
263
264 // get the parent of this item (may return NULL if root)
265 wxTreeItemId GetParent(const wxTreeItemId& item) const;
266
267 // for this enumeration function you must pass in a "cookie" parameter
268 // which is opaque for the application but is necessary for the library
269 // to make these functions reentrant (i.e. allow more than one
270 // enumeration on one and the same object simultaneously). Of course,
271 // the "cookie" passed to GetFirstChild() and GetNextChild() should be
272 // the same!
273
274 // get the first child of this item
275 wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& _cookie) const;
276 // get the next child
277 wxTreeItemId GetNextChild(const wxTreeItemId& item, long& _cookie) const;
278
279 // get the next sibling of this item
280 wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
281 // get the previous sibling
282 wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
283
284 // get first visible item
285 wxTreeItemId GetFirstVisibleItem() const;
286 // get the next visible item: item must be visible itself!
287 // see IsVisible() and wxTreeCtrl::GetFirstVisibleItem()
288 wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
289 // get the previous visible item: item must be visible itself!
290 wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
291
292 // operations
293 // ----------
294
295 // add the root node to the tree
296 wxTreeItemId AddRoot(const wxString& text,
297 int image = -1, int selectedImage = -1,
298 wxTreeItemData *data = NULL);
299
300 // insert a new item in as the first child of the parent
301 wxTreeItemId PrependItem(const wxTreeItemId& parent,
302 const wxString& text,
303 int image = -1, int selectedImage = -1,
304 wxTreeItemData *data = NULL);
305
306 // insert a new item after a given one
307 wxTreeItemId InsertItem(const wxTreeItemId& parent,
308 const wxTreeItemId& idPrevious,
309 const wxString& text,
310 int image = -1, int selectedImage = -1,
311 wxTreeItemData *data = NULL);
312
313 // insert a new item in as the last child of the parent
314 wxTreeItemId AppendItem(const wxTreeItemId& parent,
315 const wxString& text,
316 int image = -1, int selectedImage = -1,
317 wxTreeItemData *data = NULL);
318
319 // delete this item and associated data if any
320 void Delete(const wxTreeItemId& item);
321 // delete all items from the tree
322 void DeleteAllItems();
323
324 // expand this item
325 void Expand(const wxTreeItemId& item);
326 // collapse the item without removing its children
327 void Collapse(const wxTreeItemId& item);
328 // collapse the item and remove all children
329 void CollapseAndReset(const wxTreeItemId& item);
330 // toggles the current state
331 void Toggle(const wxTreeItemId& item);
332
333 // remove the selection from currently selected item (if any)
334 void Unselect();
335 // select this item
336 void SelectItem(const wxTreeItemId& item);
337 // make sure this item is visible (expanding the parent item and/or
338 // scrolling to this item if necessary)
339 void EnsureVisible(const wxTreeItemId& item);
340 // scroll to this item (but don't expand its parent)
341 void ScrollTo(const wxTreeItemId& item);
342
343 // start editing the item label: this (temporarily) replaces the item
344 // with a one line edit control. The item will be selected if it hadn't
345 // been before. textCtrlClass parameter allows you to create an edit
346 // control of arbitrary user-defined class deriving from wxTextCtrl.
347 wxTextCtrl* EditLabel(const wxTreeItemId& item,
348 wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
349 // returns the same pointer as StartEdit() if the item is being edited,
350 // NULL otherwise (it's assumed that no more than one item may be
351 // edited simultaneously)
352 wxTextCtrl* GetEditControl() const;
353 // end editing and accept or discard the changes to item label
354 void EndEditLabel(const wxTreeItemId& item, bool discardChanges = FALSE);
355
356 // sort the children of this item using the specified callback function
357 // (it should return -1, 0 or +1 as usual), if it's not specified
358 // alphabetical comparaison is performed.
359 //
360 // NB: this function is not reentrant!
361 void SortChildren(const wxTreeItemId& item,
362 wxTreeItemCmpFunc *cmpFunction = NULL);
363
364 // helpers
365 // -------
366
367 // @@@ do we really need to expose these functions to the application?
368
369 // get the bounding rectangle of the item (or of its label only)
370 void GetBoundingRect(const wxTreeItemId& item,
371 wxRectangle& rect,
372 bool textOnly = FALSE) const;
373
374 // determine to which item (if any) belongs the given point (the
375 // coordinates specified are relative to the client area of tree ctrl)
376 // and fill the flags parameter with a bitmask of wxTREE_HITTEST_xxx
377 // constants
378 wxTreeItemId HitTest(const wxPoint& point, int& flags);
379
380 // deprecated
381 // ----------
382
383 // these methods are deprecated and will be removed in future versions of
384 // wxWindows, they're here for compatibility only, don't use them in new
385 // code (the comments indicate why these methods are now useless and how to
386 // replace them)
387
388 // use Expand, Collapse, CollapseAndReset or Toggle
389 void ExpandItem(const wxTreeItemId& item, int action);
390
391 // use AddRoot, PrependItem or AppendItem
392 wxTreeItemId InsertItem(const wxTreeItemId& parent,
393 const wxString& text,
394 int image = -1, int selImage = -1,
395 long insertAfter = wxTREE_INSERT_LAST);
396
397 // use Set/GetImageList and Set/GetStateImageList
398 wxImageList *GetImageList(int) const
399 { return GetImageList(); }
400 void SetImageList(wxImageList *imageList, int)
401 { SetImageList(imageList); }
402
403 // implementation
404 // --------------
405 void Command(wxCommandEvent& event) { ProcessCommand(event); };
406 bool MSWCommand(WXUINT param, WXWORD id);
407 bool MSWNotify(WXWPARAM wParam, WXLPARAM lParam);
408
409 protected:
410 // SetImageList helper
411 void SetAnyImageList(wxImageList *imageList, int which);
412
413 wxTextCtrl* m_textCtrl; // used while editing the item label
414 wxImageList *m_imageListNormal, // images for tree elements
415 *m_imageListState; // special images for app defined states
416
417 private:
418 // the common part of all ctors
419 void Init();
420
421 // helper functions
422 inline bool DoGetItem(wxTreeViewItem *tvItem) const;
423 inline void DoSetItem(wxTreeViewItem *tvItem);
424
425 inline void DoExpand(const wxTreeItemId& item, int flag);
426
427 wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
428 wxTreeItemId hInsertAfter,
429 const wxString& text,
430 int image, int selectedImage,
431 wxTreeItemData *data);
432
433 void DeleteTextCtrl();
434
435 DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
436 };
437
438 // ----------------------------------------------------------------------------
439 // wxTreeEvent is a special class for all events associated with tree controls
440 //
441 // NB: note that not all accessors make sense for all events, see the event
442 // descriptions below
443 // ----------------------------------------------------------------------------
444 class WXDLLEXPORT wxTreeEvent : public wxCommandEvent
445 {
446 friend wxTreeCtrl;
447 public:
448 wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
449
450 // accessors
451 // get the item on which the operation was performed or the newly
452 // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
453 wxTreeItemId GetItem() const { return m_item; }
454
455 // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
456 // selected item
457 wxTreeItemId GetOldItem() const { return m_itemOld; }
458
459 // the point where the mouse was when the drag operation started (for
460 // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only)
461 wxPoint GetPoint() const { return m_pointDrag; }
462
463 // keyboard code (for wxEVT_COMMAND_TREE_KEY_DOWN only)
464 int GetCode() const { return m_code; }
465
466 // set return code for wxEVT_COMMAND_TREE_ITEM_{EXPAND|COLLAPS}ING events
467 // call this to forbid the change in item status
468 void Veto() { m_code = TRUE; }
469
470 private:
471 // @@ we could save some space by using union here
472 int m_code;
473 wxTreeItemId m_item,
474 m_itemOld;
475 wxPoint m_pointDrag;
476
477 DECLARE_DYNAMIC_CLASS(wxTreeEvent)
478 };
479
480 typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
481
482 // ----------------------------------------------------------------------------
483 // macros for handling tree control events
484 // ----------------------------------------------------------------------------
485
486 // GetItem() returns the item being dragged, GetPoint() the mouse coords
487 #define EVT_TREE_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
488 #define EVT_TREE_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
489
490 // GetItem() returns the itme whose label is being edited
491 #define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
492 #define EVT_TREE_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
493
494 // provide/update information about GetItem() item
495 #define EVT_TREE_GET_INFO(id, fn) { wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
496 #define EVT_TREE_SET_INFO(id, fn) { wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
497
498 // GetItem() is the item being expanded/collapsed, the "ING" versions can use
499 #define EVT_TREE_ITEM_EXPANDED(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
500 #define EVT_TREE_ITEM_EXPANDING(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
501 #define EVT_TREE_ITEM_COLLAPSED(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
502 #define EVT_TREE_ITEM_COLLAPSING(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
503
504 // GetOldItem() is the item which had the selection previously, GetItem() is
505 // the item which acquires selection
506 #define EVT_TREE_SEL_CHANGED(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
507 #define EVT_TREE_SEL_CHANGING(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
508
509 // GetCode() returns the key code
510 // NB: this is the only message for which GetItem() is invalid (you may get the
511 // item from GetSelection())
512 #define EVT_TREE_KEY_DOWN(id, fn) { wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
513
514 // GetItem() returns the item being deleted, the associated data (if any) will
515 // be deleted just after the return of this event handler (if any)
516 #define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
517
518 #endif
519 // _WX_TREECTRL_H_