Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::anonymous_namespace{selhelp.cpp}::KeywordsHelpTopic Class Reference
+ Inheritance diagram for gmx::anonymous_namespace{selhelp.cpp}::KeywordsHelpTopic:
+ Collaboration diagram for gmx::anonymous_namespace{selhelp.cpp}::KeywordsHelpTopic:

Description

Custom help topic for printing a list of selection keywords.

Public Member Functions

void writeHelp (const HelpWriterContext &context) const override
 Prints the help text for this topic. More...
 
- Public Member Functions inherited from gmx::CompositeHelpTopic< KeywordsHelpText >
const char * name () const override
 Returns the name of the topic. More...
 
const char * title () const override
 Returns a title for the topic. More...
 
- Public Member Functions inherited from gmx::AbstractCompositeHelpTopic
bool hasSubTopics () const override
 Returns whether the topic has any subtopics.
 
const IHelpTopicfindSubTopic (const char *name) const override
 Finds a subtopic by name. More...
 
void addSubTopic (HelpTopicPointer topic)
 Adds a given topic as a subtopic of this topic. More...
 
template<class Topic >
void registerSubTopic ()
 Registers a subtopic of a certain type to this topic. More...
 

Additional Inherited Members

- Protected Member Functions inherited from gmx::CompositeHelpTopic< KeywordsHelpText >
std::string helpText () const override
 Returns the help text for this topic. More...
 
- Protected Member Functions inherited from gmx::AbstractCompositeHelpTopic
bool writeSubTopicList (const HelpWriterContext &context, const std::string &title) const
 Writes the list of subtopics. More...
 

Member Function Documentation

void gmx::anonymous_namespace{selhelp.cpp}::KeywordsHelpTopic::writeHelp ( const HelpWriterContext context) const
overridevirtual

Prints the help text for this topic.

Parameters
[in]contextContext object for writing the help.
Exceptions
std::bad_allocif out of memory.
FileIOErroron any I/O error.

Reimplemented from gmx::AbstractCompositeHelpTopic.


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