Gromacs  2016.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions
gmx::AbstractCompositeHelpTopic Class Referenceabstract

#include <gromacs/onlinehelp/helptopic.h>

+ Inheritance diagram for gmx::AbstractCompositeHelpTopic:
+ Collaboration diagram for gmx::AbstractCompositeHelpTopic:

Description

Abstract base class for help topics that have simple text and subtopics.

This class implements an internal container for subtopics and provides public methods for adding subtopics (as IHelpTopic objects). Subtopic-related methods from IHelpTopic are implemented to access the internal container. writeHelp() is also implemented such that it uses HelpTopicContext::writeTextBlock() to write out the text returned by a new virtual method helpText(), and a list of subtopics is written after the actual text.

See Also
CompositeHelpTopic

Public Member Functions

virtual const char * name () const =0
 Returns the name of the topic. More...
 
virtual const char * title () const =0
 Returns a title for the topic. More...
 
virtual bool hasSubTopics () const
 Returns whether the topic has any subtopics.
 
virtual const IHelpTopicfindSubTopic (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...
 
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...
 

Protected Member Functions

virtual std::string helpText () const =0
 Returns the help text for this topic. More...
 
bool writeSubTopicList (const HelpWriterContext &context, const std::string &title) const
 Writes the list of subtopics. More...
 

Member Function Documentation

void gmx::AbstractCompositeHelpTopic::addSubTopic ( HelpTopicPointer  topic)

Adds a given topic as a subtopic of this topic.

Parameters
topicTopis to add.
Exceptions
std::bad_allocif out of memory.

This topic takes ownership of the object.

See Also
registerSubTopic()
const IHelpTopic * gmx::AbstractCompositeHelpTopic::findSubTopic ( const char *  name) const
virtual

Finds a subtopic by name.

Parameters
[in]nameName of subtopic to find.
Returns
Pointer to the found subtopic, or NULL if matching topic is not found.

Implements gmx::IHelpTopic.

virtual std::string gmx::AbstractCompositeHelpTopic::helpText ( ) const
protectedpure virtual

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

Implemented in gmx::CompositeHelpTopic< HelpText >.

virtual const char* gmx::AbstractCompositeHelpTopic::name ( ) const
pure virtual

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

Implemented in gmx::CompositeHelpTopic< HelpText >.

template<class Topic >
void gmx::AbstractCompositeHelpTopic::registerSubTopic ( )
inline

Registers a subtopic of a certain type to this topic.

Template Parameters
TopicType of topic to register.
Exceptions
std::bad_allocif out of memory.

Topic must be default-constructible and implement IHelpTopic.

This method is provided as a convenient alternative to addSubTopic() for cases where each topic is implemented by a different type (which is a common case outside unit tests).

virtual const char* gmx::AbstractCompositeHelpTopic::title ( ) const
pure virtual

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

Implemented in gmx::CompositeHelpTopic< HelpText >.

void gmx::AbstractCompositeHelpTopic::writeHelp ( const HelpWriterContext context) const
virtual

Prints the help text for this topic.

Parameters
[in]contextContext object for writing the help.
Exceptions
std::bad_allocif out of memory.
FileIOErroron any I/O error.

Implements gmx::IHelpTopic.

bool gmx::AbstractCompositeHelpTopic::writeSubTopicList ( const HelpWriterContext context,
const std::string &  title 
) const
protected

Writes the list of subtopics.

Parameters
[in]contextContext for writing the help.
[in]titleTitle for the written list.
Returns
true if anything was printed.
Exceptions
std::bad_allocif out of memory.
FileIOErroron any I/O error.

Subtopics with empty titles are skipped from the list. If there would be no subtopics in the list, title is not printed either.

This method is provided for cases where helpText() does not provide the needed flexibility and the derived class needs to override writeHelp(). This method can then be called to print the same subtopic list that is printed by the default writeHelp() implementation.


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