#include <gromacs/onlinehelp/helpmanager.h>

Description

Helper for providing interactive online help.

Classes
class	Impl
	Private implementation class for HelpManager. More...

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]	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

std::bad_allod	if out of memory.
InvalidInputError	if 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] name Subtopic name to enter.

Exceptions

std::bad_allod	if out of memory.
InvalidInputError	if topic with `name` is not found.

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: