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 // ----------------------------------------------------------------------------
36 // wxDataViewCtrl globals
37 // ----------------------------------------------------------------------------
39 class WXDLLIMPEXP_FWD_ADV wxDataViewItem
;
40 class WXDLLIMPEXP_FWD_ADV wxDataViewModel
;
41 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl
;
42 class WXDLLIMPEXP_FWD_ADV wxDataViewColumn
;
43 class WXDLLIMPEXP_FWD_ADV wxDataViewRenderer
;
44 class WXDLLIMPEXP_FWD_ADV wxDataViewModelNotifier
;
46 extern WXDLLIMPEXP_DATA_ADV(const char) wxDataViewCtrlNameStr
[];
48 // ----------------------------------------------------------------------------
49 // wxDataViewCtrl flags
50 // ----------------------------------------------------------------------------
52 // size of a wxDataViewRenderer without contents:
53 #define wxDVC_DEFAULT_RENDERER_SIZE 20
55 // the default width of new (text) columns:
56 #define wxDVC_DEFAULT_WIDTH 80
58 // the default width of new toggle columns:
59 #define wxDVC_TOGGLE_DEFAULT_WIDTH 30
61 // the default minimal width of the columns:
62 #define wxDVC_DEFAULT_MINWIDTH 30
64 // The default alignment of wxDataViewRenderers is to take
65 // the alignment from the column it owns.
66 #define wxDVR_DEFAULT_ALIGNMENT -1
69 // ---------------------------------------------------------
71 // ---------------------------------------------------------
73 class WXDLLIMPEXP_ADV wxDataViewItem
76 wxDataViewItem( void* id
= NULL
)
78 wxDataViewItem( const wxDataViewItem
&item
)
80 bool IsOk() const { return m_id
!= NULL
; }
81 void* GetID() const { return m_id
; }
82 operator const void* () const { return m_id
; }
88 bool operator == (const wxDataViewItem
&left
, const wxDataViewItem
&right
);
90 WX_DEFINE_ARRAY(wxDataViewItem
, wxDataViewItemArray
);
92 // ---------------------------------------------------------
93 // wxDataViewModelNotifier
94 // ---------------------------------------------------------
96 class WXDLLIMPEXP_ADV wxDataViewModelNotifier
99 wxDataViewModelNotifier() { m_owner
= NULL
; }
100 virtual ~wxDataViewModelNotifier() { m_owner
= NULL
; }
102 virtual bool ItemAdded( const wxDataViewItem
&parent
, const wxDataViewItem
&item
) = 0;
103 virtual bool ItemDeleted( const wxDataViewItem
&parent
, const wxDataViewItem
&item
) = 0;
104 virtual bool ItemChanged( const wxDataViewItem
&item
) = 0;
105 virtual bool ItemsAdded( const wxDataViewItem
&parent
, const wxDataViewItemArray
&items
);
106 virtual bool ItemsDeleted( const wxDataViewItem
&parent
, const wxDataViewItemArray
&items
);
107 virtual bool ItemsChanged( const wxDataViewItemArray
&items
);
108 virtual bool ValueChanged( const wxDataViewItem
&item
, unsigned int col
) = 0;
109 virtual bool Cleared() = 0;
111 virtual void Resort() = 0;
113 void SetOwner( wxDataViewModel
*owner
) { m_owner
= owner
; }
114 wxDataViewModel
*GetOwner() const { return m_owner
; }
117 wxDataViewModel
*m_owner
;
122 // ----------------------------------------------------------------------------
123 // wxDataViewItemAttr: a structure containing the visual attributes of an item
124 // ----------------------------------------------------------------------------
126 // TODO: this should be renamed to wxItemAttr or something general like this
128 class WXDLLIMPEXP_ADV wxDataViewItemAttr
139 void SetColour(const wxColour
& colour
) { m_colour
= colour
; }
140 void SetBold( bool set
) { m_bold
= set
; }
141 void SetItalic( bool set
) { m_italic
= set
; }
144 bool HasColour() const { return m_colour
.Ok(); }
145 const wxColour
& GetColour() const { return m_colour
; }
147 bool GetBold() const { return m_bold
; }
148 bool GetItalic() const { return m_italic
; }
157 // ---------------------------------------------------------
159 // ---------------------------------------------------------
161 WX_DECLARE_LIST_WITH_DECL(wxDataViewModelNotifier
, wxDataViewModelNotifiers
,
162 class WXDLLIMPEXP_ADV
);
164 class WXDLLIMPEXP_ADV wxDataViewModel
: public wxRefCounter
169 virtual unsigned int GetColumnCount() const = 0;
171 // return type as reported by wxVariant
172 virtual wxString
GetColumnType( unsigned int col
) const = 0;
174 // get value into a wxVariant
175 virtual void GetValue( wxVariant
&variant
,
176 const wxDataViewItem
&item
, unsigned int col
) const = 0;
178 // set value, call ValueChanged() afterwards!
179 virtual bool SetValue( const wxVariant
&variant
,
180 const wxDataViewItem
&item
, unsigned int col
) = 0;
182 // Get text attribute, return false of default attributes should be used
183 virtual bool GetAttr( const wxDataViewItem
&WXUNUSED(item
), unsigned int WXUNUSED(col
), wxDataViewItemAttr
&WXUNUSED(attr
) )
187 virtual wxDataViewItem
GetParent( const wxDataViewItem
&item
) const = 0;
188 virtual bool IsContainer( const wxDataViewItem
&item
) const = 0;
189 // Is the container just a header or an item with all columns
190 virtual bool HasContainerColumns(const wxDataViewItem
& WXUNUSED(item
)) const
192 virtual unsigned int GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const = 0;
194 // delegated notifiers
195 virtual bool ItemAdded( const wxDataViewItem
&parent
, const wxDataViewItem
&item
);
196 virtual bool ItemsAdded( const wxDataViewItem
&parent
, const wxDataViewItemArray
&items
);
197 virtual bool ItemDeleted( const wxDataViewItem
&parent
, const wxDataViewItem
&item
);
198 virtual bool ItemsDeleted( const wxDataViewItem
&parent
, const wxDataViewItemArray
&items
);
199 virtual bool ItemChanged( const wxDataViewItem
&item
);
200 virtual bool ItemsChanged( const wxDataViewItemArray
&items
);
201 virtual bool ValueChanged( const wxDataViewItem
&item
, unsigned int col
);
202 virtual bool Cleared();
205 virtual void Resort();
207 void AddNotifier( wxDataViewModelNotifier
*notifier
);
208 void RemoveNotifier( wxDataViewModelNotifier
*notifier
);
210 // default compare function
211 virtual int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
212 unsigned int column
, bool ascending
) const;
213 virtual bool HasDefaultCompare() const { return false; }
216 virtual bool IsVirtualListModel() const { return false; }
219 // the user should not delete this class directly: he should use DecRef() instead!
220 virtual ~wxDataViewModel() { }
222 wxDataViewModelNotifiers m_notifiers
;
225 // ---------------------------------------------------------
226 // wxDataViewIndexListModel
227 // ---------------------------------------------------------
229 class WXDLLIMPEXP_ADV wxDataViewIndexListModel
: public wxDataViewModel
232 wxDataViewIndexListModel( unsigned int initial_size
= 0 );
233 ~wxDataViewIndexListModel();
235 virtual void GetValueByRow( wxVariant
&variant
,
236 unsigned int row
, unsigned int col
) const = 0;
238 virtual bool SetValueByRow( const wxVariant
&variant
,
239 unsigned int row
, unsigned int col
) = 0;
241 virtual bool GetAttrByRow( unsigned int WXUNUSED(row
), unsigned int WXUNUSED(col
), wxDataViewItemAttr
&WXUNUSED(attr
) )
245 void RowInserted( unsigned int before
);
247 void RowDeleted( unsigned int row
);
248 void RowsDeleted( const wxArrayInt
&rows
);
249 void RowChanged( unsigned int row
);
250 void RowValueChanged( unsigned int row
, unsigned int col
);
251 void Reset( unsigned int new_size
);
253 // convert to/from row/wxDataViewItem
255 unsigned int GetRow( const wxDataViewItem
&item
) const;
256 wxDataViewItem
GetItem( unsigned int row
) const;
258 // compare based on index
260 virtual int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
261 unsigned int column
, bool ascending
) const;
262 virtual bool HasDefaultCompare() const;
264 // implement base methods
266 virtual void GetValue( wxVariant
&variant
,
267 const wxDataViewItem
&item
, unsigned int col
) const;
268 virtual bool SetValue( const wxVariant
&variant
,
269 const wxDataViewItem
&item
, unsigned int col
);
270 virtual bool GetAttr( const wxDataViewItem
&item
, unsigned int col
, wxDataViewItemAttr
&attr
);
271 virtual wxDataViewItem
GetParent( const wxDataViewItem
&item
) const;
272 virtual bool IsContainer( const wxDataViewItem
&item
) const;
273 virtual unsigned int GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const;
276 virtual bool IsVirtualListModel() const { return false; }
277 unsigned int GetLastIndex() const { return m_lastIndex
; }
280 wxDataViewItemArray m_hash
;
281 unsigned int m_lastIndex
;
285 // ---------------------------------------------------------
286 // wxDataViewVirtualListModel
287 // ---------------------------------------------------------
290 // better than nothing
291 typedef wxDataViewIndexListModel wxDataViewVirtualListModel
;
294 class WXDLLIMPEXP_ADV wxDataViewVirtualListModel
: public wxDataViewModel
297 wxDataViewVirtualListModel( unsigned int initial_size
= 0 );
298 ~wxDataViewVirtualListModel();
300 virtual void GetValueByRow( wxVariant
&variant
,
301 unsigned int row
, unsigned int col
) const = 0;
303 virtual bool SetValueByRow( const wxVariant
&variant
,
304 unsigned int row
, unsigned int col
) = 0;
306 virtual bool GetAttrByRow( unsigned int WXUNUSED(row
), unsigned int WXUNUSED(col
), wxDataViewItemAttr
&WXUNUSED(attr
) )
310 void RowInserted( unsigned int before
);
312 void RowDeleted( unsigned int row
);
313 void RowsDeleted( const wxArrayInt
&rows
);
314 void RowChanged( unsigned int row
);
315 void RowValueChanged( unsigned int row
, unsigned int col
);
316 void Reset( unsigned int new_size
);
318 // convert to/from row/wxDataViewItem
320 unsigned int GetRow( const wxDataViewItem
&item
) const;
321 wxDataViewItem
GetItem( unsigned int row
) const;
323 // compare based on index
325 virtual int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
326 unsigned int column
, bool ascending
) const;
327 virtual bool HasDefaultCompare() const;
329 // implement base methods
331 virtual void GetValue( wxVariant
&variant
,
332 const wxDataViewItem
&item
, unsigned int col
) const;
333 virtual bool SetValue( const wxVariant
&variant
,
334 const wxDataViewItem
&item
, unsigned int col
);
335 virtual bool GetAttr( const wxDataViewItem
&item
, unsigned int col
, wxDataViewItemAttr
&attr
);
336 virtual wxDataViewItem
GetParent( const wxDataViewItem
&item
) const;
337 virtual bool IsContainer( const wxDataViewItem
&item
) const;
338 virtual unsigned int GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const;
341 virtual bool IsVirtualListModel() const { return true; }
342 unsigned int GetLastIndex() const { return m_lastIndex
; }
345 wxDataViewItemArray m_hash
;
346 unsigned int m_lastIndex
;
351 //-----------------------------------------------------------------------------
352 // wxDataViewEditorCtrlEvtHandler
353 //-----------------------------------------------------------------------------
355 class wxDataViewEditorCtrlEvtHandler
: public wxEvtHandler
358 wxDataViewEditorCtrlEvtHandler( wxControl
*editor
, wxDataViewRenderer
*owner
);
360 void AcceptChangesAndFinish();
361 void SetFocusOnIdle( bool focus
= true ) { m_focusOnIdle
= focus
; }
364 void OnChar( wxKeyEvent
&event
);
365 void OnTextEnter( wxCommandEvent
&event
);
366 void OnKillFocus( wxFocusEvent
&event
);
367 void OnIdle( wxIdleEvent
&event
);
370 wxDataViewRenderer
*m_owner
;
371 wxControl
*m_editorCtrl
;
376 DECLARE_EVENT_TABLE()
379 // ---------------------------------------------------------
380 // wxDataViewRendererBase
381 // ---------------------------------------------------------
383 enum wxDataViewCellMode
385 wxDATAVIEW_CELL_INERT
,
386 wxDATAVIEW_CELL_ACTIVATABLE
,
387 wxDATAVIEW_CELL_EDITABLE
390 enum wxDataViewCellRenderState
392 wxDATAVIEW_CELL_SELECTED
= 1,
393 wxDATAVIEW_CELL_PRELIT
= 2,
394 wxDATAVIEW_CELL_INSENSITIVE
= 4,
395 wxDATAVIEW_CELL_FOCUSED
= 8
398 class WXDLLIMPEXP_ADV wxDataViewRendererBase
: public wxObject
401 wxDataViewRendererBase( const wxString
&varianttype
,
402 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
403 int alignment
= wxDVR_DEFAULT_ALIGNMENT
);
404 ~wxDataViewRendererBase();
406 virtual bool Validate( wxVariant
& WXUNUSED(value
) )
409 void SetOwner( wxDataViewColumn
*owner
) { m_owner
= owner
; }
410 wxDataViewColumn
* GetOwner() const { return m_owner
; }
412 // renderer properties:
414 virtual bool SetValue( const wxVariant
& WXUNUSED(value
) ) = 0;
415 virtual bool GetValue( wxVariant
& WXUNUSED(value
) ) const = 0;
417 wxString
GetVariantType() const { return m_variantType
; }
419 virtual void SetMode( wxDataViewCellMode mode
) = 0;
420 virtual wxDataViewCellMode
GetMode() const = 0;
422 // NOTE: Set/GetAlignment do not take/return a wxAlignment enum but
423 // rather an "int"; that's because for rendering cells it's allowed
424 // to combine alignment flags (e.g. wxALIGN_LEFT|wxALIGN_BOTTOM)
425 virtual void SetAlignment( int align
) = 0;
426 virtual int GetAlignment() const = 0;
429 virtual bool HasEditorCtrl() const
431 virtual wxControl
* CreateEditorCtrl(wxWindow
* WXUNUSED(parent
),
432 wxRect
WXUNUSED(labelRect
),
433 const wxVariant
& WXUNUSED(value
))
435 virtual bool GetValueFromEditorCtrl(wxControl
* WXUNUSED(editor
),
436 wxVariant
& WXUNUSED(value
))
439 virtual bool StartEditing( const wxDataViewItem
&item
, wxRect labelRect
);
440 virtual void CancelEditing();
441 virtual bool FinishEditing();
443 wxControl
*GetEditorCtrl() { return m_editorCtrl
; }
446 wxString m_variantType
;
447 wxDataViewColumn
*m_owner
;
448 wxWeakRef
<wxControl
> m_editorCtrl
;
449 wxDataViewItem m_item
; // for m_editorCtrl
452 const wxDataViewCtrl
* GetView() const;
455 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase
)
458 //-----------------------------------------------------------------------------
459 // wxDataViewIconText
460 //-----------------------------------------------------------------------------
462 class WXDLLIMPEXP_ADV wxDataViewIconText
: public wxObject
465 wxDataViewIconText( const wxString
&text
= wxEmptyString
, const wxIcon
& icon
= wxNullIcon
)
466 : m_text(text
), m_icon(icon
)
468 wxDataViewIconText( const wxDataViewIconText
&other
)
470 { m_icon
= other
.m_icon
; m_text
= other
.m_text
; }
472 void SetText( const wxString
&text
) { m_text
= text
; }
473 wxString
GetText() const { return m_text
; }
474 void SetIcon( const wxIcon
&icon
) { m_icon
= icon
; }
475 const wxIcon
&GetIcon() const { return m_icon
; }
482 DECLARE_DYNAMIC_CLASS(wxDataViewIconText
)
485 bool operator == (const wxDataViewIconText
&one
, const wxDataViewIconText
&two
);
487 DECLARE_VARIANT_OBJECT_EXPORTED(wxDataViewIconText
, WXDLLIMPEXP_ADV
)
489 // ---------------------------------------------------------
490 // wxDataViewColumnBase
491 // ---------------------------------------------------------
493 // for compatibility only, do not use
494 enum wxDataViewColumnFlags
496 wxDATAVIEW_COL_RESIZABLE
= wxCOL_RESIZABLE
,
497 wxDATAVIEW_COL_SORTABLE
= wxCOL_SORTABLE
,
498 wxDATAVIEW_COL_REORDERABLE
= wxCOL_REORDERABLE
,
499 wxDATAVIEW_COL_HIDDEN
= wxCOL_HIDDEN
502 class WXDLLIMPEXP_ADV wxDataViewColumnBase
: public wxSettableHeaderColumn
505 // ctor for the text columns: takes ownership of renderer
506 wxDataViewColumnBase(wxDataViewRenderer
*renderer
,
507 unsigned int model_column
)
509 Init(renderer
, model_column
);
512 // ctor for the bitmap columns
513 wxDataViewColumnBase(const wxBitmap
& bitmap
,
514 wxDataViewRenderer
*renderer
,
515 unsigned int model_column
)
518 Init(renderer
, model_column
);
521 virtual ~wxDataViewColumnBase();
524 virtual void SetOwner( wxDataViewCtrl
*owner
)
528 unsigned int GetModelColumn() const { return static_cast<unsigned int>(m_model_column
); }
529 wxDataViewCtrl
*GetOwner() const { return m_owner
; }
530 wxDataViewRenderer
* GetRenderer() const { return m_renderer
; }
532 // implement some of base class pure virtuals (the rest is port-dependent
533 // and done differently in generic and native versions)
534 virtual void SetBitmap( const wxBitmap
& bitmap
) { m_bitmap
= bitmap
; }
535 virtual wxBitmap
GetBitmap() const { return m_bitmap
; }
538 wxDataViewRenderer
*m_renderer
;
541 wxDataViewCtrl
*m_owner
;
544 // common part of all ctors
545 void Init(wxDataViewRenderer
*renderer
, unsigned int model_column
);
548 // ---------------------------------------------------------
549 // wxDataViewCtrlBase
550 // ---------------------------------------------------------
552 #define wxDV_SINGLE 0x0000 // for convenience
553 #define wxDV_MULTIPLE 0x0001 // can select multiple items
555 #define wxDV_NO_HEADER 0x0002 // column titles not visible
556 #define wxDV_HORIZ_RULES 0x0004 // light horizontal rules between rows
557 #define wxDV_VERT_RULES 0x0008 // light vertical rules between columns
559 #define wxDV_ROW_LINES 0x0010 // alternating colour in rows
560 #define wxDV_VARIABLE_LINE_HEIGHT 0x0020 // variable line height
562 class WXDLLIMPEXP_ADV wxDataViewCtrlBase
: public wxControl
565 wxDataViewCtrlBase();
566 virtual ~wxDataViewCtrlBase();
571 virtual bool AssociateModel( wxDataViewModel
*model
);
572 wxDataViewModel
* GetModel();
573 const wxDataViewModel
* GetModel() const;
579 wxDataViewColumn
*PrependTextColumn( const wxString
&label
, unsigned int model_column
,
580 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
581 wxAlignment align
= wxALIGN_NOT
,
582 int flags
= wxDATAVIEW_COL_RESIZABLE
);
583 wxDataViewColumn
*PrependIconTextColumn( const wxString
&label
, unsigned int model_column
,
584 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
585 wxAlignment align
= wxALIGN_NOT
,
586 int flags
= wxDATAVIEW_COL_RESIZABLE
);
587 wxDataViewColumn
*PrependToggleColumn( const wxString
&label
, unsigned int model_column
,
588 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
589 wxAlignment align
= wxALIGN_CENTER
,
590 int flags
= wxDATAVIEW_COL_RESIZABLE
);
591 wxDataViewColumn
*PrependProgressColumn( const wxString
&label
, unsigned int model_column
,
592 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
593 wxAlignment align
= wxALIGN_CENTER
,
594 int flags
= wxDATAVIEW_COL_RESIZABLE
);
595 wxDataViewColumn
*PrependDateColumn( const wxString
&label
, unsigned int model_column
,
596 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
597 wxAlignment align
= wxALIGN_NOT
,
598 int flags
= wxDATAVIEW_COL_RESIZABLE
);
599 wxDataViewColumn
*PrependBitmapColumn( const wxString
&label
, unsigned int model_column
,
600 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
601 wxAlignment align
= wxALIGN_CENTER
,
602 int flags
= wxDATAVIEW_COL_RESIZABLE
);
603 wxDataViewColumn
*PrependTextColumn( const wxBitmap
&label
, unsigned int model_column
,
604 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
605 wxAlignment align
= wxALIGN_NOT
,
606 int flags
= wxDATAVIEW_COL_RESIZABLE
);
607 wxDataViewColumn
*PrependIconTextColumn( const wxBitmap
&label
, unsigned int model_column
,
608 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
609 wxAlignment align
= wxALIGN_NOT
,
610 int flags
= wxDATAVIEW_COL_RESIZABLE
);
611 wxDataViewColumn
*PrependToggleColumn( const wxBitmap
&label
, unsigned int model_column
,
612 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
613 wxAlignment align
= wxALIGN_CENTER
,
614 int flags
= wxDATAVIEW_COL_RESIZABLE
);
615 wxDataViewColumn
*PrependProgressColumn( const wxBitmap
&label
, unsigned int model_column
,
616 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
617 wxAlignment align
= wxALIGN_CENTER
,
618 int flags
= wxDATAVIEW_COL_RESIZABLE
);
619 wxDataViewColumn
*PrependDateColumn( const wxBitmap
&label
, unsigned int model_column
,
620 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
621 wxAlignment align
= wxALIGN_NOT
,
622 int flags
= wxDATAVIEW_COL_RESIZABLE
);
623 wxDataViewColumn
*PrependBitmapColumn( const wxBitmap
&label
, unsigned int model_column
,
624 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
625 wxAlignment align
= wxALIGN_CENTER
,
626 int flags
= wxDATAVIEW_COL_RESIZABLE
);
628 wxDataViewColumn
*AppendTextColumn( const wxString
&label
, unsigned int model_column
,
629 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
630 wxAlignment align
= wxALIGN_NOT
,
631 int flags
= wxDATAVIEW_COL_RESIZABLE
);
632 wxDataViewColumn
*AppendIconTextColumn( const wxString
&label
, unsigned int model_column
,
633 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
634 wxAlignment align
= wxALIGN_NOT
,
635 int flags
= wxDATAVIEW_COL_RESIZABLE
);
636 wxDataViewColumn
*AppendToggleColumn( const wxString
&label
, unsigned int model_column
,
637 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
638 wxAlignment align
= wxALIGN_CENTER
,
639 int flags
= wxDATAVIEW_COL_RESIZABLE
);
640 wxDataViewColumn
*AppendProgressColumn( const wxString
&label
, unsigned int model_column
,
641 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
642 wxAlignment align
= wxALIGN_CENTER
,
643 int flags
= wxDATAVIEW_COL_RESIZABLE
);
644 wxDataViewColumn
*AppendDateColumn( const wxString
&label
, unsigned int model_column
,
645 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
646 wxAlignment align
= wxALIGN_NOT
,
647 int flags
= wxDATAVIEW_COL_RESIZABLE
);
648 wxDataViewColumn
*AppendBitmapColumn( const wxString
&label
, unsigned int model_column
,
649 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
650 wxAlignment align
= wxALIGN_CENTER
,
651 int flags
= wxDATAVIEW_COL_RESIZABLE
);
652 wxDataViewColumn
*AppendTextColumn( const wxBitmap
&label
, unsigned int model_column
,
653 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
654 wxAlignment align
= wxALIGN_NOT
,
655 int flags
= wxDATAVIEW_COL_RESIZABLE
);
656 wxDataViewColumn
*AppendIconTextColumn( const wxBitmap
&label
, unsigned int model_column
,
657 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
658 wxAlignment align
= wxALIGN_NOT
,
659 int flags
= wxDATAVIEW_COL_RESIZABLE
);
660 wxDataViewColumn
*AppendToggleColumn( const wxBitmap
&label
, unsigned int model_column
,
661 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
662 wxAlignment align
= wxALIGN_CENTER
,
663 int flags
= wxDATAVIEW_COL_RESIZABLE
);
664 wxDataViewColumn
*AppendProgressColumn( const wxBitmap
&label
, unsigned int model_column
,
665 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
666 wxAlignment align
= wxALIGN_CENTER
,
667 int flags
= wxDATAVIEW_COL_RESIZABLE
);
668 wxDataViewColumn
*AppendDateColumn( const wxBitmap
&label
, unsigned int model_column
,
669 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
670 wxAlignment align
= wxALIGN_NOT
,
671 int flags
= wxDATAVIEW_COL_RESIZABLE
);
672 wxDataViewColumn
*AppendBitmapColumn( const wxBitmap
&label
, unsigned int model_column
,
673 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
674 wxAlignment align
= wxALIGN_CENTER
,
675 int flags
= wxDATAVIEW_COL_RESIZABLE
);
677 virtual bool PrependColumn( wxDataViewColumn
*col
);
678 virtual bool InsertColumn( unsigned int pos
, wxDataViewColumn
*col
);
679 virtual bool AppendColumn( wxDataViewColumn
*col
);
681 virtual unsigned int GetColumnCount() const = 0;
682 virtual wxDataViewColumn
* GetColumn( unsigned int pos
) const = 0;
683 virtual int GetColumnPosition( const wxDataViewColumn
*column
) const = 0;
685 virtual bool DeleteColumn( wxDataViewColumn
*column
) = 0;
686 virtual bool ClearColumns() = 0;
688 void SetExpanderColumn( wxDataViewColumn
*col
)
689 { m_expander_column
= col
; DoSetExpanderColumn(); }
690 wxDataViewColumn
*GetExpanderColumn() const
691 { return m_expander_column
; }
693 virtual wxDataViewColumn
*GetSortingColumn() const = 0;
699 void SetIndent( int indent
)
700 { m_indent
= indent
; DoSetIndent(); }
701 int GetIndent() const
704 virtual wxDataViewItem
GetSelection() const = 0;
705 virtual int GetSelections( wxDataViewItemArray
& sel
) const = 0;
706 virtual void SetSelections( const wxDataViewItemArray
& sel
) = 0;
707 virtual void Select( const wxDataViewItem
& item
) = 0;
708 virtual void Unselect( const wxDataViewItem
& item
) = 0;
709 virtual bool IsSelected( const wxDataViewItem
& item
) const = 0;
711 virtual void SelectAll() = 0;
712 virtual void UnselectAll() = 0;
714 virtual void Expand( const wxDataViewItem
& item
) = 0;
715 virtual void ExpandAncestors( const wxDataViewItem
& item
);
716 virtual void Collapse( const wxDataViewItem
& item
) = 0;
717 virtual bool IsExpanded( const wxDataViewItem
& item
) const = 0;
719 virtual void EnsureVisible( const wxDataViewItem
& item
,
720 const wxDataViewColumn
*column
= NULL
) = 0;
721 virtual void HitTest( const wxPoint
& point
, wxDataViewItem
&item
, wxDataViewColumn
* &column
) const = 0;
722 virtual wxRect
GetItemRect( const wxDataViewItem
& item
, const wxDataViewColumn
*column
= NULL
) const = 0;
724 #if wxUSE_DRAG_AND_DROP
725 virtual bool EnableDragSource(const wxDataFormat
& WXUNUSED(format
))
727 virtual bool EnableDropTarget(const wxDataFormat
& WXUNUSED(format
))
729 #endif // wxUSE_DRAG_AND_DROP
732 virtual void DoSetExpanderColumn() = 0 ;
733 virtual void DoSetIndent() = 0;
736 wxDataViewModel
*m_model
;
737 wxDataViewColumn
*m_expander_column
;
741 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase
)
744 // ----------------------------------------------------------------------------
745 // wxDataViewEvent - the event class for the wxDataViewCtrl notifications
746 // ----------------------------------------------------------------------------
748 class WXDLLIMPEXP_ADV wxDataViewEvent
: public wxNotifyEvent
751 wxDataViewEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
752 : wxNotifyEvent(commandType
, winid
),
756 m_value(wxNullVariant
),
759 #if wxUSE_DRAG_AND_DROP
760 , m_dataObject(NULL
),
766 wxDataViewEvent(const wxDataViewEvent
& event
)
767 : wxNotifyEvent(event
),
768 m_item(event
.m_item
),
770 m_model(event
.m_model
),
771 m_value(event
.m_value
),
772 m_column(event
.m_column
),
774 #if wxUSE_DRAG_AND_DROP
775 , m_dataObject(event
.m_dataObject
),
776 m_dataFormat(event
.m_dataFormat
),
777 m_dataBuffer(event
.m_dataBuffer
),
778 m_dataSize(event
.m_dataSize
)
782 wxDataViewItem
GetItem() const { return m_item
; }
783 void SetItem( const wxDataViewItem
&item
) { m_item
= item
; }
785 int GetColumn() const { return m_col
; }
786 void SetColumn( int col
) { m_col
= col
; }
788 wxDataViewModel
* GetModel() const { return m_model
; }
789 void SetModel( wxDataViewModel
*model
) { m_model
= model
; }
791 const wxVariant
&GetValue() const { return m_value
; }
792 void SetValue( const wxVariant
&value
) { m_value
= value
; }
794 // for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only
795 void SetDataViewColumn( wxDataViewColumn
*col
) { m_column
= col
; }
796 wxDataViewColumn
*GetDataViewColumn() const { return m_column
; }
798 // for wxEVT_DATAVIEW_CONTEXT_MENU only
799 wxPoint
GetPosition() const { return m_pos
; }
800 void SetPosition( int x
, int y
) { m_pos
.x
= x
; m_pos
.y
= y
; }
802 #if wxUSE_DRAG_AND_DROP
803 // For drag operations
804 void SetDataObject( wxDataObject
*obj
) { m_dataObject
= obj
; }
805 wxDataObject
*GetDataObject() const { return m_dataObject
; }
807 // For drop operations
808 void SetDataFormat( const wxDataFormat
&format
) { m_dataFormat
= format
; }
809 wxDataFormat
GetDataFormat() const { return m_dataFormat
; }
810 void SetDataSize( size_t size
) { m_dataSize
= size
; }
811 size_t GetDataSize() const { return m_dataSize
; }
812 void SetDataBuffer( void* buf
) { m_dataBuffer
= buf
;}
813 void *GetDataBuffer() const { return m_dataBuffer
; }
814 #endif // wxUSE_DRAG_AND_DROP
816 virtual wxEvent
*Clone() const { return new wxDataViewEvent(*this); }
819 wxDataViewItem m_item
;
821 wxDataViewModel
*m_model
;
823 wxDataViewColumn
*m_column
;
826 #if wxUSE_DRAG_AND_DROP
827 wxDataObject
*m_dataObject
;
829 wxDataFormat m_dataFormat
;
832 #endif // wxUSE_DRAG_AND_DROP
835 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent
)
838 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED
, wxDataViewEvent
);
840 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED
, wxDataViewEvent
);
841 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED
, wxDataViewEvent
);
842 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED
, wxDataViewEvent
);
843 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING
, wxDataViewEvent
);
844 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING
, wxDataViewEvent
);
845 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_START_EDITING
, wxDataViewEvent
);
846 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED
, wxDataViewEvent
);
847 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE
, wxDataViewEvent
);
848 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED
, wxDataViewEvent
);
850 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU
, wxDataViewEvent
);
852 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK
, wxDataViewEvent
);
853 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK
, wxDataViewEvent
);
854 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED
, wxDataViewEvent
);
855 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED
, wxDataViewEvent
);
857 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_BEGIN_DRAG
, wxDataViewEvent
);
858 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_DROP_POSSIBLE
, wxDataViewEvent
);
859 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_DROP
, wxDataViewEvent
);
861 typedef void (wxEvtHandler::*wxDataViewEventFunction
)(wxDataViewEvent
&);
863 #define wxDataViewEventHandler(func) \
864 wxEVENT_HANDLER_CAST(wxDataViewEventFunction, func)
866 #define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \
867 wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn))
869 #define EVT_DATAVIEW_SELECTION_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(SELECTION_CHANGED, id, fn)
871 #define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_ACTIVATED, id, fn)
872 #define EVT_DATAVIEW_ITEM_COLLAPSING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSING, id, fn)
873 #define EVT_DATAVIEW_ITEM_COLLAPSED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSED, id, fn)
874 #define EVT_DATAVIEW_ITEM_EXPANDING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDING, id, fn)
875 #define EVT_DATAVIEW_ITEM_EXPANDED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDED, id, fn)
876 #define EVT_DATAVIEW_ITEM_START_EDITING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_START_EDITING, id, fn)
877 #define EVT_DATAVIEW_ITEM_EDITING_STARTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_STARTED, id, fn)
878 #define EVT_DATAVIEW_ITEM_EDITING_DONE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_DONE, id, fn)
879 #define EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_VALUE_CHANGED, id, fn)
881 #define EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_CONTEXT_MENU, id, fn)
883 #define EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_CLICK, id, fn)
884 #define EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_RIGHT_CLICK, id, fn)
885 #define EVT_DATAVIEW_COLUMN_SORTED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_SORTED, id, fn)
886 #define EVT_DATAVIEW_COLUMN_REORDERED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_REORDERED, id, fn)
888 #define EVT_DATAVIEW_ITEM_BEGIN_DRAG(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_BEGIN_DRAG, id, fn)
889 #define EVT_DATAVIEW_ITEM_DROP_POSSIBLE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_DROP_POSSIBLE, id, fn)
890 #define EVT_DATAVIEW_ITEM_DROP(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_DROP, id, fn)
892 #ifdef wxHAS_GENERIC_DATAVIEWCTRL
893 // this symbol doesn't follow the convention for wxUSE_XXX symbols which
894 // are normally always defined as either 0 or 1, so its use is deprecated
895 // and it only exists for backwards compatibility, don't use it any more
896 // and use wxHAS_GENERIC_DATAVIEWCTRL instead
897 #define wxUSE_GENERICDATAVIEWCTRL
899 #include "wx/generic/dataview.h"
900 #elif defined(__WXGTK20__)
901 #include "wx/gtk/dataview.h"
902 #elif defined(__WXMAC__)
903 #include "wx/osx/dataview.h"
905 #error "unknown native wxDataViewCtrl implementation"
908 // -------------------------------------
909 // wxDataViewSpinRenderer
910 // -------------------------------------
912 class WXDLLIMPEXP_ADV wxDataViewSpinRenderer
: public wxDataViewCustomRenderer
915 wxDataViewSpinRenderer( int min
, int max
,
916 wxDataViewCellMode mode
= wxDATAVIEW_CELL_EDITABLE
,
917 int alignment
= wxDVR_DEFAULT_ALIGNMENT
);
918 virtual bool HasEditorCtrl() const { return true; }
919 virtual wxControl
* CreateEditorCtrl( wxWindow
*parent
, wxRect labelRect
, const wxVariant
&value
);
920 virtual bool GetValueFromEditorCtrl( wxControl
* editor
, wxVariant
&value
);
921 virtual bool Render( wxRect rect
, wxDC
*dc
, int state
);
922 virtual wxSize
GetSize() const;
923 virtual bool SetValue( const wxVariant
&value
);
924 virtual bool GetValue( wxVariant
&value
) const;
931 #if defined(wxHAS_GENERIC_DATAVIEWCTRL) || defined(__WXOSX_CARBON__)
933 // -------------------------------------
934 // wxDataViewChoiceRenderer
935 // -------------------------------------
937 class WXDLLIMPEXP_ADV wxDataViewChoiceRenderer
: public wxDataViewCustomRenderer
940 wxDataViewChoiceRenderer( const wxArrayString
&choices
,
941 wxDataViewCellMode mode
= wxDATAVIEW_CELL_EDITABLE
,
942 int alignment
= wxDVR_DEFAULT_ALIGNMENT
);
943 virtual bool HasEditorCtrl() const { return true; }
944 virtual wxControl
* CreateEditorCtrl( wxWindow
*parent
, wxRect labelRect
, const wxVariant
&value
);
945 virtual bool GetValueFromEditorCtrl( wxControl
* editor
, wxVariant
&value
);
946 virtual bool Render( wxRect rect
, wxDC
*dc
, int state
);
947 virtual wxSize
GetSize() const;
948 virtual bool SetValue( const wxVariant
&value
);
949 virtual bool GetValue( wxVariant
&value
) const;
952 wxArrayString m_choices
;
958 //-----------------------------------------------------------------------------
959 // wxDataViewListStore
960 //-----------------------------------------------------------------------------
962 class WXDLLIMPEXP_ADV wxDataViewListStoreLine
965 wxDataViewListStoreLine( wxClientData
*data
= NULL
)
969 virtual ~wxDataViewListStoreLine()
974 void SetData( wxClientData
*data
)
975 { if (m_data
) delete m_data
; m_data
= data
; }
976 wxClientData
*GetData() const
979 wxVector
<wxVariant
> m_values
;
982 wxClientData
*m_data
;
986 class WXDLLIMPEXP_ADV wxDataViewListStore
: public wxDataViewIndexListModel
989 wxDataViewListStore();
990 ~wxDataViewListStore();
992 void PrependColumn( const wxString
&varianttype
);
993 void InsertColumn( unsigned int pos
, const wxString
&varianttype
);
994 void AppendColumn( const wxString
&varianttype
);
996 void AppendItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
997 void PrependItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
998 void InsertItem( unsigned int row
, const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
999 void DeleteItem( unsigned int pos
);
1000 void DeleteAllItems();
1002 // override base virtuals
1004 virtual unsigned int GetColumnCount() const;
1006 virtual wxString
GetColumnType( unsigned int col
) const;
1008 virtual void GetValueByRow( wxVariant
&value
,
1009 unsigned int row
, unsigned int col
) const;
1011 virtual bool SetValueByRow( const wxVariant
&value
,
1012 unsigned int row
, unsigned int col
);
1016 wxVector
<wxDataViewListStoreLine
*> m_data
;
1017 wxArrayString m_cols
;
1020 //-----------------------------------------------------------------------------
1022 class WXDLLIMPEXP_ADV wxDataViewListCtrl
: public wxDataViewCtrl
1025 wxDataViewListCtrl();
1026 wxDataViewListCtrl( wxWindow
*parent
, wxWindowID id
,
1027 const wxPoint
& pos
= wxDefaultPosition
,
1028 const wxSize
& size
= wxDefaultSize
, long style
= wxDV_ROW_LINES
,
1029 const wxValidator
& validator
= wxDefaultValidator
);
1030 ~wxDataViewListCtrl();
1032 bool Create( wxWindow
*parent
, wxWindowID id
,
1033 const wxPoint
& pos
= wxDefaultPosition
,
1034 const wxSize
& size
= wxDefaultSize
, long style
= wxDV_ROW_LINES
,
1035 const wxValidator
& validator
= wxDefaultValidator
);
1037 wxDataViewListStore
*GetStore()
1038 { return (wxDataViewListStore
*) GetModel(); }
1039 const wxDataViewListStore
*GetStore() const
1040 { return (const wxDataViewListStore
*) GetModel(); }
1042 bool AppendColumn( wxDataViewColumn
*column
, const wxString
&varianttype
);
1043 bool PrependColumn( wxDataViewColumn
*column
, const wxString
&varianttype
);
1044 bool InsertColumn( unsigned int pos
, wxDataViewColumn
*column
, const wxString
&varianttype
);
1046 // overridden from base class
1047 virtual bool PrependColumn( wxDataViewColumn
*col
);
1048 virtual bool InsertColumn( unsigned int pos
, wxDataViewColumn
*col
);
1049 virtual bool AppendColumn( wxDataViewColumn
*col
);
1051 wxDataViewColumn
*AppendTextColumn( const wxString
&label
,
1052 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1053 int width
= -1, wxAlignment align
= wxALIGN_LEFT
, int flags
= wxDATAVIEW_COL_RESIZABLE
);
1054 wxDataViewColumn
*AppendToggleColumn( const wxString
&label
,
1055 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
,
1056 int width
= -1, wxAlignment align
= wxALIGN_LEFT
, int flags
= wxDATAVIEW_COL_RESIZABLE
);
1057 wxDataViewColumn
*AppendProgressColumn( const wxString
&label
,
1058 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1059 int width
= -1, wxAlignment align
= wxALIGN_LEFT
, int flags
= wxDATAVIEW_COL_RESIZABLE
);
1060 wxDataViewColumn
*AppendIconTextColumn( const wxString
&label
,
1061 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1062 int width
= -1, wxAlignment align
= wxALIGN_LEFT
, int flags
= wxDATAVIEW_COL_RESIZABLE
);
1064 void AppendItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
)
1065 { GetStore()->AppendItem( values
, data
); }
1066 void PrependItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
)
1067 { GetStore()->PrependItem( values
, data
); }
1068 void InsertItem( unsigned int row
, const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
)
1069 { GetStore()->InsertItem( row
, values
, data
); }
1070 void DeleteItem( unsigned row
)
1071 { GetStore()->DeleteItem( row
); }
1072 void DeleteAllItems()
1073 { GetStore()->DeleteAllItems(); }
1075 void SetValue( const wxVariant
&value
, unsigned int row
, unsigned int col
)
1076 { GetStore()->SetValueByRow( value
, row
, col
);
1077 GetStore()->RowValueChanged( row
, col
); }
1078 void GetValue( wxVariant
&value
, unsigned int row
, unsigned int col
)
1079 { GetStore()->GetValueByRow( value
, row
, col
); }
1081 void SetTextValue( const wxString
&value
, unsigned int row
, unsigned int col
)
1082 { GetStore()->SetValueByRow( value
, row
, col
);
1083 GetStore()->RowValueChanged( row
, col
); }
1084 wxString
GetTextValue( unsigned int row
, unsigned int col
) const
1085 { wxVariant value
; GetStore()->GetValueByRow( value
, row
, col
); return value
.GetString(); }
1087 void SetToggleValue( bool value
, unsigned int row
, unsigned int col
)
1088 { GetStore()->SetValueByRow( value
, row
, col
);
1089 GetStore()->RowValueChanged( row
, col
); }
1090 bool GetToggleValue( unsigned int row
, unsigned int col
) const
1091 { wxVariant value
; GetStore()->GetValueByRow( value
, row
, col
); return value
.GetBool(); }
1093 void OnSize( wxSizeEvent
&event
);
1096 DECLARE_EVENT_TABLE()
1097 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewListCtrl
)
1100 //-----------------------------------------------------------------------------
1101 // wxDataViewTreeStore
1102 //-----------------------------------------------------------------------------
1104 class WXDLLIMPEXP_ADV wxDataViewTreeStoreNode
1107 wxDataViewTreeStoreNode( wxDataViewTreeStoreNode
*parent
,
1108 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, wxClientData
*data
= NULL
);
1109 virtual ~wxDataViewTreeStoreNode();
1111 void SetText( const wxString
&text
)
1113 wxString
GetText() const
1115 void SetIcon( const wxIcon
&icon
)
1117 const wxIcon
&GetIcon() const
1119 void SetData( wxClientData
*data
)
1120 { if (m_data
) delete m_data
; m_data
= data
; }
1121 wxClientData
*GetData() const
1124 wxDataViewItem
GetItem() const
1125 { return wxDataViewItem( (void*) this ); }
1127 virtual bool IsContainer()
1130 wxDataViewTreeStoreNode
*GetParent()
1131 { return m_parent
; }
1134 wxDataViewTreeStoreNode
*m_parent
;
1137 wxClientData
*m_data
;
1140 WX_DECLARE_LIST_WITH_DECL(wxDataViewTreeStoreNode
, wxDataViewTreeStoreNodeList
,
1141 class WXDLLIMPEXP_ADV
);
1143 class WXDLLIMPEXP_ADV wxDataViewTreeStoreContainerNode
: public wxDataViewTreeStoreNode
1146 wxDataViewTreeStoreContainerNode( wxDataViewTreeStoreNode
*parent
,
1147 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, const wxIcon
&expanded
= wxNullIcon
,
1148 wxClientData
*data
= NULL
);
1149 virtual ~wxDataViewTreeStoreContainerNode();
1151 const wxDataViewTreeStoreNodeList
&GetChildren() const
1152 { return m_children
; }
1153 wxDataViewTreeStoreNodeList
&GetChildren()
1154 { return m_children
; }
1156 void SetExpandedIcon( const wxIcon
&icon
)
1157 { m_iconExpanded
= icon
; }
1158 const wxIcon
&GetExpandedIcon() const
1159 { return m_iconExpanded
; }
1161 void SetExpanded( bool expanded
= true )
1162 { m_isExpanded
= expanded
; }
1163 bool IsExpanded() const
1164 { return m_isExpanded
; }
1166 virtual bool IsContainer()
1170 wxDataViewTreeStoreNodeList m_children
;
1171 wxIcon m_iconExpanded
;
1175 //-----------------------------------------------------------------------------
1177 class WXDLLIMPEXP_ADV wxDataViewTreeStore
: public wxDataViewModel
1180 wxDataViewTreeStore();
1181 ~wxDataViewTreeStore();
1183 wxDataViewItem
AppendItem( const wxDataViewItem
& parent
,
1184 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, wxClientData
*data
= NULL
);
1185 wxDataViewItem
PrependItem( const wxDataViewItem
& parent
,
1186 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, wxClientData
*data
= NULL
);
1187 wxDataViewItem
InsertItem( const wxDataViewItem
& parent
, const wxDataViewItem
& previous
,
1188 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, wxClientData
*data
= NULL
);
1190 wxDataViewItem
PrependContainer( const wxDataViewItem
& parent
,
1191 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, const wxIcon
&expanded
= wxNullIcon
,
1192 wxClientData
*data
= NULL
);
1193 wxDataViewItem
AppendContainer( const wxDataViewItem
& parent
,
1194 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, const wxIcon
&expanded
= wxNullIcon
,
1195 wxClientData
*data
= NULL
);
1196 wxDataViewItem
InsertContainer( const wxDataViewItem
& parent
, const wxDataViewItem
& previous
,
1197 const wxString
&text
, const wxIcon
&icon
= wxNullIcon
, const wxIcon
&expanded
= wxNullIcon
,
1198 wxClientData
*data
= NULL
);
1200 wxDataViewItem
GetNthChild( const wxDataViewItem
& parent
, unsigned int pos
) const;
1201 int GetChildCount( const wxDataViewItem
& parent
) const;
1203 void SetItemText( const wxDataViewItem
& item
, const wxString
&text
);
1204 wxString
GetItemText( const wxDataViewItem
& item
) const;
1205 void SetItemIcon( const wxDataViewItem
& item
, const wxIcon
&icon
);
1206 const wxIcon
&GetItemIcon( const wxDataViewItem
& item
) const;
1207 void SetItemExpandedIcon( const wxDataViewItem
& item
, const wxIcon
&icon
);
1208 const wxIcon
&GetItemExpandedIcon( const wxDataViewItem
& item
) const;
1209 void SetItemData( const wxDataViewItem
& item
, wxClientData
*data
);
1210 wxClientData
*GetItemData( const wxDataViewItem
& item
) const;
1212 void DeleteItem( const wxDataViewItem
& item
);
1213 void DeleteChildren( const wxDataViewItem
& item
);
1214 void DeleteAllItems();
1216 // implement base methods
1218 virtual void GetValue( wxVariant
&variant
,
1219 const wxDataViewItem
&item
, unsigned int col
) const;
1220 virtual bool SetValue( const wxVariant
&variant
,
1221 const wxDataViewItem
&item
, unsigned int col
);
1222 virtual wxDataViewItem
GetParent( const wxDataViewItem
&item
) const;
1223 virtual bool IsContainer( const wxDataViewItem
&item
) const;
1224 virtual unsigned int GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const;
1226 virtual int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
1227 unsigned int column
, bool ascending
) const;
1229 virtual bool HasDefaultCompare() const
1231 virtual unsigned int GetColumnCount() const
1233 virtual wxString
GetColumnType( unsigned int WXUNUSED(col
) ) const
1234 { return wxT("wxDataViewIconText"); }
1236 wxDataViewTreeStoreNode
*FindNode( const wxDataViewItem
&item
) const;
1237 wxDataViewTreeStoreContainerNode
*FindContainerNode( const wxDataViewItem
&item
) const;
1238 wxDataViewTreeStoreNode
*GetRoot() const { return m_root
; }
1241 wxDataViewTreeStoreNode
*m_root
;
1244 //-----------------------------------------------------------------------------
1246 class WXDLLIMPEXP_ADV wxDataViewTreeCtrl
: public wxDataViewCtrl
1249 wxDataViewTreeCtrl();
1250 wxDataViewTreeCtrl( wxWindow
*parent
, wxWindowID id
,
1251 const wxPoint
& pos
= wxDefaultPosition
,
1252 const wxSize
& size
= wxDefaultSize
, long style
= wxDV_NO_HEADER
| wxDV_ROW_LINES
,
1253 const wxValidator
& validator
= wxDefaultValidator
);
1254 ~wxDataViewTreeCtrl();
1256 bool Create( wxWindow
*parent
, wxWindowID id
,
1257 const wxPoint
& pos
= wxDefaultPosition
,
1258 const wxSize
& size
= wxDefaultSize
, long style
= wxDV_NO_HEADER
| wxDV_ROW_LINES
,
1259 const wxValidator
& validator
= wxDefaultValidator
);
1261 wxDataViewTreeStore
*GetStore()
1262 { return (wxDataViewTreeStore
*) GetModel(); }
1263 const wxDataViewTreeStore
*GetStore() const
1264 { return (const wxDataViewTreeStore
*) GetModel(); }
1266 void SetImageList( wxImageList
*imagelist
);
1267 wxImageList
* GetImageList() { return m_imageList
; }
1269 wxDataViewItem
AppendItem( const wxDataViewItem
& parent
,
1270 const wxString
&text
, int icon
= -1, wxClientData
*data
= NULL
);
1271 wxDataViewItem
PrependItem( const wxDataViewItem
& parent
,
1272 const wxString
&text
, int icon
= -1, wxClientData
*data
= NULL
);
1273 wxDataViewItem
InsertItem( const wxDataViewItem
& parent
, const wxDataViewItem
& previous
,
1274 const wxString
&text
, int icon
= -1, wxClientData
*data
= NULL
);
1276 wxDataViewItem
PrependContainer( const wxDataViewItem
& parent
,
1277 const wxString
&text
, int icon
= -1, int expanded
= -1,
1278 wxClientData
*data
= NULL
);
1279 wxDataViewItem
AppendContainer( const wxDataViewItem
& parent
,
1280 const wxString
&text
, int icon
= -1, int expanded
= -1,
1281 wxClientData
*data
= NULL
);
1282 wxDataViewItem
InsertContainer( const wxDataViewItem
& parent
, const wxDataViewItem
& previous
,
1283 const wxString
&text
, int icon
= -1, int expanded
= -1,
1284 wxClientData
*data
= NULL
);
1286 wxDataViewItem
GetNthChild( const wxDataViewItem
& parent
, unsigned int pos
) const
1287 { return GetStore()->GetNthChild(parent
, pos
); }
1288 int GetChildCount( const wxDataViewItem
& parent
) const
1289 { return GetStore()->GetChildCount(parent
); }
1291 void SetItemText( const wxDataViewItem
& item
, const wxString
&text
);
1292 wxString
GetItemText( const wxDataViewItem
& item
) const
1293 { return GetStore()->GetItemText(item
); }
1294 void SetItemIcon( const wxDataViewItem
& item
, const wxIcon
&icon
);
1295 const wxIcon
&GetItemIcon( const wxDataViewItem
& item
) const
1296 { return GetStore()->GetItemIcon(item
); }
1297 void SetItemExpandedIcon( const wxDataViewItem
& item
, const wxIcon
&icon
);
1298 const wxIcon
&GetItemExpandedIcon( const wxDataViewItem
& item
) const
1299 { return GetStore()->GetItemExpandedIcon(item
); }
1300 void SetItemData( const wxDataViewItem
& item
, wxClientData
*data
)
1301 { GetStore()->SetItemData(item
,data
); }
1302 wxClientData
*GetItemData( const wxDataViewItem
& item
) const
1303 { return GetStore()->GetItemData(item
); }
1305 void DeleteItem( const wxDataViewItem
& item
);
1306 void DeleteChildren( const wxDataViewItem
& item
);
1307 void DeleteAllItems();
1309 void OnExpanded( wxDataViewEvent
&event
);
1310 void OnCollapsed( wxDataViewEvent
&event
);
1311 void OnSize( wxSizeEvent
&event
);
1314 wxImageList
*m_imageList
;
1317 DECLARE_EVENT_TABLE()
1318 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewTreeCtrl
)
1321 #endif // wxUSE_DATAVIEWCTRL
1324 // _WX_DATAVIEW_H_BASE_