GNU CommonC++
|
Class for options with an argument e.g. More...
#include <cmdoptns.h>
Public Member Functions | |
CommandOptionArg (const char *inOptionName, const char *inOptionLetter, const char *inDescription, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList) | |
CommandOptionArg contructor. More... | |
virtual | ~CommandOptionArg () |
![]() | |
CommandOptionWithArg (const char *inOptionName, const char *inOptionLetter, const char *inDescription, OptionType inOptionType, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList) | |
CommandOptionWithArg contructor. More... | |
virtual | ~CommandOptionWithArg () |
virtual void | foundOption (CommandOptionParse *cop, const char *value=0) |
virtual void | foundOption (CommandOptionParse *cop, const char **value, int num) |
virtual bool | hasValue () |
![]() | |
virtual | ~CommandOption () |
A virtual destructor just in case. More... | |
CommandOption (const char *inOptionName, const char *inOptionLetter, const char *inDescription, OptionType inOptionType, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList) | |
CommandOption contructor. More... | |
virtual void | parseDone (CommandOptionParse *cop) |
Once parsing of command line options is complete, this method is called. More... | |
virtual void | performTask (CommandOptionParse *cop) |
Once CommandOption objects have completed parsing and there are no errors they may have some specific tasks to perform. More... | |
Additional Inherited Members | |
![]() | |
enum | OptionType { hasArg , noArg , trailing , collect } |
OptionType is for denoting what type of option this is, with an arg, without an arg or the trailing args. More... | |
![]() | |
const char ** | values |
Array of list of values collected for this option. More... | |
int | numValue |
Number of values in the values array. More... | |
![]() | |
const char * | optionName |
Long option name, these will be preceded with "--" on the command line. More... | |
const char * | optionLetter |
option letter, these will be preceded with "-" on the command line. More... | |
const char * | description |
A short description of the option for Usage messages. More... | |
OptionType | optionType |
This command option's OptionType. More... | |
bool | required |
True if this parameter is required. More... | |
CommandOption * | next |
This next CommandOption in this list of options or nil if no more options exist. More... | |
Class for options with an argument e.g.
–option value .
ost::CommandOptionArg::CommandOptionArg | ( | const char * | inOptionName, |
const char * | inOptionLetter, | ||
const char * | inDescription, | ||
bool | inRequired = false , |
||
CommandOption ** | ppNext = &defaultCommandOptionList |
||
) |
CommandOptionArg contructor.
This sets the optionType for this object to HasArg.
inOptionName | long option name |
inOptionLetter | short letter name |
inDescription | short description of the option |
inRequired | true if option is required |
ppNext | the linked list header |
|
virtual |