SpecularDataCanvas Class Reference

Description

Definition at line 25 of file SpecularDataCanvas.h.

Inheritance diagram for SpecularDataCanvas:

Collaboration diagram for SpecularDataCanvas:

Public Slots
void	onMousePress (QMouseEvent *event)
void	onResetViewAction ()
void	onSavePlotAction ()

Public Member Functions
	SpecularDataCanvas (QWidget *parent=nullptr)
QList< QAction * >	actionList () override
SessionItem *	currentItem ()
const SessionItem *	currentItem () const
QCustomPlot *	customPlot ()
void	enableDeprecatedOnMousePress (bool b)
	Enable or disable the onMousePress() handler. For legacy reasons the onMousePress handler is enabled. It is deprecated because of: More...
void	initScatter ()
QSize	minimumSizeHint () const override
void	setItem (SessionItem *intensityItem) override
QSize	sizeHint () const override

Protected Member Functions
void	hideEvent (QHideEvent *) override
void	showEvent (QShowEvent *) override
virtual void	subscribeToItem ()
virtual void	unsubscribeFromItem ()

Private Member Functions
void	initActions ()
SpecularDataItem *	specularDataItem ()

Private Attributes
SessionItemController *	m_itemController
SpecularPlotCanvas *	m_plot_canvas
QAction *	m_reset_view_action
QAction *	m_save_plot_action

Constructor & Destructor Documentation

SpecularDataCanvas()

SpecularDataCanvas::SpecularDataCanvas ( QWidget *  parent = nullptr )

explicit

Definition at line 23 of file SpecularDataCanvas.cpp.

    : SessionItemWidget(parent)
    , m_plot_canvas(new SpecularPlotCanvas)
    , m_reset_view_action(nullptr)
    , m_save_plot_action(nullptr)
 
{
    auto* vlayout = new QVBoxLayout(this);
    vlayout->setSpacing(0);
    vlayout->setContentsMargins(0, 0, 0, 0);
    vlayout->addWidget(m_plot_canvas);
    setLayout(vlayout);
    setStyleSheet("background-color:white;");
 
    initActions();
 
    m_plot_canvas->setStatusLabelEnabled(true);
 
    enableDeprecatedOnMousePress(true); // true for legacy reasons
}

References enableDeprecatedOnMousePress(), initActions(), m_plot_canvas, and SpecularPlotCanvas::setStatusLabelEnabled().

Here is the call graph for this function:

Member Function Documentation

actionList()

QList< QAction * > SpecularDataCanvas::actionList ( )

overridevirtual

Reimplemented from SessionItemWidget.

Definition at line 60 of file SpecularDataCanvas.cpp.

{
    return QList<QAction*>() << m_reset_view_action << m_save_plot_action;
}

References m_reset_view_action, and m_save_plot_action.

Referenced by SpecularDataWidget::actionList().

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

customPlot()

QCustomPlot * SpecularDataCanvas::customPlot

(

)

Definition at line 65 of file SpecularDataCanvas.cpp.

{
    return m_plot_canvas->customPlot();
}

References SpecularPlotCanvas::customPlot(), and m_plot_canvas.

Here is the call graph for this function:

enableDeprecatedOnMousePress()

void SpecularDataCanvas::enableDeprecatedOnMousePress

(

bool

b

)

Enable or disable the onMousePress() handler. For legacy reasons the onMousePress handler is enabled. It is deprecated because of:

• mousepress is the wrong event to listen to for opening a context menu
• disables possibility to get context menu events for specific parts of the plot (e.g. context menu for axis configuration)

Definition at line 70 of file SpecularDataCanvas.cpp.

{
    if (b)
        connect(m_plot_canvas->customPlot(), &QCustomPlot::mousePress, this,
                &SpecularDataCanvas::onMousePress, Qt::UniqueConnection);
    else
        disconnect(m_plot_canvas->customPlot(), &QCustomPlot::mousePress, this,
                   &SpecularDataCanvas::onMousePress);
}

References SpecularPlotCanvas::customPlot(), m_plot_canvas, and onMousePress().

Referenced by SpecularDataCanvas().

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:

initActions()

void SpecularDataCanvas::initActions ( )

private

Definition at line 110 of file SpecularDataCanvas.cpp.

{
    m_reset_view_action = new QAction(this);
    m_reset_view_action->setText("Center view");
    m_reset_view_action->setIcon(QIcon(":/images/camera-metering-center.svg"));
    m_reset_view_action->setToolTip("Center view\n"
                                    "x,y axes range will be set to default");
    connect(m_reset_view_action, &QAction::triggered, this, &SpecularDataCanvas::onResetViewAction);
 
    m_save_plot_action = new QAction(this);
    m_save_plot_action->setText("Save");
    m_save_plot_action->setIcon(QIcon(":/images/content-save-outline.svg"));
    m_save_plot_action->setToolTip("Save plot");
    connect(m_save_plot_action, &QAction::triggered, this, &SpecularDataCanvas::onSavePlotAction);
}

