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

Inheritance diagram for te::qt::widgets::HelpToolButton:

Public Member Functions
	HelpToolButton (QWidget *parent=0)
	Constructor. 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_pgRef
	Stores the reference for the help file to be presented. More...

Detailed Description

Tool 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 HelpToolButton.h.

Constructor & Destructor Documentation

te::qt::widgets::HelpToolButton::HelpToolButton ( QWidget * parent = 0 )

Constructor.

Parameters

parent Parent widget, used by Qt.

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

protected

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

Parameters

e	The mouse press event.

void te::qt::widgets::HelpToolButton::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.

QString te::qt::widgets::HelpToolButton::m_pgRef

protected

Stores the reference for the help file to be presented.

Definition at line 83 of file HelpToolButton.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/HelpToolButton.h