This is the minimum requirements to run a formatter. More...

#include <CLI11.hpp>

Inheritance diagram for CLI::FormatterBase:

Public Member Functions
Basic
	FormatterBase ()=default

	FormatterBase (const FormatterBase &)=default

	FormatterBase (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 column width.

Getters
std::string	get_label (std::string key) const
	Get the current value of a name (REQUIRED, etc.)

std::size_t	get_column_width () const
	Get the current column width.

Protected Attributes
Options
std::size_t	column_width_ {30}
	The width of the first column.

std::map< std::string, std::string >	labels_ {}
	The required help printout labels (user changeable) Values are Needs, Excludes, etc. More...

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 Data Documentation

std::map<std::string, std::string> CLI::FormatterBase::labels_ {}

protected

The required help printout labels (user changeable) Values are Needs, Excludes, etc.

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