Facade for a te::qt::widgets::HelpManagerImpl object. More...
#include <HelpManager.h>
Public Member Functions | |
HelpManagerImpl * | getImpl () const |
Returns the pointer to the HelpManagerImpl object being used. More... | |
void | setImpl (HelpManagerImpl *impl) |
Updates the HelpManagerImpl pointer. More... | |
Facade methods | |
Facade for the te::qt::widgets::HelpManagerImpl API.
| |
void | showHelp (const QString &htmRef, const QString &nSpace="") |
Opens the help on the selected page. More... | |
void | appendDoc (const QString &docRef) |
Appends a project of help documentation to the existing collection. More... | |
Static Public Member Functions | |
static HelpManager & | getInstance () |
It returns a reference to the singleton instance. More... | |
Protected Member Functions | |
HelpManager () | |
Protected constructor. Can not be called by clients. More... | |
Protected Attributes | |
HelpManagerImpl * | m_impl |
Pointer to HelpManagerImpl to be used. More... | |
Friends | |
class | te::common::Singleton< HelpManager > |
Facade for a te::qt::widgets::HelpManagerImpl object.
This class holds a pointer to a te::qt::widgets::HelpManagerImpl object. Before use it, the client MUST set the pointer to a valid HelpManagerImpl object. If it was not done, nothing will happen when calling methods neither exceptions will be raised.
Definition at line 53 of file HelpManager.h.
|
protected |
Protected constructor. Can not be called by clients.
Definition at line 52 of file HelpManager.cpp.
void te::qt::widgets::HelpManager::appendDoc | ( | const QString & | docRef | ) |
Appends a project of help documentation to the existing collection.
docRef | Reference to the help project to be appended. |
Definition at line 46 of file HelpManager.cpp.
te::qt::widgets::HelpManagerImpl * te::qt::widgets::HelpManager::getImpl | ( | ) | const |
Returns the pointer to the HelpManagerImpl object being used.
Definition at line 35 of file HelpManager.cpp.
|
staticinherited |
It returns a reference to the singleton instance.
Referenced by te::qt::af::ApplicationController::initialize(), te::qt::widgets::HelpToolButton::mousePressEvent(), te::qt::widgets::HelpPushButton::mousePressEvent(), and TerraView::onHelpTriggered().
void te::qt::widgets::HelpManager::setImpl | ( | HelpManagerImpl * | impl | ) |
Updates the HelpManagerImpl pointer.
Definition at line 30 of file HelpManager.cpp.
References m_impl.
void te::qt::widgets::HelpManager::showHelp | ( | const QString & | htmRef, |
const QString & | nSpace = "" |
||
) |
Opens the help on the selected page.
htmRef | Reference to some page on the help collection. |
nSpace |
Definition at line 40 of file HelpManager.cpp.
Referenced by te::qt::widgets::HelpToolButton::mousePressEvent(), and te::qt::widgets::HelpPushButton::mousePressEvent().
|
friend |
Definition at line 55 of file HelpManager.h.
|
protected |
Pointer to HelpManagerImpl to be used.
Definition at line 101 of file HelpManager.h.
Referenced by setImpl().