Ase::Property Class Reference

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

#include "api.hh"

Inheritance diagram for Ase::Property:

Public Member Functions
virtual String	name () const
virtual void	name (const String &n)
virtual StringS	metadata () const =0
virtual void	metadata (const StringS &md)
virtual String	ident () const =0
	Unique name (per owner) of this Property.
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 String	unit () const =0
	Units of the values within range.
virtual double	get_min () const =0
	Get the minimum property value, converted to double.
virtual double	get_max () const =0
	Get the maximum property value, converted to double.
virtual double	get_step () const =0
	Get the property value stepping, converted to double.
virtual void	reset ()=0
	Assign default as normalized property value.
virtual Value	value () const =0
	Get the native property value.
virtual bool	value (const Value &v)=0
	Set the native property value.
virtual double	get_normalized () const =0
	Get the normalized property value, converted to double.
virtual bool	set_normalized (double v)=0
	Set the normalized property value as double.
virtual String	get_text () const =0
	Get the current property value, converted to a text String.
virtual bool	set_text (String v)=0
	Set the current property value as a text String.
virtual bool	is_numeric () const =0
	Whether the property settings can be represented as a floating point number.
virtual ChoiceS	choices () const =0
	Enumerate choices for choosable properties.
String	hints () const
	Hints for parameter handling (metadata).
String	blurb () const
	Short description for user interface tooltips (metadata).
String	descr () const
	Elaborate description, e.g. for help dialogs (metadata).
String	group () const
	Group name for parameters of similar function (metadata).
Public Member Functions inherited from Ase::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)
Public Member Functions inherited from std::enable_shared_from_this< SharedBase >
T	enable_shared_from_this (T... args)
T	operator= (T... args)
T	shared_from_this (T... args)
T	weak_from_this (T... args)
T	~enable_shared_from_this (T... args)

Additional Inherited Members
Public Attributes inherited from Ase::Emittable
const EventHandler &	eventhandler

Detailed Description

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

Definition at line 135 of file api.hh.

Constructor & Destructor Documentation

Property()

Ase::Property::Property ( )

explicitprotected

Definition at line 16 of file properties.cc.

~Property()

Ase::Property::~Property ( )

protectedpure virtual

Definition at line 19 of file properties.cc.

Member Function Documentation

blurb()

String Ase::Property::blurb

(

)

const

Short description for user interface tooltips (metadata).

Definition at line 461 of file parameter.cc.

choices()

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

pure virtual

Enumerate choices for choosable properties.

Implemented in Ase::ParameterProperty, and Ase::PropertyImpl.

descr()

String Ase::Property::descr

(

)

const

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

Definition at line 467 of file parameter.cc.

get_max()

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

pure virtual

Get the maximum property value, converted to double.

Implemented in Ase::ParameterProperty.

get_min()

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

pure virtual

Get the minimum property value, converted to double.

Implemented in Ase::ParameterProperty.

get_normalized()

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

pure virtual

Get the normalized property value, converted to double.

Implemented in Ase::ParameterProperty.

get_step()

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

pure virtual

Get the property value stepping, converted to double.

Implemented in Ase::ParameterProperty.

get_text()

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

pure virtual

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

Implemented in Ase::ParameterProperty.

group()

String Ase::Property::group

(

)

const

Group name for parameters of similar function (metadata).

Definition at line 473 of file parameter.cc.

hints()

String Ase::Property::hints

(

)

const

Hints for parameter handling (metadata).

Definition at line 455 of file parameter.cc.

ident()

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

pure virtual

Unique name (per owner) of this Property.

Implemented in Ase::ParameterProperty.

is_numeric()

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

pure virtual

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

Implemented in Ase::ParameterProperty.

label()

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

pure virtual

Preferred user interface name.

Implemented in Ase::ParameterProperty.

metadata()

void Ase::Property::metadata ( const StringS &  md )

virtual

Definition at line 35 of file properties.cc.

name() [1/2]

String Ase::Property::name ( ) const

virtual

Definition at line 23 of file properties.cc.

name() [2/2]

void Ase::Property::name ( const String &  n )

virtual

Definition at line 29 of file properties.cc.

nick()

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

pure virtual

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

Implemented in Ase::ParameterProperty.

reset()

virtual void Ase::Property::reset ( )

pure virtual

Assign default as normalized property value.

Implemented in Ase::ParameterProperty.

set_normalized()

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

pure virtual

Set the normalized property value as double.

Implemented in Ase::ParameterProperty.

set_text()

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

pure virtual

Set the current property value as a text String.

Implemented in Ase::ParameterProperty.

unit()

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

pure virtual

Units of the values within range.

Implemented in Ase::ParameterProperty.

value() [1/2]

virtual Value Ase::Property::value ( ) const

pure virtual

Get the native property value.

Implemented in Ase::Preference, Ase::PropertyImpl, and Ase::ParameterProperty.

value() [2/2]

virtual bool Ase::Property::value ( const Value &  v )

pure virtual

Set the native property value.

Implemented in Ase::Preference, Ase::PropertyImpl, and Ase::ParameterProperty.

---

The documentation for this class was generated from the following files:

• ase/api.hh
• ase/parameter.cc
• ase/properties.cc