FileFinderWidget.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
 
#include "MantidQtWidgets/Common/DllOption.h"
#include "MantidQtWidgets/Common/FindFilesThreadPoolManager.h"
#include "MantidQtWidgets/Common/MantidWidget.h"
#include "ui_FileFinderWidget.h"
#include <QComboBox>
#include <QFileDialog>
#include <QMessageBox>
#include <QSettings>
#include <QString>
#include <QStringList>
#include <memory>
 
namespace Mantid {
namespace API {
class IAlgorithm;
}
} // namespace Mantid
 
namespace MantidQt {
// namespace MantidWidgets {
// class DataSelector;
// }
namespace API {
 
class EXPORT_OPT_MANTIDQT_COMMON FileFinderSettings {
public:
  explicit FileFinderSettings(const QString &lastDirectory = {}) : m_lastDirectory(lastDirectory) {}
 
  const QString &lastDirectory() const { return m_lastDirectory; }
 
private:
  QString m_lastDirectory;
};
 
class EXPORT_OPT_MANTIDQT_COMMON FileFinderWidget : public API::MantidWidget {
  Q_OBJECT
 
  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 multipleFiles READ allowMultipleFiles WRITE allowMultipleFiles)
  Q_PROPERTY(bool optional READ isOptional WRITE isOptional)
  Q_PROPERTY(bool multiEntry READ doMultiEntry WRITE doMultiEntry)
  Q_PROPERTY(ButtonOpts buttonOpt READ doButtonOpt WRITE doButtonOpt)
  Q_PROPERTY(QString algorithmAndProperty READ getAlgorithmProperty WRITE setAlgorithmProperty)
  Q_PROPERTY(QStringList fileExtensions READ getFileExtensions WRITE setFileExtensions)
  Q_PROPERTY(bool extsAsSingleOption READ extsAsSingleOption WRITE extsAsSingleOption)
  Q_PROPERTY(LiveButtonOpts liveButton READ liveButtonState WRITE liveButtonState)
  Q_PROPERTY(QString instrumentOverride READ getInstrumentOverride WRITE setInstrumentOverride)
  Q_ENUMS(ButtonOpts)
  Q_ENUMS(LiveButtonOpts)
 
public:
  enum ButtonOpts {
    Text, 
    Icon, 
    None  
  };
  enum {
    NO_ENTRY_NUM = -1, 
    ALL_ENTRIES = -2   
  };
  enum LiveButtonOpts {
    Hide, 
    Show, 
  };
 
  FileFinderWidget(QWidget *parent = nullptr);
 
  // property accessors/modifiers
  bool isForRunFiles() const;
  void isForRunFiles(bool /*mode*/);
  bool isForDirectory() const;
  void isForDirectory(bool /*mode*/);
  QString getLabelText() const;
  void setLabelText(const QString &text);
  void setLabelMinWidth(int /*width*/);
  bool allowMultipleFiles() const;
  void allowMultipleFiles(bool /*allow*/);
  bool isOptional() const;
  void isOptional(bool /*optional*/);
  ButtonOpts doButtonOpt() const;
  void doButtonOpt(ButtonOpts buttonOpt);
  bool doMultiEntry() const;
  void doMultiEntry(bool /*multiEntry*/);
  const QString &getAlgorithmProperty() const;
  void setAlgorithmProperty(const QString &name);
  const QStringList &getFileExtensions() const;
  std::vector<std::string> getStringFileExtensions() const;
  void setFileExtensions(const QStringList &extensions);
  bool extsAsSingleOption() const;
  void extsAsSingleOption(bool value);
  LiveButtonOpts liveButtonState() const;
  void liveButtonState(LiveButtonOpts /*option*/);
 
  // Standard setters/getters
  void liveButtonSetChecked(bool /*checked*/);
  bool liveButtonIsChecked() const;
  bool isEmpty() const;
  QString getText() const;
 
