pqHelpWindow.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
3 // SPDX-License-Identifier: BSD-3-Clause
4 #ifndef pqHelpWindow_h
5 #define pqHelpWindow_h
6 
7 #include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED_IN_5_12_0
8 
9 #include "pqComponentsModule.h" // For export macro
10 
11 #include <QMainWindow>
12 #include <QScopedPointer>
13 #include <QUrl>
14 
15 class QHelpEngine;
16 class pqBrowser;
17 
22 class PQCOMPONENTS_EXPORT pqHelpWindow : public QMainWindow
23 {
24  Q_OBJECT
25  typedef QMainWindow Superclass;
26 
27 public:
29  QHelpEngine* engine, QWidget* parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags{});
30  ~pqHelpWindow() override;
31 
32 public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
37  virtual void showPage(const QString& url);
38  virtual void showPage(const QUrl& url);
39 
44  virtual void showHomePage();
45 
51  "Please use separated setNameSpace() and showHomePage() functions instead.")
52  virtual void showHomePage(const QString& namespace_name);
53 
58  virtual void saveCurrentHomePage();
59 
61 
64  virtual void goBackward();
65  virtual void goForward();
67 
71  virtual void updateHistoryButtons();
72 
76  virtual void setNameSpace(const QString& namespace_name);
77 
78 Q_SIGNALS:
82  void helpWarnings(const QString&);
83 
84 protected Q_SLOTS:
85  void search();
86 
87 protected: // NOLINT(readability-redundant-access-specifiers)
88  QHelpEngine* HelpEngine;
89 
90 private:
91  Q_DISABLE_COPY(pqHelpWindow)
92  const QScopedPointer<pqBrowser> Browser;
93 
94  class pqInternals;
95  QScopedPointer<pqInternals> Internals;
96 };
97 
98 #endif
QHelpEngine * HelpEngine
Definition: pqHelpWindow.h:88
#define PARAVIEW_DEPRECATED_IN_5_12_0(reason)
pqHelpWindow provides a assistant-like window for showing help provided by a QHelpEngine.
Definition: pqHelpWindow.h:22
#define PQCOMPONENTS_EXPORT
url