paludis::args::ArgsGroup Class Reference

#include <args_group.hh>

Public Member Functions
void	remove ()
ArgsSection *	section () const
void	add (ArgsOption *const value)
void	remove (ArgsOption *const value)
const std::string &	name () const
const std::string &	description () const

Iterate over our ArgsOptions.
typedef WrappedForwardIterator< ConstIteratorTag, ArgsOption *const >	ConstIterator
ConstIterator	begin () const
ConstIterator	end () const

Basic operations
	ArgsGroup (ArgsSection *s, const std::string &name, const std::string &description)
	ArgsGroup (const ArgsGroup &)=delete
ArgsGroup &	operator= (const ArgsGroup &)=delete

Detailed Description

Contains a related group of command line arguments.

Member Function Documentation

add()

void paludis::args::ArgsGroup::add

(

ArgsOption *const

value

)

Add an ArgsOption instance (called by the ArgsOption constructor).

description()

const std::string & paludis::args::ArgsGroup::description ( ) const

inline

Fetch our description.

Referenced by remove().

name()

const std::string & paludis::args::ArgsGroup::name ( ) const

inline

Fetch our name.

Referenced by remove().

remove() [1/2]

void paludis::args::ArgsGroup::remove

(

)

Remove this group from our section.

remove() [2/2]

void paludis::args::ArgsGroup::remove

(

ArgsOption *const

value

)

Remove an ArgsOption instance (called by ArgsOption::remove). Calls ArgsGroup::remove() if that would leave us with no ArgsOptions.

References description(), and name().

section()

ArgsSection * paludis::args::ArgsGroup::section ( ) const

inline

Fetch our section.

---

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

• /var/tmp/paludis/build/sys-apps-paludis-scm-r1/work/paludis-scm/paludis/args/args_group.hh