AlgorithmDialog.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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
 
/* Used to register classes into the factory. creates a global object in an
 * anonymous namespace. The object itself does nothing, but the comma operator
 * is used in the call to its constructor to effect a call to the factory's
 * subscribe method.
 */
 
#define DECLARE_DIALOG(classname)                                                                                      \
  namespace {                                                                                                          \
  Mantid::Kernel::RegistrationHelper register_dialog_##classname(                                                      \
      ((MantidQt::API::AlgorithmDialogFactory::Instance().subscribe<classname>(#classname)), 0));                      \
  }
 
//----------------------------------
// Includes
//----------------------------------
#include "AlgorithmDialogFactory.h"
#include "DllOption.h"
 
// Could have forward declared this but it makes it easier to use from
// inheriting classes if it is included here
#include "MantidAPI/AlgorithmObserver.h"
#include "MantidAPI/IAlgorithm.h"
 
#include <QDialog>
#include <QHash>
#include <QString>
#include <QTimer>
#include <QVBoxLayout>
 
//----------------------------------
// Qt Forward declarations
//----------------------------------
class QLabel;
class QLineEdit;
class QComboBox;
class QCheckBox;
class QPushButton;
class QHBoxLayout;
class QSignalMapper;
class QLayout;
 
//----------------------------------
// Mantid Forward declarations
//----------------------------------
namespace Mantid {
namespace Kernel {
class Property;
}
} // namespace Mantid
 
// Top-level namespace for this library
namespace MantidQt {
 
namespace API {
 
//----------------------------------
// Forward declarations
//----------------------------------
class InterfaceManager;
 
class EXPORT_OPT_MANTIDQT_COMMON AlgorithmDialog : public QDialog, Mantid::API::AlgorithmObserver {
 
  Q_OBJECT
 
public:
  AlgorithmDialog(QWidget *parent = nullptr);
  ~AlgorithmDialog() override;
 
  void setShowKeepOpen(const bool showOption);
 
  bool isShowKeepOpen() const;
 
  void initializeLayout();
 
  bool isInitialized() const;
 
protected:
  virtual void initLayout() = 0;
 
  virtual void parseInput();
 
  virtual void saveInput();
 
  // InterfaceManager needs to be able to reset the algorithm as I can't pass it
  // in use a
  // constructor
  friend class InterfaceManager;
 
  Mantid::API::IAlgorithm_sptr getAlgorithm() const;
 
  Mantid::Kernel::Property *getAlgorithmProperty(const QString &propName) const;
  bool requiresUserInput(const QString &propName) const;
 
  QString getInputValue(const QString &propName) const;
  QLabel *getValidatorMarker(const QString &propname);
 
  void storePropertyValue(const QString &name, const QString &value);
 
  void removePropertyValue(const QString &name);
 
  bool setPropertyValues(const QStringList &skipList = QStringList());
  bool setPropertyValue(const QString &pName, bool validateOthers);
 
  void showValidators();
 
  const QString &getOptionalMessage() const;
 
  void addOptionalMessage(QVBoxLayout *mainLay);
 
  bool isForScript() const;
 
  bool isMessageAvailable() const;
 
  bool isWidgetEnabled(const QString &propName) const;
 
  QWidget *tie(QWidget *widget, const QString &property, QLayout *parent_layout = nullptr, bool readHistory = true);
 
  void untie(const QString &property);
 
  QString openFileDialog(const QString &propName);
 
  QStringList openMultipleFileDialog(const QString &propName);
 
  void fillAndSetComboBox(const QString &propName, QComboBox *optionsBox) const;
 
  void fillLineEdit(const QString &propName, QLineEdit *field);
 
  QLayout *createDefaultButtonLayout(const QString &helpText = QString("?"), const QString &loadText = QString("Run"),
                                     const QString &cancelText = QString("Close"),
                                     const QString &keepOpenText = QString("Keep Open"));
 
  QPushButton *createHelpButton(const QString &helpText = QString("?")) const;
 
  void flagInputWS(QWidget *inputWidget);
 
  QString getValue(QWidget *widget);
 
signals:
  void algCompletedSignal();
 
  void closeEventCalled();
 
protected slots:
 
  void accept() override;
 
  void reject() override;
 
  virtual void helpClicked();
 
  virtual void keepOpenChanged(int state);
 
  virtual void algorithmCompleted();
 
  virtual void executeAlgorithmAsync();
  virtual void removeAlgorithmFromManager();
  void enableExitButton();
 
protected:
  void parse();
  bool requestedToKeepEnabled(const QString &propName) const;
  QString getPreviousValue(const QString &propName) const;
  void setPreviousValue(QWidget *widget, const QString &property);
  void finishHandle(const Mantid::API::IAlgorithm *alg) override;
  void errorHandle(const Mantid::API::IAlgorithm *alg, const std::string &what) override;
  void closeEvent(QCloseEvent *evt) override;
 
public:
  void setAlgorithm(const Mantid::API::IAlgorithm_sptr & /*alg*/);
  void setPresetValues(const QHash<QString, QString> &presetValues);
  void isForScript(bool forScript);
  void executeOnAccept(bool on);
  void setOptionalMessage(const QString &message);
  void addEnabledAndDisableLists(const QStringList &enabled, const QStringList &disabled);
  void addAlgorithmObserver(Mantid::API::AlgorithmObserver *observer);
 
protected:
  Mantid::API::IAlgorithm_sptr m_algorithm;
 
  QString m_algName;
  QStringList m_algProperties;
 
  QHash<QString, QString> m_propertyValueMap;
 
  QHash<QString, QWidget *> m_tied_properties;
 
  bool m_forScript;
  QStringList m_python_arguments;
  QStringList m_enabled;
  QStringList m_disabled;
  QString m_strMessage;
  bool m_keepOpen;
  bool m_msgAvailable;
 
  bool m_isInitialized;
  bool m_autoParseOnInit;
 
  QHash<QString, QLabel *> m_validators;
 
  QHash<QString, QString> m_errors;
 
  QStringList m_noValidation;
 
  QVector<QWidget *> m_inputws_opts;
 
  QVector<QLineEdit *> m_outputws_fields;
 
  QHash<QPushButton *, int> m_wsbtn_tracker;
 
  // the keep open checkbox control
  QCheckBox *m_keepOpenCheckBox;
 
  QPushButton *m_okButton, *m_exitButton;
 
  std::vector<Mantid::API::AlgorithmObserver *> m_observers;
 
  QTimer m_btnTimer;
  bool m_statusTracked;
};
} // namespace API
} // namespace MantidQt