CLI::FormatterBase Class Reference

#include <CLI11.hpp>

Inheritance diagram for CLI::FormatterBase:

Collaboration 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.

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.

Constructor & Destructor Documentation

FormatterBase() [1/3]

CLI::FormatterBase::FormatterBase ( )

default

FormatterBase() [2/3]

CLI::FormatterBase::FormatterBase ( const FormatterBase &  )

default

FormatterBase() [3/3]

CLI::FormatterBase::FormatterBase ( FormatterBase &&  )

default

~FormatterBase()

virtual CLI::FormatterBase::~FormatterBase ( )

inlinevirtualnoexcept

Adding a destructor in this form to work around bug in GCC 4.7.

Member Function Documentation

column_width()

void CLI::FormatterBase::column_width ( std::size_t  val )

inline

Set the column width.

get_column_width()

std::size_t CLI::FormatterBase::get_column_width ( ) const

inline

Get the current column width.

get_label()

std::string CLI::FormatterBase::get_label ( std::string  key ) const

inline

Get the current value of a name (REQUIRED, etc.)

label()

void CLI::FormatterBase::label ( std::string  key, std::string  val  )

inline

Set the "REQUIRED" label.

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::Formatter, and CLI::FormatterLambda.

Member Data Documentation

column_width_

std::size_t CLI::FormatterBase::column_width_ {30}

protected

The width of the first column.

labels_

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:

• CLI11.hpp