ucommon
Public Member Functions
ucommon::shell::groupopt Class Reference

Grouping option. More...

#include <shell.h>

Inheritance diagram for ucommon::shell::groupopt:
Inheritance graph
[legend]
Collaboration diagram for ucommon::shell::groupopt:
Collaboration graph
[legend]

Public Member Functions

 groupopt (char *help)
- Public Member Functions inherited from ucommon::shell::Option
virtual char * assign (char *value)=0
 Used to send option into derived receiver.
void disable (void)
 Disable a option.
 Option (char short_option=0, char *long_option=((void *) 0), char *value_type=((void *) 0), char *help=((void *) 0))
 Construct a shell parser option.
- Public Member Functions inherited from ucommon::OrderedObject
void delist (OrderedIndex *index)
 Remove our ordered object from an existing index.
virtual void enlist (OrderedIndex *index)
 List our ordered object in default strategy mode.
void enlistHead (OrderedIndex *index)
 List our ordered object at start of a linked list on an index.
void enlistTail (OrderedIndex *index)
 List our ordered object at end of a linked list on an index.
OrderedObjectgetNext (void)
 Get next ordered member when iterating.
- 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.
bool isMember (LinkedObject *list)
 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)
- Data Fields inherited from ucommon::shell::Option
char * help_string
char * long_option
char short_option
bool trigger_option
char * uses_option
- Static Public Attributes inherited from ucommon::LinkedObject
static LinkedObjectinv
 Marker for invalid list pointer.
static LinkedObjectnil
 Marker for end of linked list.
- Protected Member Functions inherited from ucommon::OrderedObject
 OrderedObject (OrderedIndex *index)
 Construct an ordered object aot end of a an index.
 OrderedObject ()
 Construct an ordered object unattached.
- 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 414 of file shell.h.


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