ItemComboWidget Class Reference

Description

The ItemComboWidget class combines stack of widgets with QComboBox controller to switch between widgets. It is used in the case when one SessionItem can be presented with different widgets.

For example, in JobDatafieldWidget the results of the job can be presented with either IntensityDataWidget or FitDataWidget, depending from the JobView's activity type. For the presentation the special value of an empty string can be used which results in an empty widget being shown (with the toolbar hidden). In this case the current item can also be nullptr and this presentation needs not to be listed in the (active)PresentationList functions.

Definition at line 38 of file ItemComboWidget.h.

Inheritance diagram for ItemComboWidget:

Collaboration diagram for ItemComboWidget:

Public Types
using	factory_function_t = std::function< SessionItemWidget *()>

Public Member Functions
	ItemComboWidget (QWidget *parent=nullptr)
virtual QList< QAction * >	actionList ()
SessionItem *	currentItem ()
const SessionItem *	currentItem () const
void	registerWidget (const QString &presentationType, factory_function_t)
void	setItem (SessionItem *item) override
virtual void	setPresentation (const QString &presentationType)
	Sets stack to show widget corresponding to given presentation. More...
void	setToolbarVisible (bool value)

Protected Member Functions
virtual QStringList	activePresentationList (SessionItem *item)
	Returns list of active presentations for given item. Active presentation is the one which is present in QComboBox selector and can be selected. For example, if JobItem is fittable, the list will contain "FitComparisonWidgetName". More...
void	hideEvent (QHideEvent *) override
virtual QString	itemPresentation () const
	Presentation which should be shown for current item. More...
virtual QStringList	presentationList (SessionItem *item)
	Returns full list of presentations available for given item. More...
QString	selectedPresentation () const
	Presentation selected in combo selector. More...
void	showEvent (QShowEvent *) override
void	subscribeToItem () override
virtual void	unsubscribeFromItem ()

Private Slots
void	onComboChanged (const QString &name)

Private Member Functions
void	setSizeToCurrentWidget ()
	Resizes QStackedWidget to currently active page. More...

Private Attributes
QWidget *	m_blankWidget
SessionItemController *	m_itemController
QMap< QString, SessionItemWidget * >	m_presentationTypeToWidget
QStackedWidget *	m_stackedWidget
ItemComboToolbar *	m_toolbar
IFactory< QString, SessionItemWidget >	m_widgetFactory

Member Typedef Documentation

factory_function_t

using ItemComboWidget::factory_function_t = std::function<SessionItemWidget*()>

Definition at line 42 of file ItemComboWidget.h.

Constructor & Destructor Documentation

ItemComboWidget()

ItemComboWidget::ItemComboWidget ( QWidget *  parent = nullptr )

explicit

Definition at line 21 of file ItemComboWidget.cpp.

    : SessionItemWidget(parent)
    , m_toolbar(new ItemComboToolbar)
    , m_stackedWidget(new QStackedWidget)
{
    setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
    m_stackedWidget->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
    m_blankWidget = new QWidget;
    m_stackedWidget->addWidget(m_blankWidget);
 
    auto* layout = new QVBoxLayout;
    layout->setMargin(0);
    layout->setSpacing(0);
    layout->setContentsMargins(0, 0, 0, 0);
    layout->addWidget(m_toolbar);
    layout->addWidget(m_stackedWidget);
    setLayout(layout);
 
    connect(m_toolbar, &ItemComboToolbar::comboChanged, this, &ItemComboWidget::onComboChanged);
 
    setToolbarVisible(false);
}

References ItemComboToolbar::comboChanged(), m_blankWidget, m_stackedWidget, m_toolbar, onComboChanged(), and setToolbarVisible().

Here is the call graph for this function:

Member Function Documentation

actionList()

QList< QAction * > SessionItemWidget::actionList ( )

virtualinherited

Reimplemented in IntensityDataProjectionsWidget, SpecularDataWidget, SpecularDataCanvas, FitComparisonWidget1D, FitComparisonWidget, IntensityDataWidget, IntensityDataCanvas, SpecularDataImportWidget, RealDataPresenter, and RealDataMaskWidget.

Definition at line 36 of file SessionItemWidget.cpp.

{
    return QList<QAction*>();
}

Referenced by setPresentation().

activePresentationList()

QStringList ItemComboWidget::activePresentationList ( SessionItem *  item )

protectedvirtual

Returns list of active presentations for given item. Active presentation is the one which is present in QComboBox selector and can be selected. For example, if JobItem is fittable, the list will contain "FitComparisonWidgetName".

Reimplemented in JobResultsPresenter, and RealDataPresenter.

Definition at line 100 of file ItemComboWidget.cpp.

{
    Q_UNUSED(item);
    return QStringList();
}

Referenced by presentationList(), setPresentation(), and subscribeToItem().

currentItem() [1/2]

SessionItem * SessionItemWidget::currentItem ( )

inherited

Definition at line 41 of file SessionItemWidget.cpp.

{
    return const_cast<SessionItem*>(static_cast<const SessionItemWidget*>(this)->currentItem());
}

