ModelView::ViewModelController Class Reference

Propagates changes from SessionModel to its ViewModelBase. More...

Inheritance diagram for ModelView::ViewModelController:

Collaboration diagram for ModelView::ViewModelController:

Classes
struct	ViewModelControllerImpl

Public Member Functions
	ViewModelController (SessionModel *session_model, ViewModelBase *view_model=nullptr)
	~ViewModelController ()
std::vector< ViewItem * >	findViews (const ModelView::SessionItem *item) const
	Returns all ViewItem's displaying given SessionItem. More...
QStringList	horizontalHeaderLabels () const
SessionModel *	model () const
SessionItem *	rootSessionItem () const
SessionModel *	sessionModel () const
	Returns SessionModel handled by this controller. More...
void	setChildrenStrategy (std::unique_ptr< ChildrenStrategyInterface > children_strategy)
void	setOnAboutToRemoveItem (Callbacks::item_tagrow_t f, Callbacks::slot_t client={}) override
	Sets callback to be notified when the item is about to be removed. More...
void	setOnDataChange (Callbacks::item_int_t f, Callbacks::slot_t client={}) override
	Sets callback to be notified on item's data change. More...
void	setOnItemInserted (Callbacks::item_tagrow_t f, Callbacks::slot_t client={}) override
	Sets callback to be notified on item insert. More...
void	setOnItemRemoved (Callbacks::item_tagrow_t f, Callbacks::slot_t client={}) override
	Sets callback to be notified on item remove. More...
void	setOnModelAboutToBeReset (Callbacks::model_t f, Callbacks::slot_t client={}) override
	Sets the callback to be notified before model's full reset (root item recreated). More...
void	setOnModelDestroyed (Callbacks::model_t f, Callbacks::slot_t client={}) override
	Sets the callback for notifications on model destruction. More...
void	setOnModelReset (Callbacks::model_t f, Callbacks::slot_t client={}) override
	Sets the callback to be notified after model was fully reset (root item recreated). More...
void	setRootSessionItem (SessionItem *item)
void	setRowStrategy (std::unique_ptr< RowStrategyInterface > row_strategy)
void	setViewModel (ViewModelBase *view_model)
void	unsubscribe (Callbacks::slot_t client={}) override
	Removes given client from all subscriptions. More...

Protected Member Functions
virtual void	onAboutToRemoveItem (SessionItem *parent, TagRow tagrow)
virtual void	onDataChange (SessionItem *item, int role)
virtual void	onItemInserted (SessionItem *parent, TagRow tagrow)
virtual void	onItemRemoved (SessionItem *parent, TagRow tagrow)
void	update_branch (const SessionItem *item)

Protected Attributes
SessionModel *	m_model {nullptr}

Private Attributes
std::unique_ptr< ViewModelControllerImpl >	p_impl

Detailed Description

Propagates changes from SessionModel to its ViewModelBase.

Definition at line 38 of file viewmodelcontroller.h.

Constructor & Destructor Documentation

ViewModelController()

ViewModelController::ViewModelController	(	SessionModel *	session_model,
		ViewModelBase *	view_model = nullptr
	)

Definition at line 168 of file viewmodelcontroller.cpp.

    : ModelListener(session_model)
    , p_impl(std::make_unique<ViewModelControllerImpl>(this, view_model))
{
    auto on_data_change = [this](SessionItem* item, int role) { onDataChange(item, role); };
    setOnDataChange(on_data_change);
 
    auto on_item_inserted = [this](SessionItem* item, TagRow tagrow) {
        onItemInserted(item, std::move(tagrow));
    };
    setOnItemInserted(on_item_inserted);
 
    auto on_item_removed = [this](SessionItem* item, TagRow tagrow) {
        onItemRemoved(item, std::move(tagrow));
    };
    setOnItemRemoved(on_item_removed);
 
    auto on_about_to_remove = [this](SessionItem* item, TagRow tagrow) {
        onAboutToRemoveItem(item, std::move(tagrow));
    };
    setOnAboutToRemoveItem(on_about_to_remove);
 
    auto on_model_destroyed = [this](auto) {
        p_impl->m_viewModel->setRootViewItem(std::make_unique<RootViewItem>(nullptr));
    };
    setOnModelDestroyed(on_model_destroyed);
 
    auto on_model_reset = [this](auto) {
        auto root_item = Utils::ItemFromPath(*model(), p_impl->m_rootItemPath);
        p_impl->setRootSessionItemIntern(root_item ? root_item : model()->rootItem());
        p_impl->m_viewModel->endResetModel();
    };
    setOnModelReset(on_model_reset);
 
    auto on_model_about_to_be_reset = [this](auto) { p_impl->m_viewModel->beginResetModel(); };
    setOnModelAboutToBeReset(on_model_about_to_be_reset);
}

