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 ()
	Tries to locate a file name index.html in the current namespace and then shows that page. More...
virtual void	showHomePage (const QString &namespace_name)
	Set the namespace from the provided one, then tries to locate a file name index.html in the given namespace and shows that page. More...
virtual void	saveCurrentHomePage ()
	Save current page as home page. More...
virtual void	updateHistoryButtons ()
	Update the state of buttons used to navigate through history. More...
virtual void	setNameSpace (const QString &namespace_name)
	Sets the namespace to use in order to find the homepage. More...
virtual void	goBackward ()
	Navigate through the history of visited pages. More...
virtual void	goForward ()
	Navigate through the history of visited pages. 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 22 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 [1/2]

virtual void pqHelpWindow::showHomePage ( )

virtualslot

Tries to locate a file name index.html in the current namespace and then shows that page.

showHomePage [2/2]

virtual void pqHelpWindow::showHomePage ( const QString &  namespace_name )

virtualslot

Set the namespace from the provided one, then tries to locate a file name index.html in the given namespace and shows that page.

saveCurrentHomePage

virtual void pqHelpWindow::saveCurrentHomePage ( )

virtualslot

Save current page as home page.

This parameter is saved in a setting.

goBackward

virtual void pqHelpWindow::goBackward ( )

virtualslot

Navigate through the history of visited pages.

goForward

virtual void pqHelpWindow::goForward ( )

virtualslot

Navigate through the history of visited pages.

updateHistoryButtons

virtual void pqHelpWindow::updateHistoryButtons ( )

virtualslot

Update the state of buttons used to navigate through history.

setNameSpace

virtual void pqHelpWindow::setNameSpace ( const QString &  namespace_name )

virtualslot

Sets the namespace to use in order to find the homepage.

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 88 of file pqHelpWindow.h.

---

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

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