Referenced by FitFlowWidget::fitSuiteItem(), RealDataMaskWidget::intensityDataItem(), IntensityDataCanvas::intensityDataItem(), IntensityDataWidget::intensityDataItem(), IntensityDataProjectionsWidget::intensityDataItem(), ProjectionsPlot::intensityItem(), ColorMap::intensityItem(), JobResultsPresenter::itemPresentation(), FitParameterWidget::jobItem(), ParameterTuningWidget::jobItem(), RunFitControlWidget::jobItem(), FitComparisonWidget::jobItem(), FitComparisonWidget1D::jobItem(), IntensityDataPropertyWidget::jobItem(), SpecularDataPropertyWidget::jobItem(), SpecularDataImportWidget::realDataItem(), setPresentation(), JobResultsPresenter::setPresentation(), SpecularDataImportWidget::specularDataItem(), SpecularDataCanvas::specularDataItem(), SpecularDataWidget::specularDataItem(), SpecularPlot::specularItem(), subscribeToItem(), ProjectionsPlot::unsubscribeFromChildren(), and Plot1D::viewItem().

currentItem() [2/2]

const SessionItem * SessionItemWidget::currentItem ( ) const

inherited

Definition at line 46 of file SessionItemWidget.cpp.

{
    return m_itemController->currentItem();
}

References SessionItemController::currentItem(), and SessionItemWidget::m_itemController.

Here is the call graph for this function:

hideEvent()

void SessionItemWidget::hideEvent ( QHideEvent *  )

overrideprotectedinherited

Definition at line 56 of file SessionItemWidget.cpp.

{
    m_itemController->unsubscribe();
}

References SessionItemWidget::m_itemController, and SessionItemController::unsubscribe().

Here is the call graph for this function:

itemPresentation()

QString ItemComboWidget::itemPresentation ( ) const

protectedvirtual

Presentation which should be shown for current item.

Reimplemented in JobResultsPresenter.

Definition at line 115 of file ItemComboWidget.cpp.

{
    return selectedPresentation();
}

References selectedPresentation().

Referenced by setItem(), and subscribeToItem().

Here is the call graph for this function:

onComboChanged

void ItemComboWidget::onComboChanged ( const QString &  name )

privateslot

Definition at line 134 of file ItemComboWidget.cpp.

{
    setPresentation(selectedPresentation());
}

References selectedPresentation(), and setPresentation().

Referenced by ItemComboWidget().

Here is the call graph for this function:

presentationList()

QStringList ItemComboWidget::presentationList ( SessionItem *  item )

protectedvirtual

Returns full list of presentations available for given item.

Reimplemented in JobResultsPresenter.

Definition at line 108 of file ItemComboWidget.cpp.

{
    return activePresentationList(item);
}

References activePresentationList().

Referenced by subscribeToItem().

Here is the call graph for this function:

registerWidget()

void ItemComboWidget::registerWidget	(	const QString &	presentationType,
		factory_function_t	f
	)

Definition at line 44 of file ItemComboWidget.cpp.

{
    m_widgetFactory.registerItem(presentationType, f);
}

References m_widgetFactory.

Referenced by JobResultsPresenter::JobResultsPresenter(), and RealDataPresenter::RealDataPresenter().

selectedPresentation()

QString ItemComboWidget::selectedPresentation ( ) const

protected

Presentation selected in combo selector.

Definition at line 122 of file ItemComboWidget.cpp.

{
    return m_toolbar->currentPresentation();
}

References ItemComboToolbar::currentPresentation(), and m_toolbar.

Referenced by itemPresentation(), JobResultsPresenter::itemPresentation(), and onComboChanged().

Here is the call graph for this function:

setItem()

void ItemComboWidget::setItem ( SessionItem *  item )

overridevirtual

Reimplemented from SessionItemWidget.

Reimplemented in JobResultsPresenter.

Definition at line 88 of file ItemComboWidget.cpp.

{
    if (!item)
        m_stackedWidget->setCurrentWidget(m_blankWidget);
    SessionItemWidget::setItem(item);
    setToolbarVisible(item && !itemPresentation().isEmpty());
}

References itemPresentation(), m_blankWidget, m_stackedWidget, SessionItemWidget::setItem(), and setToolbarVisible().

Referenced by JobResultsPresenter::setItem().

Here is the call graph for this function:

setPresentation()

void ItemComboWidget::setPresentation ( const QString &  presentationType )

virtual

Sets stack to show widget corresponding to given presentation.

Reimplemented in JobResultsPresenter.

Definition at line 50 of file ItemComboWidget.cpp.

