ModelView::ItemMapper Class Reference

Provides notifications on various changes for a specific item. More...

Inheritance diagram for ModelView::ItemMapper:

Collaboration diagram for ModelView::ItemMapper:

Classes
struct	ItemMapperImpl

Public Member Functions
	ItemMapper (SessionItem *item)
	~ItemMapper ()
void	setActive (bool value)
	Sets activity flag to given value. Will disable all callbacks if false. More...
void	setOnAboutToRemoveItem (Callbacks::item_tagrow_t f, Callbacks::slot_t owner) override
	Sets callback to be notified when row is about to be removed. More...
void	setOnChildPropertyChange (Callbacks::item_str_t f, Callbacks::slot_t owner) override
	Sets callback to be notified on item's children property change. More...
void	setOnDataChange (Callbacks::item_int_t f, Callbacks::slot_t owner) override
	Sets callback to be notified on item's data change. More...
void	setOnItemDestroy (Callbacks::item_t f, Callbacks::slot_t owner) override
void	setOnItemInserted (Callbacks::item_tagrow_t f, Callbacks::slot_t owner) override
	Sets callback to be notified on child insertion. More...
void	setOnItemRemoved (Callbacks::item_tagrow_t f, Callbacks::slot_t owner) override
	Sets callback to be notified on child removal. More...
void	setOnPropertyChange (Callbacks::item_str_t f, Callbacks::slot_t owner) override
	Sets callback to be notified on item's property change. More...
void	unsubscribe (Callbacks::slot_t client) override
	Removes given client from all subscriptions. More...

Private Member Functions
void	callOnItemDestroy ()
	Calls all callbacks subscribed to "item is destroyed" event. More...
SessionModel *	model () const
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...

Private Attributes
SessionModel *	m_model {nullptr}
std::unique_ptr< ItemMapperImpl >	p_impl

Friends
class	SessionItem

Detailed Description

Provides notifications on various changes for a specific item.

ItemMapper listens signals coming from the model (i.e. via ModelMapper) and processes only whose signals which are related to the given item. Notifies all interested subscribers about things going with the item and its relatives.

Definition at line 31 of file itemmapper.h.

Constructor & Destructor Documentation

ItemMapper()

ItemMapper::ItemMapper

(

SessionItem *

item

)

Definition at line 147 of file itemmapper.cpp.

    : ModelListener(item->model()), p_impl(std::make_unique<ItemMapperImpl>(this))
{
    if (!item)
        throw std::runtime_error("ItemMapper::ItemMapper() -> Not initialized item");
 
    if (!item->model())
        throw std::runtime_error("ItemMapper::ItemMapper() -> Item doesn't have model");
 
    p_impl->m_item = item;
 
    auto on_data_change = [this](auto item, auto role) { p_impl->processDataChange(item, role); };
    ModelListener::setOnDataChange(on_data_change);
 
    auto on_item_inserted = [this](auto item, auto tagrow) {
        p_impl->processItemInserted(item, tagrow);
    };
    ModelListener::setOnItemInserted(on_item_inserted, this);
 
    auto on_item_removed = [this](auto item, auto tagrow) {
        p_impl->processItemRemoved(item, tagrow);
    };
    ModelListener::setOnItemRemoved(on_item_removed, this);
 
    auto on_about_to_remove_item = [this](auto item, auto tagrow) {
        p_impl->processAboutToRemoveItem(item, tagrow);
    };
    ModelListener::setOnAboutToRemoveItem(on_about_to_remove_item, this);
}

References ModelView::SessionItem::model(), p_impl, ModelView::ModelListenerBase::setOnAboutToRemoveItem(), ModelView::ModelListenerBase::setOnDataChange(), ModelView::ModelListenerBase::setOnItemInserted(), and ModelView::ModelListenerBase::setOnItemRemoved().

Here is the call graph for this function:

~ItemMapper()

ItemMapper::~ItemMapper ( )

default

Member Function Documentation

callOnItemDestroy()

void ItemMapper::callOnItemDestroy ( )

private

Calls all callbacks subscribed to "item is destroyed" event.

Definition at line 228 of file itemmapper.cpp.

{
    if (p_impl->m_active)
        p_impl->m_on_item_destroy(p_impl->m_item);
}

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); }

setActive()

void ItemMapper::setActive

(

bool

value

)

Sets activity flag to given value. Will disable all callbacks if false.

Definition at line 221 of file itemmapper.cpp.

{
    p_impl->m_active = value;
}

References p_impl.

setOnAboutToRemoveItem()

void ItemMapper::setOnAboutToRemoveItem ( Callbacks::item_tagrow_t  f, Callbacks::slot_t  owner  )

overridevirtual

Sets callback to be notified when row is about to be removed.

Callback will be called with (compound_item, tagrow). For MultiLayer containing the T_LAYERS tag, the signal will be triggered on layer deletion with (multilayer*, {T_LAYER, row}) as callback parameters.

Implements ModelView::ItemListenerInterface.