References ModelView::Utils::ItemFromPath(), ModelView::ModelListener< SessionModel >::model(), onAboutToRemoveItem(), onDataChange(), onItemInserted(), onItemRemoved(), p_impl, ModelView::ModelListenerBase::setOnAboutToRemoveItem(), ModelView::ModelListenerBase::setOnDataChange(), ModelView::ModelListenerBase::setOnItemInserted(), ModelView::ModelListenerBase::setOnItemRemoved(), ModelView::ModelListenerBase::setOnModelAboutToBeReset(), ModelView::ModelListenerBase::setOnModelDestroyed(), and ModelView::ModelListenerBase::setOnModelReset().

Here is the call graph for this function:

~ViewModelController()

ViewModelController::~ViewModelController ( )

default

Member Function Documentation

findViews()

std::vector< ViewItem * > ViewModelController::findViews

(

const ModelView::SessionItem *

item

)

const

Returns all ViewItem's displaying given SessionItem.

Definition at line 253 of file viewmodelcontroller.cpp.

{
    return p_impl->findViews(item);
}

References p_impl.

Referenced by onDataChange(), and update_branch().

horizontalHeaderLabels()

QStringList ViewModelController::horizontalHeaderLabels

(

)

const

Definition at line 258 of file viewmodelcontroller.cpp.

{
    return p_impl->m_rowStrategy->horizontalHeaderLabels();
}

References p_impl.

model()

SessionModel * ModelView::ModelListener< SessionModel >::model ( ) const

inlineinherited

Definition at line 30 of file modellistener.h.

{ return static_cast<T*>(m_model); }

onAboutToRemoveItem()

void ViewModelController::onAboutToRemoveItem ( SessionItem *  parent, TagRow  tagrow  )

protectedvirtual

Definition at line 281 of file viewmodelcontroller.cpp.

{
    auto item_to_remove = parent->getItem(tagrow.tag, tagrow.row);
    if (item_to_remove == rootSessionItem()
        || Utils::IsItemAncestor(rootSessionItem(), item_to_remove)) {
        // special case when user removes SessionItem which is one of ancestors of our root item
        // or root item iteslf
        p_impl->m_viewModel->beginResetModel();
        p_impl->m_viewModel->setRootViewItem(std::make_unique<RootViewItem>(nullptr));
        p_impl->m_itemToVview.clear();
        p_impl->m_rootItemPath = {};
        p_impl->m_viewModel->endResetModel();
    } else {
        p_impl->remove_row_of_views(item_to_remove);
    }
}

References ModelView::SessionItem::getItem(), ModelView::Utils::IsItemAncestor(), p_impl, rootSessionItem(), ModelView::TagRow::row, and ModelView::TagRow::tag.

Referenced by ViewModelController().

Here is the call graph for this function:

onDataChange()

void ViewModelController::onDataChange ( SessionItem *  item, int  role  )

protectedvirtual

Reimplemented in ModelView::PropertyFlatViewModelController, and ModelView::PropertyViewModelController.

Definition at line 263 of file viewmodelcontroller.cpp.

{
    for (auto view : findViews(item)) {
        // inform corresponding LabelView and DataView
        if (isValidItemRole(view, role)) {
            auto index = p_impl->m_viewModel->indexFromItem(view);
            p_impl->m_viewModel->dataChanged(index, index, Utils::ItemRoleToQtRole(role));
        }
    }
}

References findViews(), ModelView::Utils::ItemRoleToQtRole(), and p_impl.

