CLI11  2.5.0
Public Member Functions | List of all members
CLI::FormatterLambda Class Referencefinal

This is a specialty override for lambda functions. More...

#include <FormatterFwd.hpp>

Inheritance diagram for CLI::FormatterLambda:
Inheritance graph
[legend]
Collaboration diagram for CLI::FormatterLambda:
Collaboration graph
[legend]

Public Member Functions

 FormatterLambda (funct_t funct)
 Create a FormatterLambda with a lambda function. More...
 
 ~FormatterLambda () noexcept override
 Adding a destructor (mostly to make GCC 4.7 happy) More...
 
std::string make_help (const App *app, std::string name, AppFormatMode mode) const override
 This will simply call the lambda function. More...
 
- Public Member Functions inherited from CLI::FormatterBase
 FormatterBase ()=default
 
 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. More...
 
void label (std::string key, std::string val)
 Set the "REQUIRED" label. More...
 
void column_width (std::size_t val)
 Set the left column width (options/flags/subcommands) More...
 
void right_column_width (std::size_t val)
 Set the right column width (description of options/flags/subcommands) More...
 
void description_paragraph_width (std::size_t val)
 Set the description paragraph width at the top of help. More...
 
void footer_paragraph_width (std::size_t val)
 Set the footer paragraph width. More...
 
CLI11_NODISCARD std::string get_label (std::string key) const
 Get the current value of a name (REQUIRED, etc.) More...
 
CLI11_NODISCARD std::size_t get_column_width () const
 Get the current left column width (options/flags/subcommands) More...
 
CLI11_NODISCARD std::size_t get_right_column_width () const
 Get the current right column width (description of options/flags/subcommands) More...
 
CLI11_NODISCARD std::size_t get_description_paragraph_width () const
 Get the current description paragraph width at the top of help. More...
 
CLI11_NODISCARD std::size_t get_footer_paragraph_width () const
 Get the current footer paragraph width. More...
 

Additional Inherited Members

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

Detailed Description

This is a specialty override for lambda functions.

Constructor & Destructor Documentation

CLI::FormatterLambda::FormatterLambda ( funct_t  funct)
inlineexplicit

Create a FormatterLambda with a lambda function.

CLI::FormatterLambda::~FormatterLambda ( )
inlineoverridenoexcept

Adding a destructor (mostly to make GCC 4.7 happy)

Member Function Documentation

std::string CLI::FormatterLambda::make_help ( const App app,
std::string  name,
AppFormatMode  mode 
) const
inlineoverridevirtual

This will simply call the lambda function.

Implements CLI::FormatterBase.


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