InterfaceManager.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
 
//----------------------------------
// Includes
//----------------------------------
#include "DllOption.h"
// #include "MantidKernel/SingletonHolder.h"
#include "MantidKernel/Instantiator.h"
 
#include <QHash>
#include <QList>
#include <QPointer>
#include <QString>
#include <QStringList>
 
//----------------------------------
// Qt Forward declarations
//----------------------------------
class QWidget;
 
//----------------------------------
// Mantid forward declarations
//----------------------------------
namespace Mantid {
namespace API {
class IAlgorithm;
}
} // namespace Mantid
 
// Top level namespace for this library
namespace MantidQt {
 
namespace API {
 
//----------------------------------
// Forward declarations
//----------------------------------
class AlgorithmDialog;
class UserSubWindow;
class MantidHelpInterface;
 
class EXPORT_OPT_MANTIDQT_COMMON InterfaceManager {
 
public:
  AlgorithmDialog *createDialog(const std::shared_ptr<Mantid::API::IAlgorithm> &alg, QWidget *parent = nullptr,
                                bool forScript = false,
                                const QHash<QString, QString> &presetValues = (QHash<QString, QString>()),
                                const QString &optional_msg = QString(), const QStringList &enabled = QStringList(),
                                const QStringList &disabled = QStringList());
 
  AlgorithmDialog *createDialogFromName(const QString &algorithmName, const int version = -1, QWidget *parent = nullptr,
                                        bool forScript = false,
                                        const QHash<QString, QString> &presetValues = (QHash<QString, QString>()),
                                        const QString &optionalMsg = QString(),
                                        const QStringList &enabled = QStringList(),
                                        const QStringList &disabled = QStringList());
 
  UserSubWindow *createSubWindow(const QString &interface_name, QWidget *parent = nullptr, bool isWindow = true);
 
  MantidHelpInterface *createHelpWindow() const;
 
  void showHelpPage(const QString &url = QString());
 
  void showAlgorithmHelp(const QString &name, const int version = -1);
 
  void showConceptHelp(const QString &name);
 
  void showFitFunctionHelp(const QString &name = QString());
 
  void showCustomInterfaceHelp(const QString &name, const QString &area = QString(),
                               const QString &section = QString());
 
  void showWebPage(const QString &url);
 
  void closeHelpWindow();
 
  static void registerHelpWindowFactory(Mantid::Kernel::AbstractInstantiator<MantidHelpInterface> *factory);
 
  static QList<QPointer<UserSubWindow>> &existingInterfaces();
 
  QStringList getUserSubWindowKeys() const;
 
  InterfaceManager();
  virtual ~InterfaceManager();
 
  void showHomeHelpPage();
  void cleanup();
 
private:
  void notifyExistingInterfaces(UserSubWindow *newWindow);
 
  static Mantid::Kernel::AbstractInstantiator<MantidHelpInterface> *m_helpViewer;
};
} // namespace API
} // namespace MantidQt
 
#define REGISTER_HELPWINDOW(TYPE)                                                                                      \
  namespace {                                                                                                          \
  Mantid::Kernel::RegistrationHelper                                                                                   \
      register_helpviewer(((MantidQt::API::InterfaceManager::registerHelpWindowFactory(                                \
                               new Mantid::Kernel::Instantiator<TYPE, MantidQt::API::MantidHelpInterface>())),         \
                           0));                                                                                        \
  }