DtHelpHandler Class Reference

Inheritance diagram for DtHelpHandler:

List of all members.

Public Slots
virtual bool	userDefinedAction (DtUserDefinedType iAction, void *usr)
virtual void	assistantError (const QString &msg)
Public Member Functions
	DtHelpHandler ()
	Default Constructor.
virtual	~DtHelpHandler ()
	Destructor.
Static Public Member Functions
static DtEventHandler *	create (DtEventController *owner, void *usr)
	Static creator.
Protected Member Functions
virtual void	showHelp (const DtTMMapArea *)
	This routine will use an external browser (launched as a separate process) to show the help contained in the doc/help directory (specifically starting with the help file defined in the applications helpFile() file).
virtual void	launchWebPage (const QString *url)
	Launches a web page with the specified url.
virtual void	launchHelp (const DtTMMapArea *map, const QString &filename)
	In WIN32 will use ShellExecuteA, all other platforms will use QProcess with the current browser which will either be netscape or the value set for the BROWSER environment variable.
virtual QString	browserHelpFile () const
virtual bool	useAssistant () const
Protected Attributes
QProcess *	myAssistant

---

Constructor & Destructor Documentation

DtHelpHandler::DtHelpHandler

(

)

Default Constructor.

virtual DtHelpHandler::~DtHelpHandler

(

)

[virtual]

Destructor.

---

Member Function Documentation

static DtEventHandler* DtHelpHandler::create	(	DtEventController *	owner,
		void *	usr
	)		[static]

Static creator.

virtual bool DtHelpHandler::userDefinedAction	(	DtUserDefinedType	iAction,
		void *	usr
	)		[virtual, slot]

Reimplemented from DtEventHandler.

virtual void DtHelpHandler::assistantError

(

const QString &

msg

)

[virtual, slot]

virtual void DtHelpHandler::showHelp

(

const DtTMMapArea *

)

[protected, virtual]

This routine will use an external browser (launched as a separate process) to show the help contained in the doc/help directory (specifically starting with the help file defined in the applications helpFile() file).

virtual void DtHelpHandler::launchWebPage

(

const QString *

url

)

[protected, virtual]

Launches a web page with the specified url.

virtual void DtHelpHandler::launchHelp	(	const DtTMMapArea *	map,
		const QString &	filename
	)		[protected, virtual]

In WIN32 will use ShellExecuteA, all other platforms will use QProcess with the current browser which will either be netscape or the value set for the BROWSER environment variable.

Override this function if you want to show your own help window. Do not call the parent version of this method if it is not necessary to launch a browser window with the help file.

virtual QString DtHelpHandler::browserHelpFile

(

)

const [protected, virtual]

virtual bool DtHelpHandler::useAssistant

(

)

const [protected, virtual]

---

Member Data Documentation

QProcess* DtHelpHandler::myAssistant [protected]

---

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

• include/tmEventHandler/helpHandler.h