Gromacs  2016.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions

#include <gromacs/onlinehelp/helpmanager.h>

Description

Helper for providing interactive online help.

Public Member Functions

 HelpManager (const IHelpTopic &rootTopic, const HelpWriterContext &context)
 Creates a manager that uses a given root topic. More...
 
void enterTopic (const char *name)
 Enters a subtopic with the given name under the active topic. More...
 
void enterTopic (const std::string &name)
 Enters a subtopic with the given name under the active topic. More...
 
void writeCurrentTopic () const
 Writes out the help for the currently active topic. More...
 

Constructor & Destructor Documentation

gmx::HelpManager::HelpManager ( const IHelpTopic rootTopic,
const HelpWriterContext context 
)

Creates a manager that uses a given root topic.

Parameters
[in]rootTopicHelp topic that can be accessed through this manager.
[in]contextContext object for writing the help.
Exceptions
std::bad_allocif out of memory.

The provided topic and context objects must remain valid for the lifetime of this manager object.

Member Function Documentation

void gmx::HelpManager::enterTopic ( const char *  name)

Enters a subtopic with the given name under the active topic.

Parameters
[in]nameSubtopic name to enter.
Exceptions
std::bad_allodif out of memory.
InvalidInputErrorif topic with name is not found.
void gmx::HelpManager::enterTopic ( const std::string &  name)

Enters a subtopic with the given name under the active topic.

Parameters
[in]nameSubtopic name to enter.
Exceptions
std::bad_allodif out of memory.
InvalidInputErrorif topic with name is not found.
void gmx::HelpManager::writeCurrentTopic ( ) const

Writes out the help for the currently active topic.

Exceptions
std::bad_allocif out of memory.
FileIOErroron any I/O error.

The documentation for this class was generated from the following files: