pqHelpWindow Class Reference

pqHelpWindow provides a assistant-like window for showing help provided by a QHelpEngine. More...

#include <pqHelpWindow.h>

Inherits QMainWindow.

Public Slots
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...

Signals
void	helpWarnings (const QString &)
	fired to relay warning messages from the help system. More...

Public Member Functions
	pqHelpWindow (QHelpEngine *engine, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags{})
	~pqHelpWindow () override

Protected Slots
void	search ()

Protected Attributes
QHelpEngine *	HelpEngine

Detailed Description

pqHelpWindow provides a assistant-like window for showing help provided by a QHelpEngine.

Definition at line 47 of file pqHelpWindow.h.

Constructor & Destructor Documentation

pqHelpWindow()

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

~pqHelpWindow()

pqHelpWindow::~pqHelpWindow ( )

override

Member Function Documentation

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

Member Data Documentation

HelpEngine

QHelpEngine* pqHelpWindow::HelpEngine

protected

Definition at line 81 of file pqHelpWindow.h.

---

The documentation for this class was generated from the following file:

• /builds/gitlab-kitware-sciviz-ci/Qt/Widgets/pqHelpWindow.h