]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/generic/treectlg.h
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Clarified wxPropertyGrid::HitTest() docs
[wxWidgets.git] / include / wx / generic / treectlg.h
... / ...
CommitLineData
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 wxUSE_TREECTRL
16
17#include "wx/scrolwin.h"
18#include "wx/pen.h"
19
20// -----------------------------------------------------------------------------
21// forward declaration
22// -----------------------------------------------------------------------------
23
24class WXDLLIMPEXP_FWD_CORE wxGenericTreeItem;
25
26class WXDLLIMPEXP_FWD_CORE wxTreeItemData;
27
28class WXDLLIMPEXP_FWD_CORE wxTreeRenameTimer;
29class WXDLLIMPEXP_FWD_CORE wxTreeFindTimer;
30class WXDLLIMPEXP_FWD_CORE wxTreeTextCtrl;
31class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
32
33// -----------------------------------------------------------------------------
34// wxGenericTreeCtrl - the tree control
35// -----------------------------------------------------------------------------
36
37class WXDLLIMPEXP_CORE wxGenericTreeCtrl : public wxTreeCtrlBase,
38 public wxScrollHelper
39{
40public:
41 // creation
42 // --------
43
44 wxGenericTreeCtrl() : wxTreeCtrlBase(), wxScrollHelper(this) { Init(); }
45
46 wxGenericTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
47 const wxPoint& pos = wxDefaultPosition,
48 const wxSize& size = wxDefaultSize,
49 long style = wxTR_DEFAULT_STYLE,
50 const wxValidator &validator = wxDefaultValidator,
51 const wxString& name = wxTreeCtrlNameStr)
52 : wxTreeCtrlBase(),
53 wxScrollHelper(this)
54 {
55 Init();
56 Create(parent, id, pos, size, style, validator, name);
57 }
58
59 virtual ~wxGenericTreeCtrl();
60
61 bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
62 const wxPoint& pos = wxDefaultPosition,
63 const wxSize& size = wxDefaultSize,
64 long style = wxTR_DEFAULT_STYLE,
65 const wxValidator &validator = wxDefaultValidator,
66 const wxString& name = wxTreeCtrlNameStr);
67
68
69 // implement base class pure virtuals
70 // ----------------------------------
71
72 virtual unsigned int GetCount() const;
73
74 virtual unsigned int GetIndent() const { return m_indent; }
75 virtual void SetIndent(unsigned int indent);
76
77
78 virtual void SetImageList(wxImageList *imageList);
79 virtual void SetStateImageList(wxImageList *imageList);
80
81 virtual wxString GetItemText(const wxTreeItemId& item) const;
82 virtual int GetItemImage(const wxTreeItemId& item,
83 wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
84 virtual wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
85 virtual wxColour GetItemTextColour(const wxTreeItemId& item) const;
86 virtual wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
87 virtual wxFont GetItemFont(const wxTreeItemId& item) const;
88
89 virtual void SetItemText(const wxTreeItemId& item, const wxString& text);
90 virtual void SetItemImage(const wxTreeItemId& item,
91 int image,
92 wxTreeItemIcon which = wxTreeItemIcon_Normal);
93 virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
94
95 virtual void SetItemHasChildren(const wxTreeItemId& item, bool has = true);
96 virtual void SetItemBold(const wxTreeItemId& item, bool bold = true);
97 virtual void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = true);
98 virtual void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
99 virtual void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
100 virtual void SetItemFont(const wxTreeItemId& item, const wxFont& font);
101
102 virtual bool IsVisible(const wxTreeItemId& item) const;
103 virtual bool ItemHasChildren(const wxTreeItemId& item) const;
104 virtual bool IsExpanded(const wxTreeItemId& item) const;
105 virtual bool IsSelected(const wxTreeItemId& item) const;
106 virtual bool IsBold(const wxTreeItemId& item) const;
107
108 virtual size_t GetChildrenCount(const wxTreeItemId& item,
109 bool recursively = true) const;
110
111 // navigation
112 // ----------
113
114 virtual wxTreeItemId GetRootItem() const { return m_anchor; }
115 virtual wxTreeItemId GetSelection() const
116 {
117 wxASSERT_MSG( !HasFlag(wxTR_MULTIPLE),
118 wxT("must use GetSelections() with this control") );
119
120 return m_current;
121 }
122 virtual size_t GetSelections(wxArrayTreeItemIds&) const;
123
124 virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
125 virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
126 wxTreeItemIdValue& cookie) const;
127 virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,
128 wxTreeItemIdValue& cookie) const;
129 virtual wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
130 virtual wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
131 virtual wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
132
133 virtual wxTreeItemId GetFirstVisibleItem() const;
134 virtual wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
135 virtual wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
136
137
138 // operations
139 // ----------
140
141 virtual wxTreeItemId AddRoot(const wxString& text,
142 int image = -1, int selectedImage = -1,
143 wxTreeItemData *data = NULL);
144
145 virtual void Delete(const wxTreeItemId& item);
146 virtual void DeleteChildren(const wxTreeItemId& item);
147 virtual void DeleteAllItems();
148
149 virtual void Expand(const wxTreeItemId& item);
150 virtual void Collapse(const wxTreeItemId& item);
151 virtual void CollapseAndReset(const wxTreeItemId& item);
152 virtual void Toggle(const wxTreeItemId& item);
153
154 virtual void Unselect();
155 virtual void UnselectAll();
156 virtual void SelectItem(const wxTreeItemId& item, bool select = true);
157
158 virtual void EnsureVisible(const wxTreeItemId& item);
159 virtual void ScrollTo(const wxTreeItemId& item);
160
161 virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
162 wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
163 virtual wxTextCtrl *GetEditControl() const;
164 virtual void EndEditLabel(const wxTreeItemId& item,
165 bool discardChanges = false);
166
167 virtual void SortChildren(const wxTreeItemId& item);
168
169 // items geometry
170 // --------------
171
172 virtual bool GetBoundingRect(const wxTreeItemId& item,
173 wxRect& rect,
174 bool textOnly = false) const;
175
176
177 // this version specific methods
178 // -----------------------------
179
180 wxImageList *GetButtonsImageList() const { return m_imageListButtons; }
181 void SetButtonsImageList(wxImageList *imageList);
182 void AssignButtonsImageList(wxImageList *imageList);
183
184 void SetDropEffectAboveItem( bool above = false ) { m_dropEffectAboveItem = above; }
185 bool GetDropEffectAboveItem() const { return m_dropEffectAboveItem; }
186
187 wxTreeItemId GetNext(const wxTreeItemId& item) const;
188
189#if WXWIN_COMPATIBILITY_2_6
190 // use EditLabel() instead
191 void Edit( const wxTreeItemId& item ) { EditLabel(item); }
192#endif // WXWIN_COMPATIBILITY_2_6
193
194 // implementation only from now on
195
196 // overridden base class virtuals
197 virtual bool SetBackgroundColour(const wxColour& colour);
198 virtual bool SetForegroundColour(const wxColour& colour);
199
200 virtual void Refresh(bool eraseBackground = true, const wxRect *rect = NULL);
201
202 virtual bool SetFont( const wxFont &font );
203 virtual void SetWindowStyle(const long styles);
204
205 // callbacks
206 void OnPaint( wxPaintEvent &event );
207 void OnSetFocus( wxFocusEvent &event );
208 void OnKillFocus( wxFocusEvent &event );
209 void OnChar( wxKeyEvent &event );
210 void OnMouse( wxMouseEvent &event );
211 void OnGetToolTip( wxTreeEvent &event );
212 void OnSize( wxSizeEvent &event );
213 void OnInternalIdle( );
214
215 virtual wxVisualAttributes GetDefaultAttributes() const
216 {
217 return GetClassDefaultAttributes(GetWindowVariant());
218 }
219
220 static wxVisualAttributes
221 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
222
223 // implementation helpers
224 void AdjustMyScrollbars();
225
226 WX_FORWARD_TO_SCROLL_HELPER()
227
228protected:
229 friend class wxGenericTreeItem;
230 friend class wxTreeRenameTimer;
231 friend class wxTreeFindTimer;
232 friend class wxTreeTextCtrl;
233
234 wxFont m_normalFont;
235 wxFont m_boldFont;
236
237 wxGenericTreeItem *m_anchor;
238 wxGenericTreeItem *m_current,
239 *m_key_current,
240 // A hint to select a parent item after deleting a child
241 *m_select_me;
242 unsigned short m_indent;
243 int m_lineHeight;
244 wxPen m_dottedPen;
245 wxBrush *m_hilightBrush,
246 *m_hilightUnfocusedBrush;
247 bool m_hasFocus;
248 bool m_dirty;
249 bool m_ownsImageListButtons;
250 bool m_isDragging; // true between BEGIN/END drag events
251 bool m_lastOnSame; // last click on the same item as prev
252 wxImageList *m_imageListButtons;
253
254 int m_dragCount;
255 wxPoint m_dragStart;
256 wxGenericTreeItem *m_dropTarget;
257 wxCursor m_oldCursor; // cursor is changed while dragging
258 wxGenericTreeItem *m_oldSelection;
259 wxGenericTreeItem *m_underMouse; // for visual effects
260
261 enum { NoEffect, BorderEffect, AboveEffect, BelowEffect } m_dndEffect;
262 wxGenericTreeItem *m_dndEffectItem;
263
264 wxTreeTextCtrl *m_textCtrl;
265
266
267 wxTimer *m_renameTimer;
268
269 // incremental search data
270 wxString m_findPrefix;
271 wxTimer *m_findTimer;
272
273 bool m_dropEffectAboveItem;
274
275 // the common part of all ctors
276 void Init();
277
278 // overridden wxWindow methods
279 virtual void DoThaw();
280
281 // misc helpers
282 void SendDeleteEvent(wxGenericTreeItem *itemBeingDeleted);
283
284 void DrawBorder(const wxTreeItemId& item);
285 void DrawLine(const wxTreeItemId& item, bool below);
286 void DrawDropEffect(wxGenericTreeItem *item);
287
288 void DoSelectItem(const wxTreeItemId& id,
289 bool unselect_others = true,
290 bool extended_select = false);
291
292 virtual int DoGetItemState(const wxTreeItemId& item) const;
293 virtual void DoSetItemState(const wxTreeItemId& item, int state);
294
295 virtual wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
296 size_t previous,
297 const wxString& text,
298 int image,
299 int selectedImage,
300 wxTreeItemData *data);
301 virtual wxTreeItemId DoInsertAfter(const wxTreeItemId& parent,
302 const wxTreeItemId& idPrevious,
303 const wxString& text,
304 int image = -1, int selImage = -1,
305 wxTreeItemData *data = NULL);
306 virtual wxTreeItemId DoTreeHitTest(const wxPoint& point, int& flags) const;
307
308 // called by wxTextTreeCtrl when it marks itself for deletion
309 void ResetTextControl();
310
311 // find the first item starting with the given prefix after the given item
312 wxTreeItemId FindItem(const wxTreeItemId& id, const wxString& prefix) const;
313
314 bool HasButtons() const { return HasFlag(wxTR_HAS_BUTTONS); }
315
316 void CalculateLineHeight();
317 int GetLineHeight(wxGenericTreeItem *item) const;
318 void PaintLevel( wxGenericTreeItem *item, wxDC& dc, int level, int &y );
319 void PaintItem( wxGenericTreeItem *item, wxDC& dc);
320
321 void CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y );
322 void CalculatePositions();
323
324 void RefreshSubtree( wxGenericTreeItem *item );
325 void RefreshLine( wxGenericTreeItem *item );
326
327 // redraw all selected items
328 void RefreshSelected();
329
330 // RefreshSelected() recursive helper
331 void RefreshSelectedUnder(wxGenericTreeItem *item);
332
333 void OnRenameTimer();
334 bool OnRenameAccept(wxGenericTreeItem *item, const wxString& value);
335 void OnRenameCancelled(wxGenericTreeItem *item);
336
337 void FillArray(wxGenericTreeItem*, wxArrayTreeItemIds&) const;
338 void SelectItemRange( wxGenericTreeItem *item1, wxGenericTreeItem *item2 );
339 bool TagAllChildrenUntilLast(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select);
340 bool TagNextChildren(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select);
341 void UnselectAllChildren( wxGenericTreeItem *item );
342 void ChildrenClosing(wxGenericTreeItem* item);
343
344 void DoDirtyProcessing();
345
346 virtual wxSize DoGetBestSize() const;
347
348private:
349 DECLARE_EVENT_TABLE()
350 DECLARE_DYNAMIC_CLASS(wxGenericTreeCtrl)
351 wxDECLARE_NO_COPY_CLASS(wxGenericTreeCtrl);
352};
353
354#if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
355/*
356 * wxTreeCtrl has to be a real class or we have problems with
357 * the run-time information.
358 */
359
360class WXDLLIMPEXP_CORE wxTreeCtrl: public wxGenericTreeCtrl
361{
362 DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
363
364public:
365 wxTreeCtrl() {}
366
367 wxTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
368 const wxPoint& pos = wxDefaultPosition,
369 const wxSize& size = wxDefaultSize,
370 long style = wxTR_DEFAULT_STYLE,
371 const wxValidator &validator = wxDefaultValidator,
372 const wxString& name = wxTreeCtrlNameStr)
373 : wxGenericTreeCtrl(parent, id, pos, size, style, validator, name)
374 {
375 }
376};
377#endif // !__WXMSW__ || __WXUNIVERSAL__
378
379#endif // wxUSE_TREECTRL
380
381#endif // _GENERIC_TREECTRL_H_
wxWidgets (Impactor)