Public Types | Static Public Member Functions | Protected Member Functions | List of all members
Sawyer::CommandLine::ShowHelpAndExit Class Reference


Functor to print the Unix man page and exit.

This functor is the same as ShowHelp except it also exits with the specified value.

Definition at line 1693 of file util/Sawyer/CommandLine.h.

#include <util/Sawyer/CommandLine.h>

Inheritance diagram for Sawyer::CommandLine::ShowHelpAndExit:
Inheritance graph
Collaboration diagram for Sawyer::CommandLine::ShowHelpAndExit:
Collaboration graph

Public Types

typedef SharedPointer< ShowHelpAndExitPtr
 Reference counting pointer for this class. More...
- Public Types inherited from Sawyer::CommandLine::ShowHelp
typedef SharedPointer< ShowHelpPtr
 Reference counting pointer for this class. More...
- Public Types inherited from Sawyer::CommandLine::SwitchAction
typedef SharedPointer< SwitchActionPtr
 Reference counting pointer for this class. More...

Static Public Member Functions

static Ptr instance (int exitStatus)
 Allocating constructor. More...
- Static Public Member Functions inherited from Sawyer::CommandLine::ShowHelp
static Ptr instance ()
 Allocating constructor. More...

Protected Member Functions

 ShowHelpAndExit (int exitStatus)
 Constructor for derived classes. More...
virtual void operator() (const ParserResult &)
- Protected Member Functions inherited from Sawyer::CommandLine::ShowHelp
 ShowHelp ()
 Constructor for derived classes. More...

Additional Inherited Members

- Public Member Functions inherited from Sawyer::CommandLine::SwitchAction
void run (const ParserResult &parserResult)
 Runs the action. More...
- Public Member Functions inherited from Sawyer::SharedObject
 SharedObject ()
 Default constructor. More...
 SharedObject (const SharedObject &)
 Copy constructor. More...
virtual ~SharedObject ()
 Virtual destructor. More...
SharedObjectoperator= (const SharedObject &)
 Assignment. More...

Member Typedef Documentation

Reference counting pointer for this class.

Definition at line 1700 of file util/Sawyer/CommandLine.h.

Constructor & Destructor Documentation

Sawyer::CommandLine::ShowHelpAndExit::ShowHelpAndExit ( int  exitStatus)

Constructor for derived classes.

Non-subclass users should use instance instead.

Definition at line 1697 of file util/Sawyer/CommandLine.h.

Member Function Documentation

static Ptr Sawyer::CommandLine::ShowHelpAndExit::instance ( int  exitStatus)

Allocating constructor.

Returns a pointer to a new ShowHelpAndExit object. Users will most likely want to use the showHelpAndExit factory instead, which requires less typing.

See also
Command line action factories, and the SwitchAction class.

Definition at line 1706 of file util/Sawyer/CommandLine.h.

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