Gromacs
2024.4
|
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 IHelpTopic * | findSubTopic (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... | |
|
overridevirtual |
Prints the help text for this topic.
[in] | context | Context object for writing the help. |
std::bad_alloc | if out of memory. |
FileIOError | on any I/O error. |
Reimplemented from gmx::AbstractCompositeHelpTopic.