Description

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 Sawyer/CommandLine.h.

#include <Sawyer/CommandLine.h>

Inheritance diagram for Sawyer::CommandLine::ShowHelpAndExit:

[legend]

Collaboration diagram for Sawyer::CommandLine::ShowHelpAndExit:

[legend]

Public Types
typedef SharedPointer< ShowHelpAndExit >	Ptr
	Reference counting pointer for this class.

Public Types inherited from Sawyer::CommandLine::ShowHelp
typedef SharedPointer< ShowHelp >	Ptr
	Reference counting pointer for this class.

Public Types inherited from Sawyer::CommandLine::SwitchAction
typedef SharedPointer< SwitchAction >	Ptr
	Reference counting pointer for this class.

Static Public Member Functions
static Ptr	instance (int exitStatus)
	Allocating constructor.

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

Protected Member Functions
	ShowHelpAndExit (int exitStatus)
	Constructor for derived classes.

virtual void	operator() (const ParserResult &)

Protected Member Functions inherited from Sawyer::CommandLine::ShowHelp
	ShowHelp ()
	Constructor for derived classes.

Additional Inherited Members
Public Member Functions inherited from Sawyer::CommandLine::SwitchAction
void	run (const ParserResult &parserResult)
	Runs the action.

Public Member Functions inherited from Sawyer::SharedObject
	SharedObject ()
	Default constructor.

	SharedObject (const SharedObject &)
	Copy constructor.

virtual	~SharedObject ()
	Virtual destructor.

SharedObject &	operator= (const SharedObject &)
	Assignment.

Member Typedef Documentation

◆ Ptr

typedef SharedPointer<ShowHelpAndExit> Sawyer::CommandLine::ShowHelpAndExit::Ptr

Reference counting pointer for this class.

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

Constructor & Destructor Documentation

◆ ShowHelpAndExit()

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

inlineprotected

Constructor for derived classes.

Non-subclass users should use instance instead.

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

Member Function Documentation

◆ instance()

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

inlinestatic

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.