Class Ase::ParameterProperty
ClassList > Ase > ParameterProperty
Abstract base type for Property implementations withParameter meta data.
#include <properties.hh>
Inherits the following classes: Ase::EmittableImpl, Ase::Property
Inherited by the following classes: Ase::Preference, Ase::PropertyImpl
Public Attributes inherited from Ase::Property
See Ase::Property
| Type | Name |
|---|---|
| Member<&Property::metadata_ > | metadata |
| Member<&Property::name_ > | name |
| Member<&Property::value_ > | value |
Public Functions
| Type | Name |
|---|---|
| virtual ChoiceS | choices () override const Enumerate choices for choosable properties. |
| double | get_double () const |
| virtual double | get_max () override const Get the maximum property value, converted to double. |
| virtual double | get_min () override const Get the minimum property value, converted to double. |
| virtual double | get_normalized () override const Get the normalized property value, converted to double. |
| virtual double | get_step () override const Get the property value stepping, converted to double. |
| virtual String | get_text () override const Get the current property value, converted to a text String. |
| virtual Value | get_value () override const = 0 Get the native property value. |
| virtual String | ident () override const Unique name (per owner) of this Property . |
| Value | initial () const |
| virtual bool | is_numeric () override const Whether the property settings can be represented as a floating point number. |
| virtual String | label () override const Preferred user interface name. |
| virtual String | nick () override const Abbreviated user interface name, usually not more than 6 characters. |
| ParameterC | parameter () const |
| MinMaxStep | range () const |
| virtual void | reset () override Assign default as normalized property value. |
| virtual bool | set_normalized (double v) override Set the normalized property value as double. |
| virtual bool | set_text (String v) override Set the current property value as a text String. |
| virtual bool | set_value (const Value & v) override = 0 Set the native property value. |
| virtual String | unit () override const Units of the values within range. |
Public Functions inherited from Ase::EmittableImpl
| Type | Name |
|---|---|
| virtual void | emit_event (const String & type, const String & detail, const ValueR fields={}) override |
| virtual void | emit_notify (const String & detail) override Emit notify:detail , multiple notifications maybe coalesced if a CoalesceNotifies instance exists. |
| virtual ASE_USE_RESULT Connection | on_event (const String & eventselector, const EventHandler & eventhandler) override |
Public Functions inherited from Ase::Emittable
See Ase::Emittable
| Type | Name |
|---|---|
| virtual void | emit_event (const String & type, const String & detail, const ValueR fields={}) = 0 |
| virtual void | emit_notify (const String & detail) = 0 |
| void | js_trigger (const String & eventselector, JsTrigger callback) |
| virtual ASE_USE_RESULT Connection | on_event (const String & eventselector, const EventHandler & eventhandler) = 0 |
Public Functions inherited from Ase::Property
See Ase::Property
| Type | Name |
|---|---|
| String | blurb () const Short description for user interface tooltips (metadata). |
| virtual ChoiceS | choices () const = 0 Enumerate choices for choosable properties. |
| String | descr () const Elaborate description, e.g. for help dialogs (metadata). |
| virtual double | get_max () const = 0 Get the maximum property value, converted to double. |
| virtual double | get_min () const = 0 Get the minimum property value, converted to double. |
| virtual double | get_normalized () const = 0 Get the normalized property value, converted to double. |
| virtual double | get_step () const = 0 Get the property value stepping, converted to double. |
| virtual String | get_text () const = 0 Get the current property value, converted to a text String. |
| virtual Value | get_value () const = 0 Get the native property value. |
| String | group () const Group name for parameters of similar function (metadata). |
| String | hints () const Hints for parameter handling (metadata). |
| virtual String | ident () const = 0 Unique name (per owner) of this Property . |
| virtual bool | is_numeric () const = 0 Whether the property settings can be represented as a floating point number. |
| virtual String | label () const = 0 Preferred user interface name. |
| virtual String | nick () const = 0 Abbreviated user interface name, usually not more than 6 characters. |
| virtual void | reset () = 0 Assign default as normalized property value. |
| virtual bool | set_normalized (double v) = 0 Set the normalized property value as double. |
| virtual bool | set_text (String v) = 0 Set the current property value as a text String. |
| virtual bool | set_value (const Value & v) = 0 Set the native property value. |
| virtual String | unit () const = 0 Units of the values within range. |
Public Functions inherited from Ase::Emittable
See Ase::Emittable
| Type | Name |
|---|---|
| virtual void | emit_event (const String & type, const String & detail, const ValueR fields={}) = 0 |
| virtual void | emit_notify (const String & detail) = 0 |
| void | js_trigger (const String & eventselector, JsTrigger callback) |
| virtual ASE_USE_RESULT Connection | on_event (const String & eventselector, const EventHandler & eventhandler) = 0 |
Protected Attributes
| Type | Name |
|---|---|
| ParameterC | parameter_ |
Protected Functions
| Type | Name |
|---|---|
| virtual StringS | get_metadata () override const |
Protected Functions inherited from Ase::EmittableImpl
| Type | Name |
|---|---|
| virtual | ~EmittableImpl () |
Protected Functions inherited from Ase::VirtualBase
See Ase::VirtualBase
| Type | Name |
|---|---|
| virtual | ~VirtualBase () noexcept = 0 |
Protected Functions inherited from Ase::Property
See Ase::Property
| Type | Name |
|---|---|
| Property () |
|
| virtual StringS | get_metadata () const = 0 |
| virtual | ~Property () = 0 |
Protected Functions inherited from Ase::VirtualBase
See Ase::VirtualBase
| Type | Name |
|---|---|
| virtual | ~VirtualBase () noexcept = 0 |
Public Functions Documentation
function choices
inline virtual ChoiceS Ase::ParameterProperty::choices () override const
Implements Ase::Property::choices
function get_double
inline double Ase::ParameterProperty::get_double () const
function get_max
inline virtual double Ase::ParameterProperty::get_max () override const
Implements Ase::Property::get_max
function get_min
inline virtual double Ase::ParameterProperty::get_min () override const
Implements Ase::Property::get_min
function get_normalized
inline virtual double Ase::ParameterProperty::get_normalized () override const
Implements Ase::Property::get_normalized
function get_step
inline virtual double Ase::ParameterProperty::get_step () override const
Implements Ase::Property::get_step
function get_text
inline virtual String Ase::ParameterProperty::get_text () override const
Implements Ase::Property::get_text
function get_value
virtual Value Ase::ParameterProperty::get_value () override const = 0
Implements Ase::Property::get_value
function ident
inline virtual String Ase::ParameterProperty::ident () override const
Implements Ase::Property::ident
function initial
inline Value Ase::ParameterProperty::initial () const
function is_numeric
inline virtual bool Ase::ParameterProperty::is_numeric () override const
Implements Ase::Property::is_numeric
function label
inline virtual String Ase::ParameterProperty::label () override const
Implements Ase::Property::label
function nick
inline virtual String Ase::ParameterProperty::nick () override const
Implements Ase::Property::nick
function parameter
inline ParameterC Ase::ParameterProperty::parameter () const
function range
inline MinMaxStep Ase::ParameterProperty::range () const
function reset
inline virtual void Ase::ParameterProperty::reset () override
Implements Ase::Property::reset
function set_normalized
inline virtual bool Ase::ParameterProperty::set_normalized (
double v
) override
Implements Ase::Property::set_normalized
function set_text
inline virtual bool Ase::ParameterProperty::set_text (
String v
) override
Implements Ase::Property::set_text
function set_value
virtual bool Ase::ParameterProperty::set_value (
const Value & v
) override = 0
Implements Ase::Property::set_value
function unit
inline virtual String Ase::ParameterProperty::unit () override const
Implements Ase::Property::unit
Protected Attributes Documentation
variable parameter_
ParameterC Ase::ParameterProperty::parameter_;
Protected Functions Documentation
function get_metadata
inline virtual StringS Ase::ParameterProperty::get_metadata () override const
Implements Ase::Property::get_metadata
The documentation for this class was generated from the following file /__w/anklang/anklang/ase/properties.hh