  bool isValid() const;
  bool isSearching() const;
  const QStringList &getFilenames() const;
  QString getFirstFilename() const;
  int getEntryNum() const;
  void setEntryNum(const int num);
  QVariant getUserInput() const override;
  void setUserInput(const QVariant &value) override;
  void setText(const QString &value);
  void setFileProblem(const QString &message);
  const QString &getFileProblem() const;
  [[nodiscard]] static FileFinderSettings readSettings(const QSettings &settings);
  void restoreSettings(const FileFinderSettings &settings);
  [[nodiscard]] FileFinderSettings captureSettings() const;
  void saveSettings(QSettings &settings, const FileFinderSettings &values) const;
  void setNumberOfEntries(int number);
  void setLiveAlgorithm(const std::shared_ptr<Mantid::API::IAlgorithm> &monitorLiveData);
  const QString &getInstrumentOverride() const;
  void setInstrumentOverride(const QString &instName);
  void setReadOnly(bool readOnly);
  const QString &getLastDirectory() const { return m_lastDir; }
  void setLastDirectory(const QString &lastDir) { m_lastDir = lastDir; }
  void setTextValidator(const QValidator *validator);
  void setUseNativeWidget(bool /*native*/);
  void setProxyModel(QAbstractProxyModel *proxyModel);
 
signals:
  void fileTextChanged(const QString & /*_t1*/);
  void fileEditingFinished();
  void findingFiles();
  void filesFound();
  void filesFoundChanged();
  void fileFindingFinished();
  void liveButtonPressed(bool /*_t1*/);
  void fileInspectionFinished();
 
public slots:
  void setFileTextWithSearch(const QString &text);
  void setFileTextWithoutSearch(const QString &text);
  void clear();
  void findFiles();
  void findFiles(bool isModified);
  std::shared_ptr<const Mantid::API::IAlgorithm> stopLiveAlgorithm();
 
public:
  // Method for handling drop events
  void dropEvent(QDropEvent * /*unused*/) override;
  // called when a drag event enters the class
  void dragEnterEvent(QDragEnterEvent * /*unused*/) override;
 
private:
  QString createFileFilter();
  QStringList getFileExtensionsFromAlgorithm(const QString &algName, const QString &propName);
  QStringList getFilesFromAlgorithm(const QString &algName, const QString &propName, const QString &filename);
  QString openFileDialog();
  void setEntryNumProblem(const QString &message);
  void refreshValidator();
  void setValidatorDisplay(bool display);
  const QString findFilesGetSearchText(QString &searchText);
  void runFindFiles(const QString &searchText);
  FindFilesSearchParameters createFindFilesSearchParameters(const std::string &text) const;
 
private slots:
  void browseClicked();
  void checkEntry();
  void inspectThreadResult(const FindFilesSearchResults &results = FindFilesSearchResults());
 
private:
  bool m_findRunFiles;
  bool m_isForDirectory;
  bool m_allowMultipleFiles;
  bool m_isOptional;
  bool m_multiEntry;
  ButtonOpts m_buttonOpt;
  QString m_fileProblem;
  QString m_entryNumProblem;
  QString m_algorithmProperty;
  QStringList m_fileExtensions;
  bool m_extsAsSingleOption;
  LiveButtonOpts m_liveButtonState;
  std::shared_ptr<Mantid::API::IAlgorithm> m_monitorLiveData;
  bool m_showValidator;
  Ui::FileFinderWidget m_uiForm;
  QStringList m_foundFiles;
  QStringList m_lastFoundFiles;
  QString m_lastDir;
  QString m_fileFilter;
  QString m_defaultInstrumentName;
  QString m_valueForProperty;
  FindFilesThreadPoolManager m_pool;
  FindFilesSearchResults m_cachedResults;
  QFileDialog m_dialog;
  bool m_useNativeDialog;
};
 
} // namespace API
} // namespace MantidQt
 
Q_DECLARE_METATYPE(MantidQt::API::FileFinderWidget::ButtonOpts)
Q_DECLARE_METATYPE(MantidQt::API::FileFinderWidget::LiveButtonOpts)