Gromacs
2024.4
|
Help topic that forms the root of the help tree for the help subcommand.
Public Member Functions | |
RootHelpTopic (const CommandLineHelpModuleImpl &helpModule) | |
Creates a root help topic. More... | |
const char * | name () const override |
Returns the name of the topic. More... | |
const char * | title () const override |
Returns a title for the topic. More... | |
void | addTopic (HelpTopicPointer topic, bool bExported) |
Adds a top-level topic and optionally marks it as exported. | |
void | exportHelp (IHelpExport *exporter) |
Exports all the top-level topics with the given exporter. | |
void | writeHelp (const HelpWriterContext &context) const override |
Prints the help text for this 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 | writeHelp (const HelpWriterContext &context) const override |
Prints the help text for this topic. 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::AbstractCompositeHelpTopic | |
bool | writeSubTopicList (const HelpWriterContext &context, const std::string &title) const |
Writes the list of subtopics. More... | |
|
inlineexplicit |
Creates a root help topic.
Does not throw.
|
overridevirtual |
Returns the name of the topic.
This should be a single lowercase word, used to identify the topic. It is not used for the root of the help topic tree.
Implements gmx::AbstractCompositeHelpTopic.
|
inlineoverridevirtual |
Returns a title for the topic.
May return NULL, in which case the topic is omitted from normal subtopic lists and no title is printed by the methods provided in helptopic.h.
Implements gmx::AbstractCompositeHelpTopic.
|
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. |
Implements gmx::IHelpTopic.