1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxDataViewCtrl base classes
4 // Author: Robert Roebling
5 // Modified by: Bo Yang
8 // Copyright: (c) Robert Roebling
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_DATAVIEW_H_BASE_
13 #define _WX_DATAVIEW_H_BASE_
17 #if wxUSE_DATAVIEWCTRL
19 #include "wx/textctrl.h"
20 #include "wx/headercol.h"
21 #include "wx/variant.h"
22 #include "wx/dynarray.h"
24 #include "wx/weakref.h"
25 #include "wx/vector.h"
26 #include "wx/dataobj.h"
28 class WXDLLIMPEXP_FWD_CORE wxImageList
;
30 #if !(defined(__WXGTK20__) || defined(__WXOSX__)) || defined(__WXUNIVERSAL__)
31 // #if !(defined(__WXOSX__)) || defined(__WXUNIVERSAL__)
32 #define wxHAS_GENERIC_DATAVIEWCTRL
35 #ifdef wxHAS_GENERIC_DATAVIEWCTRL
36 // this symbol doesn't follow the convention for wxUSE_XXX symbols which
37 // are normally always defined as either 0 or 1, so its use is deprecated
38 // and it only exists for backwards compatibility, don't use it any more
39 // and use wxHAS_GENERIC_DATAVIEWCTRL instead
40 #define wxUSE_GENERICDATAVIEWCTRL
43 // ----------------------------------------------------------------------------
44 // wxDataViewCtrl globals
45 // ----------------------------------------------------------------------------
47 class WXDLLIMPEXP_FWD_ADV wxDataViewItem
;
48 class WXDLLIMPEXP_FWD_ADV wxDataViewModel
;
49 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl
;
50 class WXDLLIMPEXP_FWD_ADV wxDataViewColumn
;
51 class WXDLLIMPEXP_FWD_ADV wxDataViewRenderer
;
52 class WXDLLIMPEXP_FWD_ADV wxDataViewModelNotifier
;
54 extern WXDLLIMPEXP_DATA_ADV(const char) wxDataViewCtrlNameStr
[];
56 // ----------------------------------------------------------------------------
57 // wxDataViewCtrl flags
58 // ----------------------------------------------------------------------------
60 // size of a wxDataViewRenderer without contents:
61 #define wxDVC_DEFAULT_RENDERER_SIZE 20
63 // the default width of new (text) columns:
64 #define wxDVC_DEFAULT_WIDTH 80
66 // the default width of new toggle columns:
67 #define wxDVC_TOGGLE_DEFAULT_WIDTH 30
69 // the default minimal width of the columns:
70 #define wxDVC_DEFAULT_MINWIDTH 30
72 // The default alignment of wxDataViewRenderers is to take
73 // the alignment from the column it owns.
74 #define wxDVR_DEFAULT_ALIGNMENT -1
77 // ---------------------------------------------------------
79 // ---------------------------------------------------------
81 class WXDLLIMPEXP_ADV wxDataViewItem
84 wxDataViewItem( void* id
= NULL
)
86 wxDataViewItem( const wxDataViewItem
&item
)
88 bool IsOk() const { return m_id
!= NULL
; }
89 void* GetID() const { return m_id
; }
90 operator const void* () const { return m_id
; }
97 bool operator==(const wxDataViewItem
& left
, const wxDataViewItem
& right
)
99 return left
.GetID() == right
.GetID();
103 bool operator!=(const wxDataViewItem
& left
, const wxDataViewItem
& right
)
105 return !(left
== right
);
108 WX_DEFINE_ARRAY(wxDataViewItem
, wxDataViewItemArray
);
110 // ---------------------------------------------------------
111 // wxDataViewModelNotifier
112 // ---------------------------------------------------------
114 class WXDLLIMPEXP_ADV wxDataViewModelNotifier
117 wxDataViewModelNotifier() { m_owner
= NULL
; }
118 virtual ~wxDataViewModelNotifier() { m_owner
= NULL
; }
120 virtual bool ItemAdded( const wxDataViewItem
&parent
, const wxDataViewItem
&item
) = 0;
121 virtual bool ItemDeleted( const wxDataViewItem
&parent
, const wxDataViewItem
&item
) = 0;
122 virtual bool ItemChanged( const wxDataViewItem
&item
) = 0;
123 virtual bool ItemsAdded( const wxDataViewItem
&parent
, const wxDataViewItemArray
&items
);
124 virtual bool ItemsDeleted( const wxDataViewItem
&parent
, const wxDataViewItemArray
&items
);
125 virtual bool ItemsChanged( const wxDataViewItemArray
&items
);
126 virtual bool ValueChanged( const wxDataViewItem
&item
, unsigned int col
) = 0;
127 virtual bool Cleared() = 0;
129 // some platforms, such as GTK+, may need a two step procedure for ::Reset()
130 virtual bool BeforeReset() { return true; }
131 virtual bool AfterReset() { return Cleared(); }
133 virtual void Resort() = 0;
135 void SetOwner( wxDataViewModel
*owner
) { m_owner
= owner
; }
136 wxDataViewModel
*GetOwner() const { return m_owner
; }
139 wxDataViewModel
*m_owner
;
144 // ----------------------------------------------------------------------------
145 // wxDataViewItemAttr: a structure containing the visual attributes of an item
146 // ----------------------------------------------------------------------------
148 // TODO: this should be renamed to wxItemAttr or something general like this
150 class WXDLLIMPEXP_ADV wxDataViewItemAttr
161 void SetColour(const wxColour
& colour
) { m_colour
= colour
; }
162 void SetBold( bool set
) { m_bold
= set
; }
163 void SetItalic( bool set
) { m_italic
= set
; }
166 bool HasColour() const { return m_colour
.IsOk(); }
167 const wxColour
& GetColour() const { return m_colour
; }
169 bool HasFont() const { return m_bold
|| m_italic
; }
170 bool GetBold() const { return m_bold
; }
171 bool GetItalic() const { return m_italic
; }
173 bool IsDefault() const { return !(HasColour() || HasFont()); }
175 // Return the font based on the given one with this attribute applied to it.
176 wxFont
GetEffectiveFont(const wxFont
& font
) const;
185 // ---------------------------------------------------------
187 // ---------------------------------------------------------
189 WX_DECLARE_LIST_WITH_DECL(wxDataViewModelNotifier
, wxDataViewModelNotifiers
,
190 class WXDLLIMPEXP_ADV
);
192 class WXDLLIMPEXP_ADV wxDataViewModel
: public wxRefCounter
197 virtual unsigned int GetColumnCount() const = 0;
199 // return type as reported by wxVariant
200 virtual wxString
GetColumnType( unsigned int col
) const = 0;
202 // get value into a wxVariant
203 virtual void GetValue( wxVariant
&variant
,
204 const wxDataViewItem
&item
, unsigned int col
) const = 0;
206 // return true if the given item has a value to display in the given
207 // column: this is always true except for container items which by default
208 // only show their label in the first column (but see HasContainerColumns())
209 bool HasValue(const wxDataViewItem
& item
, unsigned col
) const
211 return col
== 0 || !IsContainer(item
) || HasContainerColumns(item
);
214 // usually ValueChanged() should be called after changing the value in the
215 // model to update the control, ChangeValue() does it on its own while
216 // SetValue() does not -- so while you will override SetValue(), you should
217 // be usually calling ChangeValue()
218 virtual bool SetValue(const wxVariant
&variant
,
219 const wxDataViewItem
&item
,
220 unsigned int col
) = 0;
222 bool ChangeValue(const wxVariant
& variant
,
223 const wxDataViewItem
& item
,
226 return SetValue(variant
, item
, col
) && ValueChanged(item
, col
);
229 // Get text attribute, return false of default attributes should be used
230 virtual bool GetAttr(const wxDataViewItem
&WXUNUSED(item
),
231 unsigned int WXUNUSED(col
),
232 wxDataViewItemAttr
&WXUNUSED(attr
)) const
237 // Override this if you want to disable specific items
238 virtual bool IsEnabled(const wxDataViewItem
&WXUNUSED(item
),
239 unsigned int WXUNUSED(col
)) const
245 virtual wxDataViewItem
GetParent( const wxDataViewItem
&item
) const = 0;
246 virtual bool IsContainer( const wxDataViewItem
&item
) const = 0;
247 // Is the container just a header or an item with all columns
248 virtual bool HasContainerColumns(const wxDataViewItem
& WXUNUSED(item
)) const
250 virtual unsigned int GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const = 0;
252 // delegated notifiers
253 bool ItemAdded( const wxDataViewItem
&parent
, const wxDataViewItem
&item
);
254 bool ItemsAdded( const wxDataViewItem
&parent
, const wxDataViewItemArray
&items
);
255 bool ItemDeleted( const wxDataViewItem
&parent
, const wxDataViewItem
&item
);
256 bool ItemsDeleted( const wxDataViewItem
&parent
, const wxDataViewItemArray
&items
);
257 bool ItemChanged( const wxDataViewItem
&item
);
258 bool ItemsChanged( const wxDataViewItemArray
&items
);
259 bool ValueChanged( const wxDataViewItem
&item
, unsigned int col
);
262 // some platforms, such as GTK+, may need a two step procedure for ::Reset()
268 virtual void Resort();
270 void AddNotifier( wxDataViewModelNotifier
*notifier
);
271 void RemoveNotifier( wxDataViewModelNotifier
*notifier
);
273 // default compare function
274 virtual int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
275 unsigned int column
, bool ascending
) const;
276 virtual bool HasDefaultCompare() const { return false; }
279 virtual bool IsListModel() const { return false; }
280 virtual bool IsVirtualListModel() const { return false; }
283 // the user should not delete this class directly: he should use DecRef() instead!
284 virtual ~wxDataViewModel() { }
286 wxDataViewModelNotifiers m_notifiers
;
289 // ----------------------------------------------------------------------------
290 // wxDataViewListModel: a model of a list, i.e. flat data structure without any
291 // branches/containers, used as base class by wxDataViewIndexListModel and
292 // wxDataViewVirtualListModel
293 // ----------------------------------------------------------------------------
295 class WXDLLIMPEXP_ADV wxDataViewListModel
: public wxDataViewModel
298 // derived classes should override these methods instead of
299 // {Get,Set}Value() and GetAttr() inherited from the base class
301 virtual void GetValueByRow(wxVariant
&variant
,
302 unsigned row
, unsigned col
) const = 0;
304 virtual bool SetValueByRow(const wxVariant
&variant
,
305 unsigned row
, unsigned col
) = 0;
308 GetAttrByRow(unsigned WXUNUSED(row
), unsigned WXUNUSED(col
),
309 wxDataViewItemAttr
&WXUNUSED(attr
)) const
314 virtual bool IsEnabledByRow(unsigned int WXUNUSED(row
),
315 unsigned int WXUNUSED(col
)) const
321 // helper methods provided by list models only
322 virtual unsigned GetRow( const wxDataViewItem
&item
) const = 0;
324 // returns the number of rows
325 virtual unsigned int GetCount() const = 0;
327 // implement some base class pure virtual directly
328 virtual wxDataViewItem
329 GetParent( const wxDataViewItem
& WXUNUSED(item
) ) const
331 // items never have valid parent in this model
332 return wxDataViewItem();
335 virtual bool IsContainer( const wxDataViewItem
&item
) const
337 // only the invisible (and invalid) root item has children
341 // and implement some others by forwarding them to our own ones
342 virtual void GetValue( wxVariant
&variant
,
343 const wxDataViewItem
&item
, unsigned int col
) const
345 GetValueByRow(variant
, GetRow(item
), col
);
348 virtual bool SetValue( const wxVariant
&variant
,
349 const wxDataViewItem
&item
, unsigned int col
)
351 return SetValueByRow( variant
, GetRow(item
), col
);
354 virtual bool GetAttr(const wxDataViewItem
&item
, unsigned int col
,
355 wxDataViewItemAttr
&attr
) const
357 return GetAttrByRow( GetRow(item
), col
, attr
);
360 virtual bool IsEnabled(const wxDataViewItem
&item
, unsigned int col
) const
362 return IsEnabledByRow( GetRow(item
), col
);
366 virtual bool IsListModel() const { return true; }
369 // ---------------------------------------------------------
370 // wxDataViewIndexListModel
371 // ---------------------------------------------------------
373 class WXDLLIMPEXP_ADV wxDataViewIndexListModel
: public wxDataViewListModel
376 wxDataViewIndexListModel( unsigned int initial_size
= 0 );
379 void RowInserted( unsigned int before
);
381 void RowDeleted( unsigned int row
);
382 void RowsDeleted( const wxArrayInt
&rows
);
383 void RowChanged( unsigned int row
);
384 void RowValueChanged( unsigned int row
, unsigned int col
);
385 void Reset( unsigned int new_size
);
387 // convert to/from row/wxDataViewItem
389 virtual unsigned GetRow( const wxDataViewItem
&item
) const;
390 wxDataViewItem
GetItem( unsigned int row
) const;
392 // compare based on index
394 virtual int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
395 unsigned int column
, bool ascending
) const;
396 virtual bool HasDefaultCompare() const;
398 // implement base methods
399 virtual unsigned int GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const;
401 unsigned int GetCount() const { return m_hash
.GetCount(); }
404 wxDataViewItemArray m_hash
;
405 unsigned int m_nextFreeID
;
409 // ---------------------------------------------------------
410 // wxDataViewVirtualListModel
411 // ---------------------------------------------------------
414 // better than nothing
415 typedef wxDataViewIndexListModel wxDataViewVirtualListModel
;
418 class WXDLLIMPEXP_ADV wxDataViewVirtualListModel
: public wxDataViewListModel
421 wxDataViewVirtualListModel( unsigned int initial_size
= 0 );
424 void RowInserted( unsigned int before
);
426 void RowDeleted( unsigned int row
);
427 void RowsDeleted( const wxArrayInt
&rows
);
428 void RowChanged( unsigned int row
);
429 void RowValueChanged( unsigned int row
, unsigned int col
);
430 void Reset( unsigned int new_size
);
432 // convert to/from row/wxDataViewItem
434 virtual unsigned GetRow( const wxDataViewItem
&item
) const;
435 wxDataViewItem
GetItem( unsigned int row
) const;
437 // compare based on index
439 virtual int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
440 unsigned int column
, bool ascending
) const;
441 virtual bool HasDefaultCompare() const;
443 // implement base methods
444 virtual unsigned int GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const;
446 unsigned int GetCount() const { return m_size
; }
449 virtual bool IsVirtualListModel() const { return true; }
457 // ----------------------------------------------------------------------------
458 // wxDataViewRenderer and related classes
459 // ----------------------------------------------------------------------------
461 #include "wx/dvrenderers.h"
463 // ---------------------------------------------------------
464 // wxDataViewColumnBase
465 // ---------------------------------------------------------
467 // for compatibility only, do not use
468 enum wxDataViewColumnFlags
470 wxDATAVIEW_COL_RESIZABLE
= wxCOL_RESIZABLE
,
471 wxDATAVIEW_COL_SORTABLE
= wxCOL_SORTABLE
,
472 wxDATAVIEW_COL_REORDERABLE
= wxCOL_REORDERABLE
,
473 wxDATAVIEW_COL_HIDDEN
= wxCOL_HIDDEN
476 class WXDLLIMPEXP_ADV wxDataViewColumnBase
: public wxSettableHeaderColumn
479 // ctor for the text columns: takes ownership of renderer
480 wxDataViewColumnBase(wxDataViewRenderer
*renderer
,
481 unsigned int model_column
)
483 Init(renderer
, model_column
);
486 // ctor for the bitmap columns
487 wxDataViewColumnBase(const wxBitmap
& bitmap
,
488 wxDataViewRenderer
*renderer
,
489 unsigned int model_column
)
492 Init(renderer
, model_column
);
495 virtual ~wxDataViewColumnBase();
498 virtual void SetOwner( wxDataViewCtrl
*owner
)
502 unsigned int GetModelColumn() const { return static_cast<unsigned int>(m_model_column
); }
503 wxDataViewCtrl
*GetOwner() const { return m_owner
; }
504 wxDataViewRenderer
* GetRenderer() const { return m_renderer
; }
506 // implement some of base class pure virtuals (the rest is port-dependent
507 // and done differently in generic and native versions)
508 virtual void SetBitmap( const wxBitmap
& bitmap
) { m_bitmap
= bitmap
; }
509 virtual wxBitmap
GetBitmap() const { return m_bitmap
; }
512 wxDataViewRenderer
*m_renderer
;
515 wxDataViewCtrl
*m_owner
;
518 // common part of all ctors
519 void Init(wxDataViewRenderer
*renderer
, unsigned int model_column
);
522 // ---------------------------------------------------------
523 // wxDataViewCtrlBase
524 // ---------------------------------------------------------
526 #define wxDV_SINGLE 0x0000 // for convenience
527 #define wxDV_MULTIPLE 0x0001 // can select multiple items
529 #define wxDV_NO_HEADER 0x0002 // column titles not visible
530 #define wxDV_HORIZ_RULES 0x0004 // light horizontal rules between rows
531 #define wxDV_VERT_RULES 0x0008 // light vertical rules between columns
533 #define wxDV_ROW_LINES 0x0010 // alternating colour in rows
534 #define wxDV_VARIABLE_LINE_HEIGHT 0x0020 // variable line height
536 class WXDLLIMPEXP_ADV wxDataViewCtrlBase
: public wxControl
539 wxDataViewCtrlBase();
540 virtual ~wxDataViewCtrlBase();
545 virtual bool AssociateModel( wxDataViewModel
*model
);
546 wxDataViewModel
* GetModel();
547 const wxDataViewModel
* GetModel() const;
553 wxDataViewColumn
*PrependTextColumn( const wxString
&label
, unsigned int model_column
,
554 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
555 wxAlignment align
= wxALIGN_NOT
,
556 int flags
= wxDATAVIEW_COL_RESIZABLE
);
557 wxDataViewColumn
*PrependIconTextColumn( const wxString
&label
, unsigned int model_column
,
558 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
559 wxAlignment align
= wxALIGN_NOT
,
560 int flags
= wxDATAVIEW_COL_RESIZABLE
);
561 wxDataViewColumn
*PrependToggleColumn( const wxString
&label
, unsigned int model_column
,
562 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
563 wxAlignment align
= wxALIGN_CENTER
,
564 int flags
= wxDATAVIEW_COL_RESIZABLE
);
565 wxDataViewColumn
*PrependProgressColumn( const wxString
&label
, unsigned int model_column
,
566 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
567 wxAlignment align
= wxALIGN_CENTER
,
568 int flags
= wxDATAVIEW_COL_RESIZABLE
);
569 wxDataViewColumn
*PrependDateColumn( const wxString
&label
, unsigned int model_column
,
570 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
571 wxAlignment align
= wxALIGN_NOT
,
572 int flags
= wxDATAVIEW_COL_RESIZABLE
);
573 wxDataViewColumn
*PrependBitmapColumn( const wxString
&label
, unsigned int model_column
,
574 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
575 wxAlignment align
= wxALIGN_CENTER
,
576 int flags
= wxDATAVIEW_COL_RESIZABLE
);
577 wxDataViewColumn
*PrependTextColumn( const wxBitmap
&label
, unsigned int model_column
,
578 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
579 wxAlignment align
= wxALIGN_NOT
,
580 int flags
= wxDATAVIEW_COL_RESIZABLE
);
581 wxDataViewColumn
*PrependIconTextColumn( const wxBitmap
&label
, unsigned int model_column
,
582 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
583 wxAlignment align
= wxALIGN_NOT
,
584 int flags
= wxDATAVIEW_COL_RESIZABLE
);
585 wxDataViewColumn
*PrependToggleColumn( const wxBitmap
&label
, unsigned int model_column
,
586 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
587 wxAlignment align
= wxALIGN_CENTER
,
588 int flags
= wxDATAVIEW_COL_RESIZABLE
);
589 wxDataViewColumn
*PrependProgressColumn( const wxBitmap
&label
, unsigned int model_column
,
590 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
591 wxAlignment align
= wxALIGN_CENTER
,
592 int flags
= wxDATAVIEW_COL_RESIZABLE
);
593 wxDataViewColumn
*PrependDateColumn( const wxBitmap
&label
, unsigned int model_column
,
594 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
595 wxAlignment align
= wxALIGN_NOT
,
596 int flags
= wxDATAVIEW_COL_RESIZABLE
);
597 wxDataViewColumn
*PrependBitmapColumn( const wxBitmap
&label
, unsigned int model_column
,
598 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
599 wxAlignment align
= wxALIGN_CENTER
,
600 int flags
= wxDATAVIEW_COL_RESIZABLE
);
602 wxDataViewColumn
*AppendTextColumn( const wxString
&label
, unsigned int model_column
,
603 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
604 wxAlignment align
= wxALIGN_NOT
,
605 int flags
= wxDATAVIEW_COL_RESIZABLE
);
606 wxDataViewColumn
*AppendIconTextColumn( const wxString
&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
*AppendToggleColumn( const wxString
&label
, unsigned int model_column
,
611 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
612 wxAlignment align
= wxALIGN_CENTER
,
613 int flags
= wxDATAVIEW_COL_RESIZABLE
);
614 wxDataViewColumn
*AppendProgressColumn( const wxString
&label
, unsigned int model_column
,
615 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
616 wxAlignment align
= wxALIGN_CENTER
,
617 int flags
= wxDATAVIEW_COL_RESIZABLE
);
618 wxDataViewColumn
*AppendDateColumn( const wxString
&label
, unsigned int model_column
,
619 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
620 wxAlignment align
= wxALIGN_NOT
,
621 int flags
= wxDATAVIEW_COL_RESIZABLE
);
622 wxDataViewColumn
*AppendBitmapColumn( const wxString
&label
, unsigned int model_column
,
623 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
624 wxAlignment align
= wxALIGN_CENTER
,
625 int flags
= wxDATAVIEW_COL_RESIZABLE
);
626 wxDataViewColumn
*AppendTextColumn( const wxBitmap
&label
, unsigned int model_column
,
627 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
628 wxAlignment align
= wxALIGN_NOT
,
629 int flags
= wxDATAVIEW_COL_RESIZABLE
);
630 wxDataViewColumn
*AppendIconTextColumn( const wxBitmap
&label
, unsigned int model_column
,
631 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
632 wxAlignment align
= wxALIGN_NOT
,
633 int flags
= wxDATAVIEW_COL_RESIZABLE
);
634 wxDataViewColumn
*AppendToggleColumn( const wxBitmap
&label
, unsigned int model_column
,
635 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
636 wxAlignment align
= wxALIGN_CENTER
,
637 int flags
= wxDATAVIEW_COL_RESIZABLE
);
638 wxDataViewColumn
*AppendProgressColumn( const wxBitmap
&label
, unsigned int model_column
,
639 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
640 wxAlignment align
= wxALIGN_CENTER
,
641 int flags
= wxDATAVIEW_COL_RESIZABLE
);
642 wxDataViewColumn
*AppendDateColumn( const wxBitmap
&label
, unsigned int model_column
,
643 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
644 wxAlignment align
= wxALIGN_NOT
,
645 int flags
= wxDATAVIEW_COL_RESIZABLE
);
646 wxDataViewColumn
*AppendBitmapColumn( const wxBitmap
&label
, unsigned int model_column
,
647 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
648 wxAlignment align
= wxALIGN_CENTER
,
649 int flags
= wxDATAVIEW_COL_RESIZABLE
);
651 virtual bool PrependColumn( wxDataViewColumn
*col
);
652 virtual bool InsertColumn( unsigned int pos
, wxDataViewColumn
*col
);
653 virtual bool AppendColumn( wxDataViewColumn
*col
);
655 virtual unsigned int GetColumnCount() const = 0;
656 virtual wxDataViewColumn
* GetColumn( unsigned int pos
) const = 0;
657 virtual int GetColumnPosition( const wxDataViewColumn
*column
) const = 0;
659 virtual bool DeleteColumn( wxDataViewColumn
*column
) = 0;
660 virtual bool ClearColumns() = 0;
662 void SetExpanderColumn( wxDataViewColumn
*col
)
663 { m_expander_column
= col
; DoSetExpanderColumn(); }
664 wxDataViewColumn
*GetExpanderColumn() const
665 { return m_expander_column
; }
667 virtual wxDataViewColumn
*GetSortingColumn() const = 0;
673 void SetIndent( int indent
)
674 { m_indent
= indent
; DoSetIndent(); }
675 int GetIndent() const
678 // Current item is the one used by the keyboard navigation, it is the same
679 // as the (unique) selected item in single selection mode so these
680 // functions are mostly useful for controls with wxDV_MULTIPLE style.
681 wxDataViewItem
GetCurrentItem() const;
682 void SetCurrentItem(const wxDataViewItem
& item
);
684 virtual wxDataViewItem
GetSelection() const = 0;
685 virtual int GetSelections( wxDataViewItemArray
& sel
) const = 0;
686 virtual void SetSelections( const wxDataViewItemArray
& sel
) = 0;
687 virtual void Select( const wxDataViewItem
& item
) = 0;
688 virtual void Unselect( const wxDataViewItem
& item
) = 0;
689 virtual bool IsSelected( const wxDataViewItem
& item
) const = 0;
691 virtual void SelectAll() = 0;
692 virtual void UnselectAll() = 0;
694 virtual void Expand( const wxDataViewItem
& item
) = 0;
695 virtual void ExpandAncestors( const wxDataViewItem
& item
);
696 virtual void Collapse( const wxDataViewItem
& item
) = 0;
697 virtual bool IsExpanded( const wxDataViewItem
& item
) const = 0;
699 virtual void EnsureVisible( const wxDataViewItem
& item
,
700 const wxDataViewColumn
*column
= NULL
) = 0;
701 virtual void HitTest( const wxPoint
& point
, wxDataViewItem
&item
, wxDataViewColumn
* &column
) const = 0;
702 virtual wxRect
GetItemRect( const wxDataViewItem
& item
, const wxDataViewColumn
*column
= NULL
) const = 0;
704 virtual bool SetRowHeight( int WXUNUSED(rowHeight
) ) { return false; }
706 virtual void StartEditor( const wxDataViewItem
& WXUNUSED(item
),
707 unsigned int WXUNUSED(column
) )
710 #if wxUSE_DRAG_AND_DROP
711 virtual bool EnableDragSource(const wxDataFormat
& WXUNUSED(format
))
713 virtual bool EnableDropTarget(const wxDataFormat
& WXUNUSED(format
))
715 #endif // wxUSE_DRAG_AND_DROP
717 // define control visual attributes
718 // --------------------------------
720 virtual wxVisualAttributes
GetDefaultAttributes() const
722 return GetClassDefaultAttributes(GetWindowVariant());
725 static wxVisualAttributes
726 GetClassDefaultAttributes(wxWindowVariant variant
= wxWINDOW_VARIANT_NORMAL
)
728 return wxControl::GetCompositeControlsDefaultAttributes(variant
);
732 virtual void DoSetExpanderColumn() = 0 ;
733 virtual void DoSetIndent() = 0;
736 // Implementation of the public Set/GetCurrentItem() methods which are only
737 // called in multi selection case (for single selection controls their
738 // implementation is trivial and is done in the base class itself).
739 virtual wxDataViewItem
DoGetCurrentItem() const = 0;
740 virtual void DoSetCurrentItem(const wxDataViewItem
& item
) = 0;
742 wxDataViewModel
*m_model
;
743 wxDataViewColumn
*m_expander_column
;
747 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase
)
750 // ----------------------------------------------------------------------------
751 // wxDataViewEvent - the event class for the wxDataViewCtrl notifications
752 // ----------------------------------------------------------------------------
754 class WXDLLIMPEXP_ADV wxDataViewEvent
: public wxNotifyEvent
757 wxDataViewEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
758 : wxNotifyEvent(commandType
, winid
),
762 m_value(wxNullVariant
),
767 #if wxUSE_DRAG_AND_DROP
768 , m_dataObject(NULL
),
774 wxDataViewEvent(const wxDataViewEvent
& event
)
775 : wxNotifyEvent(event
),
776 m_item(event
.m_item
),
778 m_model(event
.m_model
),
779 m_value(event
.m_value
),
780 m_column(event
.m_column
),
782 m_cacheFrom(event
.m_cacheFrom
),
783 m_cacheTo(event
.m_cacheTo
)
784 #if wxUSE_DRAG_AND_DROP
785 , m_dataObject(event
.m_dataObject
),
786 m_dataFormat(event
.m_dataFormat
),
787 m_dataBuffer(event
.m_dataBuffer
),
788 m_dataSize(event
.m_dataSize
)
792 wxDataViewItem
GetItem() const { return m_item
; }
793 void SetItem( const wxDataViewItem
&item
) { m_item
= item
; }
795 int GetColumn() const { return m_col
; }
796 void SetColumn( int col
) { m_col
= col
; }
798 wxDataViewModel
* GetModel() const { return m_model
; }
799 void SetModel( wxDataViewModel
*model
) { m_model
= model
; }
801 const wxVariant
&GetValue() const { return m_value
; }
802 void SetValue( const wxVariant
&value
) { m_value
= value
; }
804 // for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only
805 void SetDataViewColumn( wxDataViewColumn
*col
) { m_column
= col
; }
806 wxDataViewColumn
*GetDataViewColumn() const { return m_column
; }
808 // for wxEVT_DATAVIEW_CONTEXT_MENU only
809 wxPoint
GetPosition() const { return m_pos
; }
810 void SetPosition( int x
, int y
) { m_pos
.x
= x
; m_pos
.y
= y
; }
812 // For wxEVT_COMMAND_DATAVIEW_CACHE_HINT
813 int GetCacheFrom() const { return m_cacheFrom
; }
814 int GetCacheTo() const { return m_cacheTo
; }
815 void SetCache(int from
, int to
) { m_cacheFrom
= from
; m_cacheTo
= to
; }
818 #if wxUSE_DRAG_AND_DROP
819 // For drag operations
820 void SetDataObject( wxDataObject
*obj
) { m_dataObject
= obj
; }
821 wxDataObject
*GetDataObject() const { return m_dataObject
; }
823 // For drop operations
824 void SetDataFormat( const wxDataFormat
&format
) { m_dataFormat
= format
; }
825 wxDataFormat
GetDataFormat() const { return m_dataFormat
; }
826 void SetDataSize( size_t size
) { m_dataSize
= size
; }
827 size_t GetDataSize() const { return m_dataSize
; }
828 void SetDataBuffer( void* buf
) { m_dataBuffer
= buf
;}
829 void *GetDataBuffer() const { return m_dataBuffer
; }
830 #endif // wxUSE_DRAG_AND_DROP
832 virtual wxEvent
*Clone() const { return new wxDataViewEvent(*this); }
835 wxDataViewItem m_item
;
837 wxDataViewModel
*m_model
;
839 wxDataViewColumn
*m_column
;
844 #if wxUSE_DRAG_AND_DROP
845 wxDataObject
*m_dataObject
;
847 wxDataFormat m_dataFormat
;
850 #endif // wxUSE_DRAG_AND_DROP
853 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent
)
856 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED
, wxDataViewEvent
);
858 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED
, wxDataViewEvent
);
859 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED
, wxDataViewEvent
);
860 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED
, wxDataViewEvent
);
861 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING
, wxDataViewEvent
);
862 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING
, wxDataViewEvent
);
863 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_START_EDITING
, wxDataViewEvent
);
864 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED
, wxDataViewEvent
);
865 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE
, wxDataViewEvent
);
866 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED
, wxDataViewEvent
);
868 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU
, wxDataViewEvent
);
870 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK
, wxDataViewEvent
);
871 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK
, wxDataViewEvent
);
872 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED
, wxDataViewEvent
);
873 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED
, wxDataViewEvent
);
875 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_CACHE_HINT
, wxDataViewEvent
);
877 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_BEGIN_DRAG
, wxDataViewEvent
);
878 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_DROP_POSSIBLE
, wxDataViewEvent
);
879 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_DROP
, wxDataViewEvent
);
881 typedef void (wxEvtHandler::*wxDataViewEventFunction
)(wxDataViewEvent
&);
883 #define wxDataViewEventHandler(func) \
884 wxEVENT_HANDLER_CAST(wxDataViewEventFunction, func)
886 #define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \
887 wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn))
889 #define EVT_DATAVIEW_SELECTION_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(SELECTION_CHANGED, id, fn)
891 #define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_ACTIVATED, id, fn)
892 #define EVT_DATAVIEW_ITEM_COLLAPSING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSING, id, fn)
893 #define EVT_DATAVIEW_ITEM_COLLAPSED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSED, id, fn)
894 #define EVT_DATAVIEW_ITEM_EXPANDING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDING, id, fn)
895 #define EVT_DATAVIEW_ITEM_EXPANDED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDED, id, fn)
896 #define EVT_DATAVIEW_ITEM_START_EDITING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_START_EDITING, id, fn)
897 #define EVT_DATAVIEW_ITEM_EDITING_STARTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_STARTED, id, fn)
898 #define EVT_DATAVIEW_ITEM_EDITING_DONE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_DONE, id, fn)
899 #define EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_VALUE_CHANGED, id, fn)
901 #define EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_CONTEXT_MENU, id, fn)
903 #define EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_CLICK, id, fn)
904 #define EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_RIGHT_CLICK, id, fn)
905 #define EVT_DATAVIEW_COLUMN_SORTED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_SORTED, id, fn)
906 #define EVT_DATAVIEW_COLUMN_REORDERED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_REORDERED, id, fn)
907 #define EVT_DATAVIEW_CACHE_HINT(id, fn) wx__DECLARE_DATAVIEWEVT(CACHE_HINT, id, fn)
909 #define EVT_DATAVIEW_ITEM_BEGIN_DRAG(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_BEGIN_DRAG, id, fn)
910 #define EVT_DATAVIEW_ITEM_DROP_POSSIBLE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_DROP_POSSIBLE, id, fn)
911 #define EVT_DATAVIEW_ITEM_DROP(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_DROP, id, fn)
913 #ifdef wxHAS_GENERIC_DATAVIEWCTRL
914 #include "wx/generic/dataview.h"
915 #elif defined(__WXGTK20__)
916 #include "wx/gtk/dataview.h"
917 #elif defined(__WXMAC__)
918 #include "wx/osx/dataview.h"
920 #error "unknown native wxDataViewCtrl implementation"
923 //-----------------------------------------------------------------------------
924 // wxDataViewListStore
925 //-----------------------------------------------------------------------------
927 class WXDLLIMPEXP_ADV wxDataViewListStoreLine
930 wxDataViewListStoreLine( wxClientData
*data
= NULL
)
934 virtual ~wxDataViewListStoreLine()
939 void SetData( wxClientData
*data
)
940 { if (m_data
) delete m_data
; m_data
= data
; }
941 wxClientData
*GetData() const
944 wxVector
<wxVariant
> m_values
;
947 wxClientData
*m_data
;
951 class WXDLLIMPEXP_ADV wxDataViewListStore
: public wxDataViewIndexListModel
954 wxDataViewListStore();
955 ~wxDataViewListStore();
957 void PrependColumn( const wxString
&varianttype
);
958 void InsertColumn( unsigned int pos
, const wxString
&varianttype
);
959 void AppendColumn( const wxString
&varianttype
);
961 void AppendItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
962 void PrependItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
963 void InsertItem( unsigned int row
, const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
964 void DeleteItem( unsigned int pos
);
965 void DeleteAllItems();
967 // override base virtuals
969 virtual unsigned int GetColumnCount() const;
971 virtual wxString
GetColumnType( unsigned int col
) const;
973 virtual void GetValueByRow( wxVariant
&value
,
974 unsigned int row
, unsigned int col
) const;
976 virtual bool SetValueByRow( const wxVariant
&value
,
977 unsigned int row
, unsigned int col
);
981 wxVector
<wxDataViewListStoreLine
*> m_data
;
982 wxArrayString m_cols
;
985 //-----------------------------------------------------------------------------
987 class WXDLLIMPEXP_ADV wxDataViewListCtrl
: public wxDataViewCtrl
990 wxDataViewListCtrl();
991 wxDataViewListCtrl( wxWindow
*parent
, wxWindowID id
,
992 const wxPoint
& pos
= wxDefaultPosition
,
993 const wxSize
& size
= wxDefaultSize
, long style
= wxDV_ROW_LINES
,
994 const wxValidator
& validator
= wxDefaultValidator
);
995 ~wxDataViewListCtrl();
997 bool Create( wxWindow
*parent
, wxWindowID id
,
998 const wxPoint
& pos
= wxDefaultPosition
,
999 const wxSize
& size
= wxDefaultSize
, long style
= wxDV_ROW_LINES
,
1000 const wxValidator
& validator
= wxDefaultValidator
);
1002 wxDataViewListStore
*GetStore()
1003 { return (wxDataViewListStore
*) GetModel(); }
1004 const wxDataViewListStore
*GetStore() const
1005 { return (const wxDataViewListStore
*) GetModel(); }
1007 int ItemToRow(const wxDataViewItem
&item
) const
1008 { return item
.IsOk() ? (int)GetStore()->GetRow(item
) : wxNOT_FOUND
; }
1009 wxDataViewItem
RowToItem(int row
) const
1010 { return row
== wxNOT_FOUND
? wxDataViewItem() : GetStore()->GetItem(row
); }
1012 int GetSelectedRow() const
1013 { return ItemToRow(GetSelection()); }
1014 void SelectRow(unsigned row
)
1015 { Select(RowToItem(row
)); }
1016 void UnselectRow(unsigned row
)
1017 { Unselect(RowToItem(row
)); }
1018 bool IsRowSelected(unsigned row
) const
1019 { return IsSelected(RowToItem(row
)); }
1021 bool AppendColumn( wxDataViewColumn
*column
, const wxString
&varianttype
);
1022 bool PrependColumn( wxDataViewColumn
*column
, const wxString
&varianttype
);
1023 bool InsertColumn( unsigned int pos
, wxDataViewColumn
*column
, const wxString
&varianttype
);
1025 // overridden from base class
1026 virtual bool PrependColumn( wxDataViewColumn
*col
);
1027 virtual bool InsertColumn( unsigned int pos
, wxDataViewColumn
*col
);
1028 virtual bool AppendColumn( wxDataViewColumn
*col
);
1030 wxDataViewColumn
*AppendTextColumn( const wxString
&label
,
1031 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1032 int width
= -1, wxAlignment align
= wxALIGN_LEFT
, int flags
= wxDATAVIEW_COL_RESIZABLE
);
1033 wxDataViewColumn
*AppendToggleColumn( const wxString
&label
,
1034 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
,
1035 int width
= -1, wxAlignment align
= wxALIGN_LEFT
, int flags
= wxDATAVIEW_COL_RESIZABLE
);
1036 wxDataViewColumn
*AppendProgressColumn( const wxString
&label
,
1037 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1038 int width
= -1, wxAlignment align
= wxALIGN_LEFT
, int flags
= wxDATAVIEW_COL_RESIZABLE
);
1039 wxDataViewColumn
*AppendIconTextColumn( const wxString
&label
,
1040 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1041 int width
= -1, wxAlignment align
= wxALIGN_LEFT
, int flags
= wxDATAVIEW_COL_RESIZABLE
);
1043 void AppendItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
)
1044 { GetStore()->AppendItem( values
, data
); }
1045 void PrependItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
)
1046 { GetStore()->PrependItem( values
, data
); }
1047 void InsertItem( unsigned int row
, const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
)
1048 { GetStore()->InsertItem( row
, values
, data
); }
1049 void DeleteItem( unsigned row
)
1050 { GetStore()->DeleteItem( row
); }
1051 void DeleteAllItems()
1052 { GetStore()->DeleteAllItems(); }
1054 void SetValue( const wxVariant
&value
, unsigned int row
, unsigned int col
)
1055 { GetStore()->SetValueByRow( value
, row
, col
);
1056 GetStore()->RowValueChanged( row
, col
); }
1057 void GetValue( wxVariant
&value
, unsigned int row
, unsigned int col
)
1058 { GetStore()->GetValueByRow( value
, row
, col
); }
1060 void SetTextValue( const wxString
&value
, unsigned int row
, unsigned int col
)
1061 { GetStore()->SetValueByRow( value
, row
, col
);
1062 GetStore()->RowValueChanged( row
, col
); }
1063 wxString
GetTextValue( unsigned int row
, unsigned int col
) const
1064 { wxVariant value
; GetStore()->GetValueByRow( value
, row
, col
); return value
.GetString(); }
1066 void SetToggleValue( bool value
, unsigned int row
, unsigned int col
)
1067 { GetStore()->SetValueByRow( value
, row
, col
);
1068 GetStore()->RowValueChanged( row
, col
); }
1069 bool GetToggleValue( unsigned int row
, unsigned int col
) const
1070 { wxVariant value
; GetStore()->GetValueByRow( value
, row
, col
); return value
.GetBool(); }
1072 void OnSize( wxSizeEvent
&event
);
1075 DECLARE_EVENT_TABLE()
1076 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewListCtrl
)
1079 //-----------------------------------------------------------------------------
1080 // wxDataViewTreeStore
1081 //-----------------------------------------------------------------------------
1083 class WXDLLIMPEXP_ADV wxDataViewTreeStoreNode
1086 wxDataViewTreeStoreNode( wxDataViewTreeStoreNode
*parent
,
1087 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, wxClientData
*data
= NULL
);
1088 virtual ~wxDataViewTreeStoreNode();
1090 void SetText( const wxString
&text
)
1092 wxString
GetText() const
1094 void SetIcon( const wxIcon
&icon
)
1096 const wxIcon
&GetIcon() const
1098 void SetData( wxClientData
*data
)
1099 { if (m_data
) delete m_data
; m_data
= data
; }
1100 wxClientData
*GetData() const
1103 wxDataViewItem
GetItem() const
1104 { return wxDataViewItem( (void*) this ); }
1106 virtual bool IsContainer()
1109 wxDataViewTreeStoreNode
*GetParent()
1110 { return m_parent
; }
1113 wxDataViewTreeStoreNode
*m_parent
;
1116 wxClientData
*m_data
;
1119 WX_DECLARE_LIST_WITH_DECL(wxDataViewTreeStoreNode
, wxDataViewTreeStoreNodeList
,
1120 class WXDLLIMPEXP_ADV
);
1122 class WXDLLIMPEXP_ADV wxDataViewTreeStoreContainerNode
: public wxDataViewTreeStoreNode
1125 wxDataViewTreeStoreContainerNode( wxDataViewTreeStoreNode
*parent
,
1126 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, const wxIcon
&expanded
= wxNullIcon
,
1127 wxClientData
*data
= NULL
);
1128 virtual ~wxDataViewTreeStoreContainerNode();
1130 const wxDataViewTreeStoreNodeList
&GetChildren() const
1131 { return m_children
; }
1132 wxDataViewTreeStoreNodeList
&GetChildren()
1133 { return m_children
; }
1135 void SetExpandedIcon( const wxIcon
&icon
)
1136 { m_iconExpanded
= icon
; }
1137 const wxIcon
&GetExpandedIcon() const
1138 { return m_iconExpanded
; }
1140 void SetExpanded( bool expanded
= true )
1141 { m_isExpanded
= expanded
; }
1142 bool IsExpanded() const
1143 { return m_isExpanded
; }
1145 virtual bool IsContainer()
1149 wxDataViewTreeStoreNodeList m_children
;
1150 wxIcon m_iconExpanded
;
1154 //-----------------------------------------------------------------------------
1156 class WXDLLIMPEXP_ADV wxDataViewTreeStore
: public wxDataViewModel
1159 wxDataViewTreeStore();
1160 ~wxDataViewTreeStore();
1162 wxDataViewItem
AppendItem( const wxDataViewItem
& parent
,
1163 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, wxClientData
*data
= NULL
);
1164 wxDataViewItem
PrependItem( const wxDataViewItem
& parent
,
1165 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, wxClientData
*data
= NULL
);
1166 wxDataViewItem
InsertItem( const wxDataViewItem
& parent
, const wxDataViewItem
& previous
,
1167 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, wxClientData
*data
= NULL
);
1169 wxDataViewItem
PrependContainer( const wxDataViewItem
& parent
,
1170 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, const wxIcon
&expanded
= wxNullIcon
,
1171 wxClientData
*data
= NULL
);
1172 wxDataViewItem
AppendContainer( const wxDataViewItem
& parent
,
1173 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, const wxIcon
&expanded
= wxNullIcon
,
1174 wxClientData
*data
= NULL
);
1175 wxDataViewItem
InsertContainer( const wxDataViewItem
& parent
, const wxDataViewItem
& previous
,
1176 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, const wxIcon
&expanded
= wxNullIcon
,
1177 wxClientData
*data
= NULL
);
1179 wxDataViewItem
GetNthChild( const wxDataViewItem
& parent
, unsigned int pos
) const;
1180 int GetChildCount( const wxDataViewItem
& parent
) const;
1182 void SetItemText( const wxDataViewItem
& item
, const wxString
&text
);
1183 wxString
GetItemText( const wxDataViewItem
& item
) const;
1184 void SetItemIcon( const wxDataViewItem
& item
, const wxIcon
&icon
);
1185 const wxIcon
&GetItemIcon( const wxDataViewItem
& item
) const;
1186 void SetItemExpandedIcon( const wxDataViewItem
& item
, const wxIcon
&icon
);
1187 const wxIcon
&GetItemExpandedIcon( const wxDataViewItem
& item
) const;
1188 void SetItemData( const wxDataViewItem
& item
, wxClientData
*data
);
1189 wxClientData
*GetItemData( const wxDataViewItem
& item
) const;
1191 void DeleteItem( const wxDataViewItem
& item
);
1192 void DeleteChildren( const wxDataViewItem
& item
);
1193 void DeleteAllItems();
1195 // implement base methods
1197 virtual void GetValue( wxVariant
&variant
,
1198 const wxDataViewItem
&item
, unsigned int col
) const;
1199 virtual bool SetValue( const wxVariant
&variant
,
1200 const wxDataViewItem
&item
, unsigned int col
);
1201 virtual wxDataViewItem
GetParent( const wxDataViewItem
&item
) const;
1202 virtual bool IsContainer( const wxDataViewItem
&item
) const;
1203 virtual unsigned int GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const;
1205 virtual int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
1206 unsigned int column
, bool ascending
) const;
1208 virtual bool HasDefaultCompare() const
1210 virtual unsigned int GetColumnCount() const
1212 virtual wxString
GetColumnType( unsigned int WXUNUSED(col
) ) const
1213 { return wxT("wxDataViewIconText"); }
1215 wxDataViewTreeStoreNode
*FindNode( const wxDataViewItem
&item
) const;
1216 wxDataViewTreeStoreContainerNode
*FindContainerNode( const wxDataViewItem
&item
) const;
1217 wxDataViewTreeStoreNode
*GetRoot() const { return m_root
; }
1220 wxDataViewTreeStoreNode
*m_root
;
1223 //-----------------------------------------------------------------------------
1225 class WXDLLIMPEXP_ADV wxDataViewTreeCtrl
: public wxDataViewCtrl
1228 wxDataViewTreeCtrl() { Init(); }
1229 wxDataViewTreeCtrl(wxWindow
*parent
,
1231 const wxPoint
& pos
= wxDefaultPosition
,
1232 const wxSize
& size
= wxDefaultSize
,
1233 long style
= wxDV_NO_HEADER
| wxDV_ROW_LINES
,
1234 const wxValidator
& validator
= wxDefaultValidator
)
1238 Create(parent
, id
, pos
, size
, style
, validator
);
1241 virtual ~wxDataViewTreeCtrl();
1243 bool Create(wxWindow
*parent
,
1245 const wxPoint
& pos
= wxDefaultPosition
,
1246 const wxSize
& size
= wxDefaultSize
,
1247 long style
= wxDV_NO_HEADER
| wxDV_ROW_LINES
,
1248 const wxValidator
& validator
= wxDefaultValidator
);
1250 wxDataViewTreeStore
*GetStore()
1251 { return (wxDataViewTreeStore
*) GetModel(); }
1252 const wxDataViewTreeStore
*GetStore() const
1253 { return (const wxDataViewTreeStore
*) GetModel(); }
1255 bool IsContainer( const wxDataViewItem
& item
) const
1256 { return GetStore()->IsContainer(item
); }
1258 void SetImageList( wxImageList
*imagelist
);
1259 wxImageList
* GetImageList() { return m_imageList
; }
1261 wxDataViewItem
AppendItem( const wxDataViewItem
& parent
,
1262 const wxString
&text
, int icon
= -1, wxClientData
*data
= NULL
);
1263 wxDataViewItem
PrependItem( const wxDataViewItem
& parent
,
1264 const wxString
&text
, int icon
= -1, wxClientData
*data
= NULL
);
1265 wxDataViewItem
InsertItem( const wxDataViewItem
& parent
, const wxDataViewItem
& previous
,
1266 const wxString
&text
, int icon
= -1, wxClientData
*data
= NULL
);
1268 wxDataViewItem
PrependContainer( const wxDataViewItem
& parent
,
1269 const wxString
&text
, int icon
= -1, int expanded
= -1,
1270 wxClientData
*data
= NULL
);
1271 wxDataViewItem
AppendContainer( const wxDataViewItem
& parent
,
1272 const wxString
&text
, int icon
= -1, int expanded
= -1,
1273 wxClientData
*data
= NULL
);
1274 wxDataViewItem
InsertContainer( const wxDataViewItem
& parent
, const wxDataViewItem
& previous
,
1275 const wxString
&text
, int icon
= -1, int expanded
= -1,
1276 wxClientData
*data
= NULL
);
1278 wxDataViewItem
GetNthChild( const wxDataViewItem
& parent
, unsigned int pos
) const
1279 { return GetStore()->GetNthChild(parent
, pos
); }
1280 int GetChildCount( const wxDataViewItem
& parent
) const
1281 { return GetStore()->GetChildCount(parent
); }
1283 void SetItemText( const wxDataViewItem
& item
, const wxString
&text
);
1284 wxString
GetItemText( const wxDataViewItem
& item
) const
1285 { return GetStore()->GetItemText(item
); }
1286 void SetItemIcon( const wxDataViewItem
& item
, const wxIcon
&icon
);
1287 const wxIcon
&GetItemIcon( const wxDataViewItem
& item
) const
1288 { return GetStore()->GetItemIcon(item
); }
1289 void SetItemExpandedIcon( const wxDataViewItem
& item
, const wxIcon
&icon
);
1290 const wxIcon
&GetItemExpandedIcon( const wxDataViewItem
& item
) const
1291 { return GetStore()->GetItemExpandedIcon(item
); }
1292 void SetItemData( const wxDataViewItem
& item
, wxClientData
*data
)
1293 { GetStore()->SetItemData(item
,data
); }
1294 wxClientData
*GetItemData( const wxDataViewItem
& item
) const
1295 { return GetStore()->GetItemData(item
); }
1297 void DeleteItem( const wxDataViewItem
& item
);
1298 void DeleteChildren( const wxDataViewItem
& item
);
1299 void DeleteAllItems();
1301 void OnExpanded( wxDataViewEvent
&event
);
1302 void OnCollapsed( wxDataViewEvent
&event
);
1303 void OnSize( wxSizeEvent
&event
);
1311 wxImageList
*m_imageList
;
1314 DECLARE_EVENT_TABLE()
1315 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewTreeCtrl
)
1318 #endif // wxUSE_DATAVIEWCTRL
1321 // _WX_DATAVIEW_H_BASE_