#include <FormatterFwd.hpp>
|
std::size_t | column_width_ {30} |
| The width of the left column (options/flags/subcommands)
|
std::size_t | right_column_width_ {65} |
| The width of the right column (description of options/flags/subcommands)
|
std::size_t | description_paragraph_width_ {80} |
| The width of the description paragraph at the top of help.
|
std::size_t | footer_paragraph_width_ {80} |
| The width of the footer paragraph.
|
std::map< std::string, std::string > | labels_ {} |
| The required help printout labels (user changeable) Values are Needs, Excludes, etc.
|
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.
◆ FormatterBase() [1/3]
CLI::FormatterBase::FormatterBase |
( |
| ) |
|
|
default |
◆ FormatterBase() [2/3]
◆ FormatterBase() [3/3]
◆ ~FormatterBase()
virtual CLI::FormatterBase::~FormatterBase |
( |
| ) |
|
|
inlinevirtualnoexcept |
Adding a destructor in this form to work around bug in GCC 4.7.
◆ column_width()
void CLI::FormatterBase::column_width |
( |
std::size_t | val | ) |
|
|
inline |
Set the left column width (options/flags/subcommands)
◆ description_paragraph_width()
void CLI::FormatterBase::description_paragraph_width |
( |
std::size_t | val | ) |
|
|
inline |
Set the description paragraph width at the top of help.
◆ footer_paragraph_width()
void CLI::FormatterBase::footer_paragraph_width |
( |
std::size_t | val | ) |
|
|
inline |
Set the footer paragraph width.
◆ get_column_width()
Get the current left column width (options/flags/subcommands)
◆ get_description_paragraph_width()
CLI11_NODISCARD std::size_t CLI::FormatterBase::get_description_paragraph_width |
( |
| ) |
const |
|
inline |
Get the current description paragraph width at the top of help.
◆ get_footer_paragraph_width()
CLI11_NODISCARD std::size_t CLI::FormatterBase::get_footer_paragraph_width |
( |
| ) |
const |
|
inline |
Get the current footer paragraph width.
◆ get_label()
CLI11_NODISCARD std::string CLI::FormatterBase::get_label |
( |
std::string | key | ) |
const |
|
inline |
Get the current value of a name (REQUIRED, etc.)
◆ get_right_column_width()
CLI11_NODISCARD std::size_t CLI::FormatterBase::get_right_column_width |
( |
| ) |
const |
|
inline |
Get the current right column width (description of options/flags/subcommands)
◆ 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 |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ right_column_width()
void CLI::FormatterBase::right_column_width |
( |
std::size_t | val | ) |
|
|
inline |
Set the right column width (description of options/flags/subcommands)
◆ column_width_
std::size_t CLI::FormatterBase::column_width_ {30} |
|
protected |
The width of the left column (options/flags/subcommands)
◆ description_paragraph_width_
std::size_t CLI::FormatterBase::description_paragraph_width_ {80} |
|
protected |
The width of the description paragraph at the top of help.
◆ footer_paragraph_width_
std::size_t CLI::FormatterBase::footer_paragraph_width_ {80} |
|
protected |
The width of the footer paragraph.
◆ labels_
std::map<std::string, std::string> CLI::FormatterBase::labels_ {} |
|
protected |
The required help printout labels (user changeable) Values are Needs, Excludes, etc.
◆ right_column_width_
std::size_t CLI::FormatterBase::right_column_width_ {65} |
|
protected |
The width of the right column (description of options/flags/subcommands)
The documentation for this class was generated from the following file: