Skip to content
Snippets Groups Projects
HelpWindow.h 1.7 KiB
Newer Older
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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 +
#include "MantidQtWidgets/Common/DllOption.h"
#include <QString>
#include <string>
// forward declarations
class QUrl;
namespace MantidQt {
namespace API {
class EXPORT_OPT_MANTIDQT_COMMON HelpWindow {
  static void showPage(QWidget *parent, const std::string &url = std::string());
  static void showPage(QWidget *parent, const QString &url);
  static void showPage(QWidget *parent, const QUrl &url);
  static void showAlgorithm(QWidget *parent,
                            const std::string &name = std::string(),
                            const int version = -1);
  static void showAlgorithm(QWidget *parent, const QString &name,
                            const int version = -1);
  static void showConcept(QWidget *parent,
                          const std::string &name = std::string());
  static void showConcept(QWidget *parent, const QString &name);
  static void showFitFunction(QWidget *parent,
                              const std::string &name = std::string());
  static void showCustomInterface(QWidget *parent, const QString &name,
                                  const QString &section = QString());
  static void showCustomInterface(QWidget *parent,
                                  const std::string &name = std::string(),
                                  const std::string &section = std::string());
} // namespace MantidQt