AlgorithmPropertiesWidget.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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
 
#include "DllOption.h"
#include "MantidAPI/IAlgorithm.h"
#include "MantidQtWidgets/Common/AlgorithmInputHistory.h"
#include "MantidQtWidgets/Common/PropertyWidget.h"
#include <QWidget>
 
class QGridLayout;
class QGroupBox;
class QScrollArea;
 
namespace Mantid {
namespace Kernel {
class Property;
}
} // namespace Mantid
 
namespace MantidQt {
namespace API {
class PropertyWidget;
 
class EXPORT_OPT_MANTIDQT_COMMON AlgorithmPropertiesWidget : public QWidget {
  Q_OBJECT
  Q_PROPERTY(QString algorithmName READ getAlgorithmName WRITE setAlgorithmName)
 
public:
  AlgorithmPropertiesWidget(QWidget *parent = nullptr);
  ~AlgorithmPropertiesWidget() override;
 
  void setInputHistory(MantidQt::API::AbstractAlgorithmInputHistory *inputHistory);
 
  void initLayout();
 
  Mantid::API::IAlgorithm_sptr getAlgorithm();
  void setAlgorithm(const Mantid::API::IAlgorithm_sptr &algo);
 
  const QString &getAlgorithmName() const;
  void setAlgorithmName(QString name);
 
  void addEnabledAndDisableLists(const QStringList &enabled, const QStringList &disabled);
 
  void shareErrorsMap(const QHash<QString, QString> &errors);
 
  void hideOrDisableProperties(const QString &changedPropName = "");
 
  void saveInput();
 
  QHash<QString, PropertyWidget *> m_propWidgets;
 
  QHash<QString, QGroupBox *> m_groupWidgets;
 
  QWidget *m_viewport;
 
  QScrollArea *m_scroll;
 
public slots:
  void propertyChanged(const QString &changedPropName);
 
  void replaceWSClicked(const QString &propName);
 
protected:
  // These methods are `protected` rather than `private` to facilitate unit testing:
  //   they should really not be used outside of this dialog class.
  // For the external methods, see `IPropertyManager::isPropertyEnabled` and
  // `IPropertyManager::isPropertyVisible`.
  bool isWidgetEnabled(const Mantid::Kernel::Property *prop) const;
 
  bool isWidgetVisible(const Mantid::Kernel::Property *prop) const;
 
private:
  bool hasInputWS(const std::vector<Mantid::Kernel::Property *> &prop_list) const;
 
  QString m_algoName;
 
  Mantid::API::IAlgorithm_sptr m_algo;
 
  QGridLayout *m_inputGrid;
 
  QGridLayout *m_currentGrid;
 
  // The current widget is no longer responsible for setting property values, so this map points
  // to the corresponding map from the parent dialog.
  QHash<QString, QString> const *m_errors;
 
  QStringList m_enabled;
 
  QStringList m_disabled;
 
  MantidQt::API::AbstractAlgorithmInputHistory *m_inputHistory;
};
 
} // namespace API
} // namespace MantidQt