RealDataPresenter Class Reference

Description

Presents imported data (RealDataItem) using stack of different widgets and combo box in the right top corner of ImportDataView, to switch between widgets.

Definition at line 26 of file RealDataPresenter.h.

Inheritance diagram for RealDataPresenter:

Collaboration diagram for RealDataPresenter:

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

Public Member Functions
	RealDataPresenter (QWidget *parent=nullptr)
QList< QAction * >	actionList () override
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
QStringList	activePresentationList (SessionItem *item) override
	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*()>

inherited

Definition at line 42 of file ItemComboWidget.h.

Constructor & Destructor Documentation

RealDataPresenter()

RealDataPresenter::RealDataPresenter ( QWidget *  parent = nullptr )

explicit

Definition at line 25 of file RealDataPresenter.cpp.

    : ItemComboWidget(parent)
{
    registerWidget("Heat Map", create_new<IntensityDataWidget>);
    registerWidget("Projections", create_new<IntensityDataProjectionsWidget>);
    registerWidget("Mask Editor", create_new<RealDataMaskWidget>);
    registerWidget("Reflectometry (Graph only)", create_new<SpecularDataWidget>);
    registerWidget("Reflectometry (Configuration)", create_new<SpecularDataImportWidget>);
}

References ItemComboWidget::registerWidget().

Here is the call graph for this function:

Member Function Documentation

actionList()

QList< QAction * > RealDataPresenter::actionList ( )

overridevirtual

Reimplemented from SessionItemWidget.

Definition at line 35 of file RealDataPresenter.cpp.

{
    return QList<QAction*>();
}

activePresentationList()

QStringList RealDataPresenter::activePresentationList ( SessionItem *  item )

overrideprotectedvirtual

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 from ItemComboWidget.

Definition at line 40 of file RealDataPresenter.cpp.

{
    auto* const realDataItem = dynamic_cast<RealDataItem*>(item);
    ASSERT(realDataItem);
 
    QStringList result;
    if (realDataItem->isIntensityData())
        result << "Heat Map"
               << "Projections"
               << "Mask Editor";
    else if (realDataItem->isSpecularData()) {
        if (realDataItem->dataLoader() != nullptr)
            result << "Reflectometry (Configuration)";
        result << "Reflectometry (Graph only)";
    } else
        throw Error("Error in RealDataPresenter::activePresentationList: unsupported data type");
    return result;
}

References Error.

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(), ItemComboWidget::setPresentation(), JobResultsPresenter::setPresentation(), SpecularDataImportWidget::specularDataItem(), SpecularDataCanvas::specularDataItem(), SpecularDataWidget::specularDataItem(), SpecularPlot::specularItem(), ItemComboWidget::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

protectedvirtualinherited

Presentation which should be shown for current item.

Reimplemented in JobResultsPresenter.

Definition at line 115 of file ItemComboWidget.cpp.

{
    return selectedPresentation();
}

References ItemComboWidget::selectedPresentation().

Referenced by ItemComboWidget::setItem(), and ItemComboWidget::subscribeToItem().

Here is the call graph for this function:

onComboChanged

void ItemComboWidget::onComboChanged ( const QString &  name )

privateslotinherited

Definition at line 134 of file ItemComboWidget.cpp.

{
    setPresentation(selectedPresentation());
}

References ItemComboWidget::selectedPresentation(), and ItemComboWidget::setPresentation().

Referenced by ItemComboWidget::ItemComboWidget().

Here is the call graph for this function:

presentationList()

QStringList ItemComboWidget::presentationList ( SessionItem *  item )

protectedvirtualinherited

Returns full list of presentations available for given item.

Reimplemented in JobResultsPresenter.

Definition at line 108 of file ItemComboWidget.cpp.

{
    return activePresentationList(item);
}

References ItemComboWidget::activePresentationList().

Referenced by ItemComboWidget::subscribeToItem().

Here is the call graph for this function:

registerWidget()

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

inherited

Definition at line 44 of file ItemComboWidget.cpp.

{
    m_widgetFactory.registerItem(presentationType, f);
}

References ItemComboWidget::m_widgetFactory.

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

selectedPresentation()

QString ItemComboWidget::selectedPresentation ( ) const

protectedinherited

Presentation selected in combo selector.

Definition at line 122 of file ItemComboWidget.cpp.

{
    return m_toolbar->currentPresentation();
}

References ItemComboToolbar::currentPresentation(), and ItemComboWidget::m_toolbar.

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

Here is the call graph for this function:

setItem()

void ItemComboWidget::setItem ( SessionItem *  item )

overridevirtualinherited

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 ItemComboWidget::itemPresentation(), ItemComboWidget::m_blankWidget, ItemComboWidget::m_stackedWidget, SessionItemWidget::setItem(), and ItemComboWidget::setToolbarVisible().

Referenced by JobResultsPresenter::setItem().

Here is the call graph for this function:

setPresentation()

void ItemComboWidget::setPresentation ( const QString &  presentationType )

virtualinherited

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(), ItemComboWidget::activePresentationList(), SessionItemWidget::currentItem(), ItemComboWidget::m_blankWidget, ItemComboWidget::m_presentationTypeToWidget, ItemComboWidget::m_stackedWidget, ItemComboWidget::m_toolbar, ItemComboWidget::m_widgetFactory, ItemComboToolbar::setActionList(), SessionItemWidget::setItem(), ItemComboToolbar::setPresentation(), ItemComboWidget::setSizeToCurrentWidget(), and ItemComboWidget::setToolbarVisible().

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

Here is the call graph for this function:

setSizeToCurrentWidget()

void ItemComboWidget::setSizeToCurrentWidget ( )

privateinherited

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 ItemComboWidget::m_stackedWidget.

Referenced by ItemComboWidget::setPresentation().

setToolbarVisible()

void ItemComboWidget::setToolbarVisible ( bool  value )

inherited

Definition at line 83 of file ItemComboWidget.cpp.

{
    m_toolbar->setVisible(value);
}

References ItemComboWidget::m_toolbar.

Referenced by ItemComboWidget::ItemComboWidget(), ItemComboWidget::setItem(), and ItemComboWidget::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 ( )

overrideprotectedvirtualinherited

Reimplemented from SessionItemWidget.

Definition at line 127 of file ItemComboWidget.cpp.

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

References ItemComboWidget::activePresentationList(), SessionItemWidget::currentItem(), ItemComboWidget::itemPresentation(), ItemComboWidget::m_toolbar, ItemComboWidget::presentationList(), ItemComboWidget::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

privateinherited

Definition at line 70 of file ItemComboWidget.h.

Referenced by ItemComboWidget::ItemComboWidget(), ItemComboWidget::setItem(), and ItemComboWidget::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

privateinherited

Definition at line 69 of file ItemComboWidget.h.

Referenced by ItemComboWidget::setPresentation().

m_stackedWidget

QStackedWidget* ItemComboWidget::m_stackedWidget

privateinherited

Definition at line 67 of file ItemComboWidget.h.

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

m_toolbar

ItemComboToolbar* ItemComboWidget::m_toolbar

privateinherited

Definition at line 66 of file ItemComboWidget.h.

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

m_widgetFactory

IFactory<QString, SessionItemWidget> ItemComboWidget::m_widgetFactory

privateinherited

Definition at line 68 of file ItemComboWidget.h.

Referenced by ItemComboWidget::registerWidget(), and ItemComboWidget::setPresentation().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Import/RealDataPresenter.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Import/RealDataPresenter.cpp