AlgorithmSelectorWidget.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 "MantidAPI/AlgorithmFactory.h"
#include "MantidQtWidgets/Common/DllOption.h"
 
#include <QComboBox>
#include <QPoint>
#include <QString>
#include <QTreeWidget>
 
#include <Poco/NObserver.h>
#include <vector>
 
//------------------------------------------------------------------------------
// Forward declaration
//------------------------------------------------------------------------------
class QPushButton;
 
namespace Mantid {
namespace API {
struct Algorithm_descriptor;
}
} // namespace Mantid
namespace MantidQt {
namespace MantidWidgets {
 
class AlgorithmTreeWidget;
class FindAlgComboBox;
 
struct SelectedAlgorithm {
  QString name;
  int version;
  operator QString() { return name; }
  SelectedAlgorithm(const QString &nameIn, const int versionIn) : name(nameIn), version(versionIn) {};
};
 
//============================================================================
class EXPORT_OPT_MANTIDQT_COMMON AlgorithmSelectorWidget : public QWidget {
  Q_OBJECT
  Q_PROPERTY(bool showExecuteButton READ showExecuteButton WRITE showExecuteButton)
 
public:
  AlgorithmSelectorWidget(QWidget *parent);
  ~AlgorithmSelectorWidget() override;
 
  // delete copy operations - Poco::NObserver contains std::atomic which is not copyable
  AlgorithmSelectorWidget(const AlgorithmSelectorWidget &) = delete;
  AlgorithmSelectorWidget &operator=(const AlgorithmSelectorWidget &) = delete;
 
  SelectedAlgorithm getSelectedAlgorithm();
  void setSelectedAlgorithm(QString &algName);
  bool showExecuteButton() const;
  void showExecuteButton(const bool /*val*/);
 
public slots:
  void update();
  void executeSelected();
  void findAlgTextChanged(const QString &text);
  void treeSelectionChanged();
 
signals:
  void algorithmFactoryUpdateReceived();
  void executeAlgorithm(const QString & /*_t1*/, int /*_t2*/);
  void algorithmSelectionChanged(const QString & /*_t1*/, int /*_t2*/);
 
protected:
  AlgorithmTreeWidget *m_tree;
  FindAlgComboBox *m_findAlg;
  QPushButton *m_execButton;
 
private:
  void handleAlgorithmFactoryUpdate(Mantid::API::AlgorithmFactoryUpdateNotification_ptr /*unused*/);
  Poco::NObserver<AlgorithmSelectorWidget, Mantid::API::AlgorithmFactoryUpdateNotification> m_updateObserver;
  // Flag to indicate that we are updating
  bool m_updateInProgress;
};
 
//============================================================================
class AlgorithmTreeWidget : public QTreeWidget {
  Q_OBJECT
public:
  AlgorithmTreeWidget(QWidget *w) : QTreeWidget(w) {}
  ~AlgorithmTreeWidget() override = default;
  void mousePressEvent(QMouseEvent *e) override;
  void mouseMoveEvent(QMouseEvent *e) override;
  void mouseDoubleClickEvent(QMouseEvent *e) override;
  SelectedAlgorithm getSelectedAlgorithm();
 
public slots:
  void update();
 
signals:
  void executeAlgorithm(const QString & /*_t1*/, int /*_t2*/);
 
private:
  QPoint m_dragStartPosition;
};
 
//============================================================================
class FindAlgComboBox : public QComboBox {
  Q_OBJECT
public:
  ~FindAlgComboBox() override = default;
  SelectedAlgorithm getSelectedAlgorithm();
 
signals:
  void enterPressed();
 
public slots:
  void update();
 
protected:
  void keyPressEvent(QKeyEvent *e) override;
 
private:
  using AlgNamesType = std::vector<Mantid::API::AlgorithmDescriptor>;
  void addAliases(AlgNamesType &algNamesList);
  QString stripAlias(const QString &text) const;
};
 
} // namespace MantidWidgets
} // namespace MantidQt