Inheritance diagram for DtHelpHandler:

Public Slots
virtual bool	userDefinedAction (DtUserDefinedType iAction, void *usr)
virtual void	assistantError (const QString &msg)
Public Slots inherited from DtEventHandler
virtual bool	mouseEvent (DtTMMapArea , QMouseEvent evnt, const DtPoint &pnt)
virtual bool	keyboardEvent (DtTMMapArea , QKeyEvent evnt)
virtual bool	symbolsSelected (DtTMMapArea area, DtSymbolList sl)
virtual bool	selectionUpdated (DtTMMapArea *area, const QVector< DtModelKey > &d)
virtual bool	selectionInProgress (DtTMMapArea *area, DtSymbolSelector &d)
virtual bool	focusEvent (DtTMMapArea , QEvent evnt)
virtual bool	enterEvent (DtTMMapArea area, QEvent evnt)
virtual bool	leaveEvent (DtTMMapArea area, QEvent evnt)
virtual bool	dropEvent (DtTMMapArea area, QDropEvent evnt)
virtual bool	dragEnterEvent (DtTMMapArea area, QDragEnterEvent evnt)
virtual bool	dragMoveEvent (DtTMMapArea area, QDragMoveEvent evnt)
virtual bool	dragLeaveEvent (DtTMMapArea area, QDragLeaveEvent evnt)
virtual bool	userDefinedAction (DtUserDefinedType iAction, void *usr)
virtual bool	aboutToDraw (DtTMMapArea area, QPainter )
virtual bool	mapActivated (DtTMMapArea *area)
virtual bool	selectedModelDataUpdated (DtTMMapArea *area)
virtual bool	symbolAdded (DtTMMapArea *area, const DtModelKey &)
virtual bool	symbolRemoved (DtTMMapArea *area, const DtModelKey &)
virtual bool	disconnecting (DtTMMapArea *area)
	Called when a map is being disconnect from an event handler.
virtual bool	connecting (DtTMMapArea *area)
	Called when a map is being connected to an event handler.
virtual void	tick ()
virtual void	clearDialog ()

Public Member Functions
	DtHelpHandler ()
	Default Constructor.
virtual	~DtHelpHandler ()
	Destructor.
Public Member Functions inherited from DtEventHandler
	DtEventHandler ()
	Default Constructor.
virtual	~DtEventHandler ()
	Destructor.
virtual void	setEventController (DtEventController *)
virtual void	setInitialSelection (const QVector< DtModelKey > &d)
virtual void	showDialog (bool b)
virtual QWidget *	createDialog (QWidget *w)
	Creates the dialog associated with this handler (if there is one)
virtual QWidget *	dialog (bool createIfMissing=true, QWidget *parent=NULL)
	If createIfMissing is true, will create the dialog based on the supplied parent window, else will simply return the dialog pointer.
virtual void	reset ()
virtual DtBaseWindow *	baseWindow () const
	Returns the base window of the event controller.
virtual void	activate ()
	Called when this event handler first becomes active.
virtual void	deactivate ()
	Called when this event handler is removed as the current event.
virtual void	setBaseWindow (DtBaseWindow *w)
	Called when the base window is set for the event controller.
virtual void	init ()
	Called when the handler is first created, initialize context.
void	setSuspended (bool)
	Set when something wants to suspend some aspect of this handler without deactivating it.
bool	suspended () const
virtual void	dialogDestroyedEvent ()
	Called when dialog is destroyed.
Public Member Functions inherited from DtArchivableObject
	DtArchivableObject (QString name, DtArchivableObjectCreator fcn)
	This constructor will add this object to the archivable object factory.
	DtArchivableObject (QString name)
	DtArchivableObject ()
virtual	~DtArchivableObject ()
virtual QString	name () const
DtArchiver *	archiver ()
	Returns the archiver of this object.
virtual void	read (QTextStream &s)
	Reads/writes archiver.
virtual void	write (QTextStream &s)
virtual void	setLevel (int i)
virtual int	level () const
virtual DtArchivableObject *	clone ()
	Allows for cloning of this object.

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
Protected Attributes inherited from DtEventHandler
QWidget *	myEventDlg
DtEventController *	myEventController
bool	mySuspended
Protected Attributes inherited from DtArchivableObject
DtArchiver *	myArchiver

Additional Inherited Members
Signals inherited from DtEventHandler
void	closedDialog ()

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
	)

virtualslot

virtual void DtHelpHandler::assistantError ( const QString & msg )

virtualslot

virtual void DtHelpHandler::showHelp ( const DtTMMapArea * )

protectedvirtual

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 )

protectedvirtual

Launches a web page with the specified url.

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

protectedvirtual

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

protectedvirtual

virtual bool DtHelpHandler::useAssistant ( ) const

protectedvirtual

Member Data Documentation

QProcess* DtHelpHandler::myAssistant

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/tmEventHandler/helpHandler.h

Public Slots

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation