paludis::args::ArgsOption Class Reference

#include <args_option.hh>

Inheritance diagram for paludis::args::ArgsOption:

paludis::args::AliasArg paludis::args::EnumArg paludis::args::IntegerArg paludis::args::StringArg paludis::args::StringSequenceArg paludis::args::StringSetArg paludis::args::SwitchArg paludis::args::DepsOptionArg paludis::args::LogLevelArg

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)
ArgsGroupgroup ()
virtual bool can_be_negated () const =0
virtual const std::string forwardable_string () 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.


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.

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.

Since:
0.40

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:
Generated on Mon Sep 21 10:36:12 2009 for paludis by  doxygen 1.5.4