1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/datavcmn.cpp
3 // Purpose: wxDataViewCtrl base classes and common parts
4 // Author: Robert Roebling
7 // Copyright: (c) 2006, Robert Roebling
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
11 // For compilers that support precompilation, includes "wx.h".
12 #include "wx/wxprec.h"
18 #if wxUSE_DATAVIEWCTRL
20 #include "wx/dataview.h"
26 const wxChar wxDataViewCtrlNameStr
[] = wxT("dataviewCtrl");
29 bool operator == (const wxDataViewItem
&left
, const wxDataViewItem
&right
)
31 return (left
.GetID() == right
.GetID() );
35 // ---------------------------------------------------------
37 // ---------------------------------------------------------
39 #include "wx/listimpl.cpp"
40 WX_DEFINE_LIST(wxDataViewModelNotifiers
);
42 wxDataViewModel::wxDataViewModel()
44 m_notifiers
.DeleteContents( true );
47 bool wxDataViewModel::ItemAdded( const wxDataViewItem
&parent
, const wxDataViewItem
&item
)
51 wxDataViewModelNotifiers::iterator iter
;
52 for (iter
= m_notifiers
.begin(); iter
!= m_notifiers
.end(); ++iter
)
54 wxDataViewModelNotifier
* notifier
= *iter
;
55 if (!notifier
->ItemAdded( parent
, item
))
62 bool wxDataViewModel::ItemDeleted( const wxDataViewItem
&parent
, const wxDataViewItem
&item
)
66 wxDataViewModelNotifiers::iterator iter
;
67 for (iter
= m_notifiers
.begin(); iter
!= m_notifiers
.end(); ++iter
)
69 wxDataViewModelNotifier
* notifier
= *iter
;
70 if (!notifier
->ItemDeleted( parent
, item
))
77 bool wxDataViewModel::ItemChanged( const wxDataViewItem
&item
)
81 wxDataViewModelNotifiers::iterator iter
;
82 for (iter
= m_notifiers
.begin(); iter
!= m_notifiers
.end(); ++iter
)
84 wxDataViewModelNotifier
* notifier
= *iter
;
85 if (!notifier
->ItemChanged( item
))
92 bool wxDataViewModel::ValueChanged( const wxDataViewItem
&item
, unsigned int col
)
96 wxDataViewModelNotifiers::iterator iter
;
97 for (iter
= m_notifiers
.begin(); iter
!= m_notifiers
.end(); ++iter
)
99 wxDataViewModelNotifier
* notifier
= *iter
;
100 if (!notifier
->ValueChanged( item
, col
))
107 bool wxDataViewModel::Cleared()
111 wxDataViewModelNotifiers::iterator iter
;
112 for (iter
= m_notifiers
.begin(); iter
!= m_notifiers
.end(); ++iter
)
114 wxDataViewModelNotifier
* notifier
= *iter
;
115 if (!notifier
->Cleared())
122 void wxDataViewModel::Resort()
124 wxDataViewModelNotifiers::iterator iter
;
125 for (iter
= m_notifiers
.begin(); iter
!= m_notifiers
.end(); ++iter
)
127 wxDataViewModelNotifier
* notifier
= *iter
;
132 void wxDataViewModel::AddNotifier( wxDataViewModelNotifier
*notifier
)
134 m_notifiers
.push_back( notifier
);
135 notifier
->SetOwner( this );
138 void wxDataViewModel::RemoveNotifier( wxDataViewModelNotifier
*notifier
)
140 m_notifiers
.DeleteObject( notifier
);
143 int wxDataViewModel::Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
144 unsigned int column
, bool ascending
)
146 // sort branches before leaves
147 bool item1_is_container
= IsContainer(item1
);
148 bool item2_is_container
= IsContainer(item2
);
150 if (item1_is_container
&& !item2_is_container
)
152 if (item2_is_container
&& !item1_is_container
)
155 wxVariant value1
,value2
;
156 GetValue( value1
, item1
, column
);
157 GetValue( value2
, item2
, column
);
161 wxVariant temp
= value1
;
166 if (value1
.GetType() == wxT("string"))
168 wxString str1
= value1
.GetString();
169 wxString str2
= value2
.GetString();
170 int res
= str1
.Cmp( str2
);
173 if (value1
.GetType() == wxT("long"))
175 long l1
= value1
.GetLong();
176 long l2
= value2
.GetLong();
180 if (value1
.GetType() == wxT("double"))
182 double d1
= value1
.GetDouble();
183 double d2
= value2
.GetDouble();
184 if (d1
< d2
) return 1;
185 if (d1
> d2
) return -1;
187 if (value1
.GetType() == wxT("datetime"))
189 wxDateTime dt1
= value1
.GetDateTime();
190 wxDateTime dt2
= value2
.GetDateTime();
191 if (dt1
.IsEarlierThan(dt2
)) return 1;
192 if (dt2
.IsEarlierThan(dt1
)) return -11;
195 // items must be different
196 unsigned long litem1
= (unsigned long) item1
.GetID();
197 unsigned long litem2
= (unsigned long) item2
.GetID();
200 return litem2
-litem2
;
202 return litem1
-litem2
;
205 // ---------------------------------------------------------
206 // wxDataViewIndexListModel
207 // ---------------------------------------------------------
209 wxDataViewIndexListModel::wxDataViewIndexListModel( unsigned int initial_size
)
211 // build initial index
213 for (i
= 1; i
< initial_size
+1; i
++)
214 m_hash
.Add( (void*) i
);
215 m_lastIndex
= initial_size
+ 1;
218 wxDataViewIndexListModel::~wxDataViewIndexListModel()
222 void wxDataViewIndexListModel::RowPrepended()
224 unsigned int id
= m_lastIndex
++;
225 m_hash
.Insert( (void*) id
, 0 );
226 wxDataViewItem
item( (void*) id
);
227 ItemAdded( wxDataViewItem(0), item
);
230 void wxDataViewIndexListModel::RowInserted( unsigned int before
)
232 unsigned int id
= m_lastIndex
++;
233 m_hash
.Insert( (void*) id
, before
);
234 wxDataViewItem
item( (void*) id
);
235 ItemAdded( wxDataViewItem(0), item
);
238 void wxDataViewIndexListModel::RowAppended()
240 unsigned int id
= m_lastIndex
++;
241 m_hash
.Add( (void*) id
);
242 wxDataViewItem
item( (void*) id
);
243 ItemAdded( wxDataViewItem(0), item
);
246 void wxDataViewIndexListModel::RowDeleted( unsigned int row
)
248 wxDataViewItem
item( m_hash
[row
] );
249 wxDataViewModel::ItemDeleted( wxDataViewItem(0), item
);
250 m_hash
.RemoveAt( row
);
253 void wxDataViewIndexListModel::RowChanged( unsigned int row
)
255 wxDataViewModel::ItemChanged( GetItem(row
) );
258 void wxDataViewIndexListModel::RowValueChanged( unsigned int row
, unsigned int col
)
260 wxDataViewModel::ValueChanged( GetItem(row
), col
);
263 unsigned int wxDataViewIndexListModel::GetRow( const wxDataViewItem
&item
) const
265 // assert for not found
266 return (unsigned int) m_hash
.Index( item
.GetID() );
269 wxDataViewItem
wxDataViewIndexListModel::GetItem( unsigned int row
) const
271 wxASSERT( row
< m_hash
.GetCount() );
272 return wxDataViewItem( m_hash
[row
] );
275 int wxDataViewIndexListModel::Compare(const wxDataViewItem
& item1
,
276 const wxDataViewItem
& item2
,
277 unsigned int WXUNUSED(column
),
281 return GetRow(item1
) - GetRow(item2
);
283 return GetRow(item2
) - GetRow(item1
);
286 void wxDataViewIndexListModel::GetValue( wxVariant
&variant
,
287 const wxDataViewItem
&item
, unsigned int col
) const
289 GetValue( variant
, GetRow(item
), col
);
292 bool wxDataViewIndexListModel::SetValue( const wxVariant
&variant
,
293 const wxDataViewItem
&item
, unsigned int col
)
295 return SetValue( variant
, GetRow(item
), col
);
298 wxDataViewItem
wxDataViewIndexListModel::GetParent( const wxDataViewItem
& WXUNUSED(item
) ) const
300 return wxDataViewItem(0);
303 bool wxDataViewIndexListModel::IsContainer( const wxDataViewItem
&item
) const
305 // only the invisible root item has children
312 unsigned int wxDataViewIndexListModel::GetChildren( const wxDataViewItem
&item
, wxDataViewItemArray
&children
) const
319 return m_hash
.GetCount();
322 //-----------------------------------------------------------------------------
323 // wxDataViewIconText
324 //-----------------------------------------------------------------------------
326 IMPLEMENT_DYNAMIC_CLASS(wxDataViewIconText
,wxObject
)
328 IMPLEMENT_VARIANT_OBJECT(wxDataViewIconText
)
330 bool operator == (const wxDataViewIconText
&one
, const wxDataViewIconText
&two
)
332 if (one
.GetText() != two
.GetText()) return false;
333 if (one
.IsSameAs(two
)) return false;
337 // ---------------------------------------------------------
338 // wxDataViewRendererBase
339 // ---------------------------------------------------------
341 IMPLEMENT_ABSTRACT_CLASS(wxDataViewRendererBase
, wxObject
)
343 wxDataViewRendererBase::wxDataViewRendererBase( const wxString
&varianttype
,
344 wxDataViewCellMode
WXUNUSED(mode
),
345 int WXUNUSED(align
) )
347 m_variantType
= varianttype
;
351 const wxDataViewCtrl
* wxDataViewRendererBase::GetView() const
353 return wx_const_cast(wxDataViewRendererBase
*, this)->GetOwner()->GetOwner();
356 bool wxDataViewRendererBase::StartEditing( const wxDataViewItem
&item
, wxRect labelRect
)
358 m_item
= item
; // remember for later
360 unsigned int col
= GetOwner()->GetModelColumn();
362 GetOwner()->GetOwner()->GetModel()->GetValue( value
, item
, col
);
364 m_editorCtrl
= CreateEditorCtrl( GetOwner()->GetOwner()->GetMainWindow(), labelRect
, value
);
366 wxDataViewEditorCtrlEvtHandler
*handler
=
367 new wxDataViewEditorCtrlEvtHandler( m_editorCtrl
, (wxDataViewRenderer
*) this );
369 m_editorCtrl
->PushEventHandler( handler
);
371 #if defined(__WXGTK20__) && !defined(wxUSE_GENERICDATAVIEWCTRL)
372 handler
->SetFocusOnIdle();
374 m_editorCtrl
->SetFocus();
377 // Now we should send Editing Started event
378 wxDataViewEvent
event( wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED
, GetOwner()->GetOwner()->GetId() );
379 event
.SetDataViewColumn( GetOwner() );
380 event
.SetModel( GetOwner()->GetOwner()->GetModel() );
381 event
.SetItem( item
);
382 GetOwner()->GetOwner()->GetEventHandler()->ProcessEvent( event
);
387 void wxDataViewRendererBase::CancelEditing()
389 wxPendingDelete
.Append( m_editorCtrl
);
391 GetOwner()->GetOwner()->GetMainWindow()->SetFocus();
393 // m_editorCtrl->PopEventHandler( true );
396 bool wxDataViewRendererBase::FinishEditing()
399 GetValueFromEditorCtrl( m_editorCtrl
, value
);
401 wxPendingDelete
.Append( m_editorCtrl
);
403 GetOwner()->GetOwner()->GetMainWindow()->SetFocus();
405 if (!Validate(value
))
408 unsigned int col
= GetOwner()->GetModelColumn();
409 GetOwner()->GetOwner()->GetModel()->SetValue( value
, m_item
, col
);
410 GetOwner()->GetOwner()->GetModel()->ValueChanged( m_item
, col
);
412 // m_editorCtrl->PopEventHandler( true );
414 // Now we should send Editing Done event
415 wxDataViewEvent
event( wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE
, GetOwner()->GetOwner()->GetId() );
416 event
.SetDataViewColumn( GetOwner() );
417 event
.SetModel( GetOwner()->GetOwner()->GetModel() );
418 event
.SetItem( m_item
);
419 GetOwner()->GetOwner()->GetEventHandler()->ProcessEvent( event
);
424 //-----------------------------------------------------------------------------
425 // wxDataViewEditorCtrlEvtHandler
426 //-----------------------------------------------------------------------------
428 BEGIN_EVENT_TABLE(wxDataViewEditorCtrlEvtHandler
, wxEvtHandler
)
429 EVT_CHAR (wxDataViewEditorCtrlEvtHandler::OnChar
)
430 EVT_KILL_FOCUS (wxDataViewEditorCtrlEvtHandler::OnKillFocus
)
431 EVT_IDLE (wxDataViewEditorCtrlEvtHandler::OnIdle
)
434 wxDataViewEditorCtrlEvtHandler::wxDataViewEditorCtrlEvtHandler(
435 wxControl
*editorCtrl
,
436 wxDataViewRenderer
*owner
)
439 m_editorCtrl
= editorCtrl
;
444 void wxDataViewEditorCtrlEvtHandler::OnIdle( wxIdleEvent
&event
)
448 m_focusOnIdle
= false;
449 if (wxWindow::FindFocus() != m_editorCtrl
)
450 m_editorCtrl
->SetFocus();
456 void wxDataViewEditorCtrlEvtHandler::OnChar( wxKeyEvent
&event
)
458 switch ( event
.m_keyCode
)
462 m_owner
->FinishEditing();
467 m_owner
->CancelEditing();
475 void wxDataViewEditorCtrlEvtHandler::OnKillFocus( wxFocusEvent
&event
)
480 m_owner
->FinishEditing();
486 // ---------------------------------------------------------
487 // wxDataViewColumnBase
488 // ---------------------------------------------------------
490 IMPLEMENT_ABSTRACT_CLASS(wxDataViewColumnBase
, wxObject
)
492 wxDataViewColumnBase::wxDataViewColumnBase(const wxString
& WXUNUSED(title
),
493 wxDataViewRenderer
*renderer
,
494 unsigned int model_column
,
496 wxAlignment
WXUNUSED(align
),
499 m_renderer
= renderer
;
500 m_model_column
= model_column
;
502 m_renderer
->SetOwner( (wxDataViewColumn
*) this );
504 // NOTE: the wxDataViewColumn's ctor must store the width, align, flags
505 // parameters inside the native control!
508 wxDataViewColumnBase::wxDataViewColumnBase(const wxBitmap
& bitmap
,
509 wxDataViewRenderer
*renderer
,
510 unsigned int model_column
,
512 wxAlignment
WXUNUSED(align
),
513 int WXUNUSED(flags
) )
515 m_renderer
= renderer
;
516 m_model_column
= model_column
;
519 m_renderer
->SetOwner( (wxDataViewColumn
*) this );
522 wxDataViewColumnBase::~wxDataViewColumnBase()
528 int wxDataViewColumnBase::GetFlags() const
533 ret
|= wxDATAVIEW_COL_SORTABLE
;
535 ret
|= wxDATAVIEW_COL_RESIZABLE
;
537 ret
|= wxDATAVIEW_COL_HIDDEN
;
542 void wxDataViewColumnBase::SetFlags(int flags
)
544 SetSortable((flags
& wxDATAVIEW_COL_SORTABLE
) != 0);
545 SetResizeable((flags
& wxDATAVIEW_COL_RESIZABLE
) != 0);
546 SetHidden((flags
& wxDATAVIEW_COL_HIDDEN
) != 0);
549 // ---------------------------------------------------------
550 // wxDataViewCtrlBase
551 // ---------------------------------------------------------
553 IMPLEMENT_ABSTRACT_CLASS(wxDataViewCtrlBase
, wxControl
)
555 wxDataViewCtrlBase::wxDataViewCtrlBase()
558 m_expander_column
= 0;
562 wxDataViewCtrlBase::~wxDataViewCtrlBase()
571 bool wxDataViewCtrlBase::AssociateModel( wxDataViewModel
*model
)
575 m_model
->DecRef(); // discard old model, if any
578 // add our own reference to the new model:
588 wxDataViewModel
* wxDataViewCtrlBase::GetModel()
594 wxDataViewCtrlBase::AppendTextColumn( const wxString
&label
, unsigned int model_column
,
595 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
597 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
598 new wxDataViewTextRenderer( wxT("string"), mode
, (int)align
),
599 model_column
, width
, align
, flags
);
605 wxDataViewCtrlBase::AppendIconTextColumn( const wxString
&label
, unsigned int model_column
,
606 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
608 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
609 new wxDataViewIconTextRenderer( wxT("wxDataViewIconText"), mode
, (int)align
),
610 model_column
, width
, align
, flags
);
616 wxDataViewCtrlBase::AppendToggleColumn( const wxString
&label
, unsigned int model_column
,
617 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
620 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
621 new wxDataViewToggleRenderer( wxT("bool"), mode
, (int)align
),
622 model_column
, width
, align
, flags
);
628 wxDataViewCtrlBase::AppendProgressColumn( const wxString
&label
, unsigned int model_column
,
629 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
631 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
632 new wxDataViewProgressRenderer( wxEmptyString
, wxT("long"), mode
, (int)align
),
633 model_column
, width
, align
, flags
);
639 wxDataViewCtrlBase::AppendDateColumn( const wxString
&label
, unsigned int model_column
,
640 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
642 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
643 new wxDataViewDateRenderer( wxT("datetime"), mode
, (int)align
),
644 model_column
, width
, align
, flags
);
650 wxDataViewCtrlBase::AppendBitmapColumn( const wxString
&label
, unsigned int model_column
,
651 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
653 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
654 new wxDataViewBitmapRenderer( wxT("wxBitmap"), mode
, (int)align
),
655 model_column
, width
, align
, flags
);
661 wxDataViewCtrlBase::AppendTextColumn( const wxBitmap
&label
, unsigned int model_column
,
662 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
664 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
665 new wxDataViewTextRenderer( wxT("string"), mode
, (int)align
),
666 model_column
, width
, align
, flags
);
672 wxDataViewCtrlBase::AppendIconTextColumn( const wxBitmap
&label
, unsigned int model_column
,
673 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
675 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
676 new wxDataViewIconTextRenderer( wxT("wxDataViewIconText"), mode
, (int)align
),
677 model_column
, width
, align
, flags
);
683 wxDataViewCtrlBase::AppendToggleColumn( const wxBitmap
&label
, unsigned int model_column
,
684 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
686 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
687 new wxDataViewToggleRenderer( wxT("bool"), mode
, (int)align
),
688 model_column
, width
, align
, flags
);
694 wxDataViewCtrlBase::AppendProgressColumn( const wxBitmap
&label
, unsigned int model_column
,
695 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
697 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
698 new wxDataViewProgressRenderer( wxEmptyString
, wxT("long"), mode
, (int)align
),
699 model_column
, width
, align
, flags
);
705 wxDataViewCtrlBase::AppendDateColumn( const wxBitmap
&label
, unsigned int model_column
,
706 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
708 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
709 new wxDataViewDateRenderer( wxT("datetime"), mode
, (int)align
),
710 model_column
, width
, align
, flags
);
716 wxDataViewCtrlBase::AppendBitmapColumn( const wxBitmap
&label
, unsigned int model_column
,
717 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
719 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
720 new wxDataViewBitmapRenderer( wxT("wxBitmap"), mode
, (int)align
),
721 model_column
, width
, align
, flags
);
727 wxDataViewCtrlBase::AppendColumn( wxDataViewColumn
*col
)
729 col
->SetOwner( (wxDataViewCtrl
*) this );
733 // ---------------------------------------------------------
735 // ---------------------------------------------------------
737 IMPLEMENT_DYNAMIC_CLASS(wxDataViewEvent
,wxNotifyEvent
)
739 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED
)
741 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED
)
742 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING
)
743 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED
)
744 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING
)
745 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED
)
746 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED
)
747 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE
)
749 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK
)
750 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK
)
751 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED
)
753 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_ADDED
)
754 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_DELETED
)
755 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_CHANGED
)
756 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_MODEL_VALUE_CHANGED
)
757 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_MODEL_CLEARED
)