{
    if (presentationType.isEmpty()) {
        m_stackedWidget->setCurrentWidget(m_blankWidget);
        setToolbarVisible(false);
        return;
    }
 
    if (!activePresentationList(currentItem()).contains(presentationType))
        return;
 
    setToolbarVisible(true);
    m_toolbar->setPresentation(presentationType);
 
    ASSERT(currentItem());
 
    SessionItemWidget* widget = m_presentationTypeToWidget[presentationType];
 
    if (!widget) {
        widget = m_widgetFactory.createItemPtr(presentationType).release();
        m_stackedWidget->addWidget(widget);
        m_presentationTypeToWidget[presentationType] = widget;
    }
    ASSERT(widget);
    widget->setItem(currentItem());
    m_toolbar->setActionList(widget->actionList());
    m_stackedWidget->setCurrentWidget(widget);
    if (widget->isHidden())
        widget->show();
 
    setSizeToCurrentWidget();
}

References SessionItemWidget::actionList(), activePresentationList(), SessionItemWidget::currentItem(), m_blankWidget, m_presentationTypeToWidget, m_stackedWidget, m_toolbar, m_widgetFactory, ItemComboToolbar::setActionList(), SessionItemWidget::setItem(), ItemComboToolbar::setPresentation(), setSizeToCurrentWidget(), and setToolbarVisible().

Referenced by onComboChanged(), JobResultsPresenter::setPresentation(), and subscribeToItem().

Here is the call graph for this function:

setSizeToCurrentWidget()

void ItemComboWidget::setSizeToCurrentWidget ( )

private

Resizes QStackedWidget to currently active page.

Definition at line 141 of file ItemComboWidget.cpp.

{
    for (int i = 0; i < m_stackedWidget->count(); ++i) {
        // determine the vertical size policy
        QSizePolicy::Policy policy = QSizePolicy::Ignored;
        if (i == m_stackedWidget->currentIndex())
            policy = QSizePolicy::Expanding;
 
        // update the size policy
        auto* page = m_stackedWidget->widget(i);
        page->setSizePolicy(policy, policy);
    }
}

References m_stackedWidget.

Referenced by setPresentation().

setToolbarVisible()

void ItemComboWidget::setToolbarVisible

(

bool

value

)

Definition at line 83 of file ItemComboWidget.cpp.

{
    m_toolbar->setVisible(value);
}

References m_toolbar.

Referenced by ItemComboWidget(), setItem(), and setPresentation().

showEvent()

void SessionItemWidget::showEvent ( QShowEvent *  )

overrideprotectedinherited

Definition at line 51 of file SessionItemWidget.cpp.

{
    m_itemController->subscribe();
}

References SessionItemWidget::m_itemController, and SessionItemController::subscribe().

Here is the call graph for this function:

subscribeToItem()

void ItemComboWidget::subscribeToItem ( )

overrideprotectedvirtual

Reimplemented from SessionItemWidget.

Definition at line 127 of file ItemComboWidget.cpp.

{
    m_toolbar->setPresentationList(presentationList(currentItem()),
                                   activePresentationList(currentItem()));
    setPresentation(itemPresentation());
}

References activePresentationList(), SessionItemWidget::currentItem(), itemPresentation(), m_toolbar, presentationList(), setPresentation(), and ItemComboToolbar::setPresentationList().

Here is the call graph for this function:

unsubscribeFromItem()

virtual void SessionItemWidget::unsubscribeFromItem ( )

inlineprotectedvirtualinherited

Reimplemented in ProjectionsPlot, IntensityDataProjectionsWidget, ColorMap, SpecularPlot, Plot1D, FitFlowWidget, FitComparisonWidget1D, FitComparisonWidget, RealDataMaskWidget, and RunFitControlWidget.

Definition at line 44 of file SessionItemWidget.h.

{}

Referenced by SessionItemWidget::SessionItemWidget().

Member Data Documentation

m_blankWidget

QWidget* ItemComboWidget::m_blankWidget

private

Definition at line 70 of file ItemComboWidget.h.

Referenced by ItemComboWidget(), setItem(), and setPresentation().

m_itemController

SessionItemController* SessionItemWidget::m_itemController

privateinherited

Definition at line 49 of file SessionItemWidget.h.

Referenced by SessionItemWidget::SessionItemWidget(), SessionItemWidget::currentItem(), SessionItemWidget::hideEvent(), SessionItemWidget::setItem(), and SessionItemWidget::showEvent().

m_presentationTypeToWidget

QMap<QString, SessionItemWidget*> ItemComboWidget::m_presentationTypeToWidget

private

Definition at line 69 of file ItemComboWidget.h.

Referenced by setPresentation().

m_stackedWidget

QStackedWidget* ItemComboWidget::m_stackedWidget

private

Definition at line 67 of file ItemComboWidget.h.

Referenced by ItemComboWidget(), setItem(), setPresentation(), and setSizeToCurrentWidget().

m_toolbar

ItemComboToolbar* ItemComboWidget::m_toolbar

private

Definition at line 66 of file ItemComboWidget.h.

Referenced by ItemComboWidget(), selectedPresentation(), setPresentation(), setToolbarVisible(), and subscribeToItem().

m_widgetFactory

IFactory<QString, SessionItemWidget> ItemComboWidget::m_widgetFactory

private

Definition at line 68 of file ItemComboWidget.h.

Referenced by registerWidget(), and setPresentation().

---

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

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