Tool button that uses te::qt::widgets::HelpManager on its mouse pressed implementation. More...
#include <HelpToolButton.h>
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... | |
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.
| te::qt::widgets::HelpToolButton::HelpToolButton | ( | QWidget * | parent = 0 | ) |
Constructor.
| parent | Parent widget, used by Qt. |
Definition at line 34 of file HelpToolButton.cpp.
|
protected |
Overloaded function of QPushButton. Only LEFT button pressed will show the help.
| e | The mouse press event. |
Definition at line 45 of file HelpToolButton.cpp.
References te::common::Singleton< HelpManager >::getInstance(), and m_pgRef.
| void te::qt::widgets::HelpToolButton::setPageReference | ( | const QString & | ref | ) |
Sets the documentation page reference.
| 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 40 of file HelpToolButton.cpp.
References m_pgRef.
|
protected |
Stores the reference for the help file to be presented.
Definition at line 83 of file HelpToolButton.h.
Referenced by mousePressEvent(), and setPageReference().
1.8.11 
