MantidHelpWindow.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 "MantidQtWidgets/Common/MantidHelpInterface.h"
#include <QPointer>
#include <QWidget>
#include <string>
 
// forward declaration
class QHelpEngine;
class QString;
class QWidget;
class pqHelpWindow;
 
namespace MantidQt {
namespace MantidWidgets {
 
class EXPORT_OPT_MANTIDQT_COMMON MantidHelpWindow : public API::MantidHelpInterface {
  Q_OBJECT
 
public:
  static bool helpWindowExists() { return !g_helpWindow.isNull(); }
 
  MantidHelpWindow(const Qt::WindowFlags &flags = Qt::WindowFlags());
 
  void showPage(const std::string &url = std::string()) override;
  void showPage(const QString &url) override;
  void showPage(const QUrl &url) override;
  void showWikiPage(const std::string &page = std::string()) override;
  void showWikiPage(const QString &page) override;
  void showAlgorithm(const std::string &name = std::string(), const int version = -1) override;
  void showAlgorithm(const QString &name, const int version = -1) override;
  void showConcept(const std::string &name) override;
  void showConcept(const QString &name) override;
  void showFitFunction(const std::string &name = std::string()) override;
  void showFitFunction(const QString &name) override;
  void showCustomInterface(const std::string &name = std::string(), const std::string &area = std::string(),
                           const std::string &section = std::string()) override;
  void showCustomInterface(const QString &name, const QString &area = QString(),
                           const QString &section = QString()) override;
 
private:
  void showHelp(const QString &url);
  void openWebpage(const QUrl &url);
 
  std::string m_collectionFile;
  std::string m_cacheFile;
  static QPointer<pqHelpWindow> g_helpWindow;
 
  bool m_firstRun;
 
  void findCollectionFile(std::string &binDir);
  void determineFileLocs();
 
public slots:
  void shutdown() override;
  void warning(const QString &msg);
};
 
} // namespace MantidWidgets
} // namespace MantidQt