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)

Public Member Functions inherited from pqReaction
	pqReaction (QAction *parent, Qt::ConnectionType type=Qt::AutoConnection)
	Constructor. More...

	~pqReaction () override

QAction *	parentAction () const
	Provides access to the parent action. More...

Static Public Member Functions
static void	showHelp ()
	Show help for the application. More...

static void	showHelp (const QString &url)
	Show a particular help page. More...

static void	showProxyHelp (const QString &group, const QString &name)
	Show the documentation for a particular proxy. More...

Protected Member Functions
void	onTriggered () override
	Called when the action is triggered. More...

Additional Inherited Members
Protected Slots inherited from pqReaction
virtual void	updateEnableState ()

virtual void	updateMasterEnableState (bool)

Protected Attributes inherited from pqReaction
bool	IsMaster

Detailed Description

pqHelpReaction is reaction to show application help using Qt assistant.

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

Definition at line 15 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.

void pqHelpReaction::onTriggered ( )

inlineoverrideprotectedvirtual

Called when the action is triggered.

Reimplemented from pqReaction.

Definition at line 42 of file pqHelpReaction.h.

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