args::HelpFlag Class Reference

Help flag class. More...

#include <args.hxx>

Inheritance diagram for args::HelpFlag:

Public Member Functions
	HelpFlag (Group &group_, const std::string &name_, const std::string &help_, Matcher &&matcher_, Options options_={})
virtual void	ParseValue (const std::vector< std::string > &)
	Parse values of this option. More...
bool	Get () const noexcept
	Get whether this was matched.
Public Member Functions inherited from args::Flag
	Flag (Group &group_, const std::string &name_, const std::string &help_, Matcher &&matcher_, Options options_)
	Flag (Group &group_, const std::string &name_, const std::string &help_, Matcher &&matcher_, const bool extraError_=false)
bool	Get () const
	Get whether this was matched.
virtual Nargs	NumberOfArguments () const noexcept override
	Defines how many values can be consumed by this option. More...
Public Member Functions inherited from args::FlagBase
	FlagBase (const std::string &name_, const std::string &help_, Matcher &&matcher_, const bool extraError_=false)
	FlagBase (const std::string &name_, const std::string &help_, Matcher &&matcher_, Options options_)
virtual FlagBase *	Match (const EitherFlag &flag) override
virtual std::vector< FlagBase * >	GetAllFlags () override
const Matcher &	GetMatcher () const
virtual void	Validate (const std::string &shortPrefix, const std::string &longPrefix) const override
virtual std::vector< std::string >	GetProgramLine (const HelpParams &params) const override
virtual bool	HasFlag () const override
Public Member Functions inherited from args::NamedBase
	NamedBase (const std::string &name_, const std::string &help_, Options options_={})
void	HelpDefault (const std::string &str)
	Sets default value string that will be added to argument description. More...
std::string	HelpDefault (const HelpParams &params) const
	Gets default value string that will be added to argument description.
void	HelpChoices (const std::vector< std::string > &array)
	Sets choices strings that will be added to argument description. More...
std::vector< std::string >	HelpChoices (const HelpParams &params) const
	Gets choices strings that will be added to argument description.
virtual std::vector< std::tuple< std::string, std::string, unsigned > >	GetDescription (const HelpParams &params, const unsigned indentLevel) const override
virtual std::string	Name () const
Public Member Functions inherited from args::Base
	Base (const std::string &help_, Options options_={})
Options	GetOptions () const noexcept
bool	IsRequired () const noexcept
virtual bool	Matched () const noexcept
	operator bool () const noexcept
virtual std::vector< Command * >	GetCommands ()
virtual bool	IsGroup () const
virtual PositionalBase *	GetNextPositional ()
virtual bool	HasPositional () const
virtual bool	HasCommand () const
void	KickOut (bool kickout_) noexcept
	Sets a kick-out value for building subparsers.
bool	KickOut () const noexcept
	Gets the kick-out value for building subparsers.
virtual void	Reset () noexcept

Additional Inherited Members
Protected Member Functions inherited from args::FlagBase
virtual std::string	GetNameString (const HelpParams &params) const override
Protected Member Functions inherited from args::NamedBase
virtual std::string	GetDefaultString (const HelpParams &) const
virtual std::vector< std::string >	GetChoicesStrings (const HelpParams &) const
void	AddDescriptionPostfix (std::string &dest, const bool isManual, const std::string &manual, bool isGenerated, const std::string &generated, const std::string &str) const
Protected Attributes inherited from args::FlagBase
const Matcher	matcher
Protected Attributes inherited from args::NamedBase
const std::string	name
bool	kickout = false
std::string	defaultString
bool	defaultStringManual = false
std::vector< std::string >	choicesStrings
bool	choicesStringManual = false
Protected Attributes inherited from args::Base
bool	matched = false
const std::string	help

Detailed Description

Help flag class.

Works like a regular flag, but throws an instance of Help when it is matched

Member Function Documentation

ParseValue()

virtual void args::HelpFlag::ParseValue ( const std::vector< std::string > &  value )

inlinevirtual

Parse values of this option.

Parameters

value

Vector of values. It's size must be in NumberOfArguments() interval.

Reimplemented from args::Flag.

---

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

• args.hxx