pqHelpWindow provides a assistant-like window for showing help provided by a QHelpEngine.
More...
#include <pqHelpWindow.h>
Inherits QMainWindow.
|
| virtual void | showPage (const QString &url) |
| | Requests showing of a particular page. More...
|
| |
| virtual void | showPage (const QUrl &url) |
| |
| virtual void | showHomePage (const QString &namespace_name) |
| | Tires to locate a file name index.html in the given namespace and then shows that page. More...
|
| |
|
| void | helpWarnings (const QString &) |
| | fired to relay warning messages from the help system. More...
|
| |
pqHelpWindow provides a assistant-like window for showing help provided by a QHelpEngine.
Definition at line 47 of file pqHelpWindow.h.
§ pqHelpWindow()
| pqHelpWindow::pqHelpWindow |
( |
QHelpEngine * |
engine, |
|
|
QWidget * |
parent = 0, |
|
|
Qt::WindowFlags |
flags = 0 |
|
) |
| |
§ ~pqHelpWindow()
| virtual pqHelpWindow::~pqHelpWindow |
( |
| ) |
|
|
virtual |
§ showPage [1/2]
| virtual void pqHelpWindow::showPage |
( |
const QString & |
url | ) |
|
|
virtualslot |
Requests showing of a particular page.
The url must begin with "qthelp:" scheme when referring to pages from the help files.
§ showPage [2/2]
| virtual void pqHelpWindow::showPage |
( |
const QUrl & |
url | ) |
|
|
virtualslot |
§ showHomePage
| virtual void pqHelpWindow::showHomePage |
( |
const QString & |
namespace_name | ) |
|
|
virtualslot |
Tires to locate a file name index.html in the given namespace and then shows that page.
§ helpWarnings
| void pqHelpWindow::helpWarnings |
( |
const QString & |
| ) |
|
|
signal |
fired to relay warning messages from the help system.
§ search
| void pqHelpWindow::search |
( |
| ) |
|
|
protectedslot |
§ HelpEngine
| QHelpEngine* pqHelpWindow::HelpEngine |
|
protected |
The documentation for this class was generated from the following file:
