paludis::args::StringArg Class Reference

#include <args_option.hh>

Inheritance diagram for paludis::args::StringArg:

paludis::args::ArgsOption

List of all members.

Public Member Functions

 StringArg (ArgsGroup *const, const std::string &long_name, const char short_name, const std::string &description)
 StringArg (ArgsGroup *const, const std::string &long_name, const char short_name, const std::string &description, void(*validator)(const std::string &))
const std::string & argument () const
void set_argument (const std::string &arg)
virtual bool can_be_negated () const
virtual const std::string forwardable_string () const PALUDIS_ATTRIBUTE((warn_unused_result))


Detailed Description

An option that takes a string argument.

Constructor & Destructor Documentation

paludis::args::StringArg::StringArg ( ArgsGroup const,
const std::string &  long_name,
const char  short_name,
const std::string &  description 
)

Constructor

paludis::args::StringArg::StringArg ( ArgsGroup const,
const std::string &  long_name,
const char  short_name,
const std::string &  description,
void(*)(const std::string &)  validator 
)

Constructor with validator.


Member Function Documentation

const std::string& paludis::args::StringArg::argument (  )  const [inline]

Fetch the argument that was given to this option.

void paludis::args::StringArg::set_argument ( const std::string &  arg  ) 

Set the argument returned by argument().

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