UCommon
ucommon::shell::groupopt Class Reference

Grouping option. More...

#include <shell.h>

Inheritance diagram for ucommon::shell::groupopt:
Collaboration diagram for ucommon::shell::groupopt:

Public Member Functions

 groupopt (const char *help)
Public Member Functions inherited from ucommon::shell::Option
void disable (void)
 Disable a option.
 Option (char short_option=0, const char *long_option=NULL, const char *value_type=NULL, const char *help=NULL)
 Construct a shell parser option.
Public Member Functions inherited from ucommon::LinkedObject
void delist (LinkedObject **root)
 Locate and remove ourselves from a list of objects.
void enlist (LinkedObject **root)
 Add our object to an existing linked list through a pointer.
LinkedObjectgetNext (void) const
 Get next effective object when iterating.
bool is_member (LinkedObject *list) const
 Search to see if we are a member of a specific list.
virtual void release (void)
 Release list, mark as no longer linked.
virtual void retain (void)
 Retain by marking as self referenced list.
Public Member Functions inherited from ucommon::ObjectProtocol
ObjectProtocolcopy (void)
 Retain (increase retention of) object when copying.
void operator++ (void)
 Increase retention operator.
void operator-- (void)
 Decrease retention operator.
virtual ~ObjectProtocol ()
 Required virtual destructor.

Additional Inherited Members

Static Public Member Functions inherited from ucommon::shell::Option
static LinkedObjectfirst (void)
static void reset (void)
Static Public Member Functions inherited from ucommon::LinkedObject
static unsigned count (const LinkedObject *root)
 Count the number of linked objects in a list.
static LinkedObjectgetIndexed (LinkedObject *root, unsigned index)
 Get member by index.
static void purge (LinkedObject *root)
 Release all objects from a list.
Data Fields inherited from ucommon::shell::Option
const char * help_string
const char * long_option
char short_option
bool trigger_option
const char * uses_option
Protected Member Functions inherited from ucommon::LinkedObject
 LinkedObject ()
 Construct base class unattached to anyone.
 LinkedObject (const LinkedObject &from)
 LinkedObject (LinkedObject **root)
 Construct base class attached to a chain of objects.
Protected Attributes inherited from ucommon::LinkedObject
LinkedObjectNext

Detailed Description

Grouping option.

This is used to create a grouping entry in the shell::help() listing.

Author
David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 278 of file shell.h.


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