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 util/Sawyer/CommandLine.h.
#include <CommandLine.h>
Inheritance diagram for Sawyer::CommandLine::ShowHelpAndExit:
Collaboration diagram for Sawyer::CommandLine::ShowHelpAndExit:
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. 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... | |
| SharedObject & | operator= (const SharedObject &) |
| Assignment. More... | |
Constructor & Destructor Documentation
◆ ShowHelpAndExit()
|
inlineprotected |
Constructor for derived classes.
Non-subclass users should use instance instead.
Definition at line 1697 of file util/Sawyer/CommandLine.h.
Member Function Documentation
◆ instance()
|
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.
- 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:
