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 virtual void Resort() = 0;
131 void SetOwner( wxDataViewModel
*owner
) { m_owner
= owner
; }
132 wxDataViewModel
*GetOwner() const { return m_owner
; }
135 wxDataViewModel
*m_owner
;
140 // ----------------------------------------------------------------------------
141 // wxDataViewItemAttr: a structure containing the visual attributes of an item
142 // ----------------------------------------------------------------------------
144 // TODO: this should be renamed to wxItemAttr or something general like this
146 class WXDLLIMPEXP_ADV wxDataViewItemAttr
157 void SetColour(const wxColour
& colour
) { m_colour
= colour
; }
158 void SetBold( bool set
) { m_bold
= set
; }
159 void SetItalic( bool set
) { m_italic
= set
; }
162 bool HasColour() const { return m_colour
.Ok(); }
163 const wxColour
& GetColour() const { return m_colour
; }
165 bool HasFont() const { return m_bold
|| m_italic
; }
166 bool GetBold() const { return m_bold
; }
167 bool GetItalic() const { return m_italic
; }
169 bool IsDefault() const { return !(HasColour() || HasFont()); }
178 // ---------------------------------------------------------
180 // ---------------------------------------------------------
182 WX_DECLARE_LIST_WITH_DECL(wxDataViewModelNotifier
, wxDataViewModelNotifiers
,
183 class WXDLLIMPEXP_ADV
);
185 class WXDLLIMPEXP_ADV wxDataViewModel
: public wxRefCounter
190 virtual unsigned int GetColumnCount() const = 0;
192 // return type as reported by wxVariant
193 virtual wxString
GetColumnType( unsigned int col
) const = 0;
195 // get value into a wxVariant
196 virtual void GetValue( wxVariant
&variant
,
197 const wxDataViewItem
&item
, unsigned int col
) const = 0;
199 // return true if the given item has a value to display in the given
200 // column: this is always true except for container items which by default
201 // only show their label in the first column (but see HasContainerColumns())
202 bool HasValue(const wxDataViewItem
& item
, unsigned col
) const
204 return col
== 0 || !IsContainer(item
) || HasContainerColumns(item
);
207 // usually ValueChanged() should be called after changing the value in the
208 // model to update the control, ChangeValue() does it on its own while
209 // SetValue() does not -- so while you will override SetValue(), you should
210 // be usually calling ChangeValue()
211 virtual bool SetValue(const wxVariant
&variant
,
212 const wxDataViewItem
&item
,
213 unsigned int col
) = 0;
215 bool ChangeValue(const wxVariant
& variant
,
216 const wxDataViewItem
& item
,
219 return SetValue(variant
, item
, col
) && ValueChanged(item
, col
);
222 // Get text attribute, return false of default attributes should be used
223 virtual bool GetAttr(const wxDataViewItem
&WXUNUSED(item
),
224 unsigned int WXUNUSED(col
),
225 wxDataViewItemAttr
&WXUNUSED(attr
)) const
231 virtual wxDataViewItem
GetParent( const wxDataViewItem
&item
) const = 0;
232 virtual bool IsContainer( const wxDataViewItem
&item
) const = 0;
233 // Is the container just a header or an item with all columns
234 virtual bool HasContainerColumns(const wxDataViewItem
& WXUNUSED(item
)) const
236 virtual unsigned int GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const = 0;
238 // delegated notifiers
239 virtual bool ItemAdded( const wxDataViewItem
&parent
, const wxDataViewItem
&item
);
240 virtual bool ItemsAdded( const wxDataViewItem
&parent
, const wxDataViewItemArray
&items
);
241 virtual bool ItemDeleted( const wxDataViewItem
&parent
, const wxDataViewItem
&item
);
242 virtual bool ItemsDeleted( const wxDataViewItem
&parent
, const wxDataViewItemArray
&items
);
243 virtual bool ItemChanged( const wxDataViewItem
&item
);
244 virtual bool ItemsChanged( const wxDataViewItemArray
&items
);
245 virtual bool ValueChanged( const wxDataViewItem
&item
, unsigned int col
);
246 virtual bool Cleared();
249 virtual void Resort();
251 void AddNotifier( wxDataViewModelNotifier
*notifier
);
252 void RemoveNotifier( wxDataViewModelNotifier
*notifier
);
254 // default compare function
255 virtual int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
256 unsigned int column
, bool ascending
) const;
257 virtual bool HasDefaultCompare() const { return false; }
260 virtual bool IsVirtualListModel() const { return false; }
263 // the user should not delete this class directly: he should use DecRef() instead!
264 virtual ~wxDataViewModel() { }
266 wxDataViewModelNotifiers m_notifiers
;
269 // ----------------------------------------------------------------------------
270 // wxDataViewListModel: a model of a list, i.e. flat data structure without any
271 // branches/containers, used as base class by wxDataViewIndexListModel and
272 // wxDataViewVirtualListModel
273 // ----------------------------------------------------------------------------
275 class WXDLLIMPEXP_ADV wxDataViewListModel
: public wxDataViewModel
278 // derived classes should override these methods instead of
279 // {Get,Set}Value() and GetAttr() inherited from the base class
281 virtual void GetValueByRow(wxVariant
&variant
,
282 unsigned row
, unsigned col
) const = 0;
284 virtual bool SetValueByRow(const wxVariant
&variant
,
285 unsigned row
, unsigned col
) = 0;
288 GetAttrByRow(unsigned WXUNUSED(row
), unsigned WXUNUSED(col
),
289 wxDataViewItemAttr
&WXUNUSED(attr
)) const
295 // helper methods provided by list models only
296 virtual unsigned GetRow( const wxDataViewItem
&item
) const = 0;
299 // implement some base class pure virtual directly
300 virtual wxDataViewItem
301 GetParent( const wxDataViewItem
& WXUNUSED(item
) ) const
303 // items never have valid parent in this model
304 return wxDataViewItem();
307 virtual bool IsContainer( const wxDataViewItem
&item
) const
309 // only the invisible (and invalid) root item has children
313 // and implement some others by forwarding them to our own ones
314 virtual void GetValue( wxVariant
&variant
,
315 const wxDataViewItem
&item
, unsigned int col
) const
317 GetValueByRow(variant
, GetRow(item
), col
);
320 virtual bool SetValue( const wxVariant
&variant
,
321 const wxDataViewItem
&item
, unsigned int col
)
323 return SetValueByRow( variant
, GetRow(item
), col
);
326 virtual bool GetAttr(const wxDataViewItem
&item
, unsigned int col
,
327 wxDataViewItemAttr
&attr
) const
329 return GetAttrByRow( GetRow(item
), col
, attr
);
333 // ---------------------------------------------------------
334 // wxDataViewIndexListModel
335 // ---------------------------------------------------------
337 class WXDLLIMPEXP_ADV wxDataViewIndexListModel
: public wxDataViewListModel
340 wxDataViewIndexListModel( unsigned int initial_size
= 0 );
343 void RowInserted( unsigned int before
);
345 void RowDeleted( unsigned int row
);
346 void RowsDeleted( const wxArrayInt
&rows
);
347 void RowChanged( unsigned int row
);
348 void RowValueChanged( unsigned int row
, unsigned int col
);
349 void Reset( unsigned int new_size
);
351 // convert to/from row/wxDataViewItem
353 virtual unsigned GetRow( const wxDataViewItem
&item
) const;
354 wxDataViewItem
GetItem( unsigned int row
) const;
356 // compare based on index
358 virtual int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
359 unsigned int column
, bool ascending
) const;
360 virtual bool HasDefaultCompare() const;
362 // implement base methods
363 virtual unsigned int GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const;
365 unsigned int GetCount() const { return m_hash
.GetCount(); }
368 wxDataViewItemArray m_hash
;
369 unsigned int m_nextFreeID
;
373 // ---------------------------------------------------------
374 // wxDataViewVirtualListModel
375 // ---------------------------------------------------------
378 // better than nothing
379 typedef wxDataViewIndexListModel wxDataViewVirtualListModel
;
382 class WXDLLIMPEXP_ADV wxDataViewVirtualListModel
: public wxDataViewListModel
385 wxDataViewVirtualListModel( unsigned int initial_size
= 0 );
388 void RowInserted( unsigned int before
);
390 void RowDeleted( unsigned int row
);
391 void RowsDeleted( const wxArrayInt
&rows
);
392 void RowChanged( unsigned int row
);
393 void RowValueChanged( unsigned int row
, unsigned int col
);
394 void Reset( unsigned int new_size
);
396 // convert to/from row/wxDataViewItem
398 virtual unsigned GetRow( const wxDataViewItem
&item
) const;
399 wxDataViewItem
GetItem( unsigned int row
) const;
401 // compare based on index
403 virtual int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
404 unsigned int column
, bool ascending
) const;
405 virtual bool HasDefaultCompare() const;
407 // implement base methods
408 virtual unsigned int GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const;
410 unsigned int GetCount() const { return m_size
; }
413 virtual bool IsVirtualListModel() const { return true; }
421 // ----------------------------------------------------------------------------
422 // wxDataViewRenderer and related classes
423 // ----------------------------------------------------------------------------
425 #include "wx/dvrenderers.h"
427 // ---------------------------------------------------------
428 // wxDataViewColumnBase
429 // ---------------------------------------------------------
431 // for compatibility only, do not use
432 enum wxDataViewColumnFlags
434 wxDATAVIEW_COL_RESIZABLE
= wxCOL_RESIZABLE
,
435 wxDATAVIEW_COL_SORTABLE
= wxCOL_SORTABLE
,
436 wxDATAVIEW_COL_REORDERABLE
= wxCOL_REORDERABLE
,
437 wxDATAVIEW_COL_HIDDEN
= wxCOL_HIDDEN
440 class WXDLLIMPEXP_ADV wxDataViewColumnBase
: public wxSettableHeaderColumn
443 // ctor for the text columns: takes ownership of renderer
444 wxDataViewColumnBase(wxDataViewRenderer
*renderer
,
445 unsigned int model_column
)
447 Init(renderer
, model_column
);
450 // ctor for the bitmap columns
451 wxDataViewColumnBase(const wxBitmap
& bitmap
,
452 wxDataViewRenderer
*renderer
,
453 unsigned int model_column
)
456 Init(renderer
, model_column
);
459 virtual ~wxDataViewColumnBase();
462 virtual void SetOwner( wxDataViewCtrl
*owner
)
466 unsigned int GetModelColumn() const { return static_cast<unsigned int>(m_model_column
); }
467 wxDataViewCtrl
*GetOwner() const { return m_owner
; }
468 wxDataViewRenderer
* GetRenderer() const { return m_renderer
; }
470 // implement some of base class pure virtuals (the rest is port-dependent
471 // and done differently in generic and native versions)
472 virtual void SetBitmap( const wxBitmap
& bitmap
) { m_bitmap
= bitmap
; }
473 virtual wxBitmap
GetBitmap() const { return m_bitmap
; }
476 wxDataViewRenderer
*m_renderer
;
479 wxDataViewCtrl
*m_owner
;
482 // common part of all ctors
483 void Init(wxDataViewRenderer
*renderer
, unsigned int model_column
);
486 // ---------------------------------------------------------
487 // wxDataViewCtrlBase
488 // ---------------------------------------------------------
490 #define wxDV_SINGLE 0x0000 // for convenience
491 #define wxDV_MULTIPLE 0x0001 // can select multiple items
493 #define wxDV_NO_HEADER 0x0002 // column titles not visible
494 #define wxDV_HORIZ_RULES 0x0004 // light horizontal rules between rows
495 #define wxDV_VERT_RULES 0x0008 // light vertical rules between columns
497 #define wxDV_ROW_LINES 0x0010 // alternating colour in rows
498 #define wxDV_VARIABLE_LINE_HEIGHT 0x0020 // variable line height
500 class WXDLLIMPEXP_ADV wxDataViewCtrlBase
: public wxControl
503 wxDataViewCtrlBase();
504 virtual ~wxDataViewCtrlBase();
509 virtual bool AssociateModel( wxDataViewModel
*model
);
510 wxDataViewModel
* GetModel();
511 const wxDataViewModel
* GetModel() const;
517 wxDataViewColumn
*PrependTextColumn( const wxString
&label
, unsigned int model_column
,
518 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
519 wxAlignment align
= wxALIGN_NOT
,
520 int flags
= wxDATAVIEW_COL_RESIZABLE
);
521 wxDataViewColumn
*PrependIconTextColumn( const wxString
&label
, unsigned int model_column
,
522 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
523 wxAlignment align
= wxALIGN_NOT
,
524 int flags
= wxDATAVIEW_COL_RESIZABLE
);
525 wxDataViewColumn
*PrependToggleColumn( const wxString
&label
, unsigned int model_column
,
526 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
527 wxAlignment align
= wxALIGN_CENTER
,
528 int flags
= wxDATAVIEW_COL_RESIZABLE
);
529 wxDataViewColumn
*PrependProgressColumn( const wxString
&label
, unsigned int model_column
,
530 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
531 wxAlignment align
= wxALIGN_CENTER
,
532 int flags
= wxDATAVIEW_COL_RESIZABLE
);
533 wxDataViewColumn
*PrependDateColumn( const wxString
&label
, unsigned int model_column
,
534 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
535 wxAlignment align
= wxALIGN_NOT
,
536 int flags
= wxDATAVIEW_COL_RESIZABLE
);
537 wxDataViewColumn
*PrependBitmapColumn( const wxString
&label
, unsigned int model_column
,
538 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
539 wxAlignment align
= wxALIGN_CENTER
,
540 int flags
= wxDATAVIEW_COL_RESIZABLE
);
541 wxDataViewColumn
*PrependTextColumn( const wxBitmap
&label
, unsigned int model_column
,
542 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
543 wxAlignment align
= wxALIGN_NOT
,
544 int flags
= wxDATAVIEW_COL_RESIZABLE
);
545 wxDataViewColumn
*PrependIconTextColumn( const wxBitmap
&label
, unsigned int model_column
,
546 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
547 wxAlignment align
= wxALIGN_NOT
,
548 int flags
= wxDATAVIEW_COL_RESIZABLE
);
549 wxDataViewColumn
*PrependToggleColumn( const wxBitmap
&label
, unsigned int model_column
,
550 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
551 wxAlignment align
= wxALIGN_CENTER
,
552 int flags
= wxDATAVIEW_COL_RESIZABLE
);
553 wxDataViewColumn
*PrependProgressColumn( const wxBitmap
&label
, unsigned int model_column
,
554 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
555 wxAlignment align
= wxALIGN_CENTER
,
556 int flags
= wxDATAVIEW_COL_RESIZABLE
);
557 wxDataViewColumn
*PrependDateColumn( const wxBitmap
&label
, unsigned int model_column
,
558 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
559 wxAlignment align
= wxALIGN_NOT
,
560 int flags
= wxDATAVIEW_COL_RESIZABLE
);
561 wxDataViewColumn
*PrependBitmapColumn( const wxBitmap
&label
, unsigned int model_column
,
562 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
563 wxAlignment align
= wxALIGN_CENTER
,
564 int flags
= wxDATAVIEW_COL_RESIZABLE
);
566 wxDataViewColumn
*AppendTextColumn( const wxString
&label
, unsigned int model_column
,
567 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
568 wxAlignment align
= wxALIGN_NOT
,
569 int flags
= wxDATAVIEW_COL_RESIZABLE
);
570 wxDataViewColumn
*AppendIconTextColumn( const wxString
&label
, unsigned int model_column
,
571 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
572 wxAlignment align
= wxALIGN_NOT
,
573 int flags
= wxDATAVIEW_COL_RESIZABLE
);
574 wxDataViewColumn
*AppendToggleColumn( const wxString
&label
, unsigned int model_column
,
575 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
576 wxAlignment align
= wxALIGN_CENTER
,
577 int flags
= wxDATAVIEW_COL_RESIZABLE
);
578 wxDataViewColumn
*AppendProgressColumn( const wxString
&label
, unsigned int model_column
,
579 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
580 wxAlignment align
= wxALIGN_CENTER
,
581 int flags
= wxDATAVIEW_COL_RESIZABLE
);
582 wxDataViewColumn
*AppendDateColumn( const wxString
&label
, unsigned int model_column
,
583 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
584 wxAlignment align
= wxALIGN_NOT
,
585 int flags
= wxDATAVIEW_COL_RESIZABLE
);
586 wxDataViewColumn
*AppendBitmapColumn( const wxString
&label
, unsigned int model_column
,
587 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
588 wxAlignment align
= wxALIGN_CENTER
,
589 int flags
= wxDATAVIEW_COL_RESIZABLE
);
590 wxDataViewColumn
*AppendTextColumn( const wxBitmap
&label
, unsigned int model_column
,
591 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
592 wxAlignment align
= wxALIGN_NOT
,
593 int flags
= wxDATAVIEW_COL_RESIZABLE
);
594 wxDataViewColumn
*AppendIconTextColumn( const wxBitmap
&label
, unsigned int model_column
,
595 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
596 wxAlignment align
= wxALIGN_NOT
,
597 int flags
= wxDATAVIEW_COL_RESIZABLE
);
598 wxDataViewColumn
*AppendToggleColumn( const wxBitmap
&label
, unsigned int model_column
,
599 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
600 wxAlignment align
= wxALIGN_CENTER
,
601 int flags
= wxDATAVIEW_COL_RESIZABLE
);
602 wxDataViewColumn
*AppendProgressColumn( const wxBitmap
&label
, unsigned int model_column
,
603 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
604 wxAlignment align
= wxALIGN_CENTER
,
605 int flags
= wxDATAVIEW_COL_RESIZABLE
);
606 wxDataViewColumn
*AppendDateColumn( const wxBitmap
&label
, unsigned int model_column
,
607 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
608 wxAlignment align
= wxALIGN_NOT
,
609 int flags
= wxDATAVIEW_COL_RESIZABLE
);
610 wxDataViewColumn
*AppendBitmapColumn( const wxBitmap
&label
, unsigned int model_column
,
611 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
612 wxAlignment align
= wxALIGN_CENTER
,
613 int flags
= wxDATAVIEW_COL_RESIZABLE
);
615 virtual bool PrependColumn( wxDataViewColumn
*col
);
616 virtual bool InsertColumn( unsigned int pos
, wxDataViewColumn
*col
);
617 virtual bool AppendColumn( wxDataViewColumn
*col
);
619 virtual unsigned int GetColumnCount() const = 0;
620 virtual wxDataViewColumn
* GetColumn( unsigned int pos
) const = 0;
621 virtual int GetColumnPosition( const wxDataViewColumn
*column
) const = 0;
623 virtual bool DeleteColumn( wxDataViewColumn
*column
) = 0;
624 virtual bool ClearColumns() = 0;
626 void SetExpanderColumn( wxDataViewColumn
*col
)
627 { m_expander_column
= col
; DoSetExpanderColumn(); }
628 wxDataViewColumn
*GetExpanderColumn() const
629 { return m_expander_column
; }
631 virtual wxDataViewColumn
*GetSortingColumn() const = 0;
637 void SetIndent( int indent
)
638 { m_indent
= indent
; DoSetIndent(); }
639 int GetIndent() const
642 virtual wxDataViewItem
GetSelection() const = 0;
643 virtual int GetSelections( wxDataViewItemArray
& sel
) const = 0;
644 virtual void SetSelections( const wxDataViewItemArray
& sel
) = 0;
645 virtual void Select( const wxDataViewItem
& item
) = 0;
646 virtual void Unselect( const wxDataViewItem
& item
) = 0;
647 virtual bool IsSelected( const wxDataViewItem
& item
) const = 0;
649 virtual void SelectAll() = 0;
650 virtual void UnselectAll() = 0;
652 virtual void Expand( const wxDataViewItem
& item
) = 0;
653 virtual void ExpandAncestors( const wxDataViewItem
& item
);
654 virtual void Collapse( const wxDataViewItem
& item
) = 0;
655 virtual bool IsExpanded( const wxDataViewItem
& item
) const = 0;
657 virtual void EnsureVisible( const wxDataViewItem
& item
,
658 const wxDataViewColumn
*column
= NULL
) = 0;
659 virtual void HitTest( const wxPoint
& point
, wxDataViewItem
&item
, wxDataViewColumn
* &column
) const = 0;
660 virtual wxRect
GetItemRect( const wxDataViewItem
& item
, const wxDataViewColumn
*column
= NULL
) const = 0;
662 #if wxUSE_DRAG_AND_DROP
663 virtual bool EnableDragSource(const wxDataFormat
& WXUNUSED(format
))
665 virtual bool EnableDropTarget(const wxDataFormat
& WXUNUSED(format
))
667 #endif // wxUSE_DRAG_AND_DROP
669 // define control visual attributes
670 // --------------------------------
672 virtual wxVisualAttributes
GetDefaultAttributes() const
674 return GetClassDefaultAttributes(GetWindowVariant());
677 static wxVisualAttributes
678 GetClassDefaultAttributes(wxWindowVariant variant
= wxWINDOW_VARIANT_NORMAL
)
680 return wxControl::GetCompositeControlsDefaultAttributes(variant
);
684 virtual void DoSetExpanderColumn() = 0 ;
685 virtual void DoSetIndent() = 0;
688 wxDataViewModel
*m_model
;
689 wxDataViewColumn
*m_expander_column
;
693 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase
)
696 // ----------------------------------------------------------------------------
697 // wxDataViewEvent - the event class for the wxDataViewCtrl notifications
698 // ----------------------------------------------------------------------------
700 class WXDLLIMPEXP_ADV wxDataViewEvent
: public wxNotifyEvent
703 wxDataViewEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
704 : wxNotifyEvent(commandType
, winid
),
708 m_value(wxNullVariant
),
713 #if wxUSE_DRAG_AND_DROP
714 , m_dataObject(NULL
),
720 wxDataViewEvent(const wxDataViewEvent
& event
)
721 : wxNotifyEvent(event
),
722 m_item(event
.m_item
),
724 m_model(event
.m_model
),
725 m_value(event
.m_value
),
726 m_column(event
.m_column
),
728 m_cacheFrom(event
.m_cacheFrom
),
729 m_cacheTo(event
.m_cacheTo
)
730 #if wxUSE_DRAG_AND_DROP
731 , m_dataObject(event
.m_dataObject
),
732 m_dataFormat(event
.m_dataFormat
),
733 m_dataBuffer(event
.m_dataBuffer
),
734 m_dataSize(event
.m_dataSize
)
738 wxDataViewItem
GetItem() const { return m_item
; }
739 void SetItem( const wxDataViewItem
&item
) { m_item
= item
; }
741 int GetColumn() const { return m_col
; }
742 void SetColumn( int col
) { m_col
= col
; }
744 wxDataViewModel
* GetModel() const { return m_model
; }
745 void SetModel( wxDataViewModel
*model
) { m_model
= model
; }
747 const wxVariant
&GetValue() const { return m_value
; }
748 void SetValue( const wxVariant
&value
) { m_value
= value
; }
750 // for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only
751 void SetDataViewColumn( wxDataViewColumn
*col
) { m_column
= col
; }
752 wxDataViewColumn
*GetDataViewColumn() const { return m_column
; }
754 // for wxEVT_DATAVIEW_CONTEXT_MENU only
755 wxPoint
GetPosition() const { return m_pos
; }
756 void SetPosition( int x
, int y
) { m_pos
.x
= x
; m_pos
.y
= y
; }
758 // For wxEVT_COMMAND_DATAVIEW_CACHE_HINT
759 int GetCacheFrom() const { return m_cacheFrom
; }
760 int GetCacheTo() const { return m_cacheTo
; }
761 void SetCache(int from
, int to
) { m_cacheFrom
= from
; m_cacheTo
= to
; }
764 #if wxUSE_DRAG_AND_DROP
765 // For drag operations
766 void SetDataObject( wxDataObject
*obj
) { m_dataObject
= obj
; }
767 wxDataObject
*GetDataObject() const { return m_dataObject
; }
769 // For drop operations
770 void SetDataFormat( const wxDataFormat
&format
) { m_dataFormat
= format
; }
771 wxDataFormat
GetDataFormat() const { return m_dataFormat
; }
772 void SetDataSize( size_t size
) { m_dataSize
= size
; }
773 size_t GetDataSize() const { return m_dataSize
; }
774 void SetDataBuffer( void* buf
) { m_dataBuffer
= buf
;}
775 void *GetDataBuffer() const { return m_dataBuffer
; }
776 #endif // wxUSE_DRAG_AND_DROP
778 virtual wxEvent
*Clone() const { return new wxDataViewEvent(*this); }
781 wxDataViewItem m_item
;
783 wxDataViewModel
*m_model
;
785 wxDataViewColumn
*m_column
;
790 #if wxUSE_DRAG_AND_DROP
791 wxDataObject
*m_dataObject
;
793 wxDataFormat m_dataFormat
;
796 #endif // wxUSE_DRAG_AND_DROP
799 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent
)
802 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED
, wxDataViewEvent
);
804 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED
, wxDataViewEvent
);
805 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED
, wxDataViewEvent
);
806 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED
, wxDataViewEvent
);
807 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING
, wxDataViewEvent
);
808 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING
, wxDataViewEvent
);
809 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_START_EDITING
, wxDataViewEvent
);
810 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED
, wxDataViewEvent
);
811 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE
, wxDataViewEvent
);
812 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED
, wxDataViewEvent
);
814 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU
, wxDataViewEvent
);
816 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK
, wxDataViewEvent
);
817 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK
, wxDataViewEvent
);
818 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED
, wxDataViewEvent
);
819 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED
, wxDataViewEvent
);
821 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_CACHE_HINT
, wxDataViewEvent
);
823 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_BEGIN_DRAG
, wxDataViewEvent
);
824 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_DROP_POSSIBLE
, wxDataViewEvent
);
825 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_DROP
, wxDataViewEvent
);
827 typedef void (wxEvtHandler::*wxDataViewEventFunction
)(wxDataViewEvent
&);
829 #define wxDataViewEventHandler(func) \
830 wxEVENT_HANDLER_CAST(wxDataViewEventFunction, func)
832 #define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \
833 wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn))
835 #define EVT_DATAVIEW_SELECTION_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(SELECTION_CHANGED, id, fn)
837 #define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_ACTIVATED, id, fn)
838 #define EVT_DATAVIEW_ITEM_COLLAPSING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSING, id, fn)
839 #define EVT_DATAVIEW_ITEM_COLLAPSED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSED, id, fn)
840 #define EVT_DATAVIEW_ITEM_EXPANDING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDING, id, fn)
841 #define EVT_DATAVIEW_ITEM_EXPANDED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDED, id, fn)
842 #define EVT_DATAVIEW_ITEM_START_EDITING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_START_EDITING, id, fn)
843 #define EVT_DATAVIEW_ITEM_EDITING_STARTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_STARTED, id, fn)
844 #define EVT_DATAVIEW_ITEM_EDITING_DONE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_DONE, id, fn)
845 #define EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_VALUE_CHANGED, id, fn)
847 #define EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_CONTEXT_MENU, id, fn)
849 #define EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_CLICK, id, fn)
850 #define EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_RIGHT_CLICK, id, fn)
851 #define EVT_DATAVIEW_COLUMN_SORTED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_SORTED, id, fn)
852 #define EVT_DATAVIEW_COLUMN_REORDERED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_REORDERED, id, fn)
853 #define EVT_DATAVIEW_CACHE_HINT(id, fn) wx__DECLARE_DATAVIEWEVT(CACHE_HINT, id, fn)
855 #define EVT_DATAVIEW_ITEM_BEGIN_DRAG(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_BEGIN_DRAG, id, fn)
856 #define EVT_DATAVIEW_ITEM_DROP_POSSIBLE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_DROP_POSSIBLE, id, fn)
857 #define EVT_DATAVIEW_ITEM_DROP(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_DROP, id, fn)
859 #ifdef wxHAS_GENERIC_DATAVIEWCTRL
860 #include "wx/generic/dataview.h"
861 #elif defined(__WXGTK20__)
862 #include "wx/gtk/dataview.h"
863 #elif defined(__WXMAC__)
864 #include "wx/osx/dataview.h"
866 #error "unknown native wxDataViewCtrl implementation"
869 //-----------------------------------------------------------------------------
870 // wxDataViewListStore
871 //-----------------------------------------------------------------------------
873 class WXDLLIMPEXP_ADV wxDataViewListStoreLine
876 wxDataViewListStoreLine( wxClientData
*data
= NULL
)
880 virtual ~wxDataViewListStoreLine()
885 void SetData( wxClientData
*data
)
886 { if (m_data
) delete m_data
; m_data
= data
; }
887 wxClientData
*GetData() const
890 wxVector
<wxVariant
> m_values
;
893 wxClientData
*m_data
;
897 class WXDLLIMPEXP_ADV wxDataViewListStore
: public wxDataViewIndexListModel
900 wxDataViewListStore();
901 ~wxDataViewListStore();
903 void PrependColumn( const wxString
&varianttype
);
904 void InsertColumn( unsigned int pos
, const wxString
&varianttype
);
905 void AppendColumn( const wxString
&varianttype
);
907 void AppendItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
908 void PrependItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
909 void InsertItem( unsigned int row
, const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
910 void DeleteItem( unsigned int pos
);
911 void DeleteAllItems();
913 // override base virtuals
915 virtual unsigned int GetColumnCount() const;
917 virtual wxString
GetColumnType( unsigned int col
) const;
919 virtual void GetValueByRow( wxVariant
&value
,
920 unsigned int row
, unsigned int col
) const;
922 virtual bool SetValueByRow( const wxVariant
&value
,
923 unsigned int row
, unsigned int col
);
927 wxVector
<wxDataViewListStoreLine
*> m_data
;
928 wxArrayString m_cols
;
931 //-----------------------------------------------------------------------------
933 class WXDLLIMPEXP_ADV wxDataViewListCtrl
: public wxDataViewCtrl
936 wxDataViewListCtrl();
937 wxDataViewListCtrl( wxWindow
*parent
, wxWindowID id
,
938 const wxPoint
& pos
= wxDefaultPosition
,
939 const wxSize
& size
= wxDefaultSize
, long style
= wxDV_ROW_LINES
,
940 const wxValidator
& validator
= wxDefaultValidator
);
941 ~wxDataViewListCtrl();
943 bool Create( wxWindow
*parent
, wxWindowID id
,
944 const wxPoint
& pos
= wxDefaultPosition
,
945 const wxSize
& size
= wxDefaultSize
, long style
= wxDV_ROW_LINES
,
946 const wxValidator
& validator
= wxDefaultValidator
);
948 wxDataViewListStore
*GetStore()
949 { return (wxDataViewListStore
*) GetModel(); }
950 const wxDataViewListStore
*GetStore() const
951 { return (const wxDataViewListStore
*) GetModel(); }
953 bool AppendColumn( wxDataViewColumn
*column
, const wxString
&varianttype
);
954 bool PrependColumn( wxDataViewColumn
*column
, const wxString
&varianttype
);
955 bool InsertColumn( unsigned int pos
, wxDataViewColumn
*column
, const wxString
&varianttype
);
957 // overridden from base class
958 virtual bool PrependColumn( wxDataViewColumn
*col
);
959 virtual bool InsertColumn( unsigned int pos
, wxDataViewColumn
*col
);
960 virtual bool AppendColumn( wxDataViewColumn
*col
);
962 wxDataViewColumn
*AppendTextColumn( const wxString
&label
,
963 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
964 int width
= -1, wxAlignment align
= wxALIGN_LEFT
, int flags
= wxDATAVIEW_COL_RESIZABLE
);
965 wxDataViewColumn
*AppendToggleColumn( const wxString
&label
,
966 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
,
967 int width
= -1, wxAlignment align
= wxALIGN_LEFT
, int flags
= wxDATAVIEW_COL_RESIZABLE
);
968 wxDataViewColumn
*AppendProgressColumn( const wxString
&label
,
969 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
970 int width
= -1, wxAlignment align
= wxALIGN_LEFT
, int flags
= wxDATAVIEW_COL_RESIZABLE
);
971 wxDataViewColumn
*AppendIconTextColumn( const wxString
&label
,
972 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
973 int width
= -1, wxAlignment align
= wxALIGN_LEFT
, int flags
= wxDATAVIEW_COL_RESIZABLE
);
975 void AppendItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
)
976 { GetStore()->AppendItem( values
, data
); }
977 void PrependItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
)
978 { GetStore()->PrependItem( values
, data
); }
979 void InsertItem( unsigned int row
, const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
)
980 { GetStore()->InsertItem( row
, values
, data
); }
981 void DeleteItem( unsigned row
)
982 { GetStore()->DeleteItem( row
); }
983 void DeleteAllItems()
984 { GetStore()->DeleteAllItems(); }
986 void SetValue( const wxVariant
&value
, unsigned int row
, unsigned int col
)
987 { GetStore()->SetValueByRow( value
, row
, col
);
988 GetStore()->RowValueChanged( row
, col
); }
989 void GetValue( wxVariant
&value
, unsigned int row
, unsigned int col
)
990 { GetStore()->GetValueByRow( value
, row
, col
); }
992 void SetTextValue( const wxString
&value
, unsigned int row
, unsigned int col
)
993 { GetStore()->SetValueByRow( value
, row
, col
);
994 GetStore()->RowValueChanged( row
, col
); }
995 wxString
GetTextValue( unsigned int row
, unsigned int col
) const
996 { wxVariant value
; GetStore()->GetValueByRow( value
, row
, col
); return value
.GetString(); }
998 void SetToggleValue( bool value
, unsigned int row
, unsigned int col
)
999 { GetStore()->SetValueByRow( value
, row
, col
);
1000 GetStore()->RowValueChanged( row
, col
); }
1001 bool GetToggleValue( unsigned int row
, unsigned int col
) const
1002 { wxVariant value
; GetStore()->GetValueByRow( value
, row
, col
); return value
.GetBool(); }
1004 void OnSize( wxSizeEvent
&event
);
1007 DECLARE_EVENT_TABLE()
1008 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewListCtrl
)
1011 //-----------------------------------------------------------------------------
1012 // wxDataViewTreeStore
1013 //-----------------------------------------------------------------------------
1015 class WXDLLIMPEXP_ADV wxDataViewTreeStoreNode
1018 wxDataViewTreeStoreNode( wxDataViewTreeStoreNode
*parent
,
1019 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, wxClientData
*data
= NULL
);
1020 virtual ~wxDataViewTreeStoreNode();
1022 void SetText( const wxString
&text
)
1024 wxString
GetText() const
1026 void SetIcon( const wxIcon
&icon
)
1028 const wxIcon
&GetIcon() const
1030 void SetData( wxClientData
*data
)
1031 { if (m_data
) delete m_data
; m_data
= data
; }
1032 wxClientData
*GetData() const
1035 wxDataViewItem
GetItem() const
1036 { return wxDataViewItem( (void*) this ); }
1038 virtual bool IsContainer()
1041 wxDataViewTreeStoreNode
*GetParent()
1042 { return m_parent
; }
1045 wxDataViewTreeStoreNode
*m_parent
;
1048 wxClientData
*m_data
;
1051 WX_DECLARE_LIST_WITH_DECL(wxDataViewTreeStoreNode
, wxDataViewTreeStoreNodeList
,
1052 class WXDLLIMPEXP_ADV
);
1054 class WXDLLIMPEXP_ADV wxDataViewTreeStoreContainerNode
: public wxDataViewTreeStoreNode
1057 wxDataViewTreeStoreContainerNode( wxDataViewTreeStoreNode
*parent
,
1058 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, const wxIcon
&expanded
= wxNullIcon
,
1059 wxClientData
*data
= NULL
);
1060 virtual ~wxDataViewTreeStoreContainerNode();
1062 const wxDataViewTreeStoreNodeList
&GetChildren() const
1063 { return m_children
; }
1064 wxDataViewTreeStoreNodeList
&GetChildren()
1065 { return m_children
; }
1067 void SetExpandedIcon( const wxIcon
&icon
)
1068 { m_iconExpanded
= icon
; }
1069 const wxIcon
&GetExpandedIcon() const
1070 { return m_iconExpanded
; }
1072 void SetExpanded( bool expanded
= true )
1073 { m_isExpanded
= expanded
; }
1074 bool IsExpanded() const
1075 { return m_isExpanded
; }
1077 virtual bool IsContainer()
1081 wxDataViewTreeStoreNodeList m_children
;
1082 wxIcon m_iconExpanded
;
1086 //-----------------------------------------------------------------------------
1088 class WXDLLIMPEXP_ADV wxDataViewTreeStore
: public wxDataViewModel
1091 wxDataViewTreeStore();
1092 ~wxDataViewTreeStore();
1094 wxDataViewItem
AppendItem( const wxDataViewItem
& parent
,
1095 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, wxClientData
*data
= NULL
);
1096 wxDataViewItem
PrependItem( const wxDataViewItem
& parent
,
1097 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, wxClientData
*data
= NULL
);
1098 wxDataViewItem
InsertItem( const wxDataViewItem
& parent
, const wxDataViewItem
& previous
,
1099 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, wxClientData
*data
= NULL
);
1101 wxDataViewItem
PrependContainer( const wxDataViewItem
& parent
,
1102 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, const wxIcon
&expanded
= wxNullIcon
,
1103 wxClientData
*data
= NULL
);
1104 wxDataViewItem
AppendContainer( const wxDataViewItem
& parent
,
1105 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, const wxIcon
&expanded
= wxNullIcon
,
1106 wxClientData
*data
= NULL
);
1107 wxDataViewItem
InsertContainer( const wxDataViewItem
& parent
, const wxDataViewItem
& previous
,
1108 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, const wxIcon
&expanded
= wxNullIcon
,
1109 wxClientData
*data
= NULL
);
1111 wxDataViewItem
GetNthChild( const wxDataViewItem
& parent
, unsigned int pos
) const;
1112 int GetChildCount( const wxDataViewItem
& parent
) const;
1114 void SetItemText( const wxDataViewItem
& item
, const wxString
&text
);
1115 wxString
GetItemText( const wxDataViewItem
& item
) const;
1116 void SetItemIcon( const wxDataViewItem
& item
, const wxIcon
&icon
);
1117 const wxIcon
&GetItemIcon( const wxDataViewItem
& item
) const;
1118 void SetItemExpandedIcon( const wxDataViewItem
& item
, const wxIcon
&icon
);
1119 const wxIcon
&GetItemExpandedIcon( const wxDataViewItem
& item
) const;
1120 void SetItemData( const wxDataViewItem
& item
, wxClientData
*data
);
1121 wxClientData
*GetItemData( const wxDataViewItem
& item
) const;
1123 void DeleteItem( const wxDataViewItem
& item
);
1124 void DeleteChildren( const wxDataViewItem
& item
);
1125 void DeleteAllItems();
1127 // implement base methods
1129 virtual void GetValue( wxVariant
&variant
,
1130 const wxDataViewItem
&item
, unsigned int col
) const;
1131 virtual bool SetValue( const wxVariant
&variant
,
1132 const wxDataViewItem
&item
, unsigned int col
);
1133 virtual wxDataViewItem
GetParent( const wxDataViewItem
&item
) const;
1134 virtual bool IsContainer( const wxDataViewItem
&item
) const;
1135 virtual unsigned int GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const;
1137 virtual int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
1138 unsigned int column
, bool ascending
) const;
1140 virtual bool HasDefaultCompare() const
1142 virtual unsigned int GetColumnCount() const
1144 virtual wxString
GetColumnType( unsigned int WXUNUSED(col
) ) const
1145 { return wxT("wxDataViewIconText"); }
1147 wxDataViewTreeStoreNode
*FindNode( const wxDataViewItem
&item
) const;
1148 wxDataViewTreeStoreContainerNode
*FindContainerNode( const wxDataViewItem
&item
) const;
1149 wxDataViewTreeStoreNode
*GetRoot() const { return m_root
; }
1152 wxDataViewTreeStoreNode
*m_root
;
1155 //-----------------------------------------------------------------------------
1157 class WXDLLIMPEXP_ADV wxDataViewTreeCtrl
: public wxDataViewCtrl
1160 wxDataViewTreeCtrl() { Init(); }
1161 wxDataViewTreeCtrl(wxWindow
*parent
,
1163 const wxPoint
& pos
= wxDefaultPosition
,
1164 const wxSize
& size
= wxDefaultSize
,
1165 long style
= wxDV_NO_HEADER
| wxDV_ROW_LINES
,
1166 const wxValidator
& validator
= wxDefaultValidator
)
1170 Create(parent
, id
, pos
, size
, style
, validator
);
1173 virtual ~wxDataViewTreeCtrl();
1175 bool Create(wxWindow
*parent
,
1177 const wxPoint
& pos
= wxDefaultPosition
,
1178 const wxSize
& size
= wxDefaultSize
,
1179 long style
= wxDV_NO_HEADER
| wxDV_ROW_LINES
,
1180 const wxValidator
& validator
= wxDefaultValidator
);
1182 wxDataViewTreeStore
*GetStore()
1183 { return (wxDataViewTreeStore
*) GetModel(); }
1184 const wxDataViewTreeStore
*GetStore() const
1185 { return (const wxDataViewTreeStore
*) GetModel(); }
1187 bool IsContainer( const wxDataViewItem
& item
) const
1188 { return GetStore()->IsContainer(item
); }
1190 void SetImageList( wxImageList
*imagelist
);
1191 wxImageList
* GetImageList() { return m_imageList
; }
1193 wxDataViewItem
AppendItem( const wxDataViewItem
& parent
,
1194 const wxString
&text
, int icon
= -1, wxClientData
*data
= NULL
);
1195 wxDataViewItem
PrependItem( const wxDataViewItem
& parent
,
1196 const wxString
&text
, int icon
= -1, wxClientData
*data
= NULL
);
1197 wxDataViewItem
InsertItem( const wxDataViewItem
& parent
, const wxDataViewItem
& previous
,
1198 const wxString
&text
, int icon
= -1, wxClientData
*data
= NULL
);
1200 wxDataViewItem
PrependContainer( const wxDataViewItem
& parent
,
1201 const wxString
&text
, int icon
= -1, int expanded
= -1,
1202 wxClientData
*data
= NULL
);
1203 wxDataViewItem
AppendContainer( const wxDataViewItem
& parent
,
1204 const wxString
&text
, int icon
= -1, int expanded
= -1,
1205 wxClientData
*data
= NULL
);
1206 wxDataViewItem
InsertContainer( const wxDataViewItem
& parent
, const wxDataViewItem
& previous
,
1207 const wxString
&text
, int icon
= -1, int expanded
= -1,
1208 wxClientData
*data
= NULL
);
1210 wxDataViewItem
GetNthChild( const wxDataViewItem
& parent
, unsigned int pos
) const
1211 { return GetStore()->GetNthChild(parent
, pos
); }
1212 int GetChildCount( const wxDataViewItem
& parent
) const
1213 { return GetStore()->GetChildCount(parent
); }
1215 void SetItemText( const wxDataViewItem
& item
, const wxString
&text
);
1216 wxString
GetItemText( const wxDataViewItem
& item
) const
1217 { return GetStore()->GetItemText(item
); }
1218 void SetItemIcon( const wxDataViewItem
& item
, const wxIcon
&icon
);
1219 const wxIcon
&GetItemIcon( const wxDataViewItem
& item
) const
1220 { return GetStore()->GetItemIcon(item
); }
1221 void SetItemExpandedIcon( const wxDataViewItem
& item
, const wxIcon
&icon
);
1222 const wxIcon
&GetItemExpandedIcon( const wxDataViewItem
& item
) const
1223 { return GetStore()->GetItemExpandedIcon(item
); }
1224 void SetItemData( const wxDataViewItem
& item
, wxClientData
*data
)
1225 { GetStore()->SetItemData(item
,data
); }
1226 wxClientData
*GetItemData( const wxDataViewItem
& item
) const
1227 { return GetStore()->GetItemData(item
); }
1229 void DeleteItem( const wxDataViewItem
& item
);
1230 void DeleteChildren( const wxDataViewItem
& item
);
1231 void DeleteAllItems();
1233 void OnExpanded( wxDataViewEvent
&event
);
1234 void OnCollapsed( wxDataViewEvent
&event
);
1235 void OnSize( wxSizeEvent
&event
);
1243 wxImageList
*m_imageList
;
1246 DECLARE_EVENT_TABLE()
1247 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewTreeCtrl
)
1250 #endif // wxUSE_DATAVIEWCTRL
1253 // _WX_DATAVIEW_H_BASE_