GenericDialog.cpp

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 +
//----------------------------------
// Includes
//----------------------------------
#include "MantidQtWidgets/Common/GenericDialog.h"
#include "MantidQtWidgets/Common/AlgorithmInputHistory.h"
 
#include "MantidAPI/FileProperty.h"
#include "MantidAPI/IWorkspaceProperty.h"
#include "MantidKernel/MaskedProperty.h"
#include "MantidKernel/PropertyWithValue.h"
 
#include <QApplication>
#include <QCheckBox>
#include <QComboBox>
#include <QDesktopWidget>
#include <QDir>
#include <QFileInfo>
#include <QGridLayout>
#include <QGroupBox>
#include <QHBoxLayout>
#include <QLabel>
#include <QLineEdit>
#include <QMessageBox>
#include <QPalette>
#include <QPushButton>
#include <QScrollArea>
#include <QSignalMapper>
#include <QVBoxLayout>
 
#include "MantidQtWidgets/Common/AlgorithmPropertiesWidget.h"
#include "MantidQtWidgets/Common/PropertyWidget.h"
#include "MantidQtWidgets/Common/PropertyWidgetFactory.h"
#include <climits>
 
// Dialog stuff is defined here
using namespace MantidQt::API;
using namespace Mantid::Kernel;
using namespace Mantid::API;
 
//----------------------------------
// Public member functions
//----------------------------------
GenericDialog::GenericDialog(QWidget *parent) : AlgorithmDialog(parent), m_algoPropertiesWidget(nullptr) {}
 
GenericDialog::~GenericDialog() = default;
 
//----------------------------------
// Protected member functions
//----------------------------------
void GenericDialog::initLayout() {
 
  // Add a layout for QDialog
  auto *dialog_layout = new QVBoxLayout();
  setLayout(dialog_layout);
  // Add the helpful summary message
  if (isMessageAvailable())
    this->addOptionalMessage(dialog_layout);
 
  // Make the widget with all the properties
  m_algoPropertiesWidget = new AlgorithmPropertiesWidget(this);
  dialog_layout->addWidget(m_algoPropertiesWidget, 1);
  m_algoPropertiesWidget->setAlgorithm(this->getAlgorithm());
 
  // Create and add the OK/Cancel/Help. buttons
  dialog_layout->addLayout(this->createDefaultButtonLayout(), 0);
 
  // Mark the properties that will be forced enabled or disabled
  QStringList enabled = m_enabled;
  QStringList disabled = m_disabled;
  // Disable any python arguments
  disabled += m_python_arguments;
  m_algoPropertiesWidget->addEnabledAndDisableLists(enabled, disabled);
 
  // Share the errors map with the parent dialog
  m_algoPropertiesWidget->shareErrorsMap(m_errors);
 
  // At this point, all the widgets have been added and are visible.
  // This makes sure the viewport does not get scaled smaller, even if some
  // controls are hidden.
  QWidget *viewport = m_algoPropertiesWidget->m_viewport;
  // QScrollArea * scroll = m_algoPropertiesWidget->m_scroll;
  viewport->layout()->update();
  // This makes the layout minimum size = that of the widgets inside
  viewport->layout()->setSizeConstraint(QLayout::SetMinimumSize);
 
  QCoreApplication::processEvents();
 
  int screenHeight = QApplication::desktop()->height();
  int dialogHeight = viewport->sizeHint().height();
 
  // If the thing won't end up too big compared to the screen height,
  // resize the scroll area so we don't get a scroll bar
  if ((dialogHeight + 100) < 0.8 * screenHeight) {
    m_algoPropertiesWidget->m_scroll->setMinimumHeight(dialogHeight + 10);
 
    // Find the size that the dialog WANTS to be.
    dialogHeight = this->sizeHint().height();
 
    // Choose a width given the desired size, but limit it
    int dialogWidth = this->sizeHint().width() + 25;
    if (dialogWidth > 640)
      dialogWidth = 640;
 
    // But allow the scroll area to resize smaller again
    m_algoPropertiesWidget->m_scroll->setMinimumHeight(60);
    // But resize the dialog again to its preferred size.
    this->resize(dialogWidth, dialogHeight);
  }
 
  // Set all previous values (from history, etc.)
  for (auto it = m_algoPropertiesWidget->m_propWidgets.begin(); it != m_algoPropertiesWidget->m_propWidgets.end();
       it++) {
    this->setPreviousValue(it.value(), it.key());
  }
 
  // Using the default values, hide or disable the dynamically shown properties
  m_algoPropertiesWidget->hideOrDisableProperties();
}
 
//-----------------------------------------------------------------------------
void GenericDialog::parseInput() {
  auto itr = m_algoPropertiesWidget->m_propWidgets.begin();
  for (; itr != m_algoPropertiesWidget->m_propWidgets.end(); itr++) {
    // Get the value from each widget and store it
    storePropertyValue(itr.key(), itr.value()->getValue());
  }
}
 
//-----------------------------------------------------------------------------
void GenericDialog::accept() {
  // Get property values
  parse();
 
  // Try and set and validate the properties and
  if (setPropertyValues()) {
    // Store input for next time
    saveInput();
    if (!this->m_keepOpen) {
      QDialog::accept();
    } else {
      executeAlgorithmAsync();
    }
  } else {
    // Highlight the validators that are in error (combined from them + whole
    // algorithm)
    // If we get to this clause, there are errors
    for (auto it = m_errors.begin(); it != m_errors.end(); it++) {
      // if this assert is encountered, the property and validator keys may not
      // match (check case)
      assert(m_algoPropertiesWidget->m_propWidgets[it.key()]);
      m_algoPropertiesWidget->m_propWidgets[it.key()]->updateIconVisibility(it.value());
    }
    QMessageBox::critical(this, "",
                          "One or more properties are invalid. The invalid properties are\n"
                          "marked with a *, hold your mouse over the * for more information.");
  }
}