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

Public Slots
virtual void	showPage (const QString &url)
	Requests showing of a particular page.
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.
Signals
void	helpWarnings (const QString &)
	fired to relay warning messages from the help system.
Public Member Functions
	pqHelpWindow (QHelpEngine engine, QWidget parent=0, Qt::WindowFlags flags=0)
virtual	~pqHelpWindow ()
Protected Slots
void	search ()
Protected Attributes
QHelpEngine *	HelpEngine
QWebView *	Browser
Friends
class	pqNetworkAccessManager

Detailed Description

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

Definition at line 46 of file pqHelpWindow.h.

Constructor & Destructor Documentation

virtual pqHelpWindow::~pqHelpWindow ( ) [virtual]

virtual void pqHelpWindow::showPage ( const QString & url ) [virtual, slot]

Requests showing of a particular page.

The url must begin with "qthelp:" scheme when referring to pages from the help files.

virtual void pqHelpWindow::showPage ( const QUrl & url ) [virtual, slot]

virtual void pqHelpWindow::showHomePage ( const QString & namespace_name ) [virtual, slot]

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

void pqHelpWindow::helpWarnings ( const QString & ) [signal]

fired to relay warning messages from the help system.

void pqHelpWindow::search ( ) [protected, slot]

friend class pqNetworkAccessManager [friend]

Definition at line 79 of file pqHelpWindow.h.

QHelpEngine* pqHelpWindow::HelpEngine [protected]

Definition at line 73 of file pqHelpWindow.h.

QWebView* pqHelpWindow::Browser [protected]

Definition at line 74 of file pqHelpWindow.h.

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