Ase::Gadget Class Reference

Base type for classes that have a Property. More...

#include "api.hh"

Inheritance diagram for Ase::Gadget:

Public Member Functions
virtual GadgetImpl *	_parent () const =0
	Retrieve parent container.
virtual void	_set_parent (GadgetImpl *parent)=0
	Assign parent container.
ProjectImpl *	_project () const
	Find Project in parent ancestry.
virtual String	name () const =0
virtual void	name (const std::string &n)=0
virtual String	type_nick () const =0
virtual StringS	list_properties ()
	List all property identifiers.
virtual PropertyP	access_property (String ident)
	Retrieve handle for a Property.
virtual PropertyS	access_properties ()=0
	Retrieve handles for all properties.
Value	get_value (String ident)
	Get native property value.
bool	set_value (String ident, const Value &v)
	Set native property value.
virtual StringS	read_only_properties () const
	List x()/x (v) properties that this object can't change, their setters ignore the value or warn.
virtual bool	set_data (const String &key, const Value &v)=0
	Assign session data, prefix ephemerals with '_'.
virtual Value	get_data (const String &key) const =0
	Retrieve session data.
virtual void	remove_self ()=0
	Remove self from parent container.
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

Base type for classes that have a Property.

Definition at line 173 of file api.hh.

Constructor & Destructor Documentation

Gadget()

Ase::Gadget::Gadget ( )

explicitprotected

Definition at line 13 of file gadget.cc.

Member Function Documentation

_parent()

virtual GadgetImpl * Ase::Gadget::_parent ( ) const

pure virtual

Retrieve parent container.

Implemented in Ase::GadgetImpl.

Referenced by _project().

_project()

ProjectImpl * Ase::Gadget::_project

(

)

const

Find Project in parent ancestry.

Definition at line 94 of file gadget.cc.

References _parent().

_set_parent()

virtual void Ase::Gadget::_set_parent ( GadgetImpl *  parent )

pure virtual

Assign parent container.

Implemented in Ase::GadgetImpl.

access_properties()

virtual PropertyS Ase::Gadget::access_properties ( )

pure virtual

Retrieve handles for all properties.

Implemented in Ase::GadgetImpl.

Referenced by access_property(), and list_properties().

access_property()

PropertyP Ase::Gadget::access_property ( String  ident )

virtual

Retrieve handle for a Property.

Definition at line 120 of file gadget.cc.

References access_properties().

Referenced by get_value(), and set_value().

get_data()

virtual Value Ase::Gadget::get_data ( const String &  key ) const

pure virtual

Retrieve session data.

Implemented in Ase::GadgetImpl, and Ase::ServerImpl.

get_value()

Value Ase::Gadget::get_value

(

String

ident

)

Get native property value.

Definition at line 129 of file gadget.cc.

References access_property().

list_properties()

StringS Ase::Gadget::list_properties ( )

virtual

List all property identifiers.

Definition at line 109 of file gadget.cc.

References access_properties(), std::vector::push_back(), and std::vector::reserve().

read_only_properties()

StringS Ase::Gadget::read_only_properties ( ) const

virtual

List x()/x (v) properties that this object can't change, their setters ignore the value or warn.

Reimplemented in Ase::ClipImpl, Ase::MonitorImpl, Ase::PluginImpl, Ase::ProjectImpl, Ase::ServerImpl, and Ase::TrackImpl.

Definition at line 103 of file gadget.cc.

remove_self()

virtual void Ase::Gadget::remove_self ( )

pure virtual

Remove self from parent container.

Implemented in Ase::ClipImpl, Ase::GadgetImpl, Ase::PluginImpl, Ase::ProjectImpl, and Ase::TrackImpl.

set_data()

virtual bool Ase::Gadget::set_data ( const String &  key, const Value &  v  )

pure virtual

Assign session data, prefix ephemerals with '_'.

Implemented in Ase::GadgetImpl, and Ase::ServerImpl.

set_value()

bool Ase::Gadget::set_value	(	String	ident,
		const Value &	v
	)

Set native property value.

Definition at line 136 of file gadget.cc.

References access_property().

---

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

• ase/api.hh
• ase/gadget.cc