#include <gromacs/onlinehelp/helpmanager.h>
Helper for providing interactive online help.
Creates a manager that uses a given root topic.
- Parameters
-
[in] | rootTopic | Help topic that can be accessed through this manager. |
[in] | context | Context object for writing the help. |
- Exceptions
-
std::bad_alloc | if out of memory. |
The provided topic and context objects must remain valid for the lifetime of this manager object.
void gmx::HelpManager::enterTopic |
( |
const char * |
name | ) |
|
Enters a subtopic with the given name under the active topic.
- Parameters
-
[in] | name | Subtopic name to enter. |
- Exceptions
-
void gmx::HelpManager::enterTopic |
( |
const std::string & |
name | ) |
|
Enters a subtopic with the given name under the active topic.
- Parameters
-
[in] | name | Subtopic name to enter. |
- Exceptions
-
void gmx::HelpManager::writeCurrentTopic |
( |
| ) |
const |
Writes out the help for the currently active topic.
- Exceptions
-
std::bad_alloc | if out of memory. |
FileIOError | on any I/O error. |
The documentation for this class was generated from the following files:
- src/gromacs/onlinehelp/helpmanager.h
- src/gromacs/onlinehelp/helpmanager.cpp