CLI11
C++11 Command Line Interface Parser
Loading...
Searching...
No Matches
List of all members
CLI::FormatterBase Class Referenceabstract

#include <FormatterFwd.hpp>

Inheritance diagram for CLI::FormatterBase:
CLI::Formatter CLI::FormatterLambda

Public Member Functions

Basic
 FormatterBase (const FormatterBase &)=default
 
 FormatterBase (FormatterBase &&)=default
 
FormatterBaseoperator= (const FormatterBase &)=default
 
FormatterBaseoperator= (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
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 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.

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


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