juce::ValueTreePropertyWithDefault Class Reference

#include <juce_ValueTreePropertyWithDefault.h>

Inheritance diagram for juce::ValueTreePropertyWithDefault:

Classes
class	SynchronousValueSource

Public Member Functions
	ValueTreePropertyWithDefault ()=default
	ValueTreePropertyWithDefault (ValueTree &tree, const Identifier &propertyID, UndoManager *um)
	ValueTreePropertyWithDefault (ValueTree &tree, const Identifier &propertyID, UndoManager *um, var defaultToUse)
	ValueTreePropertyWithDefault (ValueTree &tree, const Identifier &propertyID, UndoManager *um, var defaultToUse, StringRef arrayDelimiter)
	ValueTreePropertyWithDefault (const ValueTreePropertyWithDefault &other)
	~ValueTreePropertyWithDefault () override
var	get () const noexcept
Value	getPropertyAsValue ()
var	getDefault () const
void	setDefault (const var &newDefault)
bool	isUsingDefault () const
void	resetToDefault () noexcept
ValueTreePropertyWithDefault &	operator= (const var &newValue)
void	setValue (const var &newValue, UndoManager *undoManagerToUse)
void	referTo (ValueTree tree, const Identifier &property, UndoManager *um)
void	referTo (ValueTree tree, const Identifier &property, UndoManager *um, var defaultVal)
void	referTo (ValueTree tree, const Identifier &property, UndoManager *um, var defaultVal, StringRef arrayDelimiter)
ValueTree &	getValueTree () noexcept
Identifier &	getPropertyID () noexcept
UndoManager *	getUndoManager () noexcept
ValueTreePropertyWithDefault &	operator= (const ValueTreePropertyWithDefault &other)

Public Attributes
std::function< void()>	onDefaultChange

Private Member Functions
void	valueChanged (Value &) override
void	referToWithDefault (ValueTree v, const Identifier &i, UndoManager *um, const Value &defaultVal, StringRef del)
Private Member Functions inherited from juce::Value::Listener
	Listener ()=default
virtual	~Listener ()=default

Static Private Member Functions
static String	varArrayToDelimitedString (const Array< var > &input, StringRef delim)
static Array< var >	delimitedStringToVarArray (StringRef input, StringRef delim)

Private Attributes
ValueTree	targetTree
Identifier	targetProperty
UndoManager *	undoManager = nullptr
Value	defaultValue
String	delimiter

Detailed Description

This class acts as a wrapper around a property inside a ValueTree.

If the property inside the ValueTree is missing it will return a default value, which can be specified in the constructor or by calling setDefault().

@tags{DataStructures}

Constructor & Destructor Documentation

ValueTreePropertyWithDefault() [1/5]

juce::ValueTreePropertyWithDefault::ValueTreePropertyWithDefault ( )

default

Creates an uninitialised ValueTreePropertyWithDefault object.

Initialise it using one of the referTo() methods.

ValueTreePropertyWithDefault() [2/5]

juce::ValueTreePropertyWithDefault::ValueTreePropertyWithDefault ( ValueTree & tree, const Identifier & propertyID, UndoManager * um )

inline

Creates a ValueTreePropertyWithDefault object for the specified property.

The default value will be an empty var.

ValueTreePropertyWithDefault() [3/5]

juce::ValueTreePropertyWithDefault::ValueTreePropertyWithDefault ( ValueTree & tree, const Identifier & propertyID, UndoManager * um, var defaultToUse )

inline

Creates an ValueTreePropertyWithDefault object for the specified property.

The default value will be defaultToUse.

ValueTreePropertyWithDefault() [4/5]

juce::ValueTreePropertyWithDefault::ValueTreePropertyWithDefault ( ValueTree & tree, const Identifier & propertyID, UndoManager * um, var defaultToUse, StringRef arrayDelimiter )

inline

Creates a ValueTreePropertyWithDefault object for the specified property.

The default value will be defaultToUse.

Use this constructor if the underlying var object being controlled is an array and it will handle the conversion to/from a delimited String that can be written to XML format.

ValueTreePropertyWithDefault() [5/5]

juce::ValueTreePropertyWithDefault::ValueTreePropertyWithDefault ( const ValueTreePropertyWithDefault & other )

inline

Creates a ValueTreePropertyWithDefault object from another ValueTreePropertyWithDefault object.

~ValueTreePropertyWithDefault()

juce::ValueTreePropertyWithDefault::~ValueTreePropertyWithDefault ( )

inlineoverride

Destructor.

Member Function Documentation

delimitedStringToVarArray()

