DataSelector.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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 "ui_DataSelector.h"
 
#include "MantidAPI/AlgorithmRuntimeProps.h"
#include "MantidQtWidgets/Common/MantidWidget.h"
#include "MantidQtWidgets/Common/QtAlgorithmRunner.h"
 
#include <QWidget>
 
class QSettings;
 
namespace MantidQt {
namespace MantidWidgets {
 
using ButtonOpts = API::FileFinderWidget::ButtonOpts;
using LiveButtonOpts = API::FileFinderWidget::LiveButtonOpts;
 
class EXPORT_OPT_MANTIDQT_COMMON DataSelector : public API::MantidWidget {
  Q_OBJECT
 
  // These are properties of the file browser sub-widget
  Q_PROPERTY(QStringList fileBrowserSuffixes READ getFBSuffixes WRITE setFBSuffixes)
  Q_PROPERTY(bool showLoad READ willShowLoad WRITE setShowLoad)
  Q_PROPERTY(QString instrumentOverride READ getInstrumentOverride WRITE setInstrumentOverride)
  Q_PROPERTY(bool multipleFiles READ allowMultipleFiles WRITE allowMultipleFiles)
  Q_PROPERTY(bool findRunFiles READ isForRunFiles WRITE isForRunFiles)
  Q_PROPERTY(bool findDirectory READ isForDirectory WRITE isForDirectory)
  Q_PROPERTY(QString label READ getLabelText WRITE setLabelText)
  Q_PROPERTY(bool multiEntry READ doMultiEntry WRITE doMultiEntry)
  Q_PROPERTY(QString algorithmAndProperty READ getAlgorithmProperty WRITE setAlgorithmProperty)
  Q_PROPERTY(bool extsAsSingleOption READ extsAsSingleOption WRITE extsAsSingleOption)
  Q_PROPERTY(ButtonOpts buttonOpts READ doButtonOpt WRITE doButtonOpt)
  Q_PROPERTY(LiveButtonOpts liveButton READ liveButtonState WRITE liveButtonState)
  Q_ENUMS(ButtonOpts)
  Q_ENUMS(LiveButtonOpts)
 
  // These are properties of the workspace selector sub-widget
  Q_PROPERTY(QStringList workspaceSuffixes READ getWSSuffixes WRITE setWSSuffixes)
  Q_PROPERTY(QStringList WorkspaceTypes READ getWorkspaceTypes WRITE setWorkspaceTypes)
  Q_PROPERTY(bool ShowHidden READ showHiddenWorkspaces WRITE showHiddenWorkspaces)
  Q_PROPERTY(bool ShowGroups READ showWorkspaceGroups WRITE showWorkspaceGroups)
  Q_PROPERTY(QString Algorithm READ getValidatingAlgorithm WRITE setValidatingAlgorithm)
 
  // These are global properties of data selector
  Q_PROPERTY(bool optional READ isOptional WRITE isOptional)
  Q_PROPERTY(QString loadLabelText READ getLoadBtnText WRITE setLoadBtnText)
 
public:
  DataSelector(QWidget *parent = nullptr);
  ~DataSelector() override;
 
  QString getFullFilePath() const;
  QString getWsNameFromFiles() const;
  virtual QString getCurrentDataName(bool const autoLoad = true) const;
  void setSelectorIndex(int index);
  void setTypeSelectorVisible(bool visible);
  void setWorkspaceSelectorIndex(QString const &workspaceName);
  bool isFileSelectorVisible() const;
  bool isWorkspaceSelectorVisible() const;
  virtual bool isValid(bool const autoLoad = true);
  QString getProblem() const;
  [[nodiscard]] static API::FileFinderSettings readSettings(const QSettings &settings);
  void restoreSettings(const API::FileFinderSettings &settings);
  [[nodiscard]] API::FileFinderSettings captureSettings() const;
  void saveSettings(QSettings &settings, const API::FileFinderSettings &values) const;
  bool isOptional() const;
  void isOptional(bool /*optional*/);
  bool willShowLoad();
  void setShowLoad(bool load);
  QString getLoadBtnText() const;
  void setLoadBtnText(const QString & /*text*/);
  void setAlwaysLoadAsGroup(bool const loadAsGroup);
  void setLoadProperty(std::string const &propertyName, bool const value);
  void setLoadProperty(std::string const &propertyName, std::string const &value);
 
  // These are accessors/modifiers of the child FileFinderWidget
  bool allowMultipleFiles() const { return m_uiForm.rfFileInput->allowMultipleFiles(); }
 
  void allowMultipleFiles(const bool allow) { m_uiForm.rfFileInput->allowMultipleFiles(allow); }
 
  bool isForRunFiles() const { return m_uiForm.rfFileInput->isForRunFiles(); }
 
