class: ewol::object::Parameter
Description:
Constructor and Destructor:
+ Parameter (ewol::object::ParameterList & _objectLink,
const std::string & _name);
+ virtual ~Parameter ();
Synopsis:
+ void notifyChange () const;
+ virtual std::string getName () const;
+ virtual std::string getType () = 0 const;
+ virtual std::string getString () = 0 const;
+ virtual std::string getDefault () = 0 const;
+ virtual void setString (const std::string & _newVal) = 0;
+ virtual std::string getInfo () = 0 const;
+ virtual bool isDefault () = 0 const;
+ virtual void setDefault () = 0;
Detail:
Parameter
+ Parameter (ewol::object::ParameterList & _objectLink,
const std::string & _name);
~Parameter
+ virtual ~Parameter ();
notifyChange
+ void notifyChange () const;
call main class that parameterChange
getName
+ virtual std::string getName () const;
Get the name of the parameter.
| Return: | | The name of the parameter |
getType
+ virtual std::string getType () = 0 const;
Get the type of the parameter in string mode.
| Return: | | The string type of the parameter. |
getString
+ virtual std::string getString () = 0 const;
Get the string of the current value of the parameter.
| Return: | | The string description of the value. |
getDefault
+ virtual std::string getDefault () = 0 const;
Get the string of the default value of the parameter.
| Return: | | the string decription of the default value. |
setString
+ virtual void setString (const std::string & _newVal) = 0;
Set a new value of the parameter (with string interface).
getInfo
+ virtual std::string getInfo () = 0 const;
Description of the parameters.
| Return: | | Descriptive information of the parameter (for remote UI). |
isDefault
+ virtual bool isDefault () = 0 const;
Check if the value is the default
| Return: | | true : the vakue is the default one, false otherwise. |
setDefault
+ virtual void setDefault () = 0;
Reset the value to the default value.