gmx::SimpleHelpTopic< HelpText > Class Template Reference

#include <gromacs/onlinehelp/helptopic.h>

Inheritance diagram for gmx::SimpleHelpTopic< HelpText >:

Collaboration diagram for gmx::SimpleHelpTopic< HelpText >:

Description

template<class HelpText>
class gmx::SimpleHelpTopic< HelpText >

Template for simple implementation of AbstractSimpleHelpTopic.

Template Parameters

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:

  struct ExampleHelpText
  {
      static const char name[];
      static const char title[];
      static const char *const text[];
  };

  const char ExampleHelpText::name[] = "example";
  const char ExampleHelpText::title[] =
      "Example title";
  const char *const ExampleHelpText::text[] = {
      "Text for the topic.",
      "More text for the topic."
  };

  typedef SimpleHelpTopic<ExampleHelpText> ExampleHelpTopic;
* 

Public Member Functions
virtual const char *	name () const
	Returns the name of the topic. More...
virtual const char *	title () const
	Returns a title for the topic. More...
Public Member Functions inherited from gmx::AbstractSimpleHelpTopic
virtual bool	hasSubTopics () const
	Returns whether the topic has any subtopics.
virtual const IHelpTopic *	findSubTopic (const char *name) const
	Finds a subtopic by name. More...
virtual void	writeHelp (const HelpWriterContext &context) const
	Prints the help text for this topic. More...

Protected Member Functions
virtual std::string	helpText () const
	Returns the help text for this topic. More...

Member Function Documentation

template<class HelpText >

virtual std::string gmx::SimpleHelpTopic< HelpText >::helpText ( ) const

inlineprotectedvirtual

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.

template<class HelpText >

virtual const char* gmx::SimpleHelpTopic< HelpText >::name ( ) const

inlinevirtual

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.

template<class HelpText >

virtual const char* gmx::SimpleHelpTopic< HelpText >::title ( ) const

inlinevirtual

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.

---

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

• src/gromacs/onlinehelp/helptopic.h