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