Class Ase::Gadget

ClassList > Ase > Gadget

Base type for classes that have a Property .

• #include <api.hh>

Inherits the following classes: Ase::Object

Inherited by the following classes: Ase::Clip, Ase::Device, Ase::GadgetImpl, Ase::Monitor, Ase::Server

Public Attributes

Type	Name
Member<&Gadget::name_ >	name

Public Functions

Type	Name
virtual GadgetImpl *	_parent () const = 0 Retrieve parent container.
ProjectImpl *	_project () const Find Project in parent ancestry.
virtual void	_set_parent (GadgetImpl * parent) = 0 Assign parent container.
virtual PropertyS	access_properties () = 0 Retrieve handles for all properties.
virtual PropertyP	access_property (String ident) Retrieve handle for a Property .
virtual Value	get_data (const String & key) const = 0 Retrieve session data.
Value	get_value (String ident) Get native property value.
virtual StringS	list_properties () List all property identifiers.
virtual bool	set_data (const String & key, const Value & v) = 0 Assign session data, prefix ephemerals with '_'.
bool	set_value (String ident, const Value & v)
virtual String	type_nick () const = 0

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
	Gadget ()
virtual bool	name_ (const std::string * n, std::string * q) = 0

Protected Functions inherited from Ase::Object

See Ase::Object

Type	Name
virtual	~Object () = 0

Protected Functions inherited from Ase::VirtualBase

See Ase::VirtualBase

Type	Name
virtual	~VirtualBase () noexcept = 0

Public Attributes Documentation

variable name

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

---

Public Functions Documentation

function _parent

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

---

function _project

ProjectImpl * Ase::Gadget::_project () const

---

function _set_parent

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

---

function access_properties

virtual PropertyS Ase::Gadget::access_properties () = 0

---

function access_property

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

---

function get_data

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

---

function get_value

Value Ase::Gadget::get_value (
    String ident
) 

---

function list_properties

virtual StringS Ase::Gadget::list_properties () 

---

function set_data

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

---

function set_value

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

Set native property value.

---

function type_nick

virtual String Ase::Gadget::type_nick () const = 0

---

Protected Functions Documentation

function Gadget

explicit Ase::Gadget::Gadget () 

---

function name_

virtual bool Ase::Gadget::name_ (
    const std::string * n,
    std::string * q
) = 0

---

---

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