AlgorithmProgressWidget.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2019 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 +
#include "MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressWidget.h"
#include "MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressDialogWidget.h"
#include "MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressPresenter.h"
 
#include <QProgressBar>
#include <QString>
 
namespace MantidQt::MantidWidgets {
 
AlgorithmProgressWidget::AlgorithmProgressWidget(QWidget *parent)
    : QWidget(parent), m_progressBar{new QProgressBar(this)}, m_layout{new QHBoxLayout(this)},
      m_detailsButton{new QPushButton("Details")},
      m_presenter{std::make_unique<AlgorithmProgressPresenter>(parent, this)} {
  m_progressBar->setAlignment(Qt::AlignHCenter);
  m_progressBar->setStyleSheet(R"(
    QProgressBar {
      text-align: center;
      border-radius: 3px;
    }
    QProgressBar::chunk {
      background-color: lightgreen;
      border-radius: 3px;
    }
    )");
  m_progressBar->setValue(0);
  m_progressBar->setFormat("Idle.");
  m_layout->addWidget(m_progressBar);
  m_layout->addWidget(m_detailsButton);
  this->setLayout(m_layout);
 
  connect(m_detailsButton, &QPushButton::clicked, this, &AlgorithmProgressWidget::showDetailsDialog);
}
 
void AlgorithmProgressWidget::algorithmStarted() {
  // remove the word idle as we are doing something now
  m_progressBar->setFormat("Running ...");
}
 
void AlgorithmProgressWidget::algorithmEnded() {
  m_progressBar->setValue(0);
  m_progressBar->setFormat("Idle.");
}
 
void AlgorithmProgressWidget::showDetailsDialog() {
  // If the dialog exist but is not visible, then just show it again
  if (m_details && !m_details->isVisible()) {
    m_details->show();
  } else if (!m_details) {
    // If the dialog does not exist we create it. The dialog has the attribute
    // DeleteOnClose so it will delete itself when the user closes it
    const auto parent = this->parentWidget();
    m_details = new AlgorithmProgressDialogWidget(parent, m_presenter->model());
    // the widget will be deleted when the closeEvent triggers, the
    // QPointer that is storing it will automatically set it to nullptr
    // when the widget deletes itself, so there will be no dangling pointer
    m_details->setAttribute(Qt::WA_DeleteOnClose);
    m_details->show();
  }
}
 
void AlgorithmProgressWidget::updateProgress(const double progress, const QString &message, const double estimatedTime,
                                             const int progressPrecision) {
  m_presenter->setProgressBar(m_progressBar, progress, message, estimatedTime, progressPrecision);
}
 
void AlgorithmProgressWidget::blockUpdates(bool block) { m_presenter->blockSignals(block); }
 
} // namespace MantidQt::MantidWidgets