]> git.saurik.com Git - wxWidgets.git/blob - include/wx/generic/treectlg.h
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / include / wx / generic / treectlg.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/generic/treectlg.h
3 // Purpose: wxTreeCtrl class
4 // Author: Robert Roebling
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) 1997,1998 Robert Roebling
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _GENERIC_TREECTRL_H_
13 #define _GENERIC_TREECTRL_H_
14
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "treectlg.h"
17 #endif
18
19 #if wxUSE_TREECTRL
20
21 #include "wx/scrolwin.h"
22 #include "wx/pen.h"
23 #include "wx/imaglist.h"
24
25 // -----------------------------------------------------------------------------
26 // forward declaration
27 // -----------------------------------------------------------------------------
28
29 class WXDLLEXPORT wxGenericTreeItem;
30
31 class WXDLLEXPORT wxTreeItemData;
32
33 class WXDLLEXPORT wxTreeRenameTimer;
34 class WXDLLEXPORT wxTreeFindTimer;
35 class WXDLLEXPORT wxTreeTextCtrl;
36 class WXDLLEXPORT wxTextCtrl;
37
38 // -----------------------------------------------------------------------------
39 // wxGenericTreeCtrl - the tree control
40 // -----------------------------------------------------------------------------
41
42 class WXDLLEXPORT wxGenericTreeCtrl : public wxScrolledWindow
43 {
44 public:
45 // creation
46 // --------
47 wxGenericTreeCtrl() { Init(); }
48
49 wxGenericTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
50 const wxPoint& pos = wxDefaultPosition,
51 const wxSize& size = wxDefaultSize,
52 long style = wxTR_DEFAULT_STYLE,
53 const wxValidator &validator = wxDefaultValidator,
54 const wxString& name = wxTreeCtrlNameStr)
55 {
56 Init();
57 Create(parent, id, pos, size, style, validator, name);
58 }
59
60 virtual ~wxGenericTreeCtrl();
61
62 bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
63 const wxPoint& pos = wxDefaultPosition,
64 const wxSize& size = wxDefaultSize,
65 long style = wxTR_DEFAULT_STYLE,
66 const wxValidator &validator = wxDefaultValidator,
67 const wxString& name = wxTreeCtrlNameStr);
68
69 // accessors
70 // ---------
71
72 // get the total number of items in the control
73 size_t GetCount() const;
74
75 // indent is the number of pixels the children are indented relative to
76 // the parents position. SetIndent() also redraws the control
77 // immediately.
78 unsigned int GetIndent() const { return m_indent; }
79 void SetIndent(unsigned int indent);
80
81 // spacing is the number of pixels between the start and the Text
82 unsigned int GetSpacing() const { return m_spacing; }
83 void SetSpacing(unsigned int spacing);
84
85 // image list: these functions allow to associate an image list with
86 // the control and retrieve it. Note that when assigned with
87 // SetImageList, the control does _not_ delete
88 // the associated image list when it's deleted in order to allow image
89 // lists to be shared between different controls. If you use
90 // AssignImageList, the control _does_ delete the image list.
91 //
92 // The normal image list is for the icons which correspond to the
93 // normal tree item state (whether it is selected or not).
94 // Additionally, the application might choose to show a state icon
95 // which corresponds to an app-defined item state (for example,
96 // checked/unchecked) which are taken from the state image list.
97 wxImageList *GetImageList() const;
98 wxImageList *GetStateImageList() const;
99 wxImageList *GetButtonsImageList() const;
100
101 void SetImageList(wxImageList *imageList);
102 void SetStateImageList(wxImageList *imageList);
103 void SetButtonsImageList(wxImageList *imageList);
104 void AssignImageList(wxImageList *imageList);
105 void AssignStateImageList(wxImageList *imageList);
106 void AssignButtonsImageList(wxImageList *imageList);
107
108 // Functions to work with tree ctrl items.
109
110 // accessors
111 // ---------
112
113 // retrieve item's label
114 wxString GetItemText(const wxTreeItemId& item) const;
115 // get one of the images associated with the item (normal by default)
116 int GetItemImage(const wxTreeItemId& item,
117 wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
118 // get the data associated with the item
119 wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
120
121 // get the item's text colour
122 wxColour GetItemTextColour(const wxTreeItemId& item) const;
123
124 // get the item's background colour
125 wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
126
127 // get the item's font
128 wxFont GetItemFont(const wxTreeItemId& item) const;
129
130 // modifiers
131 // ---------
132
133 // set item's label
134 void SetItemText(const wxTreeItemId& item, const wxString& text);
135 // get one of the images associated with the item (normal by default)
136 void SetItemImage(const wxTreeItemId& item, int image,
137 wxTreeItemIcon which = wxTreeItemIcon_Normal);
138 // associate some data with the item
139 void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
140
141 // force appearance of [+] button near the item. This is useful to
142 // allow the user to expand the items which don't have any children now
143 // - but instead add them only when needed, thus minimizing memory
144 // usage and loading time.
145 void SetItemHasChildren(const wxTreeItemId& item, bool has = true);
146
147 // the item will be shown in bold
148 void SetItemBold(const wxTreeItemId& item, bool bold = true);
149
150 // set the item's text colour
151 void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
152
153 // set the item's background colour
154 void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
155
156 // set the item's font (should be of the same height for all items)
157 void SetItemFont(const wxTreeItemId& item, const wxFont& font);
158
159 // set the window font
160 virtual bool SetFont( const wxFont &font );
161
162 // set the styles. No need to specify a GetWindowStyle here since
163 // the base wxWindow member function will do it for us
164 void SetWindowStyle(const long styles);
165
166 // item status inquiries
167 // ---------------------
168
169 // is the item visible (it might be outside the view or not expanded)?
170 bool IsVisible(const wxTreeItemId& item) const;
171 // does the item has any children?
172 bool HasChildren(const wxTreeItemId& item) const
173 { return ItemHasChildren(item); }
174 bool ItemHasChildren(const wxTreeItemId& item) const;
175 // is the item expanded (only makes sense if HasChildren())?
176 bool IsExpanded(const wxTreeItemId& item) const;
177 // is this item currently selected (the same as has focus)?
178 bool IsSelected(const wxTreeItemId& item) const;
179 // is item text in bold font?
180 bool IsBold(const wxTreeItemId& item) const;
181 // does the layout include space for a button?
182
183 // number of children
184 // ------------------
185
186 // if 'recursively' is false, only immediate children count, otherwise
187 // the returned number is the number of all items in this branch
188 size_t GetChildrenCount(const wxTreeItemId& item,
189 bool recursively = true) const;
190
191 // navigation
192 // ----------
193
194 // wxTreeItemId.IsOk() will return false if there is no such item
195
196 // get the root tree item
197 wxTreeItemId GetRootItem() const { return m_anchor; }
198
199 // get the item currently selected (may return NULL if no selection)
200 wxTreeItemId GetSelection() const { return m_current; }
201
202 // get the items currently selected, return the number of such item
203 size_t GetSelections(wxArrayTreeItemIds&) const;
204
205 // get the parent of this item (may return NULL if root)
206 wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
207
208 #if WXWIN_COMPATIBILITY_2_2
209 // deprecated: Use GetItemParent instead.
210 wxTreeItemId GetParent(const wxTreeItemId& item) const
211 { return GetItemParent( item ); }
212
213 // Expose the base class method hidden by the one above.
214 wxWindow *GetParent() const { return wxScrolledWindow::GetParent(); }
215 #endif // WXWIN_COMPATIBILITY_2_2
216
217 // for this enumeration function you must pass in a "cookie" parameter
218 // which is opaque for the application but is necessary for the library
219 // to make these functions reentrant (i.e. allow more than one
220 // enumeration on one and the same object simultaneously). Of course,
221 // the "cookie" passed to GetFirstChild() and GetNextChild() should be
222 // the same!
223
224 // get the first child of this item
225 wxTreeItemId GetFirstChild(const wxTreeItemId& item,
226 wxTreeItemIdValue& cookie) const;
227 // get the next child
228 wxTreeItemId GetNextChild(const wxTreeItemId& item,
229 wxTreeItemIdValue& cookie) const;
230 // get the last child of this item - this method doesn't use cookies
231 wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
232
233 // get the next sibling of this item
234 wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
235 // get the previous sibling
236 wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
237
238 // get first visible item
239 wxTreeItemId GetFirstVisibleItem() const;
240 // get the next visible item: item must be visible itself!
241 // see IsVisible() and wxTreeCtrl::GetFirstVisibleItem()
242 wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
243 // get the previous visible item: item must be visible itself!
244 wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
245
246 // Only for internal use right now, but should probably be public
247 wxTreeItemId GetNext(const wxTreeItemId& item) const;
248
249 // operations
250 // ----------
251
252 // add the root node to the tree
253 wxTreeItemId AddRoot(const wxString& text,
254 int image = -1, int selectedImage = -1,
255 wxTreeItemData *data = NULL);
256
257 // insert a new item in as the first child of the parent
258 wxTreeItemId PrependItem(const wxTreeItemId& parent,
259 const wxString& text,
260 int image = -1, int selectedImage = -1,
261 wxTreeItemData *data = NULL);
262
263 // insert a new item after a given one
264 wxTreeItemId InsertItem(const wxTreeItemId& parent,
265 const wxTreeItemId& idPrevious,
266 const wxString& text,
267 int image = -1, int selectedImage = -1,
268 wxTreeItemData *data = NULL);
269
270 // insert a new item before the one with the given index
271 wxTreeItemId InsertItem(const wxTreeItemId& parent,
272 size_t index,
273 const wxString& text,
274 int image = -1, int selectedImage = -1,
275 wxTreeItemData *data = NULL);
276
277 // insert a new item in as the last child of the parent
278 wxTreeItemId AppendItem(const wxTreeItemId& parent,
279 const wxString& text,
280 int image = -1, int selectedImage = -1,
281 wxTreeItemData *data = NULL);
282
283 // delete this item and associated data if any
284 void Delete(const wxTreeItemId& item);
285 // delete all children (but don't delete the item itself)
286 // NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
287 void DeleteChildren(const wxTreeItemId& item);
288 // delete all items from the tree
289 // NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
290 void DeleteAllItems();
291
292 // expand this item
293 void Expand(const wxTreeItemId& item);
294 // expand this item and all subitems recursively
295 void ExpandAll(const wxTreeItemId& item);
296 // collapse the item without removing its children
297 void Collapse(const wxTreeItemId& item);
298 // collapse the item and remove all children
299 void CollapseAndReset(const wxTreeItemId& item);
300 // toggles the current state
301 void Toggle(const wxTreeItemId& item);
302
303 // remove the selection from currently selected item (if any)
304 void Unselect();
305 // or from the given one (multiselect mode only)
306 void UnselectItem(const wxTreeItemId& item) { SelectItem(item, false); }
307 // or from all
308 void UnselectAll();
309 // select this item
310 void SelectItem(const wxTreeItemId& item, bool select = true);
311 // toggle the item selection
312 void ToggleItemSelection(const wxTreeItemId& item)
313 {
314 SelectItem(item, !IsSelected(item));
315 }
316
317 // make sure this item is visible (expanding the parent item and/or
318 // scrolling to this item if necessary)
319 void EnsureVisible(const wxTreeItemId& item);
320 // scroll to this item (but don't expand its parent)
321 void ScrollTo(const wxTreeItemId& item);
322 void AdjustMyScrollbars();
323
324 // The first function is more portable (because easier to implement
325 // on other platforms), but the second one returns some extra info.
326 wxTreeItemId HitTest(const wxPoint& point)
327 { int dummy; return HitTest(point, dummy); }
328 wxTreeItemId HitTest(const wxPoint& point, int& flags);
329
330 // get the bounding rectangle of the item (or of its label only)
331 bool GetBoundingRect(const wxTreeItemId& item,
332 wxRect& rect,
333 bool textOnly = false) const;
334
335 // Start editing the item label: this (temporarily) replaces the item
336 // with a one line edit control. The item will be selected if it hadn't
337 // been before.
338 void EditLabel( const wxTreeItemId& item ) { Edit( item ); }
339 void Edit( const wxTreeItemId& item );
340 // returns a pointer to the text edit control if the item is being
341 // edited, NULL otherwise (it's assumed that no more than one item may
342 // be edited simultaneously)
343 wxTextCtrl* GetEditControl() const;
344
345 // sorting
346 // this function is called to compare 2 items and should return -1, 0
347 // or +1 if the first item is less than, equal to or greater than the
348 // second one. The base class version performs alphabetic comparaison
349 // of item labels (GetText)
350 virtual int OnCompareItems(const wxTreeItemId& item1,
351 const wxTreeItemId& item2);
352 // sort the children of this item using OnCompareItems
353 //
354 // NB: this function is not reentrant and not MT-safe (FIXME)!
355 void SortChildren(const wxTreeItemId& item);
356
357 #if WXWIN_COMPATIBILITY_2_4
358 // deprecated functions: use Set/GetItemImage directly
359 int GetItemSelectedImage(const wxTreeItemId& item) const
360 { return GetItemImage(item, wxTreeItemIcon_Selected); }
361 void SetItemSelectedImage(const wxTreeItemId& item, int image)
362 { SetItemImage(item, image, wxTreeItemIcon_Selected); }
363
364 // use the versions taking wxTreeItemIdValue cookies (note that
365 // GetNextChild() is not inside wxDEPRECATED on purpose, as otherwise we
366 // get twice as many warnings without any added benefit: it is always used
367 // with GetFirstChild() anyhow)
368 wxDEPRECATED( wxTreeItemId GetFirstChild(const wxTreeItemId& item,
369 long& cookie) const );
370 wxTreeItemId GetNextChild(const wxTreeItemId& item,
371 long& cookie) const;
372 #endif // WXWIN_COMPATIBILITY_2_4
373
374 virtual bool ShouldInheritColours() const { return false; }
375
376 // implementation only from now on
377
378 // overridden base class virtuals
379 virtual bool SetBackgroundColour(const wxColour& colour);
380 virtual bool SetForegroundColour(const wxColour& colour);
381
382 virtual void Freeze();
383 virtual void Thaw();
384
385 // callbacks
386 void OnPaint( wxPaintEvent &event );
387 void OnSetFocus( wxFocusEvent &event );
388 void OnKillFocus( wxFocusEvent &event );
389 void OnChar( wxKeyEvent &event );
390 void OnMouse( wxMouseEvent &event );
391 void OnGetToolTip( wxTreeEvent &event );
392 void OnInternalIdle( );
393
394 virtual wxVisualAttributes GetDefaultAttributes() const
395 {
396 return GetClassDefaultAttributes(GetWindowVariant());
397 }
398
399 static wxVisualAttributes
400 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
401
402 // implementation helpers
403 protected:
404 friend class wxGenericTreeItem;
405 friend class wxTreeRenameTimer;
406 friend class wxTreeFindTimer;
407 friend class wxTreeTextCtrl;
408
409 wxFont m_normalFont;
410 wxFont m_boldFont;
411
412 wxGenericTreeItem *m_anchor;
413 wxGenericTreeItem *m_current,
414 *m_key_current,
415 // A hint to select a parent item after deleting a child
416 *m_select_me;
417 unsigned short m_indent;
418 unsigned short m_spacing;
419 int m_lineHeight;
420 wxPen m_dottedPen;
421 wxBrush *m_hilightBrush,
422 *m_hilightUnfocusedBrush;
423 bool m_hasFocus;
424 bool m_dirty;
425 bool m_ownsImageListNormal,
426 m_ownsImageListState,
427 m_ownsImageListButtons;
428 bool m_isDragging; // true between BEGIN/END drag events
429 bool m_lastOnSame; // last click on the same item as prev
430 wxImageList *m_imageListNormal,
431 *m_imageListState,
432 *m_imageListButtons;
433
434 int m_freezeCount;
435 int m_dragCount;
436 wxPoint m_dragStart;
437 wxGenericTreeItem *m_dropTarget;
438 wxCursor m_oldCursor; // cursor is changed while dragging
439 wxGenericTreeItem *m_oldSelection;
440 wxGenericTreeItem *m_underMouse; // for visual effects
441 wxTreeTextCtrl *m_textCtrl;
442
443 wxTimer *m_renameTimer;
444
445 // incremental search data
446 wxString m_findPrefix;
447 wxTimer *m_findTimer;
448
449 // the common part of all ctors
450 void Init();
451
452 // misc helpers
453 void SendDeleteEvent(wxGenericTreeItem *itemBeingDeleted);
454
455 void DrawBorder(const wxTreeItemId& item);
456 void DrawLine(const wxTreeItemId& item, bool below);
457 void DrawDropEffect(wxGenericTreeItem *item);
458
459 void DoSelectItem(const wxTreeItemId& id,
460 bool unselect_others = true,
461 bool extended_select = false);
462
463 wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
464 size_t previous,
465 const wxString& text,
466 int image, int selectedImage,
467 wxTreeItemData *data);
468
469 // called by wxTextTreeCtrl when it marks itself for deletion
470 void ResetTextControl();
471
472 // find the first item starting with the given prefix after the given item
473 wxTreeItemId FindItem(const wxTreeItemId& id, const wxString& prefix) const;
474
475 bool HasButtons() const { return HasFlag(wxTR_HAS_BUTTONS); }
476
477 void CalculateLineHeight();
478 int GetLineHeight(wxGenericTreeItem *item) const;
479 void PaintLevel( wxGenericTreeItem *item, wxDC& dc, int level, int &y );
480 void PaintItem( wxGenericTreeItem *item, wxDC& dc);
481
482 void CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y );
483 void CalculatePositions();
484 void CalculateSize( wxGenericTreeItem *item, wxDC &dc );
485
486 void RefreshSubtree( wxGenericTreeItem *item );
487 void RefreshLine( wxGenericTreeItem *item );
488
489 // redraw all selected items
490 void RefreshSelected();
491
492 // RefreshSelected() recursive helper
493 void RefreshSelectedUnder(wxGenericTreeItem *item);
494
495 void OnRenameTimer();
496 bool OnRenameAccept(wxGenericTreeItem *item, const wxString& value);
497 void OnRenameCancelled(wxGenericTreeItem *item);
498
499 void FillArray(wxGenericTreeItem*, wxArrayTreeItemIds&) const;
500 void SelectItemRange( wxGenericTreeItem *item1, wxGenericTreeItem *item2 );
501 bool TagAllChildrenUntilLast(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select);
502 bool TagNextChildren(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select);
503 void UnselectAllChildren( wxGenericTreeItem *item );
504
505 private:
506 DECLARE_EVENT_TABLE()
507 DECLARE_DYNAMIC_CLASS(wxGenericTreeCtrl)
508 DECLARE_NO_COPY_CLASS(wxGenericTreeCtrl)
509 };
510
511 #if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
512 /*
513 * wxTreeCtrl has to be a real class or we have problems with
514 * the run-time information.
515 */
516
517 class WXDLLEXPORT wxTreeCtrl: public wxGenericTreeCtrl
518 {
519 DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
520
521 public:
522 wxTreeCtrl() {}
523
524 wxTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
525 const wxPoint& pos = wxDefaultPosition,
526 const wxSize& size = wxDefaultSize,
527 long style = wxTR_DEFAULT_STYLE,
528 const wxValidator &validator = wxDefaultValidator,
529 const wxString& name = wxTreeCtrlNameStr)
530 : wxGenericTreeCtrl(parent, id, pos, size, style, validator, name)
531 {
532 }
533 };
534 #endif // !__WXMSW__ || __WXUNIVERSAL__
535
536 #endif // wxUSE_TREECTRL
537
538 #endif // _GENERIC_TREECTRL_H_
539