te::qt::widgets::HelpManager Class Reference

Facade for a te::qt::widgets::HelpManagerImpl object. More...

#include <HelpManager.h>

Inheritance diagram for te::qt::widgets::HelpManager:

Public Member Functions
HelpManagerImpl *	getImpl () const
	Returns the pointer to the HelpManagerImpl object being used. More...
void	setImpl (HelpManagerImpl *impl)
	Updates the HelpManagerImpl pointer. More...
Facade methods
Facade for the te::qt::widgets::HelpManagerImpl API. Note See the te::qt::widgets::HelpManagerImpl API for detais on how to call methods with the right argument's syntax.
void	showHelp (const QString &htmRef, const QString &nSpace="")
	Opens the help on the selected page. More...
void	appendDoc (const QString &docRef)
	Appends a project of help documentation to the existing collection. More...

Static Public Member Functions
static HelpManager &	getInstance ()
	It returns a reference to the singleton instance. More...

Protected Member Functions
	HelpManager ()
	Protected constructor. Can not be called by clients. More...

Protected Attributes
HelpManagerImpl *	m_impl
	Pointer to HelpManagerImpl to be used. More...

Friends
class	te::common::Singleton< HelpManager >

Detailed Description

Facade for a te::qt::widgets::HelpManagerImpl object.

This class holds a pointer to a te::qt::widgets::HelpManagerImpl object. Before use it, the client MUST set the pointer to a valid HelpManagerImpl object. If it was not done, nothing will happen when calling methods neither exceptions will be raised.

Definition at line 53 of file HelpManager.h.

Constructor & Destructor Documentation

te::qt::widgets::HelpManager::HelpManager ( )

protected

Protected constructor. Can not be called by clients.

Member Function Documentation

void te::qt::widgets::HelpManager::appendDoc

(

const QString &

docRef

)

Appends a project of help documentation to the existing collection.

Parameters

docRef

Reference to the help project to be appended.

HelpManagerImpl* te::qt::widgets::HelpManager::getImpl

(

)

const

Returns the pointer to the HelpManagerImpl object being used.

static HelpManager & te::common::Singleton< HelpManager >::getInstance ( )

staticinherited

It returns a reference to the singleton instance.

Returns

A reference to the singleton instance.

void te::qt::widgets::HelpManager::setImpl

(

HelpManagerImpl *

impl

)

Updates the HelpManagerImpl pointer.

Note

This object does NOT take the ownership of the pointer. The caller must manage the pointers. This means that the previous pointer will NOT be deleted. This method, only reassigns the pointer.

The client must ensure that the pointer of the HelpManagerImpl will be valid until the application has finished. If, for some reason, the client of this class needs to delete the pointer, it MUST use this method to set NULL or 0 to the HelpManagerImpl to be used (a null pointer means no operation to be executed), otherwise it can take to an unhandled exception of invalid pointer.

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

Opens the help on the selected page.

Parameters

htmRef	Reference to some page on the help collection.
nSpace

Friends And Related Function Documentation

friend class te::common::Singleton< HelpManager >

friend

Definition at line 55 of file HelpManager.h.

Member Data Documentation

HelpManagerImpl* te::qt::widgets::HelpManager::m_impl

protected

Pointer to HelpManagerImpl to be used.

Definition at line 101 of file HelpManager.h.

---

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

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