sptk2 logo
SPTK Home Page
Public Member Functions | List of all members
sptk::CommandLine::CommandLineArgument Class Reference

#include <CommandLine.h>

Inheritance diagram for sptk::CommandLine::CommandLineArgument:
sptk::CommandLine::CommandLineElement

Public Member Functions

 CommandLineArgument (const String &name, const String &help)
 
 ~CommandLineArgument () override=default
 
- Public Member Functions inherited from sptk::CommandLine::CommandLineElement
 CommandLineElement (const String &name, const String &shortName, const String &help, const Visibility &useWithCommands)
 
virtual ~CommandLineElement ()=default
 
virtual Type type () const
 
virtual String name () const
 
virtual String shortName () const
 
virtual bool hasValue () const
 
virtual void validate (const String &value) const
 
virtual String printableName () const
 
bool useWithCommand (const String &command) const
 
void formatHelp (size_t textWidth, Strings &formattedText) const
 
void printHelp (size_t nameWidth, size_t textWidth, const String &optionDefaultValue) const
 

Additional Inherited Members

- Public Types inherited from sptk::CommandLine::CommandLineElement
enum class  Type { IS_UNKNOWN , IS_COMMAND , IS_OPTION , IS_VALUE_OPTION }
 

Detailed Description

Command line argument

Command line argument that doesn't start from '-' character and doesn't expect a value, AKA command.

Constructor & Destructor Documentation

◆ CommandLineArgument()

sptk::CommandLine::CommandLineArgument::CommandLineArgument ( const String name,
const String help 
)

Constructor

Parameters
nameElement name
helpHelp (description) for the element

◆ ~CommandLineArgument()

sptk::CommandLine::CommandLineArgument::~CommandLineArgument ( )
overridedefault

Destructor


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

Fri Oct 14 2022 09:58:38: SPTK 5.4.1