The color parameter class.
More...
#include <murl_util_environment.h>
The color parameter class.
The color processing uses the Util::StringToColor() syntax.
|
| ColorParameter (ParameterType type, const String &longId, const String &shortId, const String &description, const Color &defaultValue=Color(0)) |
| The constructor taking an optional default value,. More...
|
|
virtual SInt32 | Process (SInt32 currentIndex, SInt32 argC, const char **argV) |
| Overload of Parameter::Process() converting the mValue. More...
|
|
| Parameter (ParameterType type, const String &longId, const String &shortId, const String &description, SInt32 skip, Bool isArray) |
| The constructor. More...
|
|
virtual | ~Parameter () |
| The destructor.
|
|
◆ ColorParameter()
The constructor taking an optional default value,.
- Parameters
-
type | The type of the parameter. |
longId | The long parameter identifier string. |
shortId | The short parameter identifier string. |
description | The parameter description string. |
defaultValue | The default value. |
◆ Process()
virtual SInt32 Murl::Util::Environment::ColorParameter::Process |
( |
SInt32 |
currentIndex, |
|
|
SInt32 |
argC, |
|
|
const char ** |
argV |
|
) |
| |
|
virtual |
Overload of Parameter::Process() converting the mValue.
- Parameters
-
currentIndex | The zero-based index to the current argument. |
argC | The number of arguments. |
argV | The argument string values. |
- Returns
- The number of arguments processed or -1 if parsing the argument failed.
Reimplemented from Murl::Util::Environment::Parameter.
◆ mValue
Color Murl::Util::Environment::ColorParameter::mValue |
The processed argument value.
The documentation for this class was generated from the following file: