BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
RealDataPresenter Class Reference

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

Inheritance diagram for RealDataPresenter:
[legend]
Collaboration diagram for RealDataPresenter:
[legend]

Public Types

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

Public Member Functions

 RealDataPresenter (QWidget *parent=nullptr)
 
QList< QAction * > actionList ()
 
SessionItemcurrentItem ()
 
const SessionItemcurrentItem () 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)
 Returns list of active presentations for given item. More...
 
virtual void hideEvent (QHideEvent *)
 
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...
 
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

SessionItemControllerm_itemController
 
QMap< QString, SessionItemWidget * > m_presentationTypeToWidget
 
QStackedWidget * m_stackedWidget
 
ItemComboToolBarm_toolBar
 
IFactory< QString, SessionItemWidgetm_widgetFactory
 

Detailed 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.

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

◆ RealDataPresenter()

RealDataPresenter::RealDataPresenter ( QWidget *  parent = nullptr)
explicit

Definition at line 25 of file RealDataPresenter.cpp.

25  : ItemComboWidget(parent)
26 {
27  registerWidget("Color Map", create_new<IntensityDataWidget>);
28  registerWidget("Projections", create_new<IntensityDataProjectionsWidget>);
29  registerWidget("Mask Editor", create_new<RealDataMaskWidget>);
30  registerWidget("Reflectometry (Graph only)", create_new<SpecularDataWidget>);
31  registerWidget("Reflectometry (Configuration)", create_new<SpecularDataImportWidget>);
32 }
ItemComboWidget(QWidget *parent=0)
void registerWidget(const QString &presentationType, factory_function_t)

References ItemComboWidget::registerWidget().

Here is the call graph for this function:

Member Function Documentation

◆ actionList()

QList< QAction * > RealDataPresenter::actionList ( )
virtual

Reimplemented from SessionItemWidget.

Definition at line 34 of file RealDataPresenter.cpp.

35 {
36  return QList<QAction*>();
37 }

◆ activePresentationList()

QStringList RealDataPresenter::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 from ItemComboWidget.

Definition at line 39 of file RealDataPresenter.cpp.

40 {
41  const auto realDataItem = dynamic_cast<RealDataItem*>(item);
42  ASSERT(realDataItem);
43 
44  QStringList result;
45  if (realDataItem->isIntensityData())
46  result << "Color Map"
47  << "Projections"
48  << "Mask Editor";
49  else if (realDataItem->isSpecularData()) {
50  if (realDataItem->dataLoader() != nullptr)
51  result << "Reflectometry (Configuration)";
52  result << "Reflectometry (Graph only)";
53  } else
54  throw GUIHelpers::Error(
55  "Error in RealDataPresenter::activePresentationList: unsupported data type");
56  return result;
57 }
#define ASSERT(condition)
Definition: Assert.h:31
The RealDataItem class represents intensity data imported from file and intended for fitting.
Definition: RealDataItem.h:35

References ASSERT.

◆ currentItem() [1/2]

SessionItem * SessionItemWidget::currentItem ( )
inherited

Definition at line 41 of file SessionItemWidget.cpp.

42 {
43  return const_cast<SessionItem*>(static_cast<const SessionItemWidget*>(this)->currentItem());
44 }
The SessionItemWidget class is a base for all widgets representing the content of SessionItem.
SessionItem * 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(), DetectorPresenter::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.

47 {
48  return m_itemController->currentItem();
49 }
SessionItemController * m_itemController

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.

57 {
59 }
void unsubscribe()
Fully unsubscribes the parent from listening item's signals.

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, InstrumentPresenter, and DetectorPresenter.

Definition at line 100 of file ItemComboWidget.cpp.

101 {
102  return selectedPresentation();
103 }
QString selectedPresentation() const
Presentation selected in combo selector.

References ItemComboWidget::selectedPresentation().

Referenced by ItemComboWidget::subscribeToItem().

Here is the call graph for this function:

◆ onComboChanged

