Gromacs  2024.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::anonymous_namespace{helpwritercontext.cpp}::IWrapper Class Referenceabstract
+ Inheritance diagram for gmx::anonymous_namespace{helpwritercontext.cpp}::IWrapper:

Description

Custom output interface for HelpWriterContext::Impl::processMarkup().

Provides an interface that is used to implement different types of output from HelpWriterContext::Impl::processMarkup().

Public Member Functions

virtual TextLineWrapperSettingssettings ()=0
 Provides the wrapping settings. More...
 
virtual void wrap (const std::string &text)=0
 Appends the given string to output.
 

Member Function Documentation

virtual TextLineWrapperSettings& gmx::anonymous_namespace{helpwritercontext.cpp}::IWrapper::settings ( )
pure virtual

Provides the wrapping settings.

HelpWriterContext::Impl::processMarkup() may provide some default values for the settings if they are not set; this is the reason the return value is not const.

Implemented in gmx::anonymous_namespace{helpwritercontext.cpp}::WrapperToVector, and gmx::anonymous_namespace{helpwritercontext.cpp}::WrapperToString.


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