Referenced by ViewModelController(), ModelView::PropertyViewModelController::onDataChange(), and ModelView::PropertyFlatViewModelController::onDataChange().

Here is the call graph for this function:

onItemInserted()

void ViewModelController::onItemInserted ( SessionItem *  parent, TagRow  tagrow  )

protectedvirtual

Definition at line 274 of file viewmodelcontroller.cpp.

{
    p_impl->insert_view(parent, tagrow);
}

References p_impl.

Referenced by ViewModelController().

onItemRemoved()

void ViewModelController::onItemRemoved ( SessionItem *  parent, TagRow  tagrow  )

protectedvirtual

Definition at line 279 of file viewmodelcontroller.cpp.

{}

Referenced by ViewModelController().

rootSessionItem()

SessionItem * ViewModelController::rootSessionItem

(

)

const

Definition at line 246 of file viewmodelcontroller.cpp.

{
    return p_impl->m_viewModel->rootItem()->item();
}

References p_impl.

Referenced by ModelView::ViewModelController::ViewModelControllerImpl::init_view_model(), and onAboutToRemoveItem().

sessionModel()

SessionModel * ViewModelController::sessionModel

(

)

const

Returns SessionModel handled by this controller.

Definition at line 226 of file viewmodelcontroller.cpp.

{
    return model();
}

References ModelView::ModelListener< SessionModel >::model().

Here is the call graph for this function:

setChildrenStrategy()

void ViewModelController::setChildrenStrategy

(

std::unique_ptr< ChildrenStrategyInterface >

children_strategy

)

Definition at line 213 of file viewmodelcontroller.cpp.

{
    p_impl->m_childrenStrategy = std::move(children_strategy);
}

References p_impl.

Referenced by ModelView::DefaultViewModelController::DefaultViewModelController(), gui2::LayerViewModelController::LayerViewModelController(), ModelView::PropertyFlatViewModelController::PropertyFlatViewModelController(), ModelView::PropertyTableViewModelController::PropertyTableViewModelController(), ModelView::PropertyViewModelController::PropertyViewModelController(), and ModelView::TopItemsViewModelController::TopItemsViewModelController().

setOnAboutToRemoveItem()

void ModelListenerBase::setOnAboutToRemoveItem ( Callbacks::item_tagrow_t  f, Callbacks::slot_t  client = {}  )

overridevirtualinherited

Sets callback to be notified when the item is about to be removed.

The callback will be called with (SessionItem* parent, tagrow), where 'tagrow' denotes child position being removed.

Implements ModelView::ModelListenerInterface.

Definition at line 61 of file modellistenerbase.cpp.

{
    m_model->mapper()->setOnAboutToRemoveItem(f, this);
}

References ModelView::ModelListenerBase::m_model, ModelView::SessionModel::mapper(), and ModelView::ModelMapper::setOnAboutToRemoveItem().

Referenced by ModelView::ItemMapper::ItemMapper(), and ViewModelController().

Here is the call graph for this function:

setOnDataChange()

void ModelListenerBase::setOnDataChange ( Callbacks::item_int_t  f, Callbacks::slot_t  client = {}  )

overridevirtualinherited

Sets callback to be notified on item's data change.

The callback will be called with (SessionItem*, data_role).

Implements ModelView::ModelListenerInterface.

Definition at line 37 of file modellistenerbase.cpp.

{
    m_model->mapper()->setOnDataChange(f, this);
}

References ModelView::ModelListenerBase::m_model, ModelView::SessionModel::mapper(), and ModelView::ModelMapper::setOnDataChange().

Referenced by gui2::ExperimentalDataController::ExperimentalDataController(), ModelView::ItemMapper::ItemMapper(), gui2::MaterialPropertyController::MaterialPropertyController(), ModelView::ModelHasChangedController::ModelHasChangedController(), and ViewModelController().

Here is the call graph for this function:

setOnItemInserted()

void ModelListenerBase::setOnItemInserted ( Callbacks::item_tagrow_t  f, Callbacks::slot_t  client = {}  )

overridevirtualinherited

Sets callback to be notified on item insert.

