DetectorPresenter Class Reference

Contains stack of detector editors and the logic to show proper editor for certain type of detector item (SphericalDetectorEditor or RectangularDetectorEditor). More...

Inheritance diagram for DetectorPresenter:

Collaboration diagram for DetectorPresenter:

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

Public Member Functions
	DetectorPresenter (QWidget *parent=nullptr)
virtual QList< QAction * >	actionList ()
SessionItem *	currentItem ()
const SessionItem *	currentItem () const
void	registerWidget (const QString &presentationType, factory_function_t)
virtual void	setItem (SessionItem *item)
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. More...
virtual void	hideEvent (QHideEvent *)
QString	itemPresentation () const override
	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...
virtual void	showEvent (QShowEvent *)
void	subscribeToItem ()
virtual void	unsubscribeFromItem ()

Private Slots
void	onComboChanged (const QString &name)

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

Private Attributes
SessionItemController *	m_itemController
QMap< QString, SessionItemWidget * >	m_presentationTypeToWidget
QStackedWidget *	m_stackedWidget
ItemComboToolBar *	m_toolBar
IFactory< QString, SessionItemWidget >	m_widgetFactory

Detailed Description

Contains stack of detector editors and the logic to show proper editor for certain type of detector item (SphericalDetectorEditor or RectangularDetectorEditor).

Main component of GISASDetectorEditor.

Definition at line 24 of file DetectorPresenter.h.

Member Typedef Documentation

factory_function_t

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

inherited

Definition at line 39 of file ItemComboWidget.h.

Constructor & Destructor Documentation

DetectorPresenter()

DetectorPresenter::DetectorPresenter ( QWidget *  parent = nullptr )

explicit

Definition at line 26 of file DetectorPresenter.cpp.

                                                    : ItemComboWidget(parent)
{
    registerWidget(SphericalDetectorPresentation, create_new<SphericalDetectorEditor>);
    registerWidget(RectangularDetectorPresentation, create_new<RectangularDetectorEditor>);
    setToolBarVisible(false);
}

References ItemComboWidget::registerWidget(), and ItemComboWidget::setToolBarVisible().

Here is the call graph for this function:

Member Function Documentation

actionList()

QList< QAction * > SessionItemWidget::actionList ( )

virtualinherited

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

Definition at line 36 of file SessionItemWidget.cpp.

{
    return QList<QAction*>();
}

Referenced by ItemComboWidget::setPresentation().

activePresentationList()

QStringList DetectorPresenter::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 48 of file DetectorPresenter.cpp.

{
    Q_UNUSED(item);
    return QStringList() << SphericalDetectorPresentation << RectangularDetectorPresentation;
}

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 RectangularDetectorEditor::detectorItem(), SphericalDetectorEditor::detectorItem(), FitFlowWidget::fitSuiteItem(), DistributionEditor::groupItem(), DepthProbeInstrumentEditor::instrumentItem(), EnvironmentEditor::instrumentItem(), GISASBeamEditor::instrumentItem(), GISASDetectorEditor::instrumentItem(), GISASInstrumentEditor::instrumentItem(), OffSpecularBeamEditor::instrumentItem(), OffSpecularInstrumentEditor::instrumentItem(), PolarizationAnalysisEditor::instrumentItem(), SpecularBeamEditor::instrumentItem(), SpecularInstrumentEditor::instrumentItem(), RealDataMaskWidget::intensityDataItem(), IntensityDataCanvas::intensityDataItem(), IntensityDataProjectionsWidget::intensityDataItem(), IntensityDataWidget::intensityDataItem(), ProjectionsPlot::intensityItem(), ColorMap::intensityItem(), itemPresentation(), InstrumentPresenter::itemPresentation(), JobResultsPresenter::itemPresentation(), FitComparisonWidget::jobItem(), FitComparisonWidget1D::jobItem(), FitParameterWidget::jobItem(), RunFitControlWidget::jobItem(), JobPropertiesWidget::jobItem(), ParameterTuningWidget::jobItem(), SpecularDataImportWidget::realDataItem(), ItemComboWidget::setPresentation(), JobResultsPresenter::setPresentation(), SpecularDataCanvas::specularDataItem(), SpecularDataImportWidget::specularDataItem(), SpecularDataWidget::specularDataItem(), SpecularPlot::specularItem(), ItemComboWidget::subscribeToItem(), DistributionEditor::subscribeToItem(), GISASDetectorEditor::subscribeToItem(), PolarizationAnalysisEditor::subscribeToItem(), IntensityDataPropertyWidget::subscribeToItem(), JobPropertiesWidget::subscribeToItem(), ProjectionsPropertyPanel::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 *  )

protectedvirtualinherited

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 DetectorPresenter::itemPresentation ( ) const

overrideprotectedvirtual

Presentation which should be shown for current item.

Reimplemented from ItemComboWidget.

Definition at line 33 of file DetectorPresenter.cpp.

