UserSubWindow.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
 
/* Used to register classes into the factory. Creates a global object in an
 * anonymous namespace. The object itself does nothing, but the comma operator
 * is used in the call to its constructor to effect a call to the factory's
 * subscribe method.
 */
#define DECLARE_SUBWINDOW(classname)                                                                                   \
  namespace {                                                                                                          \
  Mantid::Kernel::RegistrationHelper                                                                                   \
      register_subwindow_##classname(((MantidQt::API::UserSubWindowFactory::Instance().subscribe<classname>()), 0));   \
  }
 
#define DECLARE_SUBWINDOW_AND_CODERS(classname, encodertype, decodertype, decodertag)                                  \
  namespace {                                                                                                          \
  Mantid::Kernel::RegistrationHelper register_subwindow_##classname(                                                   \
      ((MantidQt::API::UserSubWindowFactory::Instance().subscribe<classname, encodertype, decodertype>(decodertag)),   \
       0));                                                                                                            \
  }
 
//----------------------------------
// Includes
//----------------------------------
#include "DllOption.h"
#include "PythonRunner.h"
#include "UserSubWindowFactory.h"
 
#include <QLabel>
#include <QMainWindow>
#include <QPointer>
#include <QStringList>
#include <QWidget>
#include <set>
 
//----------------------------------
// Qt Forward declarations
//----------------------------------
 
//----------------------------------
// Mantid Forward declarations
//----------------------------------
 
// Top-level namespace for this library
namespace MantidQt {
namespace MantidWidgets {
class FitPropertyBrowser;
}
 
namespace API {
 
//----------------------------------
// Forward declarations
//----------------------------------
class InterfaceManager;
 
class EXPORT_OPT_MANTIDQT_COMMON UserSubWindow : public QMainWindow {
  Q_OBJECT
 
public:
  static std::string name() { return "UserSubWindow::name() default Reimplement static name() method."; }
  static std::set<std::string> aliases() { return std::set<std::string>(); }
 
public:
  UserSubWindow(QWidget *parent = nullptr);
  void initializeLayout();
  void initializeLocalPython();
  bool isInitialized() const;
  bool isPyInitialized() const;
 
signals:
  void runAsPythonScript(const QString &code, bool /*_t2*/);
 
  void setFitPropertyBrowser(MantidQt::MantidWidgets::FitPropertyBrowser *browser);
 
protected:
  virtual void initLayout() = 0;
  virtual void initLocalPython() {}
 
  virtual void otherUserSubWindowCreated(QPointer<UserSubWindow> window) { UNUSED_ARG(window); }
 
  virtual void otherUserSubWindowCreated(QList<QPointer<UserSubWindow>> &windows) { UNUSED_ARG(windows); }
 
  void showInformationBox(const QString &message) const;
 
  QString runPythonCode(const QString &code, bool no_output = false);
  QString openFileDialog(const bool save, const QStringList &exts);
  QLabel *newValidator(QWidget *parent);
 
private:
  // This is so that it can set the name
  // I can't pass anything as an argument to the constructor as I am using
  // the DynamicFactory
  friend class InterfaceManager;
 
  void setInterfaceName(const QString &iface_name);
 
  bool m_bIsInitialized;
  bool m_isPyInitialized;
  QString m_ifacename;
 
  PythonRunner m_pythonRunner;
};
} // namespace API
} // namespace MantidQt