The callback will be called with (SessionItem* parent, tagrow), where 'tagrow' denotes inserted child position.

Implements ModelView::ModelListenerInterface.

Definition at line 45 of file modellistenerbase.cpp.

{
    m_model->mapper()->setOnItemInserted(f, this);
}

References ModelView::ModelListenerBase::m_model, ModelView::SessionModel::mapper(), and ModelView::ModelMapper::setOnItemInserted().

Referenced by gui2::ExperimentalDataController::ExperimentalDataController(), ModelView::ItemMapper::ItemMapper(), gui2::MaterialPropertyController::MaterialPropertyController(), ModelView::ModelHasChangedController::ModelHasChangedController(), and ViewModelController().

Here is the call graph for this function:

setOnItemRemoved()

void ModelListenerBase::setOnItemRemoved ( Callbacks::item_tagrow_t  f, Callbacks::slot_t  client = {}  )

overridevirtualinherited

Sets callback to be notified on item remove.

The callback will be called with (SessionItem* parent, tagrow), where 'tagrow' denotes child position before the removal.

Implements ModelView::ModelListenerInterface.

Definition at line 53 of file modellistenerbase.cpp.

{
    m_model->mapper()->setOnItemRemoved(f, this);
}

References ModelView::ModelListenerBase::m_model, ModelView::SessionModel::mapper(), and ModelView::ModelMapper::setOnItemRemoved().

Referenced by gui2::ExperimentalDataController::ExperimentalDataController(), ModelView::ItemMapper::ItemMapper(), gui2::MaterialPropertyController::MaterialPropertyController(), ModelView::ModelHasChangedController::ModelHasChangedController(), and ViewModelController().

Here is the call graph for this function:

setOnModelAboutToBeReset()

void ModelListenerBase::setOnModelAboutToBeReset ( Callbacks::model_t  f, Callbacks::slot_t  client = {}  )

overridevirtualinherited

Sets the callback to be notified before model's full reset (root item recreated).

Implements ModelView::ModelListenerInterface.

Definition at line 76 of file modellistenerbase.cpp.

{
    m_model->mapper()->setOnModelAboutToBeReset(f, this);
}

References ModelView::ModelListenerBase::m_model, ModelView::SessionModel::mapper(), and ModelView::ModelMapper::setOnModelAboutToBeReset().

Referenced by ViewModelController().

Here is the call graph for this function:

setOnModelDestroyed()

void ModelListenerBase::setOnModelDestroyed ( Callbacks::model_t  f, Callbacks::slot_t  client = {}  )

overridevirtualinherited

Sets the callback for notifications on model destruction.

Implements ModelView::ModelListenerInterface.

Definition at line 69 of file modellistenerbase.cpp.

{
    m_model->mapper()->setOnModelDestroyed(f, this);
}

References ModelView::ModelListenerBase::m_model, ModelView::SessionModel::mapper(), and ModelView::ModelMapper::setOnModelDestroyed().

Referenced by ModelView::ModelListenerBase::ModelListenerBase(), and ViewModelController().

Here is the call graph for this function:

setOnModelReset()

void ModelListenerBase::setOnModelReset ( Callbacks::model_t  f, Callbacks::slot_t  client = {}  )

overridevirtualinherited

Sets the callback to be notified after model was fully reset (root item recreated).

Implements ModelView::ModelListenerInterface.

Definition at line 83 of file modellistenerbase.cpp.

{
    m_model->mapper()->setOnModelReset(f, this);
}

References ModelView::ModelListenerBase::m_model, ModelView::SessionModel::mapper(), and ModelView::ModelMapper::setOnModelReset().

Referenced by gui2::ExperimentalDataController::ExperimentalDataController(), gui2::MaterialPropertyController::MaterialPropertyController(), ModelView::ModelHasChangedController::ModelHasChangedController(), and ViewModelController().

Here is the call graph for this function:

setRootSessionItem()

void ViewModelController::setRootSessionItem

(

SessionItem *

item

)

Definition at line 231 of file viewmodelcontroller.cpp.