{
    if (!currentItem())
        return {};
 
    if (currentItem()->modelType() == "SphericalDetector")
        return SphericalDetectorPresentation;
    else if (currentItem()->modelType() == "RectangularDetector")
        return RectangularDetectorPresentation;
    else
        throw GUIHelpers::Error("DetectorPresenter::itemPresentation() -> Error. Wrong item "
                                "type '"
                                + currentItem()->modelType() + "'");
}

References SessionItemWidget::currentItem().

Here is the call graph for this function:

onComboChanged

void ItemComboWidget::onComboChanged ( const QString &  name )

privateslotinherited

Definition at line 119 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 93 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 43 of file ItemComboWidget.cpp.

{
    m_widgetFactory.registerItem(presentationType, f);
}

References ItemComboWidget::m_widgetFactory, and IFactory< Key, AbstractProduct >::registerItem().

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

Here is the call graph for this function:

selectedPresentation()

QString ItemComboWidget::selectedPresentation ( ) const

protectedinherited

Presentation selected in combo selector.

Definition at line 107 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 SessionItemWidget::setItem ( SessionItem *  item )

virtualinherited

Reimplemented in SpecularPlotCanvas, SpecularDataImportWidget, SpecularDataWidget, IntensityDataWidget, SpecularDataCanvas, ProjectionsWidget, IntensityDataCanvas, ColorMapCanvas, and Plot1DCanvas.

Definition at line 28 of file SessionItemWidget.cpp.

{
    m_itemController->setItem(item);
 
    if (isVisible())
        m_itemController->subscribe();
}

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

Referenced by IntensityDataWidget::onFFTAction(), JobSelectorWidget::onSelectionChanged(), ProjectionsEditor::resetContext(), ProjectionsEditor::setContext(), MaskGraphicsProxy::setIntensityItem(), FitSessionWidget::setItem(), Plot1DCanvas::setItem(), InstrumentEditorWidget::setItem(), ColorMapCanvas::setItem(), IntensityDataCanvas::setItem(), ProjectionsWidget::setItem(), SpecularDataCanvas::setItem(), DistributionDialog::setItem(), IntensityDataWidget::setItem(), SpecularDataWidget::setItem(), SpecularDataImportWidget::setItem(), SpecularPlotCanvas::setItem(), ItemComboWidget::setPresentation(), GISASInstrumentEditor::subscribeToItem(), OffSpecularInstrumentEditor::subscribeToItem(), SpecularInstrumentEditor::subscribeToItem(), FitComparisonWidget::subscribeToItem(), FitComparisonWidget1D::subscribeToItem(), and GISASDetectorEditor::updateDetectorPresenter().

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 (!activePresentationList(currentItem()).contains(presentationType))
        return;
 
    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(), ASSERT, IFactory< Key, AbstractProduct >::createItemPtr(), SessionItemWidget::currentItem(), ItemComboWidget::m_presentationTypeToWidget, ItemComboWidget::m_stackedWidget, ItemComboWidget::m_toolBar, ItemComboWidget::m_widgetFactory, ItemComboToolBar::setActionList(), SessionItemWidget::setItem(), ItemComboToolBar::setPresentation(), and ItemComboWidget::setSizeToCurrentWidget().

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 126 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 76 of file ItemComboWidget.cpp.

{
    m_toolBar->setVisible(value);
}

References ItemComboWidget::m_toolBar.

Referenced by DetectorPresenter(), and InstrumentPresenter::InstrumentPresenter().

showEvent()

void SessionItemWidget::showEvent ( QShowEvent *  )

protectedvirtualinherited

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

protectedvirtualinherited

Reimplemented from SessionItemWidget.

Definition at line 112 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 SpecularPlot, Plot1D, ColorMap, FitComparisonWidget1D, FitComparisonWidget, ProjectionsPropertyPanel, JobPropertiesWidget, ProjectionsPlot, IntensityDataPropertyWidget, IntensityDataProjectionsWidget, SphericalDetectorEditor, SpecularBeamEditor, RectangularDetectorEditor, PolarizationAnalysisEditor, OffSpecularBeamEditor, GISASDetectorEditor, GISASBeamEditor, EnvironmentEditor, DepthProbeInstrumentEditor, RealDataMaskWidget, RunFitControlWidget, and FitFlowWidget.

Definition at line 44 of file SessionItemWidget.h.

{}

Referenced by SessionItemWidget::SessionItemWidget().

Member Data Documentation

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 68 of file ItemComboWidget.h.

Referenced by ItemComboWidget::setPresentation().

m_stackedWidget

QStackedWidget* ItemComboWidget::m_stackedWidget

privateinherited

Definition at line 65 of file ItemComboWidget.h.

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

m_toolBar

ItemComboToolBar* ItemComboWidget::m_toolBar

privateinherited

Definition at line 64 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 67 of file ItemComboWidget.h.

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

---

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

• /home/www/ba/GUI/coregui/Views/InstrumentWidgets/DetectorPresenter.h
• /home/www/ba/GUI/coregui/Views/InstrumentWidgets/DetectorPresenter.cpp