Class Ase::Property

ClassList > Ase > Property

A Property allows querying, setting and monitoring of an object property.

• #include <api.hh>

Inherits the following classes: Ase::Emittable

Inherited by the following classes: Ase::AudioPropertyImpl, Ase::ClapPropertyImpl, Ase::ParameterProperty

Public Attributes

Type	Name
Member<&Property::metadata_ >	metadata
Member<&Property::name_ >	name
Member<&Property::value_ >	value

Public Functions

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 Functions

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 Attributes Documentation

variable metadata

Member<&Property::metadata_> Ase::Property::metadata;

---

variable name

Member<&Property::name_> Ase::Property::name;

---

variable value

Member<&Property::value_> Ase::Property::value;

---

Public Functions Documentation

function blurb

String Ase::Property::blurb () const

---

function choices

virtual ChoiceS Ase::Property::choices () const = 0

---

function descr

String Ase::Property::descr () const

---

function get_max

virtual double Ase::Property::get_max () const = 0

---

function get_min

virtual double Ase::Property::get_min () const = 0

---

function get_normalized

virtual double Ase::Property::get_normalized () const = 0

---

function get_step

virtual double Ase::Property::get_step () const = 0

---

function get_text

virtual String Ase::Property::get_text () const = 0

---

function get_value

virtual Value Ase::Property::get_value () const = 0

---

function group

String Ase::Property::group () const

---

function hints

String Ase::Property::hints () const

---

function ident

virtual String Ase::Property::ident () const = 0

---

function is_numeric

virtual bool Ase::Property::is_numeric () const = 0

---

function label

virtual String Ase::Property::label () const = 0

---

function nick

virtual String Ase::Property::nick () const = 0

---

function reset

virtual void Ase::Property::reset () = 0

---

function set_normalized

virtual bool Ase::Property::set_normalized (
    double v
) = 0

---

function set_text

virtual bool Ase::Property::set_text (
    String v
) = 0

---

function set_value

virtual bool Ase::Property::set_value (
    const Value & v
) = 0

---

function unit

virtual String Ase::Property::unit () const = 0

---

Protected Functions Documentation

function Property

explicit Ase::Property::Property () 

---

function get_metadata

virtual StringS Ase::Property::get_metadata () const = 0

---

function ~Property

virtual Ase::Property::~Property () = 0

---

---

The documentation for this class was generated from the following file /__w/anklang/anklang/ase/api.hh