paludis::args::SwitchArg Class Reference

#include <args_option.hh>

Inheritance diagram for paludis::args::SwitchArg:

List of all members.

Public Member Functions
	SwitchArg (ArgsGroup *const group, const std::string &long_name, char short_name, const std::string &description, const bool can_be_negated)
virtual bool	can_be_negated () const
virtual const std::string	forwardable_string () const PALUDIS_ATTRIBUTE((warn_unused_result))

---

Detailed Description

A SwitchArg is an option that can either be specified or not specified, and that takes no value (for example, --help).

---

Constructor & Destructor Documentation

paludis::args::SwitchArg::SwitchArg	(	ArgsGroup *const	group,
		const std::string &	long_name,
		char	short_name,
		const std::string &	description,
		const bool	can_be_negated
	)

Constructor.

Since:

0.26

---

Member Function Documentation

virtual bool paludis::args::SwitchArg::can_be_negated

(

)

const [virtual]

Can we be negated?

Needs to match up with ArgsVisitor logic.

Implements paludis::args::ArgsOption.

virtual const std::string paludis::args::SwitchArg::forwardable_string

(

)

const [virtual]

Ourself as a forwardable string.

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

Since:

0.40

Implements paludis::args::ArgsOption.

---

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

• /GNOME1/NEU1/P/paludis-0.40.1/paludis/args/args_option.hh

---