juce::DynamicObject Class Reference

#include <juce_DynamicObject.h>

Inheritance diagram for juce::DynamicObject:

Public Types
using	Ptr = ReferenceCountedObjectPtr<DynamicObject>

Public Member Functions
	DynamicObject ()
	DynamicObject (const DynamicObject &)
	~DynamicObject () override
virtual bool	hasProperty (const Identifier &propertyName) const
virtual const var &	getProperty (const Identifier &propertyName) const
virtual void	setProperty (const Identifier &propertyName, const var &newValue)
virtual void	removeProperty (const Identifier &propertyName)
virtual bool	hasMethod (const Identifier &methodName) const
virtual var	invokeMethod (Identifier methodName, const var::NativeFunctionArgs &args)
void	setMethod (Identifier methodName, var::NativeFunction function)
void	clear ()
NamedValueSet &	getProperties () noexcept
void	cloneAllProperties ()
virtual Ptr	clone ()
virtual void	writeAsJSON (OutputStream &, int indentLevel, bool allOnOneLine, int maximumDecimalPlaces)
Public Member Functions inherited from juce::ReferenceCountedObject
void	incReferenceCount () noexcept
void	decReferenceCount () noexcept
bool	decReferenceCountWithoutDeleting () noexcept
int	getReferenceCount () const noexcept

Private Attributes
NamedValueSet	properties

Additional Inherited Members
Protected Member Functions inherited from juce::ReferenceCountedObject
	ReferenceCountedObject ()=default
	ReferenceCountedObject (const ReferenceCountedObject &) noexcept
	ReferenceCountedObject (ReferenceCountedObject &&) noexcept
ReferenceCountedObject &	operator= (const ReferenceCountedObject &) noexcept
ReferenceCountedObject &	operator= (ReferenceCountedObject &&) noexcept
virtual	~ReferenceCountedObject ()
void	resetReferenceCount () noexcept

Detailed Description

Represents a dynamically implemented object.

This class is primarily intended for wrapping scripting language objects, but could be used for other purposes.

An instance of a DynamicObject can be used to store named properties, and by subclassing hasMethod() and invokeMethod(), you can give your object methods.

@tags{Core}

Member Typedef Documentation

Ptr

using juce::DynamicObject::Ptr = ReferenceCountedObjectPtr<DynamicObject>

Constructor & Destructor Documentation

DynamicObject() [1/2]

juce::DynamicObject::DynamicObject

(

)

DynamicObject() [2/2]

juce::DynamicObject::DynamicObject

(

const DynamicObject &

other

)

~DynamicObject()

juce::DynamicObject::~DynamicObject ( )

override

Member Function Documentation

clear()

void juce::DynamicObject::clear

(

)

Removes all properties and methods from the object.

clone()

DynamicObject::Ptr juce::DynamicObject::clone ( )

virtual

Returns a clone of this object. The default implementation of this method just returns a new DynamicObject with a (deep) copy of all of its properties. Subclasses can override this to implement their own custom copy routines.

Reimplemented in juce::JavascriptEngine::RootObject::FunctionObject.

cloneAllProperties()

void juce::DynamicObject::cloneAllProperties

(

)

Calls var::clone() on all the properties that this object contains.

getProperties()

NamedValueSet & juce::DynamicObject::getProperties ( )

inlinenoexcept

Returns the NamedValueSet that holds the object's properties.

getProperty()

const var & juce::DynamicObject::getProperty ( const Identifier & propertyName ) const

virtual

Returns a named property. This returns var() if no such property exists.

hasMethod()

bool juce::DynamicObject::hasMethod ( const Identifier & methodName ) const

virtual

Checks whether this object has the specified method.

The default implementation of this just checks whether there's a property with this name that's actually a method, but this can be overridden for building objects with dynamic invocation.

hasProperty()

bool juce::DynamicObject::hasProperty ( const Identifier & propertyName ) const

virtual

Returns true if the object has a property with this name. Note that if the property is actually a method, this will return false.

invokeMethod()

var juce::DynamicObject::invokeMethod ( Identifier methodName, const var::NativeFunctionArgs & args )

virtual

Invokes a named method on this object.

The default implementation looks up the named property, and if it's a method call, then it invokes it.

This method is virtual to allow more dynamic invocation to used for objects where the methods may not already be set as properties.

removeProperty()

void juce::DynamicObject::removeProperty ( const Identifier & propertyName )

virtual

Removes a named property.

setMethod()

void juce::DynamicObject::setMethod	(	Identifier	methodName,
		var::NativeFunction	function )

Adds a method to the class.

This is basically the same as calling setProperty (methodName, (var::NativeFunction) myFunction), but helps to avoid accidentally invoking the wrong type of var constructor. It also makes the code easier to read.

setProperty()

void juce::DynamicObject::setProperty ( const Identifier & propertyName, const var & newValue )

virtual

Sets a named property.

writeAsJSON()

void juce::DynamicObject::writeAsJSON ( OutputStream & out, int indentLevel, bool allOnOneLine, int maximumDecimalPlaces )

virtual

Writes this object to a text stream in JSON format. This method is used by JSON::toString and JSON::writeToStream, and you should never need to call it directly, but it's virtual so that custom object types can stringify themselves appropriately.

Reimplemented in juce::JavascriptEngine::RootObject::FunctionObject.

Member Data Documentation

properties

NamedValueSet juce::DynamicObject::properties

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_core/containers/juce_DynamicObject.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_core/containers/juce_DynamicObject.cpp