Base class for a help implementation.
More...
#include <Workspace/Application/helpimplementation.h>
The Workspace allows for the way help is presented to the user to be fully customized. Plugin code issues a request for a given help topic to the PluginManager by calling one of its showHelp() functions. This will be forwarded to the currently set help implementation, if one has been set with a call to setHelpImplementation() (which is usually done at application startup). The most common arrangement is to simply include the workspace-help plugin which will register itself as the help implementation in its setup() function.
◆ ~HelpImplementation()
◆ deregistering()
| virtual void deregistering |
( |
| ) |
|
|
inlinevirtual |
◆ showHelp() [1/3]
| virtual void showHelp |
( |
const QMap< QString, QUrl > & |
links, |
|
|
const QString & |
keyword = "" |
|
) |
| |
|
pure virtual |
◆ showHelp() [2/3]
| virtual void showHelp |
( |
const QString & |
keyword | ) |
|
|
pure virtual |
◆ showHelp() [3/3]
| virtual void showHelp |
( |
const QUrl & |
url | ) |
|
|
pure virtual |
