paludis  Version 2.6.0
Public Member Functions | List of all members
paludis::args::ArgsGroup Class Reference

#include <args_group.hh>

Public Member Functions

void remove ()
 
ArgsSectionsection () 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 ()
 
 ArgsGroup (const ArgsGroup &)=delete
 
ArgsGroupoperator= (const ArgsGroup &)=delete
 

Detailed Description

Contains a related group of command line arguments.

Member Function Documentation

void paludis::args::ArgsGroup::add ( ArgsOption *const  value)

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

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

Fetch our description.

References PALUDIS_VISIBLE.

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

Fetch our name.

void paludis::args::ArgsGroup::remove ( )

Remove this group from our section.

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.

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

Fetch our section.


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