Gromacs
2024.4
|
#include <gromacs/onlinehelp/helptopic.h>
Template for simple implementation of AbstractSimpleHelpTopic.
HelpText | Struct that defines the data for the topic. |
HelpText
should have public static members "const char name[]"
, "const char title[]"
and "const char *const text[]"
.
Typical use:
Public Member Functions | |
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::AbstractSimpleHelpTopic | |
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... | |
Protected Member Functions | |
std::string | helpText () const override |
Returns the help text for this topic. More... | |
|
inlineoverrideprotectedvirtual |
Returns the help text for this topic.
writeHelp() calls this method to obtain the actual text to format for the topic. Markup substitution etc. is done automatically by writeHelp().
Implements gmx::AbstractSimpleHelpTopic.
|
inlineoverridevirtual |
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::AbstractSimpleHelpTopic.
|
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::AbstractSimpleHelpTopic.