Inheritance diagram for gmx::anonymous_namespace{selhelp.cpp}::KeywordDetailsHelpTopic:

Collaboration diagram for gmx::anonymous_namespace{selhelp.cpp}::KeywordDetailsHelpTopic:

Description

Help topic implementation for an individual selection method.

Public Member Functions
	KeywordDetailsHelpTopic (const std::string &name, const gmx_ana_selmethod_t &method)
	Initialize help topic for the given selection method.

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...

Member Function Documentation

std::string gmx::anonymous_namespace{selhelp.cpp}::KeywordDetailsHelpTopic::helpText ( ) const

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().

const char* gmx::anonymous_namespace{selhelp.cpp}::KeywordDetailsHelpTopic::name ( ) const

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.

const char* gmx::anonymous_namespace{selhelp.cpp}::KeywordDetailsHelpTopic::title ( ) const

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.

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