Added wxDataViewCtrl::IsExpanded(item)
[wxWidgets.git] / include / wx / dataview.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/dataview.h
3 // Purpose: wxDataViewCtrl base classes
4 // Author: Robert Roebling
5 // Modified by: Bo Yang
6 // Created: 08.01.06
7 // RCS-ID: $Id$
8 // Copyright: (c) Robert Roebling
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_DATAVIEW_H_BASE_
13 #define _WX_DATAVIEW_H_BASE_
14
15 #include "wx/defs.h"
16
17 #if wxUSE_DATAVIEWCTRL
18
19 #include "wx/control.h"
20 #include "wx/textctrl.h"
21 #include "wx/headercol.h"
22 #include "wx/variant.h"
23 #include "wx/dynarray.h"
24 #include "wx/icon.h"
25 #include "wx/imaglist.h"
26 #include "wx/weakref.h"
27
28 #if !(defined(__WXGTK20__) || defined(__WXMAC__)) || defined(__WXUNIVERSAL__)
29 #define wxHAS_GENERIC_DATAVIEWCTRL
30 #endif
31
32 class WXDLLIMPEXP_FWD_CORE wxDataFormat;
33
34 // ----------------------------------------------------------------------------
35 // wxDataViewCtrl flags
36 // ----------------------------------------------------------------------------
37
38 // ----------------------------------------------------------------------------
39 // wxDataViewCtrl globals
40 // ----------------------------------------------------------------------------
41
42 class WXDLLIMPEXP_FWD_ADV wxDataViewItem;
43 class WXDLLIMPEXP_FWD_ADV wxDataViewModel;
44 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
45 class WXDLLIMPEXP_FWD_ADV wxDataViewColumn;
46 class WXDLLIMPEXP_FWD_ADV wxDataViewRenderer;
47 class WXDLLIMPEXP_FWD_ADV wxDataViewModelNotifier;
48
49 extern WXDLLIMPEXP_DATA_ADV(const char) wxDataViewCtrlNameStr[];
50
51 // the default width of new (text) columns:
52 #define wxDVC_DEFAULT_WIDTH 80
53
54 // the default width of new toggle columns:
55 #define wxDVC_TOGGLE_DEFAULT_WIDTH 30
56
57 // the default minimal width of the columns:
58 #define wxDVC_DEFAULT_MINWIDTH 30
59
60 // The default alignment of wxDataViewRenderers is to take
61 // the alignment from the column it owns.
62 #define wxDVR_DEFAULT_ALIGNMENT -1
63
64
65 // ---------------------------------------------------------
66 // wxDataViewItem
67 // ---------------------------------------------------------
68
69 class WXDLLIMPEXP_ADV wxDataViewItem
70 {
71 public:
72 wxDataViewItem( void* id = NULL )
73 { m_id = id; }
74 wxDataViewItem( const wxDataViewItem &item )
75 { m_id = item.m_id; }
76 bool IsOk() const { return m_id != NULL; }
77 void* GetID() const { return m_id; }
78 operator const void* () const { return m_id; }
79
80 #ifdef __WXDEBUG__
81 void Print( const wxString &text ) const;
82 #endif
83
84 private:
85 void* m_id;
86 };
87
88 bool operator == (const wxDataViewItem &left, const wxDataViewItem &right);
89
90 WX_DEFINE_ARRAY(wxDataViewItem, wxDataViewItemArray);
91
92 // ---------------------------------------------------------
93 // wxDataViewModelNotifier
94 // ---------------------------------------------------------
95
96 class WXDLLIMPEXP_ADV wxDataViewModelNotifier
97 {
98 public:
99 wxDataViewModelNotifier() { m_owner = NULL; }
100 virtual ~wxDataViewModelNotifier() { m_owner = NULL; }
101
102 virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
103 virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
104 virtual bool ItemChanged( const wxDataViewItem &item ) = 0;
105 virtual bool ItemsAdded( const wxDataViewItem &parent, const wxDataViewItemArray &items );
106 virtual bool ItemsDeleted( const wxDataViewItem &parent, const wxDataViewItemArray &items );
107 virtual bool ItemsChanged( const wxDataViewItemArray &items );
108 virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col ) = 0;
109 virtual bool Cleared() = 0;
110
111 virtual void Resort() = 0;
112
113 void SetOwner( wxDataViewModel *owner ) { m_owner = owner; }
114 wxDataViewModel *GetOwner() const { return m_owner; }
115
116 private:
117 wxDataViewModel *m_owner;
118 };
119
120
121
122 // ----------------------------------------------------------------------------
123 // wxDataViewItemAttr: a structure containing the visual attributes of an item
124 // ----------------------------------------------------------------------------
125
126 // TODO: this should be renamed to wxItemAttr or something general like this
127
128 class WXDLLIMPEXP_ADV wxDataViewItemAttr
129 {
130 public:
131 // ctors
132 wxDataViewItemAttr()
133 {
134 m_bold = false;
135 m_italic = false;
136 }
137
138 // setters
139 void SetColour(const wxColour& colour) { m_colour = colour; }
140 void SetBold( bool set ) { m_bold = set; }
141 void SetItalic( bool set ) { m_italic = set; }
142
143 // accessors
144 bool HasColour() const { return m_colour.Ok(); }
145 const wxColour& GetColour() const { return m_colour; }
146
147 bool GetBold() const { return m_bold; }
148 bool GetItalic() const { return m_italic; }
149
150 private:
151 wxColour m_colour;
152 bool m_bold;
153 bool m_italic;
154 };
155
156
157 // ---------------------------------------------------------
158 // wxDataViewModel
159 // ---------------------------------------------------------
160
161 WX_DECLARE_LIST_WITH_DECL(wxDataViewModelNotifier, wxDataViewModelNotifiers,
162 class WXDLLIMPEXP_ADV);
163
164 class WXDLLIMPEXP_ADV wxDataViewModel: public wxObjectRefData
165 {
166 public:
167 wxDataViewModel();
168
169 virtual unsigned int GetColumnCount() const = 0;
170
171 // return type as reported by wxVariant
172 virtual wxString GetColumnType( unsigned int col ) const = 0;
173
174 // get value into a wxVariant
175 virtual void GetValue( wxVariant &variant,
176 const wxDataViewItem &item, unsigned int col ) const = 0;
177
178 // set value, call ValueChanged() afterwards!
179 virtual bool SetValue( const wxVariant &variant,
180 const wxDataViewItem &item, unsigned int col ) = 0;
181
182 // Get text attribute, return false of default attributes should be used
183 virtual bool GetAttr( const wxDataViewItem &WXUNUSED(item), unsigned int WXUNUSED(col), wxDataViewItemAttr &WXUNUSED(attr) )
184 { return false; }
185
186 // define hierachy
187 virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const = 0;
188 virtual bool IsContainer( const wxDataViewItem &item ) const = 0;
189 // Is the container just a header or an item with all columns
190 virtual bool HasContainerColumns(const wxDataViewItem& WXUNUSED(item)) const
191 { return false; }
192 virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const = 0;
193
194 // define DnD capabilities
195 virtual bool IsDraggable( const wxDataViewItem &WXUNUSED(item) )
196 { return false; }
197 virtual size_t GetDragDataSize( const wxDataViewItem &WXUNUSED(item), const wxDataFormat &WXUNUSED(format) )
198 { return 0; }
199 virtual bool GetDragData( const wxDataViewItem &WXUNUSED(item), const wxDataFormat &WXUNUSED(format),
200 void* WXUNUSED(data), size_t WXUNUSED(size) )
201 { return FALSE; }
202
203 // delegated notifiers
204 virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item );
205 virtual bool ItemsAdded( const wxDataViewItem &parent, const wxDataViewItemArray &items );
206 virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item );
207 virtual bool ItemsDeleted( const wxDataViewItem &parent, const wxDataViewItemArray &items );
208 virtual bool ItemChanged( const wxDataViewItem &item );
209 virtual bool ItemsChanged( const wxDataViewItemArray &items );
210 virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col );
211 virtual bool Cleared();
212
213 // delegatd action
214 virtual void Resort();
215
216 void AddNotifier( wxDataViewModelNotifier *notifier );
217 void RemoveNotifier( wxDataViewModelNotifier *notifier );
218
219 // default compare function
220 virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
221 unsigned int column, bool ascending );
222 virtual bool HasDefaultCompare() const { return false; }
223
224 // internal
225 virtual bool IsVirtualListModel() const { return false; }
226
227 protected:
228 // the user should not delete this class directly: he should use DecRef() instead!
229 virtual ~wxDataViewModel() { }
230
231 wxDataViewModelNotifiers m_notifiers;
232 };
233
234 // ---------------------------------------------------------
235 // wxDataViewIndexListModel
236 // ---------------------------------------------------------
237
238 class WXDLLIMPEXP_ADV wxDataViewIndexListModel: public wxDataViewModel
239 {
240 public:
241 wxDataViewIndexListModel( unsigned int initial_size = 0 );
242 ~wxDataViewIndexListModel();
243
244 virtual void GetValue( wxVariant &variant,
245 unsigned int row, unsigned int col ) const = 0;
246
247 virtual bool SetValue( const wxVariant &variant,
248 unsigned int row, unsigned int col ) = 0;
249
250 virtual bool GetAttr( unsigned int WXUNUSED(row), unsigned int WXUNUSED(col), wxDataViewItemAttr &WXUNUSED(attr) )
251 { return false; }
252
253 void RowPrepended();
254 void RowInserted( unsigned int before );
255 void RowAppended();
256 void RowDeleted( unsigned int row );
257 void RowsDeleted( const wxArrayInt &rows );
258 void RowChanged( unsigned int row );
259 void RowValueChanged( unsigned int row, unsigned int col );
260 void Reset( unsigned int new_size );
261
262 // convert to/from row/wxDataViewItem
263
264 unsigned int GetRow( const wxDataViewItem &item ) const;
265 wxDataViewItem GetItem( unsigned int row ) const;
266
267 // compare based on index
268
269 virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
270 unsigned int column, bool ascending );
271 virtual bool HasDefaultCompare() const;
272
273 // implement base methods
274
275 virtual void GetValue( wxVariant &variant,
276 const wxDataViewItem &item, unsigned int col ) const;
277 virtual bool SetValue( const wxVariant &variant,
278 const wxDataViewItem &item, unsigned int col );
279 virtual bool GetAttr( const wxDataViewItem &item, unsigned int col, wxDataViewItemAttr &attr );
280 virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const;
281 virtual bool IsContainer( const wxDataViewItem &item ) const;
282 virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
283
284 // internal
285 virtual bool IsVirtualListModel() const { return false; }
286 unsigned int GetLastIndex() const { return m_lastIndex; }
287
288 private:
289 wxDataViewItemArray m_hash;
290 unsigned int m_lastIndex;
291 bool m_ordered;
292 };
293
294 // ---------------------------------------------------------
295 // wxDataViewVirtualListModel
296 // ---------------------------------------------------------
297
298 #ifdef __WXMAC__
299 // better than nothing
300 typedef wxDataViewIndexListModel wxDataViewVirtualListModel;
301 #else
302
303 class WXDLLIMPEXP_ADV wxDataViewVirtualListModel: public wxDataViewModel
304 {
305 public:
306 wxDataViewVirtualListModel( unsigned int initial_size = 0 );
307 ~wxDataViewVirtualListModel();
308
309 virtual void GetValue( wxVariant &variant,
310 unsigned int row, unsigned int col ) const = 0;
311
312 virtual bool SetValue( const wxVariant &variant,
313 unsigned int row, unsigned int col ) = 0;
314
315 virtual bool GetAttr( unsigned int WXUNUSED(row), unsigned int WXUNUSED(col), wxDataViewItemAttr &WXUNUSED(attr) )
316 { return false; }
317
318 void RowPrepended();
319 void RowInserted( unsigned int before );
320 void RowAppended();
321 void RowDeleted( unsigned int row );
322 void RowsDeleted( const wxArrayInt &rows );
323 void RowChanged( unsigned int row );
324 void RowValueChanged( unsigned int row, unsigned int col );
325 void Reset( unsigned int new_size );
326
327 // convert to/from row/wxDataViewItem
328
329 unsigned int GetRow( const wxDataViewItem &item ) const;
330 wxDataViewItem GetItem( unsigned int row ) const;
331
332 // compare based on index
333
334 virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
335 unsigned int column, bool ascending );
336 virtual bool HasDefaultCompare() const;
337
338 // implement base methods
339
340 virtual void GetValue( wxVariant &variant,
341 const wxDataViewItem &item, unsigned int col ) const;
342 virtual bool SetValue( const wxVariant &variant,
343 const wxDataViewItem &item, unsigned int col );
344 virtual bool GetAttr( const wxDataViewItem &item, unsigned int col, wxDataViewItemAttr &attr );
345 virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const;
346 virtual bool IsContainer( const wxDataViewItem &item ) const;
347 virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
348
349 // internal
350 virtual bool IsVirtualListModel() const { return true; }
351 unsigned int GetLastIndex() const { return m_lastIndex; }
352
353 private:
354 wxDataViewItemArray m_hash;
355 unsigned int m_lastIndex;
356 bool m_ordered;
357 };
358 #endif
359
360 //-----------------------------------------------------------------------------
361 // wxDataViewEditorCtrlEvtHandler
362 //-----------------------------------------------------------------------------
363
364 class wxDataViewEditorCtrlEvtHandler: public wxEvtHandler
365 {
366 public:
367 wxDataViewEditorCtrlEvtHandler( wxControl *editor, wxDataViewRenderer *owner );
368
369 void AcceptChangesAndFinish();
370 void SetFocusOnIdle( bool focus = true ) { m_focusOnIdle = focus; }
371
372 protected:
373 void OnChar( wxKeyEvent &event );
374 void OnTextEnter( wxCommandEvent &event );
375 void OnKillFocus( wxFocusEvent &event );
376 void OnIdle( wxIdleEvent &event );
377
378 private:
379 wxDataViewRenderer *m_owner;
380 wxControl *m_editorCtrl;
381 bool m_finished;
382 bool m_focusOnIdle;
383
384 private:
385 DECLARE_EVENT_TABLE()
386 };
387
388 // ---------------------------------------------------------
389 // wxDataViewRendererBase
390 // ---------------------------------------------------------
391
392 enum wxDataViewCellMode
393 {
394 wxDATAVIEW_CELL_INERT,
395 wxDATAVIEW_CELL_ACTIVATABLE,
396 wxDATAVIEW_CELL_EDITABLE
397 };
398
399 enum wxDataViewCellRenderState
400 {
401 wxDATAVIEW_CELL_SELECTED = 1,
402 wxDATAVIEW_CELL_PRELIT = 2,
403 wxDATAVIEW_CELL_INSENSITIVE = 4,
404 wxDATAVIEW_CELL_FOCUSED = 8
405 };
406
407 class WXDLLIMPEXP_ADV wxDataViewRendererBase: public wxObject
408 {
409 public:
410 wxDataViewRendererBase( const wxString &varianttype,
411 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
412 int alignment = wxDVR_DEFAULT_ALIGNMENT );
413 ~wxDataViewRendererBase();
414
415 virtual bool Validate( wxVariant& WXUNUSED(value) )
416 { return true; }
417
418 void SetOwner( wxDataViewColumn *owner ) { m_owner = owner; }
419 wxDataViewColumn* GetOwner() const { return m_owner; }
420
421 // renderer properties:
422
423 virtual bool SetValue( const wxVariant& WXUNUSED(value) ) = 0;
424 virtual bool GetValue( wxVariant& WXUNUSED(value) ) const = 0;
425
426 wxString GetVariantType() const { return m_variantType; }
427
428 virtual void SetMode( wxDataViewCellMode mode ) = 0;
429 virtual wxDataViewCellMode GetMode() const = 0;
430
431 // NOTE: Set/GetAlignment do not take/return a wxAlignment enum but
432 // rather an "int"; that's because for rendering cells it's allowed
433 // to combine alignment flags (e.g. wxALIGN_LEFT|wxALIGN_BOTTOM)
434 virtual void SetAlignment( int align ) = 0;
435 virtual int GetAlignment() const = 0;
436
437 // in-place editing
438 virtual bool HasEditorCtrl()
439 { return false; }
440 virtual wxControl* CreateEditorCtrl(wxWindow * WXUNUSED(parent),
441 wxRect WXUNUSED(labelRect),
442 const wxVariant& WXUNUSED(value))
443 { return NULL; }
444 virtual bool GetValueFromEditorCtrl(wxControl * WXUNUSED(editor),
445 wxVariant& WXUNUSED(value))
446 { return false; }
447
448 virtual bool StartEditing( const wxDataViewItem &item, wxRect labelRect );
449 virtual void CancelEditing();
450 virtual bool FinishEditing();
451
452 wxControl *GetEditorCtrl() { return m_editorCtrl; }
453
454 protected:
455 wxString m_variantType;
456 wxDataViewColumn *m_owner;
457 wxWeakRef<wxControl> m_editorCtrl;
458 wxDataViewItem m_item; // for m_editorCtrl
459
460 // internal utility:
461 const wxDataViewCtrl* GetView() const;
462
463 protected:
464 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
465 };
466
467 //-----------------------------------------------------------------------------
468 // wxDataViewIconText
469 //-----------------------------------------------------------------------------
470
471 class WXDLLIMPEXP_ADV wxDataViewIconText: public wxObject
472 {
473 public:
474 wxDataViewIconText( const wxString &text = wxEmptyString, const wxIcon& icon = wxNullIcon )
475 : m_text(text), m_icon(icon)
476 { }
477 wxDataViewIconText( const wxDataViewIconText &other )
478 : wxObject()
479 { m_icon = other.m_icon; m_text = other.m_text; }
480
481 void SetText( const wxString &text ) { m_text = text; }
482 wxString GetText() const { return m_text; }
483 void SetIcon( const wxIcon &icon ) { m_icon = icon; }
484 const wxIcon &GetIcon() const { return m_icon; }
485
486 private:
487 wxString m_text;
488 wxIcon m_icon;
489
490 private:
491 DECLARE_DYNAMIC_CLASS(wxDataViewIconText)
492 };
493
494 bool operator == (const wxDataViewIconText &one, const wxDataViewIconText &two);
495
496 DECLARE_VARIANT_OBJECT_EXPORTED(wxDataViewIconText, WXDLLIMPEXP_ADV)
497
498 // ---------------------------------------------------------
499 // wxDataViewColumnBase
500 // ---------------------------------------------------------
501
502 // for compatibility only, do not use
503 enum wxDataViewColumnFlags
504 {
505 wxDATAVIEW_COL_RESIZABLE = wxCOL_RESIZABLE,
506 wxDATAVIEW_COL_SORTABLE = wxCOL_SORTABLE,
507 wxDATAVIEW_COL_REORDERABLE = wxCOL_REORDERABLE,
508 wxDATAVIEW_COL_HIDDEN = wxCOL_HIDDEN
509 };
510
511 class WXDLLIMPEXP_ADV wxDataViewColumnBase : public wxSettableHeaderColumn
512 {
513 public:
514 // ctor for the text columns: takes ownership of renderer
515 wxDataViewColumnBase(wxDataViewRenderer *renderer,
516 unsigned int model_column)
517 {
518 Init(renderer, model_column);
519 }
520
521 // ctor for the bitmap columns
522 wxDataViewColumnBase(const wxBitmap& bitmap,
523 wxDataViewRenderer *renderer,
524 unsigned int model_column)
525 : m_bitmap(bitmap)
526 {
527 Init(renderer, model_column);
528 }
529
530 virtual ~wxDataViewColumnBase();
531
532 // setters:
533 virtual void SetOwner( wxDataViewCtrl *owner )
534 { m_owner = owner; }
535
536 // getters:
537 unsigned int GetModelColumn() const { return static_cast<unsigned int>(m_model_column); }
538 wxDataViewCtrl *GetOwner() const { return m_owner; }
539 wxDataViewRenderer* GetRenderer() const { return m_renderer; }
540
541 // implement some of base class pure virtuals (the rest is port-dependent
542 // and done differently in generic and native versions)
543 virtual void SetBitmap( const wxBitmap& bitmap ) { m_bitmap = bitmap; }
544 virtual wxBitmap GetBitmap() const { return m_bitmap; }
545
546 protected:
547 wxDataViewRenderer *m_renderer;
548 int m_model_column;
549 wxBitmap m_bitmap;
550 wxDataViewCtrl *m_owner;
551
552 private:
553 // common part of all ctors
554 void Init(wxDataViewRenderer *renderer, unsigned int model_column);
555 };
556
557 // ---------------------------------------------------------
558 // wxDataViewCtrlBase
559 // ---------------------------------------------------------
560
561 #define wxDV_SINGLE 0x0000 // for convenience
562 #define wxDV_MULTIPLE 0x0001 // can select multiple items
563
564 #define wxDV_NO_HEADER 0x0002 // column titles not visible
565 #define wxDV_HORIZ_RULES 0x0004 // light horizontal rules between rows
566 #define wxDV_VERT_RULES 0x0008 // light vertical rules between columns
567
568 #define wxDV_ROW_LINES 0x0010 // alternating colour in rows
569 #define wxDV_VARIABLE_LINE_HEIGHT 0x0020 // variable line height
570
571 class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl
572 {
573 public:
574 wxDataViewCtrlBase();
575 virtual ~wxDataViewCtrlBase();
576
577 virtual bool AssociateModel( wxDataViewModel *model );
578 wxDataViewModel* GetModel();
579 const wxDataViewModel* GetModel() const;
580
581 // short cuts
582 wxDataViewColumn *PrependTextColumn( const wxString &label, unsigned int model_column,
583 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
584 wxAlignment align = wxALIGN_NOT,
585 int flags = wxDATAVIEW_COL_RESIZABLE );
586 wxDataViewColumn *PrependIconTextColumn( const wxString &label, unsigned int model_column,
587 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
588 wxAlignment align = wxALIGN_NOT,
589 int flags = wxDATAVIEW_COL_RESIZABLE );
590 wxDataViewColumn *PrependToggleColumn( const wxString &label, unsigned int model_column,
591 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
592 wxAlignment align = wxALIGN_CENTER,
593 int flags = wxDATAVIEW_COL_RESIZABLE );
594 wxDataViewColumn *PrependProgressColumn( const wxString &label, unsigned int model_column,
595 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
596 wxAlignment align = wxALIGN_CENTER,
597 int flags = wxDATAVIEW_COL_RESIZABLE );
598 wxDataViewColumn *PrependDateColumn( const wxString &label, unsigned int model_column,
599 wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
600 wxAlignment align = wxALIGN_NOT,
601 int flags = wxDATAVIEW_COL_RESIZABLE );
602 wxDataViewColumn *PrependBitmapColumn( const wxString &label, unsigned int model_column,
603 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
604 wxAlignment align = wxALIGN_CENTER,
605 int flags = wxDATAVIEW_COL_RESIZABLE );
606 wxDataViewColumn *PrependTextColumn( const wxBitmap &label, unsigned int model_column,
607 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
608 wxAlignment align = wxALIGN_NOT,
609 int flags = wxDATAVIEW_COL_RESIZABLE );
610 wxDataViewColumn *PrependIconTextColumn( const wxBitmap &label, unsigned int model_column,
611 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
612 wxAlignment align = wxALIGN_NOT,
613 int flags = wxDATAVIEW_COL_RESIZABLE );
614 wxDataViewColumn *PrependToggleColumn( const wxBitmap &label, unsigned int model_column,
615 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
616 wxAlignment align = wxALIGN_CENTER,
617 int flags = wxDATAVIEW_COL_RESIZABLE );
618 wxDataViewColumn *PrependProgressColumn( const wxBitmap &label, unsigned int model_column,
619 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
620 wxAlignment align = wxALIGN_CENTER,
621 int flags = wxDATAVIEW_COL_RESIZABLE );
622 wxDataViewColumn *PrependDateColumn( const wxBitmap &label, unsigned int model_column,
623 wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
624 wxAlignment align = wxALIGN_NOT,
625 int flags = wxDATAVIEW_COL_RESIZABLE );
626 wxDataViewColumn *PrependBitmapColumn( const wxBitmap &label, unsigned int model_column,
627 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
628 wxAlignment align = wxALIGN_CENTER,
629 int flags = wxDATAVIEW_COL_RESIZABLE );
630
631 wxDataViewColumn *AppendTextColumn( const wxString &label, unsigned int model_column,
632 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
633 wxAlignment align = wxALIGN_NOT,
634 int flags = wxDATAVIEW_COL_RESIZABLE );
635 wxDataViewColumn *AppendIconTextColumn( const wxString &label, unsigned int model_column,
636 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
637 wxAlignment align = wxALIGN_NOT,
638 int flags = wxDATAVIEW_COL_RESIZABLE );
639 wxDataViewColumn *AppendToggleColumn( const wxString &label, unsigned int model_column,
640 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
641 wxAlignment align = wxALIGN_CENTER,
642 int flags = wxDATAVIEW_COL_RESIZABLE );
643 wxDataViewColumn *AppendProgressColumn( const wxString &label, unsigned int model_column,
644 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
645 wxAlignment align = wxALIGN_CENTER,
646 int flags = wxDATAVIEW_COL_RESIZABLE );
647 wxDataViewColumn *AppendDateColumn( const wxString &label, unsigned int model_column,
648 wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
649 wxAlignment align = wxALIGN_NOT,
650 int flags = wxDATAVIEW_COL_RESIZABLE );
651 wxDataViewColumn *AppendBitmapColumn( const wxString &label, unsigned int model_column,
652 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
653 wxAlignment align = wxALIGN_CENTER,
654 int flags = wxDATAVIEW_COL_RESIZABLE );
655 wxDataViewColumn *AppendTextColumn( const wxBitmap &label, unsigned int model_column,
656 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
657 wxAlignment align = wxALIGN_NOT,
658 int flags = wxDATAVIEW_COL_RESIZABLE );
659 wxDataViewColumn *AppendIconTextColumn( const wxBitmap &label, unsigned int model_column,
660 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
661 wxAlignment align = wxALIGN_NOT,
662 int flags = wxDATAVIEW_COL_RESIZABLE );
663 wxDataViewColumn *AppendToggleColumn( const wxBitmap &label, unsigned int model_column,
664 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
665 wxAlignment align = wxALIGN_CENTER,
666 int flags = wxDATAVIEW_COL_RESIZABLE );
667 wxDataViewColumn *AppendProgressColumn( const wxBitmap &label, unsigned int model_column,
668 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
669 wxAlignment align = wxALIGN_CENTER,
670 int flags = wxDATAVIEW_COL_RESIZABLE );
671 wxDataViewColumn *AppendDateColumn( const wxBitmap &label, unsigned int model_column,
672 wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
673 wxAlignment align = wxALIGN_NOT,
674 int flags = wxDATAVIEW_COL_RESIZABLE );
675 wxDataViewColumn *AppendBitmapColumn( const wxBitmap &label, unsigned int model_column,
676 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
677 wxAlignment align = wxALIGN_CENTER,
678 int flags = wxDATAVIEW_COL_RESIZABLE );
679
680
681 virtual bool PrependColumn( wxDataViewColumn *col );
682 virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
683 virtual bool AppendColumn( wxDataViewColumn *col );
684
685 virtual unsigned int GetColumnCount() const = 0;
686 virtual wxDataViewColumn* GetColumn( unsigned int pos ) const = 0;
687 virtual int GetColumnPosition( const wxDataViewColumn *column ) const = 0;
688
689 virtual bool DeleteColumn( wxDataViewColumn *column ) = 0;
690 virtual bool ClearColumns() = 0;
691
692 void SetExpanderColumn( wxDataViewColumn *col )
693 { m_expander_column = col ; DoSetExpanderColumn(); }
694 wxDataViewColumn *GetExpanderColumn() const
695 { return m_expander_column; }
696
697 virtual wxDataViewColumn *GetSortingColumn() const = 0;
698
699 void SetIndent( int indent )
700 { m_indent = indent ; DoSetIndent(); }
701 int GetIndent() const
702 { return m_indent; }
703
704 virtual wxDataViewItem GetSelection() const = 0;
705 virtual int GetSelections( wxDataViewItemArray & sel ) const = 0;
706 virtual void SetSelections( const wxDataViewItemArray & sel ) = 0;
707 virtual void Select( const wxDataViewItem & item ) = 0;
708 virtual void Unselect( const wxDataViewItem & item ) = 0;
709 virtual bool IsSelected( const wxDataViewItem & item ) const = 0;
710
711 virtual void SelectAll() = 0;
712 virtual void UnselectAll() = 0;
713
714 virtual void Expand( const wxDataViewItem & item ) = 0;
715 virtual void Collapse( const wxDataViewItem & item ) = 0;
716 virtual bool IsExpanded( const wxDataViewItem & item ) const = 0;
717
718 virtual void EnsureVisible( const wxDataViewItem & item,
719 const wxDataViewColumn *column = NULL ) = 0;
720 virtual void HitTest( const wxPoint & point, wxDataViewItem &item, wxDataViewColumn* &column ) const = 0;
721 virtual wxRect GetItemRect( const wxDataViewItem & item, const wxDataViewColumn *column = NULL ) const = 0;
722
723 protected:
724 virtual void DoSetExpanderColumn() = 0 ;
725 virtual void DoSetIndent() = 0;
726
727 private:
728 wxDataViewModel *m_model;
729 wxDataViewColumn *m_expander_column;
730 int m_indent ;
731
732 protected:
733 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
734 };
735
736 // ----------------------------------------------------------------------------
737 // wxDataViewEvent - the event class for the wxDataViewCtrl notifications
738 // ----------------------------------------------------------------------------
739
740 class WXDLLIMPEXP_ADV wxDataViewEvent : public wxNotifyEvent
741 {
742 public:
743 wxDataViewEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
744 : wxNotifyEvent(commandType, winid),
745 m_item(0),
746 m_col(-1),
747 m_model(NULL),
748 m_value(wxNullVariant),
749 m_column(NULL),
750 m_pos(-1,-1)
751 { }
752
753 wxDataViewEvent(const wxDataViewEvent& event)
754 : wxNotifyEvent(event),
755 m_item(event.m_item),
756 m_col(event.m_col),
757 m_model(event.m_model),
758 m_value(event.m_value),
759 m_column(event.m_column),
760 m_pos(m_pos)
761 { }
762
763 wxDataViewItem GetItem() const { return m_item; }
764 void SetItem( const wxDataViewItem &item ) { m_item = item; }
765
766 int GetColumn() const { return m_col; }
767 void SetColumn( int col ) { m_col = col; }
768
769 wxDataViewModel* GetModel() const { return m_model; }
770 void SetModel( wxDataViewModel *model ) { m_model = model; }
771
772 const wxVariant &GetValue() const { return m_value; }
773 void SetValue( const wxVariant &value ) { m_value = value; }
774
775 // for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only
776 void SetDataViewColumn( wxDataViewColumn *col ) { m_column = col; }
777 wxDataViewColumn *GetDataViewColumn() const { return m_column; }
778
779 // for wxEVT_DATAVIEW_CONTEXT_MENU only
780 wxPoint GetPosition() const { return m_pos; }
781 void SetPosition( int x, int y ) { m_pos.x = x; m_pos.y = y; }
782
783 virtual wxEvent *Clone() const { return new wxDataViewEvent(*this); }
784
785 protected:
786 wxDataViewItem m_item;
787 int m_col;
788 wxDataViewModel *m_model;
789 wxVariant m_value;
790 wxDataViewColumn *m_column;
791 wxPoint m_pos;
792
793 private:
794 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent)
795 };
796
797 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED;
798
799 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED;
800 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED;
801 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED;
802 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING;
803 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING;
804 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED;
805 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE;
806 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED;
807
808 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU;
809
810 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK;
811 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK;
812 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED;
813 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED;
814
815 typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&);
816
817 #define wxDataViewEventHandler(func) \
818 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDataViewEventFunction, &func)
819
820 #define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \
821 wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn))
822
823 #define EVT_DATAVIEW_SELECTION_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(SELECTION_CHANGED, id, fn)
824
825 #define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_ACTIVATED, id, fn)
826 #define EVT_DATAVIEW_ITEM_COLLAPSING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSING, id, fn)
827 #define EVT_DATAVIEW_ITEM_COLLAPSED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSED, id, fn)
828 #define EVT_DATAVIEW_ITEM_EXPANDING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDING, id, fn)
829 #define EVT_DATAVIEW_ITEM_EXPANDED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDED, id, fn)
830 #define EVT_DATAVIEW_ITEM_EDITING_STARTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_STARTED, id, fn)
831 #define EVT_DATAVIEW_ITEM_EDITING_DONE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_DONE, id, fn)
832 #define EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_VALUE_CHANGED, id, fn)
833
834 #define EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_CONTEXT_MENU, id, fn)
835
836 #define EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_CLICK, id, fn)
837 #define EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_RIGHT_CLICK, id, fn)
838 #define EVT_DATAVIEW_COLUMN_SORTED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_SORTED, id, fn)
839 #define EVT_DATAVIEW_COLUMN_REORDERED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_REORDERED, id, fn)
840
841
842 #ifdef wxHAS_GENERIC_DATAVIEWCTRL
843 // this symbol doesn't follow the convention for wxUSE_XXX symbols which
844 // are normally always defined as either 0 or 1, so its use is deprecated
845 // and it only exists for backwards compatibility, don't use it any more
846 // and use wxHAS_GENERIC_DATAVIEWCTRL instead
847 #define wxUSE_GENERICDATAVIEWCTRL
848
849 #include "wx/generic/dataview.h"
850 #elif defined(__WXGTK20__)
851 #include "wx/gtk/dataview.h"
852 #elif defined(__WXMAC__)
853 #include "wx/osx/dataview.h"
854 #else
855 #error "unknown native wxDataViewCtrl implementation"
856 #endif
857
858 // -------------------------------------
859 // wxDataViewSpinRenderer
860 // -------------------------------------
861
862 class WXDLLIMPEXP_ADV wxDataViewSpinRenderer: public wxDataViewCustomRenderer
863 {
864 public:
865 wxDataViewSpinRenderer( int min, int max,
866 wxDataViewCellMode mode = wxDATAVIEW_CELL_EDITABLE,
867 int alignment = wxDVR_DEFAULT_ALIGNMENT );
868 virtual bool HasEditorCtrl() { return true; }
869 virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
870 virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
871 virtual bool Render( wxRect rect, wxDC *dc, int state );
872 virtual wxSize GetSize() const;
873 virtual bool SetValue( const wxVariant &value );
874 virtual bool GetValue( wxVariant &value ) const;
875
876 private:
877 long m_data;
878 long m_min,m_max;
879 };
880
881 #ifndef __WXGTK20__
882
883 // -------------------------------------
884 // wxDataViewChoiceRenderer
885 // -------------------------------------
886
887 class WXDLLIMPEXP_ADV wxDataViewChoiceRenderer: public wxDataViewCustomRenderer
888 {
889 public:
890 wxDataViewChoiceRenderer( const wxArrayString &choices,
891 wxDataViewCellMode mode = wxDATAVIEW_CELL_EDITABLE,
892 int alignment = wxDVR_DEFAULT_ALIGNMENT );
893 virtual bool HasEditorCtrl() { return true; }
894 virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
895 virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
896 virtual bool Render( wxRect rect, wxDC *dc, int state );
897 virtual wxSize GetSize() const;
898 virtual bool SetValue( const wxVariant &value );
899 virtual bool GetValue( wxVariant &value ) const;
900
901 private:
902 wxArrayString m_choices;
903 wxString m_data;
904 };
905
906 #endif
907
908 //-----------------------------------------------------------------------------
909 // wxDataViewTreeStore
910 //-----------------------------------------------------------------------------
911
912 class WXDLLIMPEXP_ADV wxDataViewTreeStoreNode
913 {
914 public:
915 wxDataViewTreeStoreNode( wxDataViewTreeStoreNode *parent,
916 const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
917 virtual ~wxDataViewTreeStoreNode();
918
919 void SetText( const wxString &text )
920 { m_text = text; }
921 wxString GetText() const
922 { return m_text; }
923 void SetIcon( const wxIcon &icon )
924 { m_icon = icon; }
925 const wxIcon &GetIcon() const
926 { return m_icon; }
927 void SetData( wxClientData *data )
928 { if (m_data) delete m_data; m_data = data; }
929 wxClientData *GetData() const
930 { return m_data; }
931
932 wxDataViewItem GetItem() const
933 { return wxDataViewItem( (void*) this ); }
934
935 virtual bool IsContainer()
936 { return false; }
937
938 wxDataViewTreeStoreNode *GetParent()
939 { return m_parent; }
940
941 private:
942 wxDataViewTreeStoreNode *m_parent;
943 wxString m_text;
944 wxIcon m_icon;
945 wxClientData *m_data;
946 };
947
948 WX_DECLARE_LIST_WITH_DECL(wxDataViewTreeStoreNode, wxDataViewTreeStoreNodeList,
949 class WXDLLIMPEXP_ADV);
950
951 class WXDLLIMPEXP_ADV wxDataViewTreeStoreContainerNode: public wxDataViewTreeStoreNode
952 {
953 public:
954 wxDataViewTreeStoreContainerNode( wxDataViewTreeStoreNode *parent,
955 const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
956 wxClientData *data = NULL );
957 virtual ~wxDataViewTreeStoreContainerNode();
958
959 const wxDataViewTreeStoreNodeList &GetChildren() const
960 { return m_children; }
961 wxDataViewTreeStoreNodeList &GetChildren()
962 { return m_children; }
963
964 void SetExpandedIcon( const wxIcon &icon )
965 { m_iconExpanded = icon; }
966 const wxIcon &GetExpandedIcon() const
967 { return m_iconExpanded; }
968
969 void SetExpanded( bool expanded = true )
970 { m_isExpanded = expanded; }
971 bool IsExpanded() const
972 { return m_isExpanded; }
973
974 virtual bool IsContainer()
975 { return true; }
976
977 private:
978 wxDataViewTreeStoreNodeList m_children;
979 wxIcon m_iconExpanded;
980 bool m_isExpanded;
981 };
982
983 //-----------------------------------------------------------------------------
984
985 class WXDLLIMPEXP_ADV wxDataViewTreeStore: public wxDataViewModel
986 {
987 public:
988 wxDataViewTreeStore();
989 ~wxDataViewTreeStore();
990
991 wxDataViewItem AppendItem( const wxDataViewItem& parent,
992 const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
993 wxDataViewItem PrependItem( const wxDataViewItem& parent,
994 const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
995 wxDataViewItem InsertItem( const wxDataViewItem& parent, const wxDataViewItem& previous,
996 const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
997
998 wxDataViewItem PrependContainer( const wxDataViewItem& parent,
999 const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
1000 wxClientData *data = NULL );
1001 wxDataViewItem AppendContainer( const wxDataViewItem& parent,
1002 const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
1003 wxClientData *data = NULL );
1004 wxDataViewItem InsertContainer( const wxDataViewItem& parent, const wxDataViewItem& previous,
1005 const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
1006 wxClientData *data = NULL );
1007
1008 wxDataViewItem GetNthChild( const wxDataViewItem& parent, unsigned int pos ) const;
1009 int GetChildCount( const wxDataViewItem& parent ) const;
1010
1011 void SetItemText( const wxDataViewItem& item, const wxString &text );
1012 wxString GetItemText( const wxDataViewItem& item ) const;
1013 void SetItemIcon( const wxDataViewItem& item, const wxIcon &icon );
1014 const wxIcon &GetItemIcon( const wxDataViewItem& item ) const;
1015 void SetItemExpandedIcon( const wxDataViewItem& item, const wxIcon &icon );
1016 const wxIcon &GetItemExpandedIcon( const wxDataViewItem& item ) const;
1017 void SetItemData( const wxDataViewItem& item, wxClientData *data );
1018 wxClientData *GetItemData( const wxDataViewItem& item ) const;
1019
1020 void DeleteItem( const wxDataViewItem& item );
1021 void DeleteChildren( const wxDataViewItem& item );
1022 void DeleteAllItems();
1023
1024 // implement base methods
1025
1026 virtual void GetValue( wxVariant &variant,
1027 const wxDataViewItem &item, unsigned int col ) const;
1028 virtual bool SetValue( const wxVariant &variant,
1029 const wxDataViewItem &item, unsigned int col );
1030 virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const;
1031 virtual bool IsContainer( const wxDataViewItem &item ) const;
1032 virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
1033
1034 virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
1035 unsigned int column, bool ascending );
1036
1037 virtual bool HasDefaultCompare() const
1038 { return true; }
1039 virtual unsigned int GetColumnCount() const
1040 { return 1; };
1041 virtual wxString GetColumnType( unsigned int WXUNUSED(col) ) const
1042 { return wxT("wxDataViewIconText"); }
1043
1044 wxDataViewTreeStoreNode *FindNode( const wxDataViewItem &item ) const;
1045 wxDataViewTreeStoreContainerNode *FindContainerNode( const wxDataViewItem &item ) const;
1046 wxDataViewTreeStoreNode *GetRoot() const { return m_root; }
1047
1048 public:
1049 wxDataViewTreeStoreNode *m_root;
1050 };
1051
1052 class WXDLLIMPEXP_ADV wxDataViewTreeCtrl: public wxDataViewCtrl
1053 {
1054 public:
1055 wxDataViewTreeCtrl();
1056 wxDataViewTreeCtrl( wxWindow *parent, wxWindowID id,
1057 const wxPoint& pos = wxDefaultPosition,
1058 const wxSize& size = wxDefaultSize, long style = wxDV_NO_HEADER | wxDV_ROW_LINES,
1059 const wxValidator& validator = wxDefaultValidator );
1060 ~wxDataViewTreeCtrl();
1061
1062 bool Create( wxWindow *parent, wxWindowID id,
1063 const wxPoint& pos = wxDefaultPosition,
1064 const wxSize& size = wxDefaultSize, long style = wxDV_NO_HEADER | wxDV_ROW_LINES,
1065 const wxValidator& validator = wxDefaultValidator );
1066
1067 wxDataViewTreeStore *GetStore()
1068 { return (wxDataViewTreeStore*) GetModel(); }
1069 const wxDataViewTreeStore *GetStore() const
1070 { return (const wxDataViewTreeStore*) GetModel(); }
1071
1072 void SetImageList( wxImageList *imagelist );
1073 wxImageList* GetImageList() { return m_imageList; }
1074
1075 wxDataViewItem AppendItem( const wxDataViewItem& parent,
1076 const wxString &text, int icon = -1, wxClientData *data = NULL );
1077 wxDataViewItem PrependItem( const wxDataViewItem& parent,
1078 const wxString &text, int icon = -1, wxClientData *data = NULL );
1079 wxDataViewItem InsertItem( const wxDataViewItem& parent, const wxDataViewItem& previous,
1080 const wxString &text, int icon = -1, wxClientData *data = NULL );
1081
1082 wxDataViewItem PrependContainer( const wxDataViewItem& parent,
1083 const wxString &text, int icon = -1, int expanded = -1,
1084 wxClientData *data = NULL );
1085 wxDataViewItem AppendContainer( const wxDataViewItem& parent,
1086 const wxString &text, int icon = -1, int expanded = -1,
1087 wxClientData *data = NULL );
1088 wxDataViewItem InsertContainer( const wxDataViewItem& parent, const wxDataViewItem& previous,
1089 const wxString &text, int icon = -1, int expanded = -1,
1090 wxClientData *data = NULL );
1091
1092 wxDataViewItem GetNthChild( const wxDataViewItem& parent, unsigned int pos ) const
1093 { return GetStore()->GetNthChild(parent, pos); }
1094 int GetChildCount( const wxDataViewItem& parent ) const
1095 { return GetStore()->GetChildCount(parent); }
1096
1097 void SetItemText( const wxDataViewItem& item, const wxString &text )
1098 { GetStore()->SetItemText(item,text); }
1099 wxString GetItemText( const wxDataViewItem& item ) const
1100 { return GetStore()->GetItemText(item); }
1101 void SetItemIcon( const wxDataViewItem& item, const wxIcon &icon )
1102 { GetStore()->SetItemIcon(item,icon); }
1103 const wxIcon &GetItemIcon( const wxDataViewItem& item ) const
1104 { return GetStore()->GetItemIcon(item); }
1105 void SetItemExpandedIcon( const wxDataViewItem& item, const wxIcon &icon )
1106 { GetStore()->SetItemExpandedIcon(item,icon); }
1107 const wxIcon &GetItemExpandedIcon( const wxDataViewItem& item ) const
1108 { return GetStore()->GetItemExpandedIcon(item); }
1109 void SetItemData( const wxDataViewItem& item, wxClientData *data )
1110 { GetStore()->SetItemData(item,data); }
1111 wxClientData *GetItemData( const wxDataViewItem& item ) const
1112 { return GetStore()->GetItemData(item); }
1113
1114 void DeleteItem( const wxDataViewItem& item )
1115 { GetStore()->DeleteItem(item); }
1116 void DeleteChildren( const wxDataViewItem& item )
1117 { GetStore()->DeleteChildren(item); }
1118 void DeleteAllItems()
1119 { GetStore()->DeleteAllItems(); }
1120
1121 void OnExpanded( wxDataViewEvent &event );
1122 void OnCollapsed( wxDataViewEvent &event );
1123 void OnSize( wxSizeEvent &event );
1124
1125 private:
1126 wxImageList *m_imageList;
1127
1128 private:
1129 DECLARE_EVENT_TABLE()
1130 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewTreeCtrl)
1131 };
1132
1133 #endif // wxUSE_DATAVIEWCTRL
1134
1135 #endif
1136 // _WX_DATAVIEW_H_BASE_