Scarab  v3.2.3
Project 8 C++ Utility Library
Public Member Functions | List of all members
OptionDefaults Class Reference

#include <CLI11.hpp>

Inheritance diagram for OptionDefaults:
Inheritance graph

Public Member Functions

 OptionDefaults ()=default
 
OptionDefaultsmulti_option_policy (MultiOptionPolicy value=MultiOptionPolicy::Throw)
 Take the last argument if given multiple times. More...
 
OptionDefaultsignore_case (bool value=true)
 Ignore the case of the option name. More...
 
OptionDefaultsignore_underscore (bool value=true)
 Ignore underscores in the option name. More...
 
OptionDefaultsdisable_flag_override (bool value=true)
 Disable overriding flag values with an '=' segment. More...
 
OptionDefaultsdelimiter (char value='\0')
 set a delimiter character to split up single arguments to treat as multiple inputs More...
 
- Public Member Functions inherited from OptionBase< OptionDefaults >
OptionDefaultsgroup (std::string name)
 Changes the group membership. More...
 
OptionDefaultsrequired (bool value=true)
 Set the option as required. More...
 
OptionDefaultsmandatory (bool value=true)
 Support Plumbum term. More...
 
OptionDefaultsalways_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 delimeter 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...
 
OptionDefaultstake_last ()
 Set the multi option policy to take last. More...
 
OptionDefaultstake_first ()
 Set the multi option policy to take last. More...
 
OptionDefaultsjoin ()
 Set the multi option policy to take last. More...
 
OptionDefaultsconfigurable (bool value=true)
 Allow in a configuration file. More...
 
OptionDefaultsdelimiter (char value='\0')
 Allow in a configuration file. More...
 

Additional Inherited Members

- Protected Member Functions inherited from OptionBase< OptionDefaults >
void copy_to (T *other) const
 Copy the contents to another similar class (one based on OptionBase) More...
 
- Protected Attributes inherited from 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 multiple arguments when expected_ == 1 (can be set on bool flags, too) 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.

Definition at line 2811 of file CLI11.hpp.

Constructor & Destructor Documentation

◆ OptionDefaults()

OptionDefaults ( )
default

Member Function Documentation

◆ delimiter()

OptionDefaults* delimiter ( char  value = '\0')
inline

set a delimiter character to split up single arguments to treat as multiple inputs

Definition at line 2842 of file CLI11.hpp.

◆ disable_flag_override()

OptionDefaults* disable_flag_override ( bool  value = true)
inline

Disable overriding flag values with an '=' segment.

Definition at line 2836 of file CLI11.hpp.

◆ ignore_case()

OptionDefaults* ignore_case ( bool  value = true)
inline

Ignore the case of the option name.

Definition at line 2824 of file CLI11.hpp.

◆ ignore_underscore()

OptionDefaults* ignore_underscore ( bool  value = true)
inline

Ignore underscores in the option name.

Definition at line 2830 of file CLI11.hpp.

◆ multi_option_policy()

OptionDefaults* multi_option_policy ( MultiOptionPolicy  value = MultiOptionPolicy::Throw)
inline

Take the last argument if given multiple times.

Definition at line 2818 of file CLI11.hpp.


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