All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
te::qt::widgets::HelpToolButton Class Reference
Widgets

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

#include <HelpToolButton.h>

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
parentParent widget, used by Qt.

Definition at line 34 of file HelpToolButton.cpp.

Member Function Documentation

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

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

Parameters
eThe mouse press event.

Definition at line 45 of file HelpToolButton.cpp.

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

void te::qt::widgets::HelpToolButton::setPageReference ( const QString &  ref)

Sets the documentation page reference.

Parameters
refReference 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 40 of file HelpToolButton.cpp.

Member Data Documentation

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 files: