Mantid
Loading...
Searching...
No Matches
Public Slots | Public Member Functions | Private Attributes | List of all members
MantidQt::MantidWidgets::AlgorithmProgressWidget Class Reference

#include <AlgorithmProgressWidget.h>

Inheritance diagram for MantidQt::MantidWidgets::AlgorithmProgressWidget:
MantidQt::MantidWidgets::IAlgorithmProgressWidget

Public Slots

void showDetailsDialog () override
 

Public Member Functions

void algorithmEnded () override
 Setup the view for whenever an algorithm has ended. More...
 
 AlgorithmProgressWidget (QWidget *parent=nullptr)
 
void algorithmStarted () override
 Setup the view for whenever an algorithm has started. More...
 
void blockUpdates (bool block=true)
 Enable or disable the processing of updates to the algorithm progress. More...
 
void updateProgress (const double progress, const QString &message, const double estimatedTime, const int progressPrecision) override
 Update the progress bar. More...
 
- Public Member Functions inherited from MantidQt::MantidWidgets::IAlgorithmProgressWidget
virtual void algorithmEnded ()=0
 
virtual void algorithmStarted ()=0
 
 IAlgorithmProgressWidget ()=default
 
virtual void showDetailsDialog ()=0
 
virtual void updateProgress (const double progress, const QString &message, const double estimatedTime, const int progressPrecision)=0
 
virtual ~IAlgorithmProgressWidget ()=default
 

Private Attributes

QPointer< AlgorithmProgressDialogWidgetm_details
 Pointer to the details dialog. More...
 
QPushButton *const m_detailsButton
 Button to display the Details window. More...
 
QHBoxLayout *const m_layout
 Layout that contains all the widget for displaying. More...
 
std::unique_ptr< AlgorithmProgressPresenterm_presenter
 The presenter of the ProgressWidget. More...
 
QProgressBar *const m_progressBar
 Progress bar shown on the workbench. More...
 

Detailed Description

Definition at line 37 of file AlgorithmProgressWidget.h.

Constructor & Destructor Documentation

◆ AlgorithmProgressWidget()

MantidQt::MantidWidgets::AlgorithmProgressWidget::AlgorithmProgressWidget ( QWidget *  parent = nullptr)

Member Function Documentation

◆ algorithmEnded()

void MantidQt::MantidWidgets::AlgorithmProgressWidget::algorithmEnded ( )
overridevirtual

Setup the view for whenever an algorithm has ended.

Implements MantidQt::MantidWidgets::IAlgorithmProgressWidget.

Definition at line 33 of file AlgorithmProgressWidget.cpp.

References m_progressBar.

◆ algorithmStarted()

void MantidQt::MantidWidgets::AlgorithmProgressWidget::algorithmStarted ( )
overridevirtual

Setup the view for whenever an algorithm has started.

Implements MantidQt::MantidWidgets::IAlgorithmProgressWidget.

Definition at line 28 of file AlgorithmProgressWidget.cpp.

References m_progressBar.

◆ blockUpdates()

void MantidQt::MantidWidgets::AlgorithmProgressWidget::blockUpdates ( bool  block = true)

Enable or disable the processing of updates to the algorithm progress.

Definition at line 60 of file AlgorithmProgressWidget.cpp.

References m_presenter.

◆ showDetailsDialog

void MantidQt::MantidWidgets::AlgorithmProgressWidget::showDetailsDialog ( )
overrideslot

Definition at line 38 of file AlgorithmProgressWidget.cpp.

References m_details, and m_presenter.

Referenced by AlgorithmProgressWidget().

◆ updateProgress()

void MantidQt::MantidWidgets::AlgorithmProgressWidget::updateProgress ( const double  progress,
const QString &  message,
const double  estimatedTime,
const int  progressPrecision 
)
overridevirtual

Update the progress bar.

Implements MantidQt::MantidWidgets::IAlgorithmProgressWidget.

Definition at line 55 of file AlgorithmProgressWidget.cpp.

References m_presenter, and m_progressBar.

Member Data Documentation

◆ m_details

QPointer<AlgorithmProgressDialogWidget> MantidQt::MantidWidgets::AlgorithmProgressWidget::m_details
private

Pointer to the details dialog.

Will be set to nullptr by QPointer when the dialog closes

Definition at line 66 of file AlgorithmProgressWidget.h.

Referenced by showDetailsDialog().

◆ m_detailsButton

QPushButton* const MantidQt::MantidWidgets::AlgorithmProgressWidget::m_detailsButton
private

Button to display the Details window.

Definition at line 63 of file AlgorithmProgressWidget.h.

Referenced by AlgorithmProgressWidget().

◆ m_layout

QHBoxLayout* const MantidQt::MantidWidgets::AlgorithmProgressWidget::m_layout
private

Layout that contains all the widget for displaying.

Definition at line 61 of file AlgorithmProgressWidget.h.

Referenced by AlgorithmProgressWidget().

◆ m_presenter

std::unique_ptr<AlgorithmProgressPresenter> MantidQt::MantidWidgets::AlgorithmProgressWidget::m_presenter
private

The presenter of the ProgressWidget.

Definition at line 68 of file AlgorithmProgressWidget.h.

Referenced by blockUpdates(), showDetailsDialog(), and updateProgress().

◆ m_progressBar

QProgressBar* const MantidQt::MantidWidgets::AlgorithmProgressWidget::m_progressBar
private

Progress bar shown on the workbench.

Definition at line 59 of file AlgorithmProgressWidget.h.

Referenced by algorithmEnded(), AlgorithmProgressWidget(), algorithmStarted(), and updateProgress().


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