#include <CLI11.hpp>
|
template<typename T > |
void | copy_to (T *other) const |
| Copy the contents to another similar class (one based on OptionBase) More...
|
|
template<typename CRTP>
class CLI::OptionBase< CRTP >
This is the CRTP base class for Option and OptionDefaults. It was designed this way to share parts of the class; an OptionDefaults can copy to an Option.
Definition at line 2677 of file CLI11.hpp.
◆ always_capture_default()
CRTP* always_capture_default |
( |
bool |
value = true | ) |
|
|
inline |
◆ configurable()
CRTP* configurable |
( |
bool |
value = true | ) |
|
|
inline |
Allow in a configuration file.
Definition at line 2797 of file CLI11.hpp.
◆ copy_to()
void copy_to |
( |
T * |
other | ) |
const |
|
inlineprotected |
◆ delimiter()
CRTP* delimiter |
( |
char |
value = '\0' | ) |
|
|
inline |
Allow in a configuration file.
Definition at line 2803 of file CLI11.hpp.
◆ get_always_capture_default()
bool get_always_capture_default |
( |
| ) |
const |
|
inline |
Return true if this will automatically capture the default value for help printing.
Definition at line 2768 of file CLI11.hpp.
◆ get_configurable()
bool get_configurable |
( |
| ) |
const |
|
inline |
The status of configurable.
Definition at line 2759 of file CLI11.hpp.
◆ get_delimiter()
char get_delimiter |
( |
| ) |
const |
|
inline |
Get the current delimeter char.
Definition at line 2765 of file CLI11.hpp.
◆ get_disable_flag_override()
bool get_disable_flag_override |
( |
| ) |
const |
|
inline |
The status of configurable.
Definition at line 2762 of file CLI11.hpp.
◆ get_group()
const std::string& get_group |
( |
| ) |
const |
|
inline |
Get the group of this option.
Definition at line 2747 of file CLI11.hpp.
◆ get_ignore_case()
bool get_ignore_case |
( |
| ) |
const |
|
inline |
The status of ignore case.
Definition at line 2753 of file CLI11.hpp.
◆ get_ignore_underscore()
bool get_ignore_underscore |
( |
| ) |
const |
|
inline |
The status of ignore_underscore.
Definition at line 2756 of file CLI11.hpp.
◆ get_multi_option_policy()
The status of the multi option policy.
Definition at line 2771 of file CLI11.hpp.
◆ get_required()
bool get_required |
( |
| ) |
const |
|
inline |
True if this is a required option.
Definition at line 2750 of file CLI11.hpp.
◆ group()
CRTP* group |
( |
std::string |
name | ) |
|
|
inline |
Changes the group membership.
Definition at line 2725 of file CLI11.hpp.
◆ join()
Set the multi option policy to take last.
Definition at line 2790 of file CLI11.hpp.
◆ mandatory()
CRTP* mandatory |
( |
bool |
value = true | ) |
|
|
inline |
◆ required()
CRTP* required |
( |
bool |
value = true | ) |
|
|
inline |
Set the option as required.
Definition at line 2731 of file CLI11.hpp.
◆ take_first()
Set the multi option policy to take last.
Definition at line 2783 of file CLI11.hpp.
◆ take_last()
Set the multi option policy to take last.
Definition at line 2776 of file CLI11.hpp.
◆ always_capture_default_
bool always_capture_default_ {false} |
|
protected |
Automatically capture default value.
Definition at line 2703 of file CLI11.hpp.
◆ App
◆ configurable_
bool configurable_ {true} |
|
protected |
Allow this option to be given in a configuration file.
Definition at line 2694 of file CLI11.hpp.
◆ delimiter_
Specify a delimiter character for vector arguments.
Definition at line 2700 of file CLI11.hpp.
◆ disable_flag_override_
bool disable_flag_override_ {false} |
|
protected |
Disable overriding flag values with '=value'.
Definition at line 2697 of file CLI11.hpp.
◆ group_
std::string group_ = std::string("Options") |
|
protected |
◆ ignore_case_
bool ignore_case_ {false} |
|
protected |
Ignore the case when matching (option, not value)
Definition at line 2688 of file CLI11.hpp.
◆ ignore_underscore_
bool ignore_underscore_ {false} |
|
protected |
Ignore underscores when matching (option, not value)
Definition at line 2691 of file CLI11.hpp.
◆ multi_option_policy_
Policy for multiple arguments when expected_ == 1
(can be set on bool flags, too)
Definition at line 2706 of file CLI11.hpp.
◆ required_
True if this is a required option.
Definition at line 2685 of file CLI11.hpp.
The documentation for this class was generated from the following file: