Alias to a single command line argument. More...

Inheritance diagram for CommandLine::Alias:

Public Member Functions
	Alias (Argument *a, char short_alias)
	Alias (Argument *a, const std::string &long_alias)
void	set_handled (bool f)
	Set the handled flag.
void	handle (const std::string &arg)
	Handle the argument.
Help	get_help () const
	Return two columns of help text.
Public Member Functions inherited from CommandLine::Argument
void	set_short_name (char c)
void	set_long_name (const std::string &s)
void	set_type (const std::string &s)
void	set_help (const std::string &s)
void	set_long_help (const std::string &s)
void	set_has_arg (int h)
void	set_handled (bool f)
	Set the handled flag.
void	set_notification (bool &f)
bool	matches (int c) const
	Return true if key matches.
Help	get_help () const
	Return two columns of help text.
Public Member Functions inherited from Reference::Able
	Able ()
	Default constructor.
	Able (const Able &)
	Copy constructor.
Able &	operator= (const Able &)
	Assignment operator.
virtual	~Able ()
	Destructor.
unsigned	get_reference_count () const
	Returns the number of references there are to this.
Public Member Functions inherited from Reference::HeapTracked
	HeapTracked ()
	Default constructor.
	HeapTracked (const HeapTracked &)
	Copy constructor.
HeapTracked &	operator= (const HeapTracked &)
	Assignment operator.
virtual	~HeapTracked ()
	Destructor.
bool	__is_on_heap () const
	Return true if this instance is found in heap addresses.

Protected Member Functions
void	set_argument (Argument *)
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
	Add the address of a reference to this object.
void	__dereference (bool auto_delete=true) const
	Remove the address of a reference to this object.

Protected Attributes
Reference::To< Argument >	argument
Protected Attributes inherited from CommandLine::Argument
std::string	short_name
	Single-character name of value.
std::string	long_name
	Long name of value.
std::string	type
	Type of value.
std::string	help
	Brief description of value.
std::string	long_help
	Detailed description of value.
int	has_arg
	The has_arg attribute used by getopt_long.
int	val
	Code assigned to this Argument by Menu class.
bool *	handled
	bool handled notification

Additional Inherited Members
Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()
	Returns the current number instances in existence.
Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)
	Records the addresses of new instances allocated on the heap.
static void	operator delete (void location, void ptr)
	Placement delete overload to match the placement new overload.
static void	operator delete (void *location)
	Regular delete overload.
static size_t	get_heap_queue_size ()
	Return the number of heap addresses awaiting processing.

Detailed Description

Alias to a single command line argument.

Member Function Documentation

CommandLine::Help Alias::get_help ( ) const

virtual

Return two columns of help text.

void CommandLine::Alias::handle ( const std::string & arg )

inlinevirtual

Handle the argument.

void CommandLine::Alias::set_handled ( bool )

inlinevirtual

Set the handled flag.

Reimplemented from CommandLine::Item.

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