ModelView::ModelHasChangedController Class Reference

Tracks changes in the model. More...

Inheritance diagram for ModelView::ModelHasChangedController:

Collaboration diagram for ModelView::ModelHasChangedController:

Public Types
using	callback_t = std::function< void()>

Public Member Functions
	ModelHasChangedController (SessionModel *model, callback_t callback={})
	Constructor of ModelHasChangedController. More...
bool	hasChanged () const
	Returns true if the model was changed since last call of resetChanged. More...
SessionModel *	model () const
void	resetChanged ()
	Reset has_changed flag. More...
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	unsubscribe (Callbacks::slot_t client={}) override
	Removes given client from all subscriptions. More...

Protected Attributes
SessionModel *	m_model {nullptr}

Private Member Functions
void	process_change ()
	Sets 'has_changed' flag and reports back to client. More...

Private Attributes
callback_t	m_callback
bool	m_has_changed {false}

Detailed Description

Tracks changes in the model.

Allows to check if model has been changed (e.g. modified, inserted or removed items) since last call of ::resetChanged().

Definition at line 27 of file modelhaschangedcontroller.h.

Member Typedef Documentation

callback_t

using ModelView::ModelHasChangedController::callback_t = std::function<void()>

Definition at line 29 of file modelhaschangedcontroller.h.

Constructor & Destructor Documentation

ModelHasChangedController()

ModelHasChangedController::ModelHasChangedController	(	SessionModel *	model,
		callback_t	callback = {}
	)

Constructor of ModelHasChangedController.

Acccept 'model' to listen, and a 'callback' to report about changes in a model.

Definition at line 22 of file modelhaschangedcontroller.cpp.

    : ModelListener(model), m_callback(callback)
{
    setOnDataChange([this](auto, auto) { process_change(); });
    setOnItemInserted([this](auto, auto) { process_change(); });
    setOnItemRemoved([this](auto, auto) { process_change(); });
    setOnModelReset([this](auto) { process_change(); });
}

References process_change(), ModelView::ModelListenerBase::setOnDataChange(), ModelView::ModelListenerBase::setOnItemInserted(), ModelView::ModelListenerBase::setOnItemRemoved(), and ModelView::ModelListenerBase::setOnModelReset().

Here is the call graph for this function:

Member Function Documentation

hasChanged()

bool ModelHasChangedController::hasChanged

(

)

const

Returns true if the model was changed since last call of resetChanged.

Definition at line 33 of file modelhaschangedcontroller.cpp.

{
    return m_has_changed;
}

References m_has_changed.

Referenced by TEST_F().

model()

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

inlineinherited

Definition at line 30 of file modellistener.h.

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

process_change()

void ModelHasChangedController::process_change ( )

private

Sets 'has_changed' flag and reports back to client.

Definition at line 47 of file modelhaschangedcontroller.cpp.

{
    m_has_changed = true;
    if (m_callback)
        m_callback();
}

References m_callback, and m_has_changed.

Referenced by ModelHasChangedController().

resetChanged()

void ModelHasChangedController::resetChanged

(

)

Reset has_changed flag.

Definition at line 40 of file modelhaschangedcontroller.cpp.

{
    m_has_changed = false;
}

References m_has_changed.

Referenced by TEST_F().

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 ModelView::ViewModelController::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(), ModelHasChangedController(), and ModelView::ViewModelController::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(), ModelHasChangedController(), and ModelView::ViewModelController::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(), ModelHasChangedController(), and ModelView::ViewModelController::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 ModelView::ViewModelController::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 ModelView::ViewModelController::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(), ModelHasChangedController(), and ModelView::ViewModelController::ViewModelController().

Here is the call graph for this function:

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:

Member Data Documentation

m_callback

callback_t ModelView::ModelHasChangedController::m_callback

private

Definition at line 39 of file modelhaschangedcontroller.h.

Referenced by process_change().

m_has_changed

bool ModelView::ModelHasChangedController::m_has_changed {false}

private

Definition at line 38 of file modelhaschangedcontroller.h.

Referenced by hasChanged(), process_change(), and resetChanged().

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().

---

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

• /home/www/ba/mvvm/model/mvvm/project/modelhaschangedcontroller.h
• /home/www/ba/mvvm/model/mvvm/project/modelhaschangedcontroller.cpp