te::qt::widgets::AssistantHelpManagerImpl Class Reference

A help manager that uses the QAssistant to manage help files. More...

#include <AssistantHelpManagerImpl.h>

Inheritance diagram for te::qt::widgets::AssistantHelpManagerImpl:

Public Slots
void	appendDoc (const QString &docRef)
void	showHelp (const QString &htmRef, const QString &nSpace="")

Public Member Functions
	AssistantHelpManagerImpl (const QString &collectionFile, QObject *parent=0)
	Constructor. More...
bool	startAssistant ()
	It starts the Qt assistant help process pointing out to the given collection file. More...
	~AssistantHelpManagerImpl ()
	Destructor. More...

Protected Attributes
QString	m_collectionFile
	Collection name. More...
QProcess *	m_proc
	Qt process, used to init QAssistant. More...
QStringList	m_regDocs
	Registered documents. More...

Detailed Description

A help manager that uses the QAssistant to manage help files.

Definition at line 53 of file AssistantHelpManagerImpl.h.

Constructor & Destructor Documentation

te::qt::widgets::AssistantHelpManagerImpl::AssistantHelpManagerImpl	(	const QString &	collectionFile,
		QObject *	parent = 0
	)

Constructor.

Parameters

collectionFile	Name of the Qt collection file to be used.
parent	Used by QObject constructor.

Definition at line 59 of file AssistantHelpManagerImpl.cpp.

te::qt::widgets::AssistantHelpManagerImpl::~AssistantHelpManagerImpl

(

)

Destructor.

Definition at line 66 of file AssistantHelpManagerImpl.cpp.

Member Function Documentation

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

slot

Definition at line 144 of file AssistantHelpManagerImpl.cpp.

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

slot

Definition at line 131 of file AssistantHelpManagerImpl.cpp.

bool te::qt::widgets::AssistantHelpManagerImpl::startAssistant

(

)

It starts the Qt assistant help process pointing out to the given collection file.

Returns

True if start assistant with no problems, false otherwise.

Definition at line 92 of file AssistantHelpManagerImpl.cpp.

References GetMainWindow().

Member Data Documentation

QString te::qt::widgets::AssistantHelpManagerImpl::m_collectionFile

protected

Collection name.

Definition at line 86 of file AssistantHelpManagerImpl.h.

QProcess* te::qt::widgets::AssistantHelpManagerImpl::m_proc

protected

Qt process, used to init QAssistant.

Definition at line 84 of file AssistantHelpManagerImpl.h.

QStringList te::qt::widgets::AssistantHelpManagerImpl::m_regDocs

protected

Registered documents.

Definition at line 85 of file AssistantHelpManagerImpl.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git/src/terralib/qt/widgets/help/AssistantHelpManagerImpl.h
• /home/castejon/castejon_files/develop/terralib5/git/src/terralib/qt/widgets/help/AssistantHelpManagerImpl.cpp