Inheritance diagram for paludis::args::ArgsOption:

Public Member Functions
void	remove ()
const std::string &	long_name () const
char	short_name () const
const std::string &	description () const
virtual bool	specified () const
virtual void	set_specified (const bool value)
ArgsGroup *	group ()
virtual bool	can_be_negated () const =0
virtual const std::string	forwardable_string () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual const std::shared_ptr < Sequence< std::string > >	forwardable_args () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
Protected Member Functions
	ArgsOption (ArgsGroup *const, const std::string &long_name, const char short_name, const std::string &description)
virtual	~ArgsOption ()
Friends
class	ArgsHandler

Detailed Description

Base class for a command line option.

Constructor & Destructor Documentation

paludis::args::ArgsOption::ArgsOption	(	ArgsGroup *	const,
		const std::string &	long_name,
		const char	short_name,
		const std::string &	description
	)			`[protected]`

Constructor.

virtual paludis::args::ArgsOption::~ArgsOption ( ) [protected, virtual]

Destructor.

virtual bool paludis::args::ArgsOption::can_be_negated ( ) const [pure virtual]

Can we be negated?

Needs to match up with ArgsVisitor logic.

const std::string& paludis::args::ArgsOption::description ( ) const [inline]

Fetch our description.

virtual const std::shared_ptr<Sequence<std::string> > paludis::args::ArgsOption::forwardable_args ( ) const [pure virtual]

Ourself as a sequence of strings.

For example, { '--foo', 'bar' } or { '--foo', 'bar', '--foo', 'baz' } if not specified, an empty sequence.

virtual const std::string paludis::args::ArgsOption::forwardable_string ( ) const [pure virtual]

Ourself as a forwardable string.

For example, '--foo bar' or '--foo bar --foo baz' or '--foo', or if not specified, the empty string.

ArgsGroup* paludis::args::ArgsOption::group ( ) [inline]

Fetch our group.

const std::string& paludis::args::ArgsOption::long_name ( ) const [inline]

Fetch our long name.

void paludis::args::ArgsOption::remove ( )

Remove this option. Removes our group from its section if the group would be left empty.

virtual void paludis::args::ArgsOption::set_specified ( const bool value ) [inline, virtual]

Set the value returned by specified().

char paludis::args::ArgsOption::short_name ( ) const [inline]

Fetch our short name (may be 0).

virtual bool paludis::args::ArgsOption::specified ( ) const [inline, virtual]

Fetch whether or not we were specified on the command line.

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