#include <Option.hpp>
Inheritance diagram for CLI::OptionDefaults:
Public Member Functions | |
| OptionDefaults ()=default | |
| OptionDefaults * | multi_option_policy (MultiOptionPolicy value=MultiOptionPolicy::Throw) |
| Take the last argument if given multiple times. More... | |
| OptionDefaults * | ignore_case (bool value=true) |
| Ignore the case of the option name. More... | |
| OptionDefaults * | ignore_underscore (bool value=true) |
| Ignore underscores in the option name. More... | |
| OptionDefaults * | disable_flag_override (bool value=true) |
| Disable overriding flag values with an '=' segment. More... | |
| OptionDefaults * | delimiter (char value='\0') |
| set a delimiter character to split up single arguments to treat as multiple inputs More... | |
 Public Member Functions inherited from CLI::OptionBase< OptionDefaults > | |
| OptionDefaults * | group (const std::string &name) |
| Changes the group membership. More... | |
| OptionDefaults * | required (bool value=true) |
| Set the option as required. More... | |
| OptionDefaults * | mandatory (bool value=true) |
| Support Plumbum term. More... | |
| OptionDefaults * | always_capture_default (bool value=true) |
| const std::string & | get_group () const |
| Get the group of this option. More... | |
| bool | get_required () const |
| True if this is a required option. More... | |
| bool | get_ignore_case () const |
| The status of ignore case. More... | |
| bool | get_ignore_underscore () const |
| The status of ignore_underscore. More... | |
| bool | get_configurable () const |
| The status of configurable. More... | |
| bool | get_disable_flag_override () const |
| The status of configurable. More... | |
| char | get_delimiter () const |
| Get the current delimiter char. More... | |
| bool | get_always_capture_default () const |
| Return true if this will automatically capture the default value for help printing. More... | |
| MultiOptionPolicy | get_multi_option_policy () const |
| The status of the multi option policy. More... | |
| OptionDefaults * | take_last () |
| Set the multi option policy to take last. More... | |
| OptionDefaults * | take_first () |
| Set the multi option policy to take last. More... | |
| OptionDefaults * | take_all () |
| Set the multi option policy to take all arguments. More... | |
| OptionDefaults * | join () |
| Set the multi option policy to join. More... | |
| OptionDefaults * | join (char delim) |
| Set the multi option policy to join with a specific delimiter. More... | |
| OptionDefaults * | configurable (bool value=true) |
| Allow in a configuration file. More... | |
| OptionDefaults * | delimiter (char value='\0') |
| Allow in a configuration file. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from CLI::OptionBase< OptionDefaults > | |
| void | copy_to (T *other) const |
| Copy the contents to another similar class (one based on OptionBase) More... | |
| Protected Attributes inherited from CLI::OptionBase< OptionDefaults > | |
| std::string | group_ |
| The group membership. More... | |
| bool | required_ |
| True if this is a required option. More... | |
| bool | ignore_case_ |
| Ignore the case when matching (option, not value) More... | |
| bool | ignore_underscore_ |
| Ignore underscores when matching (option, not value) More... | |
| bool | configurable_ |
| Allow this option to be given in a configuration file. More... | |
| bool | disable_flag_override_ |
| Disable overriding flag values with '=value'. More... | |
| char | delimiter_ |
| Specify a delimiter character for vector arguments. More... | |
| bool | always_capture_default_ |
| Automatically capture default value. More... | |
| MultiOptionPolicy | multi_option_policy_ |
| Policy for handling multiple arguments beyond the expected Max. More... | |
Detailed Description
This is a version of OptionBase that only supports setting values, for defaults. It is stored as the default option in an App.
Constructor & Destructor Documentation
◆ OptionDefaults()
|
default |
Member Function Documentation
◆ delimiter()
|
inline |
set a delimiter character to split up single arguments to treat as multiple inputs
◆ disable_flag_override()
|
inline |
Disable overriding flag values with an '=' segment.
◆ ignore_case()
|
inline |
Ignore the case of the option name.
◆ ignore_underscore()
|
inline |
Ignore underscores in the option name.
◆ multi_option_policy()
|
inline |
Take the last argument if given multiple times.
The documentation for this class was generated from the following file:
- include/CLI/Option.hpp