References m_reset_view_action, m_save_plot_action, onResetViewAction(), and onSavePlotAction().

Referenced by SpecularDataCanvas().

Here is the call graph for this function:

initScatter()

void SpecularDataCanvas::initScatter

(

)

Definition at line 80 of file SpecularDataCanvas.cpp.

{
    m_plot_canvas->initScatter();
}

References SpecularPlotCanvas::initScatter(), and m_plot_canvas.

Referenced by SpecularDataWidget::setItem().

Here is the call graph for this function:

minimumSizeHint()

QSize SpecularDataCanvas::minimumSizeHint ( ) const

override

Definition at line 55 of file SpecularDataCanvas.cpp.

{
    return QSize(128, 128);
}

onMousePress

void SpecularDataCanvas::onMousePress ( QMouseEvent *  event )

slot

Definition at line 96 of file SpecularDataCanvas.cpp.

{
    if (event->button() == Qt::RightButton)
        emit customContextMenuRequested(event->globalPos());
}

Referenced by enableDeprecatedOnMousePress().

onResetViewAction

void SpecularDataCanvas::onResetViewAction ( )

slot

Definition at line 85 of file SpecularDataCanvas.cpp.

{
    specularDataItem()->resetView();
}

References SpecularDataItem::resetView(), and specularDataItem().

Referenced by initActions().

Here is the call graph for this function:

onSavePlotAction

void SpecularDataCanvas::onSavePlotAction ( )

slot

Definition at line 90 of file SpecularDataCanvas.cpp.

{
    QString dirname = gSessionData->projectDocument.value()->userExportDir();
    GUI::Plot::savePlot(dirname, m_plot_canvas->customPlot(), specularDataItem()->getDatafield());
}

References SpecularPlotCanvas::customPlot(), gSessionData, m_plot_canvas, SessionData::projectDocument, GUI::Plot::savePlot(), and specularDataItem().

Referenced by initActions().

Here is the call graph for this function:

setItem()

void SpecularDataCanvas::setItem ( SessionItem *  intensityItem )

overridevirtual

Reimplemented from SessionItemWidget.

Definition at line 44 of file SpecularDataCanvas.cpp.

{
    SessionItemWidget::setItem(intensityItem);
    m_plot_canvas->setItem(intensityItem);
}

References m_plot_canvas, SessionItemWidget::setItem(), and SpecularPlotCanvas::setItem().

Referenced by SpecularDataWidget::setItem().

Here is the call graph for this function:

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:

sizeHint()

QSize SpecularDataCanvas::sizeHint ( ) const

override

Definition at line 50 of file SpecularDataCanvas.cpp.

{
    return QSize(500, 400);
}

specularDataItem()

SpecularDataItem * SpecularDataCanvas::specularDataItem ( )

private

Definition at line 102 of file SpecularDataCanvas.cpp.

{
    auto* result = dynamic_cast<SpecularDataItem*>(currentItem());
    ASSERT(result);
    return result;
}

References SessionItemWidget::currentItem().

Referenced by onResetViewAction(), and onSavePlotAction().

Here is the call graph for this function:

subscribeToItem()

virtual void SessionItemWidget::subscribeToItem ( )

inlineprotectedvirtualinherited

Reimplemented in ProjectionsPlot, IntensityDataProjectionsWidget, ColorMap, SpecularPlot, Plot1D, FitFlowWidget, FitComparisonWidget1D, FitComparisonWidget, IntensityDataCanvas, RealDataMaskWidget, RunFitControlWidget, ParameterTuningWidget, FitParameterWidget, and ItemComboWidget.

Definition at line 43 of file SessionItemWidget.h.

{}

Referenced by SessionItemWidget::SessionItemWidget().

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_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_plot_canvas

SpecularPlotCanvas* SpecularDataCanvas::m_plot_canvas

private

Definition at line 56 of file SpecularDataCanvas.h.

Referenced by SpecularDataCanvas(), customPlot(), enableDeprecatedOnMousePress(), initScatter(), onSavePlotAction(), and setItem().

m_reset_view_action

QAction* SpecularDataCanvas::m_reset_view_action

private

Definition at line 57 of file SpecularDataCanvas.h.

Referenced by actionList(), and initActions().

m_save_plot_action

QAction* SpecularDataCanvas::m_save_plot_action

private

Definition at line 58 of file SpecularDataCanvas.h.

Referenced by actionList(), and initActions().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/PlotSpecular/SpecularDataCanvas.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/PlotSpecular/SpecularDataCanvas.cpp