helptopic.h File Reference

#include <memory>
#include <string>
#include "gromacs/onlinehelp/ihelptopic.h"
#include "gromacs/utility/stringutil.h"

Include dependency graph for helptopic.h:

This graph shows which files directly or indirectly include this file:

Description

Declares helper classes for implementing gmx::IHelpTopic.

Author

Teemu Murtola teemu.nosp@m..mur.nosp@m.tola@.nosp@m.gmai.nosp@m.l.com

Classes
class	gmx::AbstractSimpleHelpTopic
	Abstract base class for help topics that have simple text and no subtopics. More...
class	gmx::AbstractCompositeHelpTopic
	Abstract base class for help topics that have simple text and subtopics. More...
class	gmx::SimpleHelpTopic< HelpText >
	Template for simple implementation of AbstractSimpleHelpTopic. More...
class	gmx::CompositeHelpTopic< HelpText >
	Template for simple implementation of AbstractCompositeHelpTopic. More...

Typedefs
typedef std::unique_ptr < AbstractCompositeHelpTopic >	gmx::CompositeHelpTopicPointer
	Smart pointer type to manage a AbstractCompositeHelpTopic object.