CLI11
2.5.0
|
#include <FormatterFwd.hpp>
Public Member Functions | |
Basic | |
FormatterBase ()=default | |
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. More... | |
virtual std::string | make_help (const App *, std::string, AppFormatMode) const =0 |
This is the key method that puts together help. More... | |
Setters | |
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... | |
Getters | |
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... | |
Protected Attributes | |
Options | |
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... | |
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.
|
default |
|
default |
|
default |
|
inlinevirtualnoexcept |
Adding a destructor in this form to work around bug in GCC 4.7.
|
inline |
Set the left column width (options/flags/subcommands)
|
inline |
Set the description paragraph width at the top of help.
|
inline |
Set the footer paragraph width.
|
inline |
Get the current left column width (options/flags/subcommands)
|
inline |
Get the current description paragraph width at the top of help.
|
inline |
Get the current footer paragraph width.
|
inline |
Get the current value of a name (REQUIRED, etc.)
|
inline |
Get the current right column width (description of options/flags/subcommands)
|
inline |
Set the "REQUIRED" label.
|
pure virtual |
This is the key method that puts together help.
Implemented in CLI::Formatter, and CLI::FormatterLambda.
|
default |
|
default |
|
inline |
Set the right column width (description of options/flags/subcommands)
|
protected |
The width of the left column (options/flags/subcommands)
|
protected |
The width of the description paragraph at the top of help.
|
protected |
The width of the footer paragraph.
|
protected |
The required help printout labels (user changeable) Values are Needs, Excludes, etc.
|
protected |
The width of the right column (description of options/flags/subcommands)