CLI::FormatterBase Class Reference

#include <FormatterFwd.hpp>

Inheritance diagram for CLI::FormatterBase:

Public Member Functions
Basic
	FormatterBase (const FormatterBase &)=default
	FormatterBase (FormatterBase &&)=default
FormatterBase &	operator= (const FormatterBase &)=default
FormatterBase &	operator= (FormatterBase &&)=default
virtual	~FormatterBase () noexcept
	Adding a destructor in this form to work around bug in GCC 4.7.
virtual std::string	make_help (const App *, std::string, AppFormatMode) const =0
	This is the key method that puts together help.
Setters
void	label (std::string key, std::string val)
	Set the "REQUIRED" label.
void	column_width (std::size_t val)
	Set the left column width (options/flags/subcommands)
void	right_column_width (std::size_t val)
	Set the right column width (description of options/flags/subcommands)
void	description_paragraph_width (std::size_t val)
	Set the description paragraph width at the top of help.
void	footer_paragraph_width (std::size_t val)
	Set the footer paragraph width.
Getters
CLI11_NODISCARD std::string	get_label (std::string key) const
	Get the current value of a name (REQUIRED, etc.)
CLI11_NODISCARD std::size_t	get_column_width () const
	Get the current left column width (options/flags/subcommands)
CLI11_NODISCARD std::size_t	get_right_column_width () const
	Get the current right column width (description of options/flags/subcommands)
CLI11_NODISCARD std::size_t	get_description_paragraph_width () const
	Get the current description paragraph width at the top of help.
CLI11_NODISCARD std::size_t	get_footer_paragraph_width () const
	Get the current footer paragraph width.

Protected Attributes
Options
std::size_t	column_width_ {30}
	The width of the left column (options/flags/subcommands)
std::size_t	right_column_width_ {65}
	The width of the right column (description of options/flags/subcommands)
std::size_t	description_paragraph_width_ {80}
	The width of the description paragraph at the top of help.
std::size_t	footer_paragraph_width_ {80}
	The width of the footer paragraph.
std::map< std::string, std::string >	labels_ {}
	The required help printout labels (user changeable) Values are Needs, Excludes, etc.

Detailed Description

This is the minimum requirements to run a formatter.

A user can subclass this is if they do not care at all about the structure in CLI::Formatter.

Member Function Documentation

make_help()

virtual std::string CLI::FormatterBase::make_help ( const App *  , std::string  , AppFormatMode    ) const

pure virtual

This is the key method that puts together help.

Implemented in CLI::FormatterLambda, and CLI::Formatter.

---

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

• include/CLI/FormatterFwd.hpp