Class TValueOption
Unit
Declaration
type TValueOption = class(TOption)
Description
Base class for all options that have values.
These options that take one or more values of the form --option=value or --option value etc
Source: source/component/PasDoc_OptionParser.pas (line 121).
Hierarchy
- TObject
- TOption
- TValueOption
Overview
Fields
| Protected | FShort: char; |
| Protected | FLong: string; |
| Protected | FShortSens: boolean; |
| Protected | FLongSens: boolean; |
| Protected | FExplanation: string; |
| Protected | FWasSpecified: boolean; |
| Protected | FParser: TOptionParser; |
Methods
| Public | constructor Create(const AShort:char; const ALong: string); |
| Public | constructor CreateEx(const AShort:char; const ALong: string; const AShortCaseSensitive, ALongCaseSensitive: boolean); virtual; |
| Public | function GetOptionWidth: Integer; |
| Public | procedure WriteExplanation(const AOptWidth: Integer); |
| Protected | function CheckValue(const AString: String): boolean; virtual; abstract; |
| Protected | function ParseOption(const AWords: TStrings): boolean; override; |
Properties
| Public | property ShortForm: char read FShort write FShort; |
| Public | property LongForm: string read FLong write FLong; |
| Public | property ShortCaseSensitive: boolean read FShortSens write FShortSens; |
| Public | property LongCaseSensitive: boolean read FLongSens write FLongSens; |
| Public | property WasSpecified: boolean read FWasSpecified; |
| Public | property Explanation: string read FExplanation write FExplanation; |
Description
Fields
| Protected | FShort: char; |
|
This item is declared in ancestor TOption. This item has no description. | |
| Protected | FLong: string; |
|
This item is declared in ancestor TOption. This item has no description. | |
| Protected | FShortSens: boolean; |
|
This item is declared in ancestor TOption. This item has no description. | |
| Protected | FLongSens: boolean; |
|
This item is declared in ancestor TOption. This item has no description. | |
| Protected | FExplanation: string; |
|
This item is declared in ancestor TOption. This item has no description. | |
| Protected | FWasSpecified: boolean; |
|
This item is declared in ancestor TOption. This item has no description. | |
| Protected | FParser: TOptionParser; |
|
This item is declared in ancestor TOption. This item has no description. | |
Methods
| Public | constructor Create(const AShort:char; const ALong: string); |
|
This item is declared in ancestor TOption. Create a new Option. Set AShort to #0 in order to have no short option. Technically you can set ALong to '' to have no long option, but in practive *every* option should have long form. Don't override this in descendants (this always simply calls CreateEx). Override only CreateEx. | |
| Public | constructor CreateEx(const AShort:char; const ALong: string; const AShortCaseSensitive, ALongCaseSensitive: boolean); virtual; |
|
This item is declared in ancestor TOption. This item has no description. | |
| Public | function GetOptionWidth: Integer; |
|
This item is declared in ancestor TOption. returns the width of the string "-s, --long-option" where s is the short option. Removes non-existant options (longoption = '' or shortoption = #0) | |
| Public | procedure WriteExplanation(const AOptWidth: Integer); |
|
This item is declared in ancestor TOption. writes the wrapped explanation including option format, AOptWidth determines how much it is indented & wrapped | |
| Protected | function CheckValue(const AString: String): boolean; virtual; abstract; |
|
This item has no description. Source: source/component/PasDoc_OptionParser.pas (line 123). | |
| Protected | function ParseOption(const AWords: TStrings): boolean; override; |
|
This item has no description. Source: source/component/PasDoc_OptionParser.pas (line 124). | |
Properties
| Public | property ShortForm: char read FShort write FShort; |
|
This item is declared in ancestor TOption. Short form of the option — single character — if #0 then not used | |
| Public | property LongForm: string read FLong write FLong; |
|
This item is declared in ancestor TOption. long form of the option — string — if empty, then not used | |
| Public | property ShortCaseSensitive: boolean read FShortSens write FShortSens; |
|
This item is declared in ancestor TOption. specified whether the short form should be case sensitive or not | |
| Public | property LongCaseSensitive: boolean read FLongSens write FLongSens; |
|
This item is declared in ancestor TOption. specifies whether the long form should be case sensitive or not | |
| Public | property WasSpecified: boolean read FWasSpecified; |
|
This item is declared in ancestor TOption. signifies if the option was specified at least once Source: source/component/PasDoc_OptionParser.pas (line 101). | |
| Public | property Explanation: string read FExplanation write FExplanation; |
|
This item is declared in ancestor TOption. explanation for the option, see also WriteExplanation Source: source/component/PasDoc_OptionParser.pas (line 103). | |
Generated by PasDoc 1.0.2.