ItemStackPresenter< T > Class Template Reference

Description

template<class T>
class ItemStackPresenter< T >

The ItemStackPresenter templated class extends ItemStackWidget so it could operate with SesionItem editor's of specified type, while still keeping signal/slots alive.

Definition at line 29 of file ItemStackPresenter.h.

Inheritance diagram for ItemStackPresenter< T >:

Collaboration diagram for ItemStackPresenter< T >:

Public Slots
virtual void	onModelAboutToBeReset ()
virtual void	onRowsAboutToBeRemoved (const QModelIndex &parent, int first, int)

Public Member Functions
	ItemStackPresenter (bool single_widget=false)
T *	currentWidget ()
void	hideWidgets ()
T *	itemWidget (SessionItem *item)
QSize	minimumSizeHint () const override
template<class U >
void	setItem (U *item, bool *isNew=nullptr)
	Shows the widget for given item (and hides previous one). If no widget yet exists, it will be created (flag isNew will become 'true' in this case). More...
void	setModel (SessionModel *model)
void	setSizeHint (const QSize &size_hint)
QSize	sizeHint () const override

Protected Member Functions
void	connectModel ()
void	disconnectModel ()
void	removeWidgetForItem (SessionItem *item) override
void	removeWidgets () override
void	validateItem (SessionItem *item)
	Checks if model was set correctly. More...

Protected Attributes
SessionModel *	m_model
QSize	m_size_hint
class QStackedWidget *	m_stackedWidget

Private Attributes
QMap< SessionItem *, T * >	m_itemToWidget
bool	m_single_widget
	Different items will be served by same widget. More...

Constructor & Destructor Documentation

ItemStackPresenter()

template<class T >

ItemStackPresenter< T >::ItemStackPresenter ( bool  single_widget = false )

inline

Definition at line 31 of file ItemStackPresenter.h.

        : m_single_widget(single_widget)
    {
    }

Member Function Documentation

connectModel()

void ItemStackWidget::connectModel ( )

protectedinherited

Definition at line 74 of file ItemStackWidget.cpp.

{
    if (!m_model)
        return;
 
    connect(m_model, &SessionModel::modelAboutToBeReset, this,
            &ItemStackWidget::onModelAboutToBeReset, Qt::UniqueConnection);
 
    connect(m_model, &SessionModel::rowsAboutToBeRemoved, this,
            &ItemStackWidget::onRowsAboutToBeRemoved, Qt::UniqueConnection);
}

References ItemStackWidget::m_model, ItemStackWidget::onModelAboutToBeReset(), and ItemStackWidget::onRowsAboutToBeRemoved().

Referenced by ItemStackWidget::setModel().

Here is the call graph for this function:

currentWidget()

template<class T >

T * ItemStackPresenter< T >::currentWidget

Definition at line 86 of file ItemStackPresenter.h.

{
    return dynamic_cast<T*>(m_stackedWidget->currentWidget());
}

disconnectModel()

void ItemStackWidget::disconnectModel ( )

protectedinherited

Definition at line 86 of file ItemStackWidget.cpp.

{
    if (!m_model)
        return;
 
    disconnect(m_model, &SessionModel::modelAboutToBeReset, this,
               &ItemStackWidget::onModelAboutToBeReset);
 
    disconnect(m_model, &SessionModel::rowsAboutToBeRemoved, this,
               &ItemStackWidget::onRowsAboutToBeRemoved);
}

References ItemStackWidget::m_model, ItemStackWidget::onModelAboutToBeReset(), and ItemStackWidget::onRowsAboutToBeRemoved().

Referenced by ItemStackWidget::setModel().

Here is the call graph for this function:

hideWidgets()

template<class T >

void ItemStackPresenter< T >::hideWidgets

Definition at line 105 of file ItemStackPresenter.h.

{
    if (m_stackedWidget->currentWidget())
        m_stackedWidget->currentWidget()->hide();
}

Referenced by JobRealTimeWidget::setItem().

itemWidget()

template<class T >

T * ItemStackPresenter< T >::itemWidget

(

SessionItem *

item

)

Definition at line 92 of file ItemStackPresenter.h.

{
    if (m_single_widget) {
        if (!m_itemToWidget.empty())
            return m_itemToWidget.first();
    } else {
        return m_itemToWidget[item];
    }
 
    return nullptr;
}

Referenced by JobRealTimeWidget::parameterTuningWidget().

minimumSizeHint()

QSize ItemStackWidget::minimumSizeHint ( ) const

overrideinherited

Definition at line 53 of file ItemStackWidget.cpp.

{
    return QSize(25, 25);
}

onModelAboutToBeReset

void ItemStackWidget::onModelAboutToBeReset ( )

virtualslotinherited

Definition at line 63 of file ItemStackWidget.cpp.

{
    removeWidgets();
}

References ItemStackWidget::removeWidgets().

Referenced by ItemStackWidget::connectModel(), and ItemStackWidget::disconnectModel().

Here is the call graph for this function:

onRowsAboutToBeRemoved

void ItemStackWidget::onRowsAboutToBeRemoved ( const QModelIndex &  parent, int  first, int    )

virtualslotinherited

Definition at line 68 of file ItemStackWidget.cpp.

{
    SessionItem* item = m_model->itemForIndex(m_model->index(first, 0, parent));
    removeWidgetForItem(item);
}

