gmx::HelpWriterContext::Impl::SharedState Class Reference

Collaboration diagram for gmx::HelpWriterContext::Impl::SharedState:

Description

Shared, non-modifiable state for context objects.

Contents of this structure are shared between all context objects that are created from a common parent. This state should not be modified after construction.

Public Member Functions
	SharedState (TextWriter *writer, HelpOutputFormat format, const HelpLinks *links)
	Initializes the state with the given parameters.
TextTableFormatter &	consoleOptionsFormatter () const
	Returns a formatter for formatting options lists for console output. More...

Public Attributes
TextWriter &	file_
	Writer for writing the help.
HelpOutputFormat	format_
	Output format for the help output.
const HelpLinks *	links_
	Links to use.

Member Function Documentation

TextTableFormatter& gmx::HelpWriterContext::Impl::SharedState::consoleOptionsFormatter ( ) const

inline

Returns a formatter for formatting options lists for console output.

The formatter is lazily initialized on first access.

---

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

• src/gromacs/onlinehelp/helpwritercontext.cpp