Array< var > juce::ValueTreePropertyWithDefault::delimitedStringToVarArray ( StringRef input, StringRef delim )

inlinestaticprivate

get()

var juce::ValueTreePropertyWithDefault::get ( ) const

inlinenoexcept

Returns the current value of the property.

If the property does not exist this returns the default value.

getDefault()

var juce::ValueTreePropertyWithDefault::getDefault ( ) const

inline

Returns the current default value.

getPropertyAsValue()

Value juce::ValueTreePropertyWithDefault::getPropertyAsValue ( )

inline

Returns the current property as a Value object.

getPropertyID()

Identifier & juce::ValueTreePropertyWithDefault::getPropertyID ( )

inlinenoexcept

Returns the property ID of the referenced property.

getUndoManager()

UndoManager * juce::ValueTreePropertyWithDefault::getUndoManager ( )

inlinenoexcept

Returns the UndoManager that is being used.

getValueTree()

ValueTree & juce::ValueTreePropertyWithDefault::getValueTree ( )

inlinenoexcept

Returns a reference to the ValueTree containing the referenced property.

isUsingDefault()

bool juce::ValueTreePropertyWithDefault::isUsingDefault ( ) const

inline

Returns true if the property does not exist in the referenced ValueTree.

operator=() [1/2]

ValueTreePropertyWithDefault & juce::ValueTreePropertyWithDefault::operator= ( const ValueTreePropertyWithDefault & other )

inline

operator=() [2/2]

ValueTreePropertyWithDefault & juce::ValueTreePropertyWithDefault::operator= ( const var & newValue )

inline

Sets the property and returns the new ValueTreePropertyWithDefault.

This will modify the property in the referenced ValueTree.

referTo() [1/3]

void juce::ValueTreePropertyWithDefault::referTo ( ValueTree tree, const Identifier & property, UndoManager * um )

inline

Makes the ValueTreePropertyWithDefault refer to the specified property inside the given ValueTree.

The default value will be an empty var.

referTo() [2/3]

void juce::ValueTreePropertyWithDefault::referTo ( ValueTree tree, const Identifier & property, UndoManager * um, var defaultVal )

inline

Makes the ValueTreePropertyWithDefault refer to the specified property inside the given ValueTree.

The default value will be defaultVal.

referTo() [3/3]

void juce::ValueTreePropertyWithDefault::referTo ( ValueTree tree, const Identifier & property, UndoManager * um, var defaultVal, StringRef arrayDelimiter )

inline

Makes the ValueTreePropertyWithDefault refer to the specified property inside the given ValueTree.

The default value will be defaultVal.

referToWithDefault()

void juce::ValueTreePropertyWithDefault::referToWithDefault ( ValueTree v, const Identifier & i, UndoManager * um, const Value & defaultVal, StringRef del )

inlineprivate

resetToDefault()

void juce::ValueTreePropertyWithDefault::resetToDefault ( )

inlinenoexcept

Removes the property from the referenced ValueTree.

setDefault()

void juce::ValueTreePropertyWithDefault::setDefault ( const var & newDefault )

inline

Sets the default value to a new var.

setValue()

void juce::ValueTreePropertyWithDefault::setValue ( const var & newValue, UndoManager * undoManagerToUse )

inline

Sets the property.

This will modify the property in the referenced ValueTree.

valueChanged()

void juce::ValueTreePropertyWithDefault::valueChanged ( Value & value )

inlineoverrideprivatevirtual

Called when a Value object is changed.

Note that the Value object passed as a parameter may not be exactly the same object that you registered the listener with - it might be a copy that refers to the same underlying ValueSource. To find out, you can call Value::refersToSameSourceAs().

Implements juce::Value::Listener.

varArrayToDelimitedString()

String juce::ValueTreePropertyWithDefault::varArrayToDelimitedString ( const Array< var > & input, StringRef delim )

inlinestaticprivate

Member Data Documentation

defaultValue

Value juce::ValueTreePropertyWithDefault::defaultValue

private

delimiter

String juce::ValueTreePropertyWithDefault::delimiter

private

onDefaultChange

std::function<void()> juce::ValueTreePropertyWithDefault::onDefaultChange

You can assign a lambda to this callback and it will called when the default value is changed.

See also

setDefault

targetProperty

Identifier juce::ValueTreePropertyWithDefault::targetProperty

private

targetTree

ValueTree juce::ValueTreePropertyWithDefault::targetTree

private

undoManager

UndoManager* juce::ValueTreePropertyWithDefault::undoManager = nullptr

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_data_structures/values/juce_ValueTreePropertyWithDefault.h