An interface for help managers implementations. More...

Inheritance diagram for te::qt::widgets::HelpManagerImpl:

Public Member Functions
virtual void	appendDoc (const QString &docRef)=0
	Appends a collection of help documentation to the existing collection. More...

virtual void	showHelp (const QString &htmRef, const QString &nSpace="")=0
	Opens the help on the selected page. More...

Detailed Description

An interface for help managers implementations.

Definition at line 45 of file HelpManagerImpl.h.

Member Function Documentation

virtual void te::qt::widgets::HelpManagerImpl::appendDoc ( const QString & docRef )

pure virtual

Appends a collection of help documentation to the existing collection.

Parameters

docRef Reference to the help collection to be appended.

Note: The docRef argument refers to an existing Qt Help project file. See Qt documentation for details on how to create these kind of files.

virtual void te::qt::widgets::HelpManagerImpl::showHelp	(	const QString &	htmRef,
		const QString &	nSpace = `""`
	)

pure virtual

Opens the help on the selected page.

Parameters

htmRef	Reference to some page on the help collection.
nSpace	Namespace to be used.

Note: There is a syntax for the argument. If it is not respected, we CAN NOT garantee the correct operation. The right syntax is as follows: "qthelp://<NAMESPACE defined in Qt help project/<virtual folder>/<fileName>", i.e. qthelp://dpi.inpe.br.terraview.5.0/doc/associando_arquivos_sites.htm, "dpi.inpe.br.terraview.5.0" is the namespace defined in the Qt help project file, "doc" is the virtual folder, also defined in Qt project file, and "associando_arquivos_sites.htm" is file compiled within the project.

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

/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/qt/widgets/help/HelpManagerImpl.h