///////////////////////////////////////////////////////////////////////////// // Name: src/osx/dataview_osx.cpp // Purpose: wxDataViewCtrl native mac implementation // Author: // Copyright: (c) 2009 // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #if wxUSE_DATAVIEWCTRL #include "wx/dataview.h" #ifndef wxHAS_GENERIC_DATAVIEWCTRL #include #ifndef WX_PRECOMP #include "wx/timer.h" #include "wx/settings.h" #include "wx/dcclient.h" #include "wx/icon.h" #endif #include "wx/osx/core/dataview.h" #include "wx/osx/private.h" #include "wx/renderer.h" // ============================================================================ // Helper functions for dataviewe implementation on OSX // ============================================================================ wxString ConcatenateDataViewItemValues(wxDataViewCtrl const* dataViewCtrlPtr, wxDataViewItem const& dataViewItem) { wxString dataString; // contains the TAB concatenated data for (size_t i=0; iGetColumnCount(); i++) { // variable definition: wxVariant dataValue; dataViewCtrlPtr->GetModel()->GetValue(dataValue,dataViewItem,dataViewCtrlPtr->GetColumn(i)->GetModelColumn()); if (i > 0) dataString << wxT('\t'); dataString << dataValue.MakeString(); } return dataString; } // ============================================================================ // wxOSXDataViewModelNotifier // ============================================================================ class wxOSXDataViewModelNotifier : public wxDataViewModelNotifier { public: // // constructors / destructor // wxOSXDataViewModelNotifier(wxDataViewCtrl* initDataViewCtrlPtr); // // inherited methods from wxDataViewModelNotifier // virtual bool ItemAdded (wxDataViewItem const &parent, wxDataViewItem const &item) wxOVERRIDE; virtual bool ItemsAdded (wxDataViewItem const& parent, wxDataViewItemArray const& items) wxOVERRIDE; virtual bool ItemChanged (wxDataViewItem const& item) wxOVERRIDE; virtual bool ItemsChanged(wxDataViewItemArray const& items) wxOVERRIDE; virtual bool ItemDeleted (wxDataViewItem const& parent, wxDataViewItem const& item) wxOVERRIDE; virtual bool ItemsDeleted(wxDataViewItem const& parent, wxDataViewItemArray const& items) wxOVERRIDE; virtual bool ValueChanged(wxDataViewItem const& item, unsigned int col) wxOVERRIDE; virtual bool Cleared() wxOVERRIDE; virtual void Resort() wxOVERRIDE; // adjust wxCOL_WIDTH_AUTOSIZE columns to fit the data void AdjustAutosizedColumns(); protected: // if the dataview control can have a variable row height this method sets the dataview's control row height of // the passed item to the maximum value occupied by the item in all columns void AdjustRowHeight(wxDataViewItem const& item); // ... and the same method for a couple of items: void AdjustRowHeights(wxDataViewItemArray const& items); private: wxDataViewCtrl* m_DataViewCtrlPtr; }; // // constructors / destructor // wxOSXDataViewModelNotifier::wxOSXDataViewModelNotifier(wxDataViewCtrl* initDataViewCtrlPtr) :m_DataViewCtrlPtr(initDataViewCtrlPtr) { if (initDataViewCtrlPtr == NULL) wxFAIL_MSG("Pointer to dataview control must not be NULL"); } bool wxOSXDataViewModelNotifier::ItemAdded(wxDataViewItem const& parent, wxDataViewItem const& item) { bool noFailureFlag; wxCHECK_MSG(item.IsOk(),false,"Added item is invalid."); noFailureFlag = m_DataViewCtrlPtr->GetDataViewPeer()->Add(parent,item); AdjustRowHeight(item); AdjustAutosizedColumns(); return noFailureFlag; } bool wxOSXDataViewModelNotifier::ItemsAdded(wxDataViewItem const& parent, wxDataViewItemArray const& items) { bool noFailureFlag; // insert all valid items into control: noFailureFlag = m_DataViewCtrlPtr->GetDataViewPeer()->Add(parent,items); // adjust row heights: AdjustRowHeights(items); AdjustAutosizedColumns(); // done: return noFailureFlag; } bool wxOSXDataViewModelNotifier::ItemChanged(wxDataViewItem const& item) { wxCHECK_MSG(item.IsOk(), false,"Changed item is invalid."); wxCHECK_MSG(GetOwner() != NULL,false,"Owner not initialized."); if (m_DataViewCtrlPtr->GetDataViewPeer()->Update(GetOwner()->GetParent(item),item)) { // send the equivalent wxWidgets event: wxDataViewEvent dataViewEvent(wxEVT_DATAVIEW_ITEM_VALUE_CHANGED, m_DataViewCtrlPtr, item); m_DataViewCtrlPtr->HandleWindowEvent(dataViewEvent); // row height may have to be adjusted: AdjustRowHeight(item); AdjustAutosizedColumns(); // done return true; } else return false; } bool wxOSXDataViewModelNotifier::ItemsChanged(wxDataViewItemArray const& items) { size_t const noOfItems = items.GetCount(); for (size_t indexItem=0; indexItemGetDataViewPeer()->Update(GetOwner()->GetParent(items[indexItem]),items[indexItem])) { // send for all changed items a wxWidgets event: wxDataViewEvent dataViewEvent(wxEVT_DATAVIEW_ITEM_VALUE_CHANGED,m_DataViewCtrlPtr,items[indexItem]); m_DataViewCtrlPtr->HandleWindowEvent(dataViewEvent); } else return false; // if this location is reached all items have been updated: AdjustRowHeights(items); AdjustAutosizedColumns(); // done: return true; } bool wxOSXDataViewModelNotifier::ItemDeleted(wxDataViewItem const& parent, wxDataViewItem const& item) { bool noFailureFlag; wxCHECK_MSG(item.IsOk(),false,"To be deleted item is invalid."); // 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 // not to be identical because the being edited item might be below the passed item in the hierarchy); // to prevent the control trying to ask the model to update an already deleted item the control is informed that currently a deleting process // has been started and that variables can currently not be updated even when requested by the system: m_DataViewCtrlPtr->SetDeleting(true); noFailureFlag = m_DataViewCtrlPtr->GetDataViewPeer()->Remove(parent); // enable automatic updating again: m_DataViewCtrlPtr->SetDeleting(false); AdjustAutosizedColumns(); // done: return noFailureFlag; } bool wxOSXDataViewModelNotifier::ItemsDeleted(wxDataViewItem const& parent, wxDataViewItemArray const& WXUNUSED(items)) { bool noFailureFlag; // 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 // not to be identical because the being edited item might be below the passed item in the hierarchy); // to prevent the control trying to ask the model to update an already deleted item the control is informed that currently a deleting process // has been started and that variables can currently not be updated even when requested by the system: m_DataViewCtrlPtr->SetDeleting(true); // delete all specified items: noFailureFlag = m_DataViewCtrlPtr->GetDataViewPeer()->Remove(parent); // enable automatic updating again: m_DataViewCtrlPtr->SetDeleting(false); AdjustAutosizedColumns(); // done: return noFailureFlag; } bool wxOSXDataViewModelNotifier::ValueChanged(wxDataViewItem const& item, unsigned int col) { wxCHECK_MSG(item.IsOk(), false,"Passed item is invalid."); wxCHECK_MSG(GetOwner() != NULL,false,"Owner not initialized."); if (m_DataViewCtrlPtr->GetDataViewPeer()->Update(GetOwner()->GetParent(item),item)) { wxDataViewEvent dataViewEvent(wxEVT_DATAVIEW_ITEM_VALUE_CHANGED, m_DataViewCtrlPtr, m_DataViewCtrlPtr->GetColumn(col), item); // send the equivalent wxWidgets event: m_DataViewCtrlPtr->HandleWindowEvent(dataViewEvent); AdjustAutosizedColumns(); // done return true; } else return false; } bool wxOSXDataViewModelNotifier::Cleared() { return m_DataViewCtrlPtr->GetDataViewPeer()->Reload(); } void wxOSXDataViewModelNotifier::Resort() { m_DataViewCtrlPtr->GetDataViewPeer()->Resort(); } void wxOSXDataViewModelNotifier::AdjustRowHeight(wxDataViewItem const& item) { if ((m_DataViewCtrlPtr->GetWindowStyle() & wxDV_VARIABLE_LINE_HEIGHT) != 0) { wxDataViewModel *model = GetOwner(); int height = 20; // TODO find out standard height unsigned int num = m_DataViewCtrlPtr->GetColumnCount(); unsigned int col; for (col = 0; col < num; col++) { wxDataViewColumn* column(m_DataViewCtrlPtr->GetColumnPtr(col)); if (!(column->IsHidden())) { wxDataViewCustomRenderer *renderer = dynamic_cast(column->GetRenderer()); if (renderer) { wxVariant value; model->GetValue( value, item, column->GetModelColumn() ); renderer->SetValue( value ); height = wxMax( height, renderer->GetSize().y ); } } } if (height > 20) m_DataViewCtrlPtr->GetDataViewPeer()->SetRowHeight(item,height); } } void wxOSXDataViewModelNotifier::AdjustRowHeights(wxDataViewItemArray const& items) { if ((m_DataViewCtrlPtr->GetWindowStyle() & wxDV_VARIABLE_LINE_HEIGHT) != 0) { size_t const noOfItems = items.GetCount(); wxDataViewModel *model = GetOwner(); for (size_t itemIndex=0; itemIndexGetColumnCount(); unsigned int col; for (col = 0; col < num; col++) { wxDataViewColumn* column(m_DataViewCtrlPtr->GetColumnPtr(col)); if (!(column->IsHidden())) { wxDataViewCustomRenderer *renderer = dynamic_cast(column->GetRenderer()); if (renderer) { wxVariant value; model->GetValue( value, items[itemIndex], column->GetModelColumn() ); renderer->SetValue( value ); height = wxMax( height, renderer->GetSize().y ); } } } if (height > 20) m_DataViewCtrlPtr->GetDataViewPeer()->SetRowHeight(items[itemIndex],height); } } } void wxOSXDataViewModelNotifier::AdjustAutosizedColumns() { unsigned count = m_DataViewCtrlPtr->GetColumnCount(); for ( unsigned col = 0; col < count; col++ ) { m_DataViewCtrlPtr->GetDataViewPeer()->FitColumnWidthToContent(col); } } // --------------------------------------------------------- // wxDataViewCustomRenderer // The constructor, the implementation macro and environment // dependent methods can be found in the environment's // source file. // --------------------------------------------------------- wxDataViewCustomRenderer::~wxDataViewCustomRenderer() { delete m_DCPtr; } wxDC* wxDataViewCustomRenderer::GetDC() { if ((m_DCPtr == NULL) && (GetOwner() != NULL) && (GetOwner()->GetOwner() != NULL)) m_DCPtr = new wxClientDC(GetOwner()->GetOwner()); return m_DCPtr; } void wxDataViewCustomRenderer::SetDC(wxDC* newDCPtr) { delete m_DCPtr; m_DCPtr = newDCPtr; } //----------------------------------------------------------------------------- // wxDataViewCtrl //----------------------------------------------------------------------------- wxDataViewCtrl::~wxDataViewCtrl() { // Notice that we don't call ClearColumns() from here as with Cocoa this // method actually recreates the entire control which is unnecessary when // we're about to dsetroy it and results in unexpected side effects (e.g. // calls to comparison function as the entire contents of the control is // re-added to it and so possibly re-sorted). WX_CLEAR_ARRAY(m_ColumnPtrs); // Ensure that the already destructed controls is not notified about changes // in the model any more. if (m_ModelNotifier != NULL) m_ModelNotifier->GetOwner()->RemoveNotifier(m_ModelNotifier); } void wxDataViewCtrl::Init() { m_CustomRendererPtr = NULL; m_Deleting = false; m_cgContext = NULL; m_ModelNotifier = NULL; } bool wxDataViewCtrl::Create(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long style, const wxValidator& validator, const wxString& name) { // Remove wxVSCROLL and wxHSCROLL from the style, since the dataview panel has scrollbars // by default, and wxControl::Create trys to make some but crashes in the process style &= ~(wxVSCROLL | wxHSCROLL); DontCreatePeer(); if (!(wxControl::Create(parent,id,pos,size,style,validator,name))) return false; SetPeer(::CreateDataView(this,parent,id,pos,size,style,GetExtraStyle())); MacPostControlCreate(pos,size); return true; } bool wxDataViewCtrl::AssociateModel(wxDataViewModel* model) { wxDataViewWidgetImpl* dataViewWidgetPtr(GetDataViewPeer()); wxCHECK_MSG(dataViewWidgetPtr != NULL,false,"Pointer to native control must not be NULL."); // We could have been associated with another model previously, break the // association in this case. if ( m_ModelNotifier ) { m_ModelNotifier->GetOwner()->RemoveNotifier(m_ModelNotifier); m_ModelNotifier = NULL; } if (wxDataViewCtrlBase::AssociateModel(model) && dataViewWidgetPtr->AssociateModel(model)) { if (model != NULL) { m_ModelNotifier = new wxOSXDataViewModelNotifier(this); model->AddNotifier(m_ModelNotifier); } return true; } else return false; } bool wxDataViewCtrl::AppendColumn(wxDataViewColumn* columnPtr) { return wxDataViewCtrl::InsertColumn( GetColumnCount(), columnPtr ); } bool wxDataViewCtrl::PrependColumn(wxDataViewColumn* columnPtr) { return wxDataViewCtrl::InsertColumn( 0, columnPtr ); } bool wxDataViewCtrl::InsertColumn(unsigned int pos, wxDataViewColumn* columnPtr) { wxDataViewWidgetImpl* dataViewWidgetPtr(GetDataViewPeer()); // first, some error checking: wxCHECK_MSG(dataViewWidgetPtr != NULL, false,"Pointer to native control must not be NULL."); wxCHECK_MSG(columnPtr != NULL, false,"Column pointer must not be NULL."); wxCHECK_MSG(columnPtr->GetRenderer() != NULL, false,"Column does not have a renderer."); // add column to wxWidget's internal structure: if (wxDataViewCtrlBase::InsertColumn(pos,columnPtr)) { m_ColumnPtrs.Add(columnPtr); // if the insertion in the native control is successful the rest can also be initialized: if (dataViewWidgetPtr->InsertColumn(pos,columnPtr)) { // make sure that the data is up-to-date... // if the newly appended column is the first column add the initial data to the control and mark the column as an expander column, // otherwise ask the control to 'update' the data in the newly appended column: if (GetColumnCount() == 1) SetExpanderColumn(columnPtr); AdjustAutosizedColumns(); // done: return true; } else { // clean-up: m_ColumnPtrs.Remove(columnPtr); delete columnPtr; // and send a message in debug mode: wxFAIL_MSG("Column could not be added to native control."); // failed: return false; } } else { // clean-up: delete columnPtr; wxFAIL_MSG("Could not add column to internal structures."); // failed: return false; } } bool wxDataViewCtrl::ClearColumns() { if (GetDataViewPeer()->ClearColumns()) { WX_CLEAR_ARRAY(m_ColumnPtrs); return true; } else return false; } bool wxDataViewCtrl::DeleteColumn(wxDataViewColumn* columnPtr) { if (GetDataViewPeer()->DeleteColumn(columnPtr)) { m_ColumnPtrs.Remove(columnPtr); delete columnPtr; AdjustAutosizedColumns(); return true; } else return false; } wxDataViewColumn* wxDataViewCtrl::GetColumn(unsigned int pos) const { return GetDataViewPeer()->GetColumn(pos); } unsigned int wxDataViewCtrl::GetColumnCount() const { return m_ColumnPtrs.GetCount(); } int wxDataViewCtrl::GetColumnPosition(wxDataViewColumn const* columnPtr) const { return GetDataViewPeer()->GetColumnPosition(columnPtr); } void wxDataViewCtrl::Collapse(wxDataViewItem const& item) { GetDataViewPeer()->Collapse(item); AdjustAutosizedColumns(); } void wxDataViewCtrl::EnsureVisible(wxDataViewItem const& item, wxDataViewColumn const* columnPtr) { if (item.IsOk()) { ExpandAncestors(item); // make sure that the item exists in the control GetDataViewPeer()->EnsureVisible(item,columnPtr); } } void wxDataViewCtrl::DoExpand(wxDataViewItem const& item, bool expandChildren) { GetDataViewPeer()->DoExpand(item, expandChildren); AdjustAutosizedColumns(); } bool wxDataViewCtrl::IsExpanded( const wxDataViewItem & item ) const { return (item.IsOk() && GetDataViewPeer()->IsExpanded(item)); } wxDataViewColumn* wxDataViewCtrl::GetSortingColumn() const { return GetDataViewPeer()->GetSortingColumn(); } unsigned int wxDataViewCtrl::GetCount() const { return GetDataViewPeer()->GetCount(); } wxDataViewItem wxDataViewCtrl::DoGetCurrentItem() const { return GetDataViewPeer()->GetCurrentItem(); } void wxDataViewCtrl::DoSetCurrentItem(const wxDataViewItem& item) { GetDataViewPeer()->SetCurrentItem(item); } wxDataViewColumn *wxDataViewCtrl::GetCurrentColumn() const { return GetDataViewPeer()->GetCurrentColumn(); } wxRect wxDataViewCtrl::GetItemRect(wxDataViewItem const& item, wxDataViewColumn const* columnPtr) const { if ( !item.IsOk() ) return wxRect(); wxRect rect = GetDataViewPeer()->GetRectangle(item, columnPtr ? columnPtr : GetColumn(0)); if ( !columnPtr ) { const unsigned columnCount = GetColumnCount(); if ( columnCount != 1 ) { // Extend the rectangle to the rightmost part of the last column. const wxRect rectLastCol = GetDataViewPeer()->GetRectangle(item, GetColumn(columnCount - 1)); rect.SetRight(rectLastCol.GetRight()); } //else: We already have the rectangle we need. } return rect; } int wxDataViewCtrl::GetSelectedItemsCount() const { return GetDataViewPeer()->GetSelectedItemsCount(); } int wxDataViewCtrl::GetSelections(wxDataViewItemArray& sel) const { return GetDataViewPeer()->GetSelections(sel); } wxDataViewItem wxDataViewCtrl::GetTopItem() const { return GetDataViewPeer()->GetTopItem(); } int wxDataViewCtrl::GetCountPerPage() const { return GetDataViewPeer()->GetCountPerPage(); } void wxDataViewCtrl::HitTest(wxPoint const& point, wxDataViewItem& item, wxDataViewColumn*& columnPtr) const { return GetDataViewPeer()->HitTest(point,item,columnPtr); } bool wxDataViewCtrl::SetRowHeight(int rowHeight) { GetDataViewPeer()->SetRowHeight(rowHeight); return true; } bool wxDataViewCtrl::IsSelected(wxDataViewItem const& item) const { return GetDataViewPeer()->IsSelected(item); } void wxDataViewCtrl::Select(wxDataViewItem const& item) { if (item.IsOk()) { ExpandAncestors(item); // make sure that the item exists in the control GetDataViewPeer()->Select(item); } } void wxDataViewCtrl::SelectAll() { GetDataViewPeer()->SelectAll(); } void wxDataViewCtrl::SetSelections(wxDataViewItemArray const& sel) { wxDataViewWidgetImpl* dataViewWidgetPtr(GetDataViewPeer()); dataViewWidgetPtr->UnselectAll(); size_t const noOfSelections = sel.GetCount(); size_t i; wxDataViewItem last_parent; // make sure that all to be selected items are visible in the control: for (i = 0; i < noOfSelections; i++) { wxDataViewItem item = sel[i]; wxDataViewItem parent = GetModel()->GetParent( item ); if (parent.IsOk() && (parent != last_parent)) ExpandAncestors(item); last_parent = parent; } // finally select the items: dataViewWidgetPtr->Select(sel); } void wxDataViewCtrl::Unselect(wxDataViewItem const& item) { if (item.IsOk()) GetDataViewPeer()->Unselect(item); } void wxDataViewCtrl::UnselectAll() { GetDataViewPeer()->UnselectAll(); } // // implementation // wxDataViewWidgetImpl* wxDataViewCtrl::GetDataViewPeer() const { return dynamic_cast(GetPeer()); } void wxDataViewCtrl::AddChildren(wxDataViewItem const& parentItem) { wxDataViewItemArray items; wxCHECK_RET(GetModel() != NULL,"Model pointer not initialized."); GetModel()->GetChildren(parentItem,items); (void) GetModel()->ItemsAdded(parentItem,items); } void wxDataViewCtrl::EditItem(const wxDataViewItem& item, const wxDataViewColumn *column) { GetDataViewPeer()->StartEditor(item, GetColumnPosition(column)); } void wxDataViewCtrl::FinishCustomItemEditing() { if (GetCustomRendererItem().IsOk()) { GetCustomRendererPtr()->FinishEditing(); SetCustomRendererItem(wxDataViewItem()); SetCustomRendererPtr (NULL); } } void wxDataViewCtrl::AdjustAutosizedColumns() const { if ( m_ModelNotifier ) m_ModelNotifier->AdjustAutosizedColumns(); } /*static*/ wxVisualAttributes wxDataViewCtrl::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant)) { wxVisualAttributes attr; attr.colFg = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT ); attr.colBg = wxSystemSettings::GetColour( wxSYS_COLOUR_LISTBOX ); static wxFont font = wxFont(wxOSX_SYSTEM_FONT_VIEWS); attr.font = font; return attr; } // inherited methods from wxDataViewCtrlBase void wxDataViewCtrl::DoSetExpanderColumn() { if (GetExpanderColumn() != NULL) GetDataViewPeer()->DoSetExpanderColumn(GetExpanderColumn()); } void wxDataViewCtrl::DoSetIndent() { GetDataViewPeer()->DoSetIndent(GetIndent()); } // event handling: void wxDataViewCtrl::OnSize(wxSizeEvent& event) { unsigned int const noOfColumns = GetColumnCount(); // reset DC of all custom renderers because DC has changed: for (unsigned int i=0; i(dataViewColumnPtr->GetRenderer())); if (dataViewCustomRendererPtr != NULL) dataViewCustomRendererPtr->SetDC(NULL); } } // update the layout of the native control after a size event: GetDataViewPeer()->OnSize(); event.Skip(); } wxSize wxDataViewCtrl::DoGetBestSize() const { wxSize best = wxControl::DoGetBestSize(); best.y = 80; return best; } void wxDataViewCtrl::OnMouse(wxMouseEvent& event) { event.Skip(); } wxIMPLEMENT_DYNAMIC_CLASS(wxDataViewCtrl,wxDataViewCtrlBase); wxBEGIN_EVENT_TABLE(wxDataViewCtrl,wxDataViewCtrlBase) EVT_SIZE(wxDataViewCtrl::OnSize) EVT_MOTION(wxDataViewCtrl::OnMouse) wxEND_EVENT_TABLE() #endif // !wxHAS_GENERIC_DATAVIEWCTRL #endif // wxUSE_DATAVIEWCTRL