  void isForRunFiles(const bool mode) { m_uiForm.rfFileInput->isForRunFiles(mode); }
 
  bool isForDirectory() const { return m_uiForm.rfFileInput->isForDirectory(); }
 
  void isForDirectory(const bool mode) { m_uiForm.rfFileInput->isForDirectory(mode); }
 
  QString getLabelText() const { return m_uiForm.rfFileInput->getLabelText(); }
 
  void setLabelText(const QString &text) { m_uiForm.rfFileInput->setLabelText(text); }
 
  bool doMultiEntry() const { return m_uiForm.rfFileInput->doMultiEntry(); }
 
  void doMultiEntry(const bool multiEntry) { m_uiForm.rfFileInput->doMultiEntry(multiEntry); }
 
  QString getAlgorithmProperty() const { return m_uiForm.rfFileInput->getAlgorithmProperty(); }
 
  void setAlgorithmProperty(const QString &text) { m_uiForm.rfFileInput->setAlgorithmProperty(text); }
 
  bool extsAsSingleOption() const { return m_uiForm.rfFileInput->extsAsSingleOption(); }
 
  void extsAsSingleOption(const bool value) { m_uiForm.rfFileInput->extsAsSingleOption(value); }
 
  QStringList getFBSuffixes() { return m_uiForm.rfFileInput->getFileExtensions(); }
 
  void setFBSuffixes(const QStringList &suffixes) { m_uiForm.rfFileInput->setFileExtensions(suffixes); }
 
  QString getInstrumentOverride() { return m_uiForm.rfFileInput->getInstrumentOverride(); }
 
  void setInstrumentOverride(const QString &instName) { m_uiForm.rfFileInput->setInstrumentOverride(instName); }
 
  ButtonOpts doButtonOpt() const { return m_uiForm.rfFileInput->doButtonOpt(); }
 
  void doButtonOpt(const ButtonOpts buttonOpt) { m_uiForm.rfFileInput->doButtonOpt(buttonOpt); }
 
  LiveButtonOpts liveButtonState() const { return m_uiForm.rfFileInput->liveButtonState(); }
 
  void liveButtonState(const LiveButtonOpts option) { m_uiForm.rfFileInput->liveButtonState(option); }
 
  // These are accessors/modifiers of the child WorkspaceSelector
  QStringList getWSSuffixes() { return m_uiForm.wsWorkspaceInput->getSuffixes(); }
 
  void setWSSuffixes(const QStringList &suffixes) { m_uiForm.wsWorkspaceInput->setSuffixes(suffixes); }
 
  QStringList getWorkspaceTypes() const { return m_uiForm.wsWorkspaceInput->getWorkspaceTypes(); }
 
  void setWorkspaceTypes(const QStringList &types) { m_uiForm.wsWorkspaceInput->setWorkspaceTypes(types); }
 
  bool showHiddenWorkspaces() const { return m_uiForm.wsWorkspaceInput->showHiddenWorkspaces(); }
 
  void showHiddenWorkspaces(bool show) { m_uiForm.wsWorkspaceInput->showHiddenWorkspaces(show); }
 
  bool showWorkspaceGroups() const { return m_uiForm.wsWorkspaceInput->showWorkspaceGroups(); }
 
  void showWorkspaceGroups(bool show) { m_uiForm.wsWorkspaceInput->showWorkspaceGroups(show); }
 
  QString getValidatingAlgorithm() const { return m_uiForm.wsWorkspaceInput->getValidatingAlgorithm(); }
 
  void setValidatingAlgorithm(const QString &algName) { m_uiForm.wsWorkspaceInput->setValidatingAlgorithm(algName); }
 
signals:
  void filesFound();
  void fileViewVisible();
  void workspaceViewVisible();
  void dataReady(const QString &wsname);
  void loadClicked();
  void filesAutoLoaded();
 
protected:
  // Method for handling drop events
  void dropEvent(QDropEvent * /*unused*/) override;
  // called when a drag event enters the class
  void dragEnterEvent(QDragEnterEvent * /*unused*/) override;
 
private slots:
  void handleViewChanged(int index);
  void handleFileInput();
  void handleWorkspaceInput();
  void handleAutoLoadComplete(bool error);
 
private:
  void autoLoadFile(const QString &filenames);
  void executeLoadAlgorithm(std::string const &filename, std::string const &outputWorkspace);
  Ui::DataSelector m_uiForm;
  Mantid::API::AlgorithmRuntimeProps m_loadProperties;
  MantidQt::API::QtAlgorithmRunner m_algRunner;
  bool m_showLoad;
  bool m_isOptional;
  bool m_alwaysLoadAsGroup;
};
 
} /* namespace MantidWidgets */
} /* namespace MantidQt */