pqHelpWindow.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqHelpWindow_h
#define pqHelpWindow_h

#include "pqComponentsModule.h" // For export macro

#include <QMainWindow>
#include <QScopedPointer>
#include <QUrl>

class QHelpEngine;
class pqBrowser;

class PQCOMPONENTS_EXPORT pqHelpWindow : public QMainWindow
{
  Q_OBJECT
  typedef QMainWindow Superclass;

public:
  pqHelpWindow(
    QHelpEngine* engine, QWidget* parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags{});
  ~pqHelpWindow() override;

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  virtual void showPage(const QString& url);
  virtual void showPage(const QUrl& url);

  virtual void showHomePage();

  virtual void saveCurrentHomePage();


  virtual void goBackward();
  virtual void goForward();

  virtual void updateHistoryButtons();

  virtual void setNameSpace(const QString& namespace_name);

Q_SIGNALS:
  void helpWarnings(const QString&);

protected Q_SLOTS:
  void search();

protected: // NOLINT(readability-redundant-access-specifiers)
  QHelpEngine* HelpEngine;

private:
  Q_DISABLE_COPY(pqHelpWindow)
  const QScopedPointer<pqBrowser> Browser;

  class pqInternals;
  QScopedPointer<pqInternals> Internals;
};

#endif