Description

Private implementation class for HelpWriterContext.

Classes
class	SharedState
	Shared, non-modifiable state for context objects. More...

Public Types
typedef std::shared_ptr< const SharedState >	StatePointer
	Smart pointer type for managing the shared state.

typedef std::vector< ReplaceItem >	ReplaceList
	Shorthand for a list of markup/other replacements.

Public Member Functions
	Impl (const StatePointer &state, int sectionDepth)
	Initializes the context with the given state and section depth.

	Impl (const Impl &)=default
	Copies the context.

void	addReplacement (const std::string &search, const std::string &replace)
	Adds a new replacement.

std::string	replaceLinks (const std::string &input) const
	Replaces links in a given string.

void	processMarkup (const std::string &text, IWrapper *wrapper) const
	Process markup and wrap lines within a block of text. More...

Public Attributes
StatePointer	state_
	Constant state shared by all child context objects.

ReplaceList	replacements_
	List of markup/other replacements.

int	sectionDepth_
	Number of subsections above this context.

Member Function Documentation

void gmx::HelpWriterContext::Impl::processMarkup	(	const std::string &	text,
		IWrapper *	wrapper
	)		const

Process markup and wrap lines within a block of text.

Parameters

[in]	text	Text to process.
	wrapper	Object used to wrap the text.

The wrapper should take care of either writing the text to output or providing an interface for the caller to retrieve the output.

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