AlgorithmProgressWidget.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
//----------------------------------
// Includes
//----------------------------------
#include "MantidAPI/AlgorithmObserver.h"
#include "MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressDialogWidget.h"
#include "MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressPresenter.h"
#include "MantidQtWidgets/Common/AlgorithmProgress/IAlgorithmProgressWidget.h"
#include "MantidQtWidgets/Common/DllOption.h"
 
#include <QHBoxLayout>
#include <QPointer>
#include <QPushButton>
#include <QWidget>
#include <memory>
 
class QProgressBar;
class QString;
 
namespace MantidQt {
namespace MantidWidgets {
 
class EXPORT_OPT_MANTIDQT_COMMON AlgorithmProgressWidget : public QWidget, public IAlgorithmProgressWidget {
  Q_OBJECT
public:
  AlgorithmProgressWidget(QWidget *parent = nullptr);
 
  void algorithmStarted() override;
  void algorithmEnded() override;
  void blockUpdates(bool block = true);
  void updateProgress(const double progress, const QString &message, const double estimatedTime,
                      const int progressPrecision) override;
 
public slots:
  void showDetailsDialog() override;
 
private:
  // Widgets are managed by Qt. This class owns them, and Qt will delete them on
  // close.
  QProgressBar *const m_progressBar;
  QHBoxLayout *const m_layout;
  QPushButton *const m_detailsButton;
  QPointer<AlgorithmProgressDialogWidget> m_details;
  std::unique_ptr<AlgorithmProgressPresenter> m_presenter;
};
 
} // namespace MantidWidgets
} // namespace MantidQt