References SessionModel::index(), SessionModel::itemForIndex(), ItemStackWidget::m_model, and ItemStackWidget::removeWidgetForItem().

Referenced by ItemStackWidget::connectModel(), and ItemStackWidget::disconnectModel().

Here is the call graph for this function:

removeWidgetForItem()

template<class T >

void ItemStackPresenter< T >::removeWidgetForItem ( SessionItem *  item )

overrideprotectedvirtual

Implements ItemStackWidget.

Definition at line 112 of file ItemStackPresenter.h.

{
    ASSERT(item);
 
    if (m_single_widget)
        return;
 
    T* widget = m_itemToWidget[item];
    if (!widget)
        return;
 
    typename QMap<SessionItem*, T*>::iterator it = m_itemToWidget.begin();
    while (it != m_itemToWidget.end()) {
        if (it.value() == widget)
            it = m_itemToWidget.erase(it);
        else
            ++it;
    }
 
    m_stackedWidget->removeWidget(widget);
    delete widget;
}

removeWidgets()

template<class T >

void ItemStackPresenter< T >::removeWidgets

overrideprotectedvirtual

Implements ItemStackWidget.

Definition at line 136 of file ItemStackPresenter.h.

{
    typename QMap<SessionItem*, T*>::iterator it = m_itemToWidget.begin();
    while (it != m_itemToWidget.end()) {
        m_stackedWidget->removeWidget(it.value());
        delete it.value();
        ++it;
    }
    m_itemToWidget.clear();
}

setItem()

template<class T >

template<class U >

void ItemStackPresenter< T >::setItem	(	U *	item,
		bool *	isNew = nullptr
	)

Shows the widget for given item (and hides previous one). If no widget yet exists, it will be created (flag isNew will become 'true' in this case).

Definition at line 56 of file ItemStackPresenter.h.

{
    validateItem(item);
 
    if (isNew)
        *isNew = false;
 
    if (!item) {
        hideWidgets();
        return;
    }
 
    T* widget = itemWidget(item);
 
    if (!widget) {
        widget = new T();
        if (isNew)
            *isNew = true;
        m_stackedWidget->addWidget(widget);
        m_itemToWidget[item] = widget;
    }
 
    m_stackedWidget->setCurrentWidget(widget);
    if (widget->isHidden())
        widget->show();
 
    widget->setItem(item);
}

Referenced by ImportDataView::onSelectionChanged(), and JobRealTimeWidget::setItem().

setModel()

void ItemStackWidget::setModel ( SessionModel *  model )

inherited

Definition at line 38 of file ItemStackWidget.cpp.

{
    if (model == m_model)
        return;
 
    disconnectModel();
    m_model = model;
    connectModel();
}

References ItemStackWidget::connectModel(), ItemStackWidget::disconnectModel(), and ItemStackWidget::m_model.

Referenced by ImportDataView::ImportDataView(), JobRealTimeWidget::JobRealTimeWidget(), and ItemStackWidget::validateItem().

Here is the call graph for this function:

setSizeHint()

void ItemStackWidget::setSizeHint ( const QSize &  size_hint )

inherited

Definition at line 58 of file ItemStackWidget.cpp.

{
    m_size_hint = size_hint;
}

References ItemStackWidget::m_size_hint.

Referenced by ImportDataView::ImportDataView().

sizeHint()

QSize ItemStackWidget::sizeHint ( ) const

overrideinherited

Definition at line 48 of file ItemStackWidget.cpp.

{
    return m_size_hint;
}

References ItemStackWidget::m_size_hint.

validateItem()

void ItemStackWidget::validateItem ( SessionItem *  item )

protectedinherited

Checks if model was set correctly.

Definition at line 100 of file ItemStackWidget.cpp.

{
    if (!item)
        return;
 
    if (m_model) {
        if (m_model != item->model())
            // in principle it should be possible, but should be tested
            throw Error("ItemStackWidget::validateItem() -> Error. "
                        "Attempt to use items from different models.");
    } else {
        setModel(item->model());
    }
}

References Error, ItemStackWidget::m_model, SessionItem::model(), and ItemStackWidget::setModel().

Here is the call graph for this function:

Member Data Documentation

m_itemToWidget

template<class T >

QMap<SessionItem*, T*> ItemStackPresenter< T >::m_itemToWidget

private

Definition at line 50 of file ItemStackPresenter.h.

m_model

SessionModel* ItemStackWidget::m_model

protectedinherited

Definition at line 55 of file ItemStackWidget.h.

Referenced by ItemStackWidget::connectModel(), ItemStackWidget::disconnectModel(), ItemStackWidget::onRowsAboutToBeRemoved(), ItemStackWidget::setModel(), and ItemStackWidget::validateItem().

m_single_widget

template<class T >

bool ItemStackPresenter< T >::m_single_widget

private

Different items will be served by same widget.

Definition at line 51 of file ItemStackPresenter.h.

m_size_hint

QSize ItemStackWidget::m_size_hint

protectedinherited

Definition at line 56 of file ItemStackWidget.h.

Referenced by ItemStackWidget::setSizeHint(), and ItemStackWidget::sizeHint().

m_stackedWidget

class QStackedWidget* ItemStackWidget::m_stackedWidget

protectedinherited

Definition at line 54 of file ItemStackWidget.h.

Referenced by ItemStackWidget::ItemStackWidget().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Common/ItemStackPresenter.h