CLI::OptionDefaults Class Reference

#include <CLI11.hpp>

Inheritance diagram for CLI::OptionDefaults:

Collaboration 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.
OptionDefaults *	ignore_case (bool value=true)
	Ignore the case of the option name.
OptionDefaults *	ignore_underscore (bool value=true)
	Ignore underscores in the option name.
OptionDefaults *	disable_flag_override (bool value=true)
	Disable overriding flag values with an '=' segment.
OptionDefaults *	delimiter (char value='\0')
	set a delimiter character to split up single arguments to treat as multiple inputs
Public Member Functions inherited from CLI::OptionBase< OptionDefaults >
OptionDefaults *	group (const std::string &name)
	Changes the group membership.
OptionDefaults *	required (bool value=true)
	Set the option as required.
OptionDefaults *	mandatory (bool value=true)
	Support Plumbum term.
OptionDefaults *	always_capture_default (bool value=true)
const std::string &	get_group () const
	Get the group of this option.
bool	get_required () const
	True if this is a required option.
bool	get_ignore_case () const
	The status of ignore case.
bool	get_ignore_underscore () const
	The status of ignore_underscore.
bool	get_configurable () const
	The status of configurable.
bool	get_disable_flag_override () const
	The status of configurable.
char	get_delimiter () const
	Get the current delimiter char.
bool	get_always_capture_default () const
	Return true if this will automatically capture the default value for help printing.
MultiOptionPolicy	get_multi_option_policy () const
	The status of the multi option policy.
OptionDefaults *	take_last ()
	Set the multi option policy to take last.
OptionDefaults *	take_first ()
	Set the multi option policy to take last.
OptionDefaults *	take_all ()
	Set the multi option policy to take all arguments.
OptionDefaults *	join ()
	Set the multi option policy to join.
OptionDefaults *	join (char delim)
	Set the multi option policy to join with a specific delimiter.
OptionDefaults *	configurable (bool value=true)
	Allow in a configuration file.
OptionDefaults *	delimiter (char value='\0')
	Allow in a configuration file.

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)
Protected Attributes inherited from CLI::OptionBase< OptionDefaults >
std::string	group_
	The group membership.
bool	required_
	True if this is a required option.
bool	ignore_case_
	Ignore the case when matching (option, not value)
bool	ignore_underscore_
	Ignore underscores when matching (option, not value)
bool	configurable_
	Allow this option to be given in a configuration file.
bool	disable_flag_override_
	Disable overriding flag values with '=value'.
char	delimiter_
	Specify a delimiter character for vector arguments.
bool	always_capture_default_
	Automatically capture default value.
MultiOptionPolicy	multi_option_policy_
	Policy for handling multiple arguments beyond the expected Max.

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 3495 of file CLI11.hpp.

Constructor & Destructor Documentation

OptionDefaults()

CLI::OptionDefaults::OptionDefaults ( )

default

Member Function Documentation

delimiter()

OptionDefaults * CLI::OptionDefaults::delimiter ( char value = '\0' )

inline

Definition at line 3526 of file CLI11.hpp.

                                                 {
        delimiter_ = value;
        return this;
    }

disable_flag_override()

OptionDefaults * CLI::OptionDefaults::disable_flag_override ( bool value = true )

inline

Definition at line 3520 of file CLI11.hpp.

                                                             {
        disable_flag_override_ = value;
        return this;
    }

ignore_case()

OptionDefaults * CLI::OptionDefaults::ignore_case ( bool value = true )

inline

Definition at line 3508 of file CLI11.hpp.

                                                   {
        ignore_case_ = value;
        return this;
    }

ignore_underscore()

OptionDefaults * CLI::OptionDefaults::ignore_underscore ( bool value = true )

inline

Definition at line 3514 of file CLI11.hpp.

                                                         {
        ignore_underscore_ = value;
        return this;
    }

multi_option_policy()

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

inline

Definition at line 3502 of file CLI11.hpp.

                                                                                          {
        multi_option_policy_ = value;
        return this;
    }

---

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

• programs/clio/CLI11.hpp