void ItemComboWidget::onComboChanged ( const QString &  name)
privateslotinherited

Definition at line 119 of file ItemComboWidget.cpp.

120 {
122 }
virtual void setPresentation(const QString &presentationType)
Sets stack to show widget corresponding to given presentation.

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.

94 {
95  return activePresentationList(item);
96 }
virtual QStringList activePresentationList(SessionItem *item)
Returns list of active presentations for given 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.

44 {
45  m_widgetFactory.registerItem(presentationType, f);
46 }
bool registerItem(const Key &item_key, CreateItemCallback CreateFn)
Registers object's creation function.
Definition: IFactory.h:53
IFactory< QString, SessionItemWidget > m_widgetFactory

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

Referenced by DetectorPresenter::DetectorPresenter(), InstrumentPresenter::InstrumentPresenter(), JobResultsPresenter::JobResultsPresenter(), and 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.

108 {
109  return m_toolBar->currentPresentation();
110 }
QString currentPresentation() const
ItemComboToolBar * m_toolBar

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.

29 {
31 
32  if (isVisible())
34 }
void setItem(SessionItem *item)
void subscribe()
Subscribe parent to item's signals.

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.

51 {
52  if (!activePresentationList(currentItem()).contains(presentationType))
53  return;
54 
55  m_toolBar->setPresentation(presentationType);
56 
58 
59  SessionItemWidget* widget = m_presentationTypeToWidget[presentationType];
60 
61  if (!widget) {
62  widget = m_widgetFactory.createItemPtr(presentationType).release();
63  m_stackedWidget->addWidget(widget);
64  m_presentationTypeToWidget[presentationType] = widget;
65  }
66  ASSERT(widget);
67  widget->setItem(currentItem());
69  m_stackedWidget->setCurrentWidget(widget);
70  if (widget->isHidden())
71  widget->show();
72 
74 }
std::unique_ptr< AbstractProduct > createItemPtr(const Key &item_key) const
Definition: IFactory.h:46
void setActionList(const QList< QAction * > &actionList)
Sets external actions to tool bar (previous actions will be removed).
void setPresentation(const QString &name)
QMap< QString, SessionItemWidget * > m_presentationTypeToWidget
QStackedWidget * m_stackedWidget
void setSizeToCurrentWidget()
Resizes QStackedWidget to currently active page.
virtual QList< QAction * > actionList()
virtual void setItem(SessionItem *item)

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.

127 {
128  for (int i = 0; i < m_stackedWidget->count(); ++i) {
129  // determine the vertical size policy
130  QSizePolicy::Policy policy = QSizePolicy::Ignored;
131  if (i == m_stackedWidget->currentIndex())
132  policy = QSizePolicy::Expanding;
133 
134  // update the size policy
135  auto page = m_stackedWidget->widget(i);
136  page->setSizePolicy(policy, policy);
137  }
138 }

References ItemComboWidget::m_stackedWidget.

Referenced by ItemComboWidget::setPresentation().

◆ setToolBarVisible()

void ItemComboWidget::setToolBarVisible ( bool  value)
inherited

Definition at line 76 of file ItemComboWidget.cpp.

77 {
78  m_toolBar->setVisible(value);
79 }

References ItemComboWidget::m_toolBar.

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

◆ showEvent()

void SessionItemWidget::showEvent ( QShowEvent *  )
protectedvirtualinherited

Definition at line 51 of file SessionItemWidget.cpp.

52 {
54 }

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.

113 {
117 }
void setPresentationList(const QStringList &presentationList, const QStringList &activeList={})
virtual QStringList presentationList(SessionItem *item)
Returns full list of presentations available for given item.
virtual QString itemPresentation() const
Presentation which should be shown for current item.

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

Member Data Documentation

◆ m_itemController

◆ 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

◆ m_toolBar

◆ m_widgetFactory

IFactory<QString, SessionItemWidget> ItemComboWidget::m_widgetFactory
privateinherited

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