Inheritance diagram for gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::RootHelpTopic:

Collaboration diagram for gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::RootHelpTopic:

Description

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

virtual const char *	name () const
	Returns the name of the topic. More...

virtual const char *	title () const
	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.

virtual void	writeHelp (const HelpWriterContext &context) const
	Prints the help text for this topic. More...

Public Member Functions inherited from gmx::AbstractCompositeHelpTopic
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...

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

Constructor & Destructor Documentation

gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::RootHelpTopic::RootHelpTopic ( const CommandLineHelpModuleImpl & helpModule )

inlineexplicit

Creates a root help topic.

Does not throw.

const char * gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::RootHelpTopic::name ( ) const

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.

virtual const char* gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::RootHelpTopic::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.

void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::RootHelpTopic::writeHelp ( const HelpWriterContext & context ) const

virtual

Prints the help text for this topic.

Parameters

[in] context Context object for writing the help.

Exceptions

std::bad_alloc	if out of memory.
FileIOError	on any I/O error.

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