Definition at line 209 of file itemmapper.cpp.

{
    p_impl->m_on_about_to_remove_item.connect(std::move(f), owner);
}

References p_impl.

Referenced by MockWidgetForItem::setItem().

setOnChildPropertyChange()

void ItemMapper::setOnChildPropertyChange ( Callbacks::item_str_t  f, Callbacks::slot_t  owner  )

overridevirtual

Sets callback to be notified on item's children property change.

Callback will be called with (compound_item, property_name). For MultiLayer containing the layer with "thickness" property, the signal will be triggered on thickness change using (layeritem*, "thickness") as callback parameters.

Implements ModelView::ItemListenerInterface.

Definition at line 194 of file itemmapper.cpp.

{
    p_impl->m_on_child_property_change.connect(std::move(f), owner);
}

References p_impl.

Referenced by MockWidgetForItem::setItem().

setOnDataChange()

void ItemMapper::setOnDataChange ( Callbacks::item_int_t  f, Callbacks::slot_t  owner  )

overridevirtual

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

Callback will be called with (SessionItem*, data_role).

Implements ModelView::ItemListenerInterface.

Definition at line 184 of file itemmapper.cpp.

{
    p_impl->m_on_data_change.connect(std::move(f), owner);
}

References p_impl.

Referenced by MockWidgetForItem::setItem().

setOnItemDestroy()

void ItemMapper::setOnItemDestroy ( Callbacks::item_t  f, Callbacks::slot_t  owner  )

overridevirtual

Implements ModelView::ItemListenerInterface.

Definition at line 179 of file itemmapper.cpp.

{
    p_impl->m_on_item_destroy.connect(std::move(f), owner);
}

References p_impl.

Referenced by MockWidgetForItem::setItem().

setOnItemInserted()

void ItemMapper::setOnItemInserted ( Callbacks::item_tagrow_t  f, Callbacks::slot_t  owner  )

overridevirtual

Sets callback to be notified on child insertion.

Callback will be called with (compound_item, tag, row). For MultiLayer containing the T_LAYERS tag, the signal will be triggered on layer insertion with (multilayer*, {T_LAYER, row}) as callback parameters.

Implements ModelView::ItemListenerInterface.

Definition at line 199 of file itemmapper.cpp.

{
    p_impl->m_on_item_inserted.connect(std::move(f), owner);
}

References p_impl.

Referenced by gui2::MultiLayerItem::activate(), and MockWidgetForItem::setItem().

setOnItemRemoved()

void ItemMapper::setOnItemRemoved ( Callbacks::item_tagrow_t  f, Callbacks::slot_t  owner  )

overridevirtual

Sets callback to be notified on child removal.

Callback will be called with (compound_item, tag, row). For MultiLayer containing the T_LAYERS tag, the signal will be triggered on layer removal with (multilayer*, {T_LAYER, oldrow}) as callback parameters.

Implements ModelView::ItemListenerInterface.

Definition at line 204 of file itemmapper.cpp.

{
    p_impl->m_on_item_removed.connect(std::move(f), owner);
}

References p_impl.

Referenced by gui2::MultiLayerItem::activate(), and MockWidgetForItem::setItem().

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

Here is the call graph for this function:

setOnPropertyChange()

void ItemMapper::setOnPropertyChange ( Callbacks::item_str_t  f, Callbacks::slot_t  owner  )

overridevirtual

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

Callback will be called with (compound_item, property_name).

Implements ModelView::ItemListenerInterface.

Definition at line 189 of file itemmapper.cpp.

{
    p_impl->m_on_property_change.connect(std::move(f), owner);
}

References p_impl.

Referenced by ModelView::VectorItem::activate(), ToyItems::LatticeItem::activate(), gui2::LayerElementController::connectToModel(), and MockWidgetForItem::setItem().

unsubscribe()

void ItemMapper::unsubscribe ( Callbacks::slot_t  client )

overridevirtual

Removes given client from all subscriptions.

Implements ModelView::ItemListenerInterface.

Definition at line 214 of file itemmapper.cpp.

{
    p_impl->unsubscribe(client);
}

References p_impl.

Referenced by MockWidgetForItem::~MockWidgetForItem(), gui2::LayerElementController::disconnectFormModel(), and MockWidgetForItem::setItem().

Friends And Related Function Documentation

SessionItem

friend class SessionItem

friend

Definition at line 50 of file itemmapper.h.

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<ItemMapperImpl> ModelView::ItemMapper::p_impl

private

Definition at line 54 of file itemmapper.h.

Referenced by ItemMapper(), callOnItemDestroy(), setActive(), setOnAboutToRemoveItem(), setOnChildPropertyChange(), setOnDataChange(), setOnItemDestroy(), setOnItemInserted(), setOnItemRemoved(), setOnPropertyChange(), and unsubscribe().

---

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

• /home/www/ba/mvvm/model/mvvm/signals/itemmapper.h
• /home/www/ba/mvvm/model/mvvm/signals/itemmapper.cpp