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
, const wxDataViewItem
&item2
,
276 unsigned int column
, bool ascending
)
279 return GetRow(item1
) - GetRow(item2
);
281 return GetRow(item2
) - GetRow(item1
);
284 void wxDataViewIndexListModel::GetValue( wxVariant
&variant
,
285 const wxDataViewItem
&item
, unsigned int col
) const
287 GetValue( variant
, GetRow(item
), col
);
290 bool wxDataViewIndexListModel::SetValue( const wxVariant
&variant
,
291 const wxDataViewItem
&item
, unsigned int col
)
293 return SetValue( variant
, GetRow(item
), col
);
296 wxDataViewItem
wxDataViewIndexListModel::GetParent( const wxDataViewItem
& WXUNUSED(item
) ) const
298 return wxDataViewItem(0);
301 bool wxDataViewIndexListModel::IsContainer( const wxDataViewItem
&item
) const
303 // only the invisible root item has children
310 wxDataViewItem
wxDataViewIndexListModel::GetFirstChild( const wxDataViewItem
&parent
) const
314 if (m_hash
.GetCount() == 0)
315 return wxDataViewItem(0);
317 return wxDataViewItem( m_hash
[0]);
320 return wxDataViewItem(0);
323 wxDataViewItem
wxDataViewIndexListModel::GetNextSibling( const wxDataViewItem
&item
) const
326 return wxDataViewItem(0);
328 int pos
= m_hash
.Index( item
.GetID() );
329 if ((pos
== wxNOT_FOUND
) || (pos
== (int) (m_hash
.GetCount()-1)))
330 return wxDataViewItem(0);
332 return wxDataViewItem( m_hash
[pos
+1] );
335 // ---------------------------------------------------------
336 // wxDataViewRendererBase
337 // ---------------------------------------------------------
339 IMPLEMENT_ABSTRACT_CLASS(wxDataViewRendererBase
, wxObject
)
341 wxDataViewRendererBase::wxDataViewRendererBase( const wxString
&varianttype
,
342 wxDataViewCellMode
WXUNUSED(mode
),
343 int WXUNUSED(align
) )
345 m_variantType
= varianttype
;
349 const wxDataViewCtrl
* wxDataViewRendererBase::GetView() const
351 return wx_const_cast(wxDataViewRendererBase
*, this)->GetOwner()->GetOwner();
354 bool wxDataViewRendererBase::StartEditing( const wxDataViewItem
&item
, wxRect labelRect
)
356 m_item
= item
; // remember for later
358 unsigned int col
= GetOwner()->GetModelColumn();
360 GetOwner()->GetOwner()->GetModel()->GetValue( value
, item
, col
);
362 m_editorCtrl
= CreateEditorCtrl( GetOwner()->GetOwner()->GetMainWindow(), labelRect
, value
);
364 wxDataViewEditorCtrlEvtHandler
*handler
=
365 new wxDataViewEditorCtrlEvtHandler( m_editorCtrl
, (wxDataViewRenderer
*) this );
367 m_editorCtrl
->PushEventHandler( handler
);
369 #if defined(__WXGTK20__) && !defined(wxUSE_GENERICDATAVIEWCTRL)
370 handler
->SetFocusOnIdle();
372 m_editorCtrl
->SetFocus();
378 void wxDataViewRendererBase::CancelEditing()
380 wxPendingDelete
.Append( m_editorCtrl
);
382 GetOwner()->GetOwner()->GetMainWindow()->SetFocus();
384 // m_editorCtrl->PopEventHandler( true );
387 bool wxDataViewRendererBase::FinishEditing()
390 GetValueFromEditorCtrl( m_editorCtrl
, value
);
392 wxPendingDelete
.Append( m_editorCtrl
);
394 GetOwner()->GetOwner()->GetMainWindow()->SetFocus();
396 if (!Validate(value
))
399 unsigned int col
= GetOwner()->GetModelColumn();
400 GetOwner()->GetOwner()->GetModel()->SetValue( value
, m_item
, col
);
401 GetOwner()->GetOwner()->GetModel()->ValueChanged( m_item
, col
);
403 // m_editorCtrl->PopEventHandler( true );
408 //-----------------------------------------------------------------------------
409 // wxDataViewEditorCtrlEvtHandler
410 //-----------------------------------------------------------------------------
412 BEGIN_EVENT_TABLE(wxDataViewEditorCtrlEvtHandler
, wxEvtHandler
)
413 EVT_CHAR (wxDataViewEditorCtrlEvtHandler::OnChar
)
414 EVT_KILL_FOCUS (wxDataViewEditorCtrlEvtHandler::OnKillFocus
)
415 EVT_IDLE (wxDataViewEditorCtrlEvtHandler::OnIdle
)
418 wxDataViewEditorCtrlEvtHandler::wxDataViewEditorCtrlEvtHandler(
419 wxControl
*editorCtrl
,
420 wxDataViewRenderer
*owner
)
423 m_editorCtrl
= editorCtrl
;
428 void wxDataViewEditorCtrlEvtHandler::OnIdle( wxIdleEvent
&event
)
432 m_focusOnIdle
= false;
433 if (wxWindow::FindFocus() != m_editorCtrl
)
434 m_editorCtrl
->SetFocus();
440 void wxDataViewEditorCtrlEvtHandler::OnChar( wxKeyEvent
&event
)
442 switch ( event
.m_keyCode
)
446 m_owner
->FinishEditing();
451 m_owner
->CancelEditing();
459 void wxDataViewEditorCtrlEvtHandler::OnKillFocus( wxFocusEvent
&event
)
464 m_owner
->FinishEditing();
470 // ---------------------------------------------------------
471 // wxDataViewColumnBase
472 // ---------------------------------------------------------
474 IMPLEMENT_ABSTRACT_CLASS(wxDataViewColumnBase
, wxObject
)
476 wxDataViewColumnBase::wxDataViewColumnBase(const wxString
& WXUNUSED(title
),
477 wxDataViewRenderer
*renderer
,
478 unsigned int model_column
,
480 wxAlignment
WXUNUSED(align
),
483 m_renderer
= renderer
;
484 m_model_column
= model_column
;
486 m_renderer
->SetOwner( (wxDataViewColumn
*) this );
488 // NOTE: the wxDataViewColumn's ctor must store the width, align, flags
489 // parameters inside the native control!
492 wxDataViewColumnBase::wxDataViewColumnBase(const wxBitmap
& bitmap
,
493 wxDataViewRenderer
*renderer
,
494 unsigned int model_column
,
496 wxAlignment
WXUNUSED(align
),
497 int WXUNUSED(flags
) )
499 m_renderer
= renderer
;
500 m_model_column
= model_column
;
503 m_renderer
->SetOwner( (wxDataViewColumn
*) this );
506 wxDataViewColumnBase::~wxDataViewColumnBase()
512 int wxDataViewColumnBase::GetFlags() const
517 ret
|= wxDATAVIEW_COL_SORTABLE
;
519 ret
|= wxDATAVIEW_COL_RESIZABLE
;
521 ret
|= wxDATAVIEW_COL_HIDDEN
;
526 void wxDataViewColumnBase::SetFlags(int flags
)
528 SetSortable((flags
& wxDATAVIEW_COL_SORTABLE
) != 0);
529 SetResizeable((flags
& wxDATAVIEW_COL_RESIZABLE
) != 0);
530 SetHidden((flags
& wxDATAVIEW_COL_HIDDEN
) != 0);
533 // ---------------------------------------------------------
534 // wxDataViewCtrlBase
535 // ---------------------------------------------------------
537 IMPLEMENT_ABSTRACT_CLASS(wxDataViewCtrlBase
, wxControl
)
539 wxDataViewCtrlBase::wxDataViewCtrlBase()
542 m_cols
.DeleteContents( true );
543 m_expander_column
= 0;
547 wxDataViewCtrlBase::~wxDataViewCtrlBase()
549 // IMPORTANT: before calling DecRef() on our model (since it may
550 // result in a free() call), erase all columns (since
551 // they hold a pointer to our model)
561 bool wxDataViewCtrlBase::AssociateModel( wxDataViewModel
*model
)
565 m_model
->DecRef(); // discard old model, if any
568 // add our own reference to the new model:
578 wxDataViewModel
* wxDataViewCtrlBase::GetModel()
584 wxDataViewCtrlBase::AppendTextColumn( const wxString
&label
, unsigned int model_column
,
585 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
587 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
588 new wxDataViewTextRenderer( wxT("string"), mode
, (int)align
),
589 model_column
, width
, align
, flags
);
595 wxDataViewCtrlBase::AppendToggleColumn( const wxString
&label
, unsigned int model_column
,
596 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
599 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
600 new wxDataViewToggleRenderer( wxT("bool"), mode
, (int)align
),
601 model_column
, width
, align
, flags
);
607 wxDataViewCtrlBase::AppendProgressColumn( const wxString
&label
, unsigned int model_column
,
608 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
610 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
611 new wxDataViewProgressRenderer( wxEmptyString
, wxT("long"), mode
, (int)align
),
612 model_column
, width
, align
, flags
);
618 wxDataViewCtrlBase::AppendDateColumn( const wxString
&label
, unsigned int model_column
,
619 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
621 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
622 new wxDataViewDateRenderer( wxT("datetime"), mode
, (int)align
),
623 model_column
, width
, align
, flags
);
629 wxDataViewCtrlBase::AppendBitmapColumn( const wxString
&label
, unsigned int model_column
,
630 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
632 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
633 new wxDataViewBitmapRenderer( wxT("wxBitmap"), mode
, (int)align
),
634 model_column
, width
, align
, flags
);
640 wxDataViewCtrlBase::AppendTextColumn( const wxBitmap
&label
, unsigned int model_column
,
641 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
643 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
644 new wxDataViewTextRenderer( wxT("string"), mode
, (int)align
),
645 model_column
, width
, align
, flags
);
651 wxDataViewCtrlBase::AppendToggleColumn( const wxBitmap
&label
, unsigned int model_column
,
652 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
654 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
655 new wxDataViewToggleRenderer( wxT("bool"), mode
, (int)align
),
656 model_column
, width
, align
, flags
);
662 wxDataViewCtrlBase::AppendProgressColumn( const wxBitmap
&label
, unsigned int model_column
,
663 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
665 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
666 new wxDataViewProgressRenderer( wxEmptyString
, wxT("long"), mode
, (int)align
),
667 model_column
, width
, align
, flags
);
673 wxDataViewCtrlBase::AppendDateColumn( const wxBitmap
&label
, unsigned int model_column
,
674 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
676 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
677 new wxDataViewDateRenderer( wxT("datetime"), mode
, (int)align
),
678 model_column
, width
, align
, flags
);
684 wxDataViewCtrlBase::AppendBitmapColumn( const wxBitmap
&label
, unsigned int model_column
,
685 wxDataViewCellMode mode
, int width
, wxAlignment align
, int flags
)
687 wxDataViewColumn
*ret
= new wxDataViewColumn( label
,
688 new wxDataViewBitmapRenderer( wxT("wxBitmap"), mode
, (int)align
),
689 model_column
, width
, align
, flags
);
695 wxDataViewCtrlBase::AppendColumn( wxDataViewColumn
*col
)
697 m_cols
.Append( (wxObject
*) col
);
698 col
->SetOwner( (wxDataViewCtrl
*) this );
702 unsigned int wxDataViewCtrlBase::GetColumnCount() const
704 return m_cols
.GetCount();
707 bool wxDataViewCtrlBase::DeleteColumn( unsigned int WXUNUSED(pos
) )
712 bool wxDataViewCtrlBase::ClearColumns()
717 wxDataViewColumn
* wxDataViewCtrlBase::GetColumn( unsigned int pos
) const
719 if( pos
>= m_cols
.GetCount() )
722 return (wxDataViewColumn
*) m_cols
[ pos
];
725 // ---------------------------------------------------------
727 // ---------------------------------------------------------
729 IMPLEMENT_DYNAMIC_CLASS(wxDataViewEvent
,wxNotifyEvent
)
731 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_SELECTED
)
732 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_DESELECTED
)
733 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED
)
734 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING
)
735 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED
)
736 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING
)
737 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED
)
738 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED
)
739 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE
)
741 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK
)
742 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK
)
743 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED
)
745 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_ADDED
)
746 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_DELETED
)
747 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_CHANGED
)
748 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_MODEL_VALUE_CHANGED
)
749 DEFINE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_MODEL_CLEARED
)