te::qt::widgets::HelpPushButton Class Reference

Push button that uses te::qt::widgets::HelpManager on its mouse pressed implementation. More...

#include <HelpPushButton.h>

Inheritance diagram for te::qt::widgets::HelpPushButton:

Public Member Functions
	HelpPushButton (QWidget *parent=0)
	Constructor. More...
void	setNameSpace (const QString &ns)
	Sets the namespace to be used. More...
void	setPageReference (const QString &ref)
	Sets the documentation page reference. More...

Protected Member Functions
void	mousePressEvent (QMouseEvent *e)
	Overloaded function of QPushButton. Only LEFT button pressed will show the help. More...

Protected Attributes
QString	m_ns
	Namespace being used. (Qt help usage) More...
QString	m_pgRef
	Stores the reference for the help file to be presented. More...

Detailed Description

Push button that uses te::qt::widgets::HelpManager on its mouse pressed implementation.

The client must set the page reference, as described in te::qt::widgets::HelpManagerImpl API documentation, before using it or nothing will happen.

Definition at line 50 of file HelpPushButton.h.

Constructor & Destructor Documentation

te::qt::widgets::HelpPushButton::HelpPushButton

(

QWidget *

parent = 0

)

Constructor.

Parameters

parent

Parent widget, used by Qt.

Definition at line 33 of file HelpPushButton.cpp.

Member Function Documentation

void te::qt::widgets::HelpPushButton::mousePressEvent ( QMouseEvent *  e )

protected

Overloaded function of QPushButton. Only LEFT button pressed will show the help.

Parameters

e	The mouse press event.

Definition at line 48 of file HelpPushButton.cpp.

References te::common::Singleton< HelpManager >::getInstance(), and te::qt::widgets::HelpManager::showHelp().

void te::qt::widgets::HelpPushButton::setNameSpace

(

const QString &

ns

)

Sets the namespace to be used.

Parameters

ns	New namespace.

Definition at line 43 of file HelpPushButton.cpp.

void te::qt::widgets::HelpPushButton::setPageReference

(

const QString &

ref

)

Sets the documentation page reference.

Parameters

ref	Reference to a page contained in help file project. See te::qt::widgets::HelpManagerImpl for correct syntax of this value.

This will be used to open the correct help file when left mouse button pressed. Using it we can make a context sensitive helper.

Definition at line 38 of file HelpPushButton.cpp.

Referenced by te::qt::widgets::ContrastWizard::ContrastWizard(), te::qt::widgets::DataExchangerWizard::DataExchangerWizard(), te::qt::widgets::MixtureModelWizard::MixtureModelWizard(), te::qt::widgets::QueryLayerBuilderWizard::QueryLayerBuilderWizard(), te::qt::widgets::RegisterWizard::RegisterWizard(), te::qt::widgets::SegmenterWizard::SegmenterWizard(), and te::qt::plugins::terralib4::TL4ConverterWizard::TL4ConverterWizard().

Member Data Documentation

QString te::qt::widgets::HelpPushButton::m_ns

protected

Namespace being used. (Qt help usage)

Definition at line 91 of file HelpPushButton.h.

QString te::qt::widgets::HelpPushButton::m_pgRef

protected

Stores the reference for the help file to be presented.

Definition at line 90 of file HelpPushButton.h.

---

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

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