{
    if (!item)
        throw std::runtime_error(
            "Error in ViewModelController: atttemp to set nulptr as root item");
 
    if (item->model() != model())
        throw std::runtime_error(
            "Error in ViewModelController: atttemp to use item from alien model as new root.");
 
    p_impl->m_viewModel->beginResetModel();
    p_impl->setRootSessionItemIntern(item);
    p_impl->m_viewModel->endResetModel();
}

References ModelView::SessionItem::model(), ModelView::ModelListener< SessionModel >::model(), and p_impl.

Here is the call graph for this function:

setRowStrategy()

void ViewModelController::setRowStrategy

(

std::unique_ptr< RowStrategyInterface >

row_strategy

)

Definition at line 219 of file viewmodelcontroller.cpp.

{
    p_impl->m_rowStrategy = std::move(row_strategy);
}

References p_impl.

Referenced by ModelView::DefaultViewModelController::DefaultViewModelController(), gui2::LayerViewModelController::LayerViewModelController(), ModelView::PropertyFlatViewModelController::PropertyFlatViewModelController(), ModelView::PropertyTableViewModelController::PropertyTableViewModelController(), ModelView::PropertyViewModelController::PropertyViewModelController(), and ModelView::TopItemsViewModelController::TopItemsViewModelController().

setViewModel()

void ViewModelController::setViewModel

(

ViewModelBase *

view_model

)

Definition at line 206 of file viewmodelcontroller.cpp.

{
    p_impl->m_viewModel = view_model;
}

References p_impl.

unsubscribe()

void ModelListenerBase::unsubscribe ( Callbacks::slot_t  client = {} )

overridevirtualinherited

Removes given client from all subscriptions.

Implements ModelView::ModelListenerInterface.

Definition at line 88 of file modellistenerbase.cpp.

{
    if (m_model)
        m_model->mapper()->unsubscribe(this);
}

References ModelView::ModelListenerBase::m_model, ModelView::SessionModel::mapper(), and ModelView::ModelMapper::unsubscribe().

Referenced by ModelView::ModelListenerBase::~ModelListenerBase().

Here is the call graph for this function:

update_branch()

void ViewModelController::update_branch ( const SessionItem *  item )

protected

Definition at line 298 of file viewmodelcontroller.cpp.

{
    auto views = findViews(item);
    if (views.empty())
        return;
 
    for (auto view : views)
        p_impl->remove_children_of_view(view);
 
    p_impl->iterate(item, views.at(0));
}

References findViews(), and p_impl.

Referenced by ModelView::PropertyViewModelController::onDataChange(), and ModelView::PropertyFlatViewModelController::onDataChange().

Here is the call graph for this function:

Member Data Documentation

m_model

SessionModel* ModelView::ModelListenerBase::m_model {nullptr}

protectedinherited

Definition at line 46 of file modellistenerbase.h.

Referenced by ModelView::ModelListenerBase::ModelListenerBase(), ModelView::ModelListener< T >::model(), ModelView::ModelListenerBase::setOnAboutToRemoveItem(), ModelView::ModelListenerBase::setOnDataChange(), ModelView::ModelListenerBase::setOnItemInserted(), ModelView::ModelListenerBase::setOnItemRemoved(), ModelView::ModelListenerBase::setOnModelAboutToBeReset(), ModelView::ModelListenerBase::setOnModelDestroyed(), ModelView::ModelListenerBase::setOnModelReset(), and ModelView::ModelListenerBase::unsubscribe().

p_impl

std::unique_ptr<ViewModelControllerImpl> ModelView::ViewModelController::p_impl

private

Definition at line 69 of file viewmodelcontroller.h.

Referenced by ViewModelController(), findViews(), horizontalHeaderLabels(), onAboutToRemoveItem(), onDataChange(), onItemInserted(), rootSessionItem(), setChildrenStrategy(), setRootSessionItem(), setRowStrategy(), setViewModel(), and update_branch().

---

The documentation for this class was generated from the following files:

• /home/www/ba/mvvm/viewmodel/mvvm/viewmodel/viewmodelcontroller.h
• /home/www/ba/mvvm/viewmodel/mvvm/viewmodel/viewmodelcontroller.cpp