pqHelpReaction is reaction to show application help using Qt assistant. More...

Inheritance diagram for pqHelpReaction:

Collaboration diagram for pqHelpReaction:

Public Member Functions
	pqHelpReaction (QAction *parent)
Static Public Member Functions
static void	showHelp ()
	Show help for the application.
static void	showHelp (const QString &url)
	Show a particular help page.
static void	showProxyHelp (const QString &group, const QString &name)
	Show the documentation for a particular proxy.
Protected Member Functions
virtual void	onTriggered ()
	Called when the action is triggered.

Detailed Description

pqHelpReaction is reaction to show application help using Qt assistant.

It searches for ":/<AppName>HelpCollection/*.qhc" files and shows the first help collection file found as the help collection.

Definition at line 41 of file pqHelpReaction.h.

Constructor & Destructor Documentation

pqHelpReaction::pqHelpReaction ( QAction * parent )

static void pqHelpReaction::showHelp ( ) [static]

Show help for the application.

static void pqHelpReaction::showHelp ( const QString & url ) [static]

Show a particular help page.

static void pqHelpReaction::showProxyHelp	(	const QString &	group,
		const QString &	name
	)		`[static]`

Show the documentation for a particular proxy.

virtual void pqHelpReaction::onTriggered ( ) [inline, protected, virtual]

Called when the action is triggered.

Reimplemented from pqReaction.

Definition at line 59 of file pqHelpReaction.h.

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

/home/kitware/Dashboards/My Tests/ParaView/Qt/ApplicationComponents/pqHelpReaction.h