Property

#include "api.hh"

Inheritance diagram for Property:

Public Member Functions
String	blurb () const
virtual ChoiceS	choices () const =0
String	descr () const
virtual double	get_max () const =0
virtual double	get_min () const =0
virtual double	get_normalized () const =0
virtual double	get_step () const =0
virtual String	get_text () const =0
virtual Value	get_value () const =0
String	group () const
String	hints () const
virtual String	ident () const =0
virtual bool	is_numeric () const =0
virtual String	label () const =0
virtual String	nick () const =0
virtual void	reset ()=0
virtual bool	set_normalized (double v)=0
virtual bool	set_text (String v)=0
virtual bool	set_value (const Value &v)=0
virtual String	unit () const =0
Public Member Functions inherited from Emittable
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 Attributes
Member<&Property::metadata_ >	metadata
Member<&Property::name_ >	name
Member<&Property::value_ >	value

Protected Member Functions
virtual StringS	get_metadata () const =0
	Property ()
virtual	~Property ()=0
Protected Member Functions inherited from VirtualBase
virtual	~VirtualBase () noexcept=0

Detailed Description

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

Constructor & Destructor Documentation

Property()

Property ( )

explicitprotected

~Property()

~Property ( )

protectedpure virtual

Member Function Documentation

get_metadata()

virtual StringS get_metadata ( ) const

protectedpure virtual

Implemented in ClapPropertyImpl, AudioPropertyImpl, and ParameterProperty.

ident()

virtual String ident ( ) const

pure virtual

Unique name (per owner) of this Property.

Implemented in ClapPropertyImpl, AudioPropertyImpl, and ParameterProperty.

label()

virtual String label ( ) const

pure virtual

Preferred user interface name.

Implemented in ClapPropertyImpl, AudioPropertyImpl, and ParameterProperty.

nick()

virtual String nick ( ) const

pure virtual

Abbreviated user interface name, usually not more than 6 characters.

Implemented in ClapPropertyImpl, AudioPropertyImpl, and ParameterProperty.

unit()

virtual String unit ( ) const

pure virtual

Units of the values within range.

Implemented in ClapPropertyImpl, AudioPropertyImpl, and ParameterProperty.

get_min()

virtual double get_min ( ) const

pure virtual

Get the minimum property value, converted to double.

Implemented in ClapPropertyImpl, AudioPropertyImpl, and ParameterProperty.

get_max()

virtual double get_max ( ) const

pure virtual

Get the maximum property value, converted to double.

Implemented in ClapPropertyImpl, AudioPropertyImpl, and ParameterProperty.

get_step()

virtual double get_step ( ) const

pure virtual

Get the property value stepping, converted to double.

Implemented in ClapPropertyImpl, AudioPropertyImpl, and ParameterProperty.

reset()

virtual void reset ( )

pure virtual

Assign default as normalized property value.

Implemented in ClapPropertyImpl, AudioPropertyImpl, and ParameterProperty.

get_value()

virtual Value get_value ( ) const

pure virtual

Get the native property value.

Implemented in ClapPropertyImpl, AudioPropertyImpl, Preference, PropertyImpl, and ParameterProperty.

set_value()

virtual bool set_value ( const Value & v )

pure virtual

Set the native property value.

Implemented in Preference, PropertyImpl, ParameterProperty, ClapPropertyImpl, and AudioPropertyImpl.

get_normalized()

virtual double get_normalized ( ) const

pure virtual

Get the normalized property value, converted to double.

Implemented in ClapPropertyImpl, AudioPropertyImpl, and ParameterProperty.

set_normalized()

virtual bool set_normalized ( double v )

pure virtual

Set the normalized property value as double.

Implemented in AudioPropertyImpl, ClapPropertyImpl, and ParameterProperty.

get_text()

virtual String get_text ( ) const

pure virtual

Get the current property value, converted to a text String.

Implemented in ClapPropertyImpl, AudioPropertyImpl, and ParameterProperty.

set_text()

virtual bool set_text ( String v )

pure virtual

Set the current property value as a text String.

Implemented in ParameterProperty, ClapPropertyImpl, and AudioPropertyImpl.

is_numeric()

virtual bool is_numeric ( ) const

pure virtual

Whether the property settings can be represented as a floating point number.

Implemented in ClapPropertyImpl, AudioPropertyImpl, and ParameterProperty.

choices()

virtual ChoiceS choices ( ) const

pure virtual

Enumerate choices for choosable properties.

Implemented in ClapPropertyImpl, AudioPropertyImpl, ParameterProperty, and PropertyImpl.

hints()

String hints

(

)

const

Hints for parameter handling (metadata).

blurb()

String blurb

(

)

const

Short description for user interface tooltips (metadata).

descr()

String descr

(

)

const

Elaborate description, e.g. for help dialogs (metadata).

group()

String group

(

)

const

Group name for parameters of similar function (metadata).

Member Data Documentation

name

Member<&Property::name_> name

value

Member<&Property::value_> value

metadata

Member<&Property::metadata_> metadata