paludis::args::ArgsOption Class Reference

#include <args_option.hh>

Inheritance diagram for paludis::args::ArgsOption:

List of all members.

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
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.

---

Member Function Documentation

void paludis::args::ArgsOption::remove

(

)

Remove this option.

const std::string& paludis::args::ArgsOption::long_name

(

)

const [inline]

Fetch our long name.

char paludis::args::ArgsOption::short_name

(

)

const [inline]

Fetch our short name (may be 0).

const std::string& paludis::args::ArgsOption::description

(

)

const [inline]

Fetch our description.

virtual bool paludis::args::ArgsOption::specified

(

)

const [inline, virtual]

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

Reimplemented in paludis::args::AliasArg.

virtual void paludis::args::ArgsOption::set_specified

(

const bool

value

)

[inline, virtual]

Set the value returned by specified().

Reimplemented in paludis::args::AliasArg.

ArgsGroup* paludis::args::ArgsOption::group

(

)

[inline]

Fetch our group.

virtual bool paludis::args::ArgsOption::can_be_negated

(

)

const [pure virtual]

Can we be negated?

Needs to match up with ArgsVisitor logic.

Implemented in paludis::args::SwitchArg, paludis::args::StringArg, paludis::args::StringSetArg, paludis::args::StringSequenceArg, paludis::args::AliasArg, paludis::args::IntegerArg, and paludis::args::EnumArg.

---

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

• /home/users/ciaranm/work/paludis/paludis/args/args_option.hh