1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/osx/dataview_osx.cpp
3 // Purpose: wxDataViewCtrl native mac implementation
5 // Id: $Id: dataview_osx.cpp 58317 2009-01-27
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 // For compilers that support precompilation, includes "wx.h".
11 #include "wx/wxprec.h"
13 #if (wxUSE_DATAVIEWCTRL != 0) && (!defined(wxUSE_GENERICDATAVIEWCTRL) || (wxUSE_GENERICDATAVIEWCTRL == 0))
19 #include "wx/settings.h"
20 #include "wx/dcclient.h"
24 #include "wx/osx/core/dataview.h"
25 #include "wx/osx/private.h"
26 #include "wx/renderer.h"
28 // ============================================================================
29 // Helper functions for dataviewe implementation on OSX
30 // ============================================================================
31 wxString
ConcatenateDataViewItemValues(wxDataViewCtrl
const* dataViewCtrlPtr
, wxDataViewItem
const& dataViewItem
)
33 wxString dataString
; // contains the TAB concatenated data
36 for (size_t i
=0; i
<dataViewCtrlPtr
->GetColumnCount(); i
++)
38 // variable definition:
41 dataViewCtrlPtr
->GetModel()->GetValue(dataValue
,dataViewItem
,dataViewCtrlPtr
->GetColumn(i
)->GetModelColumn());
43 dataString
<< wxT('\t');
44 dataString
<< dataValue
.MakeString();
49 // ============================================================================
50 // wxOSXDataViewModelNotifier
51 // ============================================================================
52 class wxOSXDataViewModelNotifier
: public wxDataViewModelNotifier
56 // constructors / destructor
58 wxOSXDataViewModelNotifier(wxDataViewCtrl
* initDataViewCtrlPtr
);
61 // inherited methods from wxDataViewModelNotifier
63 virtual bool ItemAdded (wxDataViewItem
const &parent
, wxDataViewItem
const &item
);
64 virtual bool ItemsAdded (wxDataViewItem
const& parent
, wxDataViewItemArray
const& items
);
65 virtual bool ItemChanged (wxDataViewItem
const& item
);
66 virtual bool ItemsChanged(wxDataViewItemArray
const& items
);
67 virtual bool ItemDeleted (wxDataViewItem
const& parent
, wxDataViewItem
const& item
);
68 virtual bool ItemsDeleted(wxDataViewItem
const& parent
, wxDataViewItemArray
const& items
);
69 virtual bool ValueChanged(wxDataViewItem
const& item
, unsigned int col
);
70 virtual bool Cleared();
71 virtual void Resort();
74 // if the dataview control can have a variable row height this method sets the dataview's control row height of
75 // the passed item to the maximum value occupied by the item in all columns
76 void AdjustRowHeight(wxDataViewItem
const& item
);
77 // ... and the same method for a couple of items:
78 void AdjustRowHeights(wxDataViewItemArray
const& items
);
81 wxDataViewCtrl
* m_DataViewCtrlPtr
;
85 // constructors / destructor
87 wxOSXDataViewModelNotifier::wxOSXDataViewModelNotifier(wxDataViewCtrl
* initDataViewCtrlPtr
)
88 :m_DataViewCtrlPtr(initDataViewCtrlPtr
)
90 if (initDataViewCtrlPtr
== NULL
)
91 wxFAIL_MSG(_("Pointer to dataview control must not be NULL"));
94 bool wxOSXDataViewModelNotifier::ItemAdded(wxDataViewItem
const& parent
, wxDataViewItem
const& item
)
99 wxCHECK_MSG(item
.IsOk(),false,_("Added item is invalid."));
100 noFailureFlag
= m_DataViewCtrlPtr
->GetDataViewPeer()->Add(parent
,item
);
101 AdjustRowHeight(item
);
102 return noFailureFlag
;
105 bool wxOSXDataViewModelNotifier::ItemsAdded(wxDataViewItem
const& parent
, wxDataViewItemArray
const& items
)
110 // insert all valid items into control:
111 noFailureFlag
= m_DataViewCtrlPtr
->GetDataViewPeer()->Add(parent
,items
);
112 // adjust row heights:
113 AdjustRowHeights(items
);
115 return noFailureFlag
;
118 bool wxOSXDataViewModelNotifier::ItemChanged(wxDataViewItem
const& item
)
120 wxCHECK_MSG(item
.IsOk(), false,_("Changed item is invalid."));
121 wxCHECK_MSG(GetOwner() != NULL
,false,_("Owner not initialized."));
122 if (m_DataViewCtrlPtr
->GetDataViewPeer()->Update(GetOwner()->GetParent(item
),item
))
124 // sent the equivalent wxWidget event:
125 wxDataViewEvent
dataViewEvent(wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED
,m_DataViewCtrlPtr
->GetId());
127 dataViewEvent
.SetEventObject(m_DataViewCtrlPtr
);
128 dataViewEvent
.SetItem(item
);
129 // sent the equivalent wxWidget event:
130 m_DataViewCtrlPtr
->HandleWindowEvent(dataViewEvent
);
131 // row height may have to be adjusted:
132 AdjustRowHeight(item
);
140 bool wxOSXDataViewModelNotifier::ItemsChanged(wxDataViewItemArray
const& items
)
142 size_t const noOfItems
= items
.GetCount();
144 wxDataViewEvent
dataViewEvent(wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED
,m_DataViewCtrlPtr
->GetId());
147 dataViewEvent
.SetEventObject(m_DataViewCtrlPtr
);
148 for (size_t indexItem
=0; indexItem
<noOfItems
; ++indexItem
)
149 if (m_DataViewCtrlPtr
->GetDataViewPeer()->Update(GetOwner()->GetParent(items
[indexItem
]),items
[indexItem
]))
151 // send for all changed items a wxWidget event:
152 dataViewEvent
.SetItem(items
[indexItem
]);
153 m_DataViewCtrlPtr
->HandleWindowEvent(dataViewEvent
);
157 // if this location is reached all items have been updated:
158 AdjustRowHeights(items
);
163 bool wxOSXDataViewModelNotifier::ItemDeleted(wxDataViewItem
const& parent
, wxDataViewItem
const& item
)
168 wxCHECK_MSG(item
.IsOk(),false,_("To be deleted item is invalid."));
169 // when this method is called and currently an item is being edited this item may have already been deleted in the model (the passed item and the being edited item have
170 // not to be identical because the being edited item might be below the passed item in the hierarchy);
171 // to prevent the control trying to ask the model to update an already deleted item the control is informed that currently a deleting process
172 // has been started and that variables can currently not be updated even when requested by the system:
173 m_DataViewCtrlPtr
->SetDeleting(true);
174 noFailureFlag
= m_DataViewCtrlPtr
->GetDataViewPeer()->Remove(parent
,item
);
175 // enable automatic updating again:
176 m_DataViewCtrlPtr
->SetDeleting(false);
178 return noFailureFlag
;
181 bool wxOSXDataViewModelNotifier::ItemsDeleted(wxDataViewItem
const& parent
, wxDataViewItemArray
const& items
)
186 // when this method is called and currently an item is being edited this item may have already been deleted in the model (the passed item and the being edited item have
187 // not to be identical because the being edited item might be below the passed item in the hierarchy);
188 // to prevent the control trying to ask the model to update an already deleted item the control is informed that currently a deleting process
189 // has been started and that variables can currently not be updated even when requested by the system:
190 m_DataViewCtrlPtr
->SetDeleting(true);
191 // delete all specified items:
192 noFailureFlag
= m_DataViewCtrlPtr
->GetDataViewPeer()->Remove(parent
,items
);
193 // enable automatic updating again:
194 m_DataViewCtrlPtr
->SetDeleting(false);
196 return noFailureFlag
;
199 bool wxOSXDataViewModelNotifier::ValueChanged(wxDataViewItem
const& item
, unsigned int col
)
201 wxCHECK_MSG(item
.IsOk(), false,_("Passed item is invalid."));
202 wxCHECK_MSG(GetOwner() != NULL
,false,_("Owner not initialized."));
203 if (m_DataViewCtrlPtr
->GetDataViewPeer()->Update(GetOwner()->GetParent(item
),item
))
205 wxDataViewEvent
dataViewEvent(wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED
,m_DataViewCtrlPtr
->GetId());
207 dataViewEvent
.SetEventObject(m_DataViewCtrlPtr
);
208 dataViewEvent
.SetColumn(col
);
209 dataViewEvent
.SetItem(item
);
210 // send the equivalent wxWidget event:
211 m_DataViewCtrlPtr
->HandleWindowEvent(dataViewEvent
);
219 bool wxOSXDataViewModelNotifier::Cleared()
221 return m_DataViewCtrlPtr
->GetDataViewPeer()->Reload();
224 void wxOSXDataViewModelNotifier::Resort()
226 m_DataViewCtrlPtr
->GetDataViewPeer()->Resort();
229 void wxOSXDataViewModelNotifier::AdjustRowHeight(wxDataViewItem
const& item
)
231 if ((m_DataViewCtrlPtr
->GetWindowStyle() & wxDV_VARIABLE_LINE_HEIGHT
) != 0)
233 wxDataViewModel
*model
= GetOwner();
235 int height
= 20; // TODO find out standard height
236 unsigned int num
= m_DataViewCtrlPtr
->GetColumnCount();
238 for (col
= 0; col
< num
; col
++)
240 wxDataViewColumn
* column(m_DataViewCtrlPtr
->GetColumnPtr(col
));
242 if (!(column
->IsHidden()))
244 wxDataViewCustomRenderer
*renderer
= dynamic_cast<wxDataViewCustomRenderer
*>(column
->GetRenderer());
248 model
->GetValue( value
, item
, column
->GetModelColumn() );
249 renderer
->SetValue( value
);
250 height
= wxMax( height
, renderer
->GetSize().y
);
255 m_DataViewCtrlPtr
->GetDataViewPeer()->SetRowHeight(item
,height
);
259 void wxOSXDataViewModelNotifier::AdjustRowHeights(wxDataViewItemArray
const& items
)
261 if ((m_DataViewCtrlPtr
->GetWindowStyle() & wxDV_VARIABLE_LINE_HEIGHT
) != 0)
263 size_t const noOfItems
= items
.GetCount();
265 wxDataViewModel
*model
= GetOwner();
267 for (size_t itemIndex
=0; itemIndex
<noOfItems
; ++itemIndex
)
269 int height
= 20; // TODO find out standard height
270 unsigned int num
= m_DataViewCtrlPtr
->GetColumnCount();
273 for (col
= 0; col
< num
; col
++)
275 wxDataViewColumn
* column(m_DataViewCtrlPtr
->GetColumnPtr(col
));
277 if (!(column
->IsHidden()))
279 wxDataViewCustomRenderer
*renderer
= dynamic_cast<wxDataViewCustomRenderer
*>(column
->GetRenderer());
283 model
->GetValue( value
, items
[itemIndex
], column
->GetModelColumn() );
284 renderer
->SetValue( value
);
285 height
= wxMax( height
, renderer
->GetSize().y
);
290 m_DataViewCtrlPtr
->GetDataViewPeer()->SetRowHeight(items
[itemIndex
],height
);
295 // ---------------------------------------------------------
296 // wxDataViewCustomRenderer
297 // The constructor, the implementation macro and environment
298 // dependent methods can be found in the environment's
300 // ---------------------------------------------------------
301 wxDataViewCustomRenderer::~wxDataViewCustomRenderer()
306 wxDC
* wxDataViewCustomRenderer::GetDC()
308 if ((m_DCPtr
== NULL
) && (GetOwner() != NULL
) && (GetOwner()->GetOwner() != NULL
))
309 m_DCPtr
= new wxClientDC(GetOwner()->GetOwner());
313 void wxDataViewCustomRenderer::SetDC(wxDC
* newDCPtr
)
319 //-----------------------------------------------------------------------------
321 //-----------------------------------------------------------------------------
323 wxDataViewCtrl::~wxDataViewCtrl()
328 void wxDataViewCtrl::Init()
330 m_CustomRendererPtr
= NULL
;
332 m_macIsUserPane
= false;
336 bool wxDataViewCtrl::Create(wxWindow
*parent
, wxWindowID id
, const wxPoint
& pos
, const wxSize
& size
, long style
, const wxValidator
& validator
)
338 if (!(wxControl::Create(parent
,id
,pos
,size
,style
& ~(wxHSCROLL
| wxVSCROLL
),validator
)))
340 m_peer
= ::CreateDataView(this,parent
,id
,pos
,size
,style
,GetExtraStyle());
342 MacPostControlCreate(pos
,size
);
347 bool wxDataViewCtrl::AssociateModel(wxDataViewModel
* model
)
349 wxDataViewWidgetImpl
* dataViewWidgetPtr(GetDataViewPeer());
352 wxCHECK_MSG(dataViewWidgetPtr
!= NULL
,false,_("Pointer to native control must not be NULL."));
353 if (wxDataViewCtrlBase::AssociateModel(model
) && dataViewWidgetPtr
->AssociateModel(model
))
356 model
->AddNotifier(new wxOSXDataViewModelNotifier(this));
363 bool wxDataViewCtrl::AppendColumn(wxDataViewColumn
* columnPtr
)
365 return wxDataViewCtrl::InsertColumn( GetColumnCount(), columnPtr
);
368 bool wxDataViewCtrl::PrependColumn(wxDataViewColumn
* columnPtr
)
370 return wxDataViewCtrl::InsertColumn( 0, columnPtr
);
373 bool wxDataViewCtrl::InsertColumn(unsigned int pos
, wxDataViewColumn
* columnPtr
)
375 wxDataViewWidgetImpl
* dataViewWidgetPtr(GetDataViewPeer());
377 // first, some error checking:
378 wxCHECK_MSG(dataViewWidgetPtr
!= NULL
, false,_("Pointer to native control must not be NULL."));
379 wxCHECK_MSG(columnPtr
!= NULL
, false,_("Column pointer must not be NULL."));
380 wxCHECK_MSG(columnPtr
->GetRenderer() != NULL
, false,_("Column does not have a renderer."));
381 wxCHECK_MSG(GetModel() != NULL
, false,_("No model associated with control."));
382 wxCHECK_MSG((columnPtr
->GetModelColumn() >= 0) &&
383 (columnPtr
->GetModelColumn() < GetModel()->GetColumnCount()),false,_("Column's model column has no equivalent in the associated model."));
385 // add column to wxWidget's internal structure:
386 if (wxDataViewCtrlBase::InsertColumn(pos
,columnPtr
))
388 m_ColumnPtrs
.Add(columnPtr
);
389 // if the insertion in the native control is successful the rest can also be initialized:
390 if (dataViewWidgetPtr
->InsertColumn(pos
,columnPtr
))
392 // make sure that the data is up-to-date...
393 // if the newly appended column is the first column add the initial data to the control and mark the column as an expander column,
394 // otherwise ask the control to 'update' the data in the newly appended column:
395 if (GetColumnCount() == 1)
396 SetExpanderColumn(columnPtr
);
403 m_ColumnPtrs
.Remove(columnPtr
);
405 // and send a message in debug mode:
406 wxFAIL_MSG(_("Column could not be added to native control."));
415 wxFAIL_MSG(_("Could not add column to internal structures."));
421 bool wxDataViewCtrl::ClearColumns()
423 if (GetDataViewPeer()->ClearColumns())
425 WX_CLEAR_ARRAY(m_ColumnPtrs
);
432 bool wxDataViewCtrl::DeleteColumn(wxDataViewColumn
* columnPtr
)
434 if (GetDataViewPeer()->DeleteColumn(columnPtr
))
436 m_ColumnPtrs
.Remove(columnPtr
);
444 wxDataViewColumn
* wxDataViewCtrl::GetColumn(unsigned int pos
) const
446 return GetDataViewPeer()->GetColumn(pos
);
449 unsigned int wxDataViewCtrl::GetColumnCount() const
451 return m_ColumnPtrs
.GetCount();
454 int wxDataViewCtrl::GetColumnPosition(wxDataViewColumn
const* columnPtr
) const
456 return GetDataViewPeer()->GetColumnPosition(columnPtr
);
459 void wxDataViewCtrl::Collapse(wxDataViewItem
const& item
)
461 GetDataViewPeer()->Collapse(item
);
464 void wxDataViewCtrl::EnsureVisible(wxDataViewItem
const& item
, wxDataViewColumn
const* columnPtr
)
468 ExpandAncestors(item
); // make sure that the item exists in the control
469 GetDataViewPeer()->EnsureVisible(item
,columnPtr
);
473 void wxDataViewCtrl::Expand(wxDataViewItem
const& item
)
475 return GetDataViewPeer()->Expand(item
);
478 bool wxDataViewCtrl::IsExpanded( const wxDataViewItem
& item
) const
480 return (item
.IsOk() && GetDataViewPeer()->IsExpanded(item
));
483 wxDataViewColumn
* wxDataViewCtrl::GetSortingColumn() const
485 return GetDataViewPeer()->GetSortingColumn();
488 unsigned int wxDataViewCtrl::GetCount() const
490 return GetDataViewPeer()->GetCount();
493 wxRect
wxDataViewCtrl::GetItemRect(wxDataViewItem
const& item
, wxDataViewColumn
const* columnPtr
) const
495 if (item
.IsOk() && (columnPtr
!= NULL
))
496 return GetDataViewPeer()->GetRectangle(item
,columnPtr
);
501 wxDataViewItem
wxDataViewCtrl::GetSelection() const
503 wxDataViewItemArray itemIDs
;
506 if (GetDataViewPeer()->GetSelections(itemIDs
) > 0)
509 return wxDataViewItem();
512 int wxDataViewCtrl::GetSelections(wxDataViewItemArray
& sel
) const
514 return GetDataViewPeer()->GetSelections(sel
);
517 void wxDataViewCtrl::HitTest(wxPoint
const& point
, wxDataViewItem
& item
, wxDataViewColumn
*& columnPtr
) const
519 return GetDataViewPeer()->HitTest(point
,item
,columnPtr
);
522 bool wxDataViewCtrl::IsSelected(wxDataViewItem
const& item
) const
524 return GetDataViewPeer()->IsSelected(item
);
527 void wxDataViewCtrl::Select(wxDataViewItem
const& item
)
531 ExpandAncestors(item
); // make sure that the item exists in the control
532 GetDataViewPeer()->Select(item
);
536 void wxDataViewCtrl::SelectAll()
538 GetDataViewPeer()->SelectAll();
541 void wxDataViewCtrl::SetSelections(wxDataViewItemArray
const& sel
)
543 size_t const noOfSelections
= sel
.GetCount();
547 wxDataViewItem last_parent
;
550 // make sure that all to be selected items are visible in the control:
551 for (i
= 0; i
< noOfSelections
; i
++)
553 wxDataViewItem item
= sel
[i
];
554 wxDataViewItem parent
= GetModel()->GetParent( item
);
556 if (parent
.IsOk() && (parent
!= last_parent
))
557 ExpandAncestors(item
);
558 last_parent
= parent
;
561 // finally select the items:
562 wxDataViewWidgetImpl
* dataViewWidgetPtr(GetDataViewPeer()); // variable definition for abbreviational purposes
564 for (i
=0; i
<noOfSelections
; ++i
)
565 dataViewWidgetPtr
->Select(sel
[i
]);
568 void wxDataViewCtrl::Unselect(wxDataViewItem
const& item
)
571 GetDataViewPeer()->Unselect(item
);
574 void wxDataViewCtrl::UnselectAll()
576 GetDataViewPeer()->UnselectAll();
582 wxDataViewWidgetImpl
* wxDataViewCtrl::GetDataViewPeer() const
584 return dynamic_cast<wxDataViewWidgetImpl
*>(GetPeer());
587 void wxDataViewCtrl::AddChildren(wxDataViewItem
const& parentItem
)
591 wxDataViewItemArray items
;
594 wxCHECK_RET(GetModel() != NULL
,_("Model pointer not initialized."));
595 noOfChildren
= GetModel()->GetChildren(parentItem
,items
);
596 (void) GetModel()->ItemsAdded(parentItem
,items
);
599 void wxDataViewCtrl::FinishCustomItemEditing()
601 if (GetCustomRendererItem().IsOk())
603 GetCustomRendererPtr()->FinishEditing();
604 SetCustomRendererItem(wxDataViewItem());
605 SetCustomRendererPtr (NULL
);
611 wxDataViewCtrl::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
613 wxVisualAttributes attr
;
615 attr
.colFg
= wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT
);
616 attr
.colBg
= wxSystemSettings::GetColour( wxSYS_COLOUR_LISTBOX
);
617 attr
.font
.CreateSystemFont(wxOSX_SYSTEM_FONT_VIEWS
);
622 // inherited methods from wxDataViewCtrlBase
623 void wxDataViewCtrl::DoSetExpanderColumn()
625 if (GetExpanderColumn() != NULL
)
626 GetDataViewPeer()->DoSetExpanderColumn(GetExpanderColumn());
629 void wxDataViewCtrl::DoSetIndent()
631 GetDataViewPeer()->DoSetIndent(GetIndent());
635 void wxDataViewCtrl::OnSize(wxSizeEvent
& event
)
637 unsigned int const noOfColumns
= GetColumnCount();
640 // reset DC of all custom renderers because DC has changed:
641 for (unsigned int i
=0; i
<noOfColumns
; ++i
)
643 wxDataViewColumn
* dataViewColumnPtr(GetColumn(i
));
645 if (dataViewColumnPtr
!= NULL
)
647 wxDataViewCustomRenderer
* dataViewCustomRendererPtr(dynamic_cast<wxDataViewCustomRenderer
*>(dataViewColumnPtr
->GetRenderer()));
649 if (dataViewCustomRendererPtr
!= NULL
)
650 dataViewCustomRendererPtr
->SetDC(NULL
);
654 // update the layout of the native control after a size event:
655 GetDataViewPeer()->OnSize();
660 wxSize
wxDataViewCtrl::DoGetBestSize() const
662 wxSize best
= wxControl::DoGetBestSize();
668 void wxDataViewCtrl::OnMouse(wxMouseEvent
& event
)
672 if (GetModel() == NULL
)
676 // Doesn't compile anymore
677 wxMacDataViewDataBrowserListViewControlPointer
MacDataViewListCtrlPtr(dynamic_cast<wxMacDataViewDataBrowserListViewControlPointer
>(m_peer
));
680 wxDataViewItemArray items
;
681 NoOfChildren
= GetModel()->GetChildren( wxDataViewItem(), items
);
682 if (NoOfChildren
== 0)
684 wxDataViewItem firstChild
= items
[0];
686 UInt16 headerHeight
= 0;
687 MacDataViewListCtrlPtr
->GetHeaderButtonHeight(&headerHeight
);
690 if (event
.GetY() < headerHeight
)
692 unsigned int col_count
= GetColumnCount();
694 for (col
= 0; col
< col_count
; col
++)
696 wxDataViewColumn
*column
= GetColumn( col
);
697 if (column
->IsHidden())
701 ::GetDataBrowserItemPartBounds( MacDataViewListCtrlPtr
->GetControlRef(),
702 reinterpret_cast<DataBrowserItemID
>(firstChild
.GetID()), column
->GetPropertyID(),
703 kDataBrowserPropertyEnclosingPart
, &itemrect
);
705 if (abs( event
.GetX() - itemrect
.right
) < 3)
707 if (column
->GetFlags() & wxDATAVIEW_COL_RESIZABLE
)
708 SetCursor( wxCursor( wxCURSOR_SIZEWE
) );
710 SetCursor( *wxSTANDARD_CURSOR
);
717 SetCursor( *wxSTANDARD_CURSOR
);
721 IMPLEMENT_DYNAMIC_CLASS(wxDataViewCtrl
,wxDataViewCtrlBase
)
723 BEGIN_EVENT_TABLE(wxDataViewCtrl
,wxDataViewCtrlBase
)
724 EVT_SIZE(wxDataViewCtrl::OnSize
)
725 EVT_MOTION(wxDataViewCtrl::OnMouse
)
728 #endif // (wxUSE_DATAVIEWCTRL != 0) && (!defined(wxUSE_GENERICDATAVIEWCTRL) || (wxUSE_GENERICDATAVIEWCTRL == 0))