PropertyWidget.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 "MantidKernel/Property.h"
#include "MantidKernel/System.h"
 
#include <QGridLayout>
#include <QLabel>
#include <QMap>
#include <QPushButton>
#include <QString>
#include <QWidget>
 
#include "DllOption.h"
 
class QLineEdit;
 
namespace MantidQt {
namespace API {
class ClickableLabel : public QLabel {
  Q_OBJECT
 
public:
  ClickableLabel(QWidget *parent);
  ~ClickableLabel() override;
 
signals:
  void clicked();
 
protected:
  void mousePressEvent(QMouseEvent *event) override;
};
 
class EXPORT_OPT_MANTIDQT_COMMON PropertyWidget : public QWidget {
  Q_OBJECT
 
public:
  static void setFieldPlaceholderText(Mantid::Kernel::Property *prop, QLineEdit *field);
 
  enum Info { INVALID, REPLACE, RESTORE };
 
  PropertyWidget(Mantid::Kernel::Property *prop, QWidget *parent = nullptr, QGridLayout *layout = nullptr,
                 int row = -1);
  ~PropertyWidget() override;
 
  bool inGrid() const;
 
  virtual QString getValue() const = 0;
 
  void setValue(const QString &value);
  void setPreviousValue(const QString &previousValue);
  void setPrevious_isDynamicDefault(bool flag);
 
  void transferHistoryState(const PropertyWidget *other, const PropertyWidget *upstream = nullptr);
 
  virtual QWidget *getMainWidget() = 0;
 
  void setEnabled(bool val);
  void setVisible(bool val) override;
 
  QGridLayout *getGridLayout() { return m_gridLayout; }
 
  int getGridRow() { return m_row; }
 
  void addReplaceWSButton();
 
  const Mantid::Kernel::Property *getProperty() const { return m_prop; }
  Mantid::Kernel::Property *getProperty() { return m_prop; }
 
  void setError(const QString &error);
 
private:
  virtual void setValueImpl(const QString &value) = 0;
 
public slots:
  void updateIconVisibility(const QString &error = "");
 
  void replaceWSButtonClicked();
 
  void valueChangedSlot();
 
  void userEditedProperty();
 
  void toggleUseHistory();
 
private:
  void setUseHistoryIcon(bool useHistory, bool isDynamicDefault);
 
signals:
  void valueChanged(const QString &propName);
 
  void replaceWorkspaceName(const QString &propName);
 
  void userChangedProperty();
 
protected:
  static void setLabelFont(Mantid::Kernel::Property *prop, QWidget *label);
 
  Mantid::Kernel::Property *m_prop;
 
  QGridLayout *m_gridLayout;
 
  QWidget *m_parent;
 
  int m_row;
 
  QString m_doc;
 
  QPushButton *m_replaceWSButton;
 
  QVector<QWidget *> m_widgets;
 
  QString m_lastValue;
 
  QString m_error;
 
  bool m_isOutputWsProp;
 
  QString m_previousValue;
 
  bool m_previous_isDynamicDefault;
 
  QString m_enteredValue;
 
  bool m_entered_isDynamicDefault;
 
  QMap<Info, ClickableLabel *> m_icons;
 
  bool m_useHistory;
};
 
} // namespace API
} // namespace MantidQt