A powerful tree structure that can be used to hold free-form data, and which can handle its own undo and redo behaviour. More...

#include <juce_ValueTree.h>

Collaboration diagram for juce::ValueTree:

[legend]

Classes
struct	ComparatorAdapter

struct	Iterator
	Iterator for a ValueTree. More...

class	Listener
	Listener class for events that happen to a ValueTree. More...

Public Member Functions
	ValueTree () noexcept
	Creates an empty, invalid ValueTree. More...

	ValueTree (const Identifier &type)
	Creates an empty ValueTree with the given type name. More...

	ValueTree (const Identifier &type, std::initializer_list< NamedValueSet::NamedValue > properties, std::initializer_list< ValueTree > subTrees={})
	Creates a value tree from nested lists of properties and ValueTrees. More...

	ValueTree (const ValueTree &) noexcept
	Creates a reference to another ValueTree. More...

	ValueTree (ValueTree &&) noexcept
	Move constructor. More...

	~ValueTree ()
	Destructor. More...

void	addChild (const ValueTree &child, int index, UndoManager *undoManager)
	Adds a child to this tree. More...

void	addListener (Listener *listener)
	Adds a listener to receive callbacks when this tree is changed in some way. More...

void	appendChild (const ValueTree &child, UndoManager *undoManager)
	Appends a new child sub-tree to this tree. More...

Iterator	begin () const noexcept
	Returns a start iterator for the children in this tree. More...

void	copyPropertiesAndChildrenFrom (const ValueTree &source, UndoManager *undoManager)
	Replaces all children and properties of this object with copies of those from the source object. More...

void	copyPropertiesFrom (const ValueTree &source, UndoManager *undoManager)
	Overwrites all the properties in this tree with the properties of the source tree. More...

ValueTree	createCopy () const
	Returns a deep copy of this tree and all its sub-trees. More...

std::unique_ptr< XmlElement >	createXml () const
	Creates an XmlElement that holds a complete image of this tree and all its children. More...

Iterator	end () const noexcept
	Returns an end iterator for the children in this tree. More...

ValueTree	getChild (int index) const
	Returns one of this tree's sub-trees. More...

ValueTree	getChildWithName (const Identifier &type) const
	Returns the first sub-tree with the specified type name. More...

ValueTree	getChildWithProperty (const Identifier &propertyName, const var &propertyValue) const
	Looks for the first sub-tree that has the specified property value. More...

int	getNumChildren () const noexcept
	Returns the number of child trees inside this one. More...

int	getNumProperties () const noexcept
	Returns the total number of properties that the tree contains. More...

ValueTree	getOrCreateChildWithName (const Identifier &type, UndoManager *undoManager)
	Returns the first sub-tree with the specified type name, creating and adding a child with this name if there wasn't already one there. More...

ValueTree	getParent () const noexcept
	Returns the parent tree that contains this one. More...

const var &	getProperty (const Identifier &name) const noexcept
	Returns the value of a named property. More...

var	getProperty (const Identifier &name, const var &defaultReturnValue) const
	Returns the value of a named property, or the value of defaultReturnValue if the property doesn't exist. More...

Value	getPropertyAsValue (const Identifier &name, UndoManager *undoManager, bool shouldUpdateSynchronously=false)
	Returns a Value object that can be used to control and respond to one of the tree's properties. More...

Identifier	getPropertyName (int index) const noexcept
	Returns the identifier of the property with a given index. More...

const var *	getPropertyPointer (const Identifier &name) const noexcept
	Returns a pointer to the value of a named property, or nullptr if the property doesn't exist. More...

int	getReferenceCount () const noexcept
	Returns the total number of references to the shared underlying data structure that this ValueTree is using. More...

ValueTree	getRoot () const noexcept
	Recursively finds the highest-level parent tree that contains this one. More...

ValueTree	getSibling (int delta) const noexcept
	Returns one of this tree's siblings in its parent's child list. More...

Identifier	getType () const noexcept
	Returns the type of this tree. More...

bool	hasProperty (const Identifier &name) const noexcept
	Returns true if the tree contains a named property. More...

bool	hasType (const Identifier &typeName) const noexcept
	Returns true if the tree has this type. More...

int	indexOf (const ValueTree &child) const noexcept
	Returns the index of a child item in this parent. More...

bool	isAChildOf (const ValueTree &possibleParent) const noexcept
	Returns true if this tree is a sub-tree (at any depth) of the given parent. More...

bool	isEquivalentTo (const ValueTree &) const
	Performs a deep comparison between the properties and children of two trees. More...

bool	isValid () const noexcept
	Returns true if this tree refers to some valid data. More...

void	moveChild (int currentIndex, int newIndex, UndoManager *undoManager)
	Moves one of the sub-trees to a different index. More...

bool	operator!= (const ValueTree &) const noexcept
	Returns true if this and the other tree refer to different underlying structures. More...

ValueTree &	operator= (const ValueTree &)
	Changes this object to be a reference to the given tree. More...

bool	operator== (const ValueTree &) const noexcept
	Returns true if both this and the other tree refer to the same underlying structure. More...

const var &	operator[] (const Identifier &name) const noexcept
	Returns the value of a named property. More...

void	removeAllChildren (UndoManager *undoManager)
	Removes all child-trees. More...

void	removeAllProperties (UndoManager *undoManager)
	Removes all properties from the tree. More...

void	removeChild (const ValueTree &child, UndoManager *undoManager)
	Removes the specified child from this tree's child-list. More...

void	removeChild (int childIndex, UndoManager *undoManager)
	Removes a sub-tree from this tree. More...

void	removeListener (Listener *listener)
	Removes a listener that was previously added with addListener(). More...

void	removeProperty (const Identifier &name, UndoManager *undoManager)
	Removes a property from the tree. More...

void	sendPropertyChangeMessage (const Identifier &property)
	Causes a property-change callback to be triggered for the specified property, calling any listeners that are registered. More...

ValueTree &	setProperty (const Identifier &name, const var &newValue, UndoManager *undoManager)
	Changes a named property of the tree. More...

ValueTree &	setPropertyExcludingListener (Listener listenerToExclude, const Identifier &name, const var &newValue, UndoManager undoManager)
	Changes a named property of the tree, but will not notify a specified listener of the change. More...

template<typename ElementComparator >
void	sort (ElementComparator &comparator, UndoManager *undoManager, bool retainOrderOfEquivalentItems)
	This method uses a comparator object to sort the tree's children into order. More...

String	toXmlString (const XmlElement::TextFormat &format={}) const
	This returns a string containing an XML representation of the tree. More...

void	writeToStream (OutputStream &output) const
	Stores this tree (and all its children) in a binary format. More...

Static Public Member Functions
static ValueTree	fromXml (const String &xmlText)
	Tries to recreate a tree from its XML representation. More...

static ValueTree	fromXml (const XmlElement &xml)
	Tries to recreate a tree from its XML representation. More...

static ValueTree	readFromData (const void *data, size_t numBytes)
	Reloads a tree from a data block that was written with writeToStream(). More...

static ValueTree	readFromGZIPData (const void *data, size_t numBytes)
	Reloads a tree from a data block that was written with writeToStream() and then zipped using GZIPCompressorOutputStream. More...

static ValueTree	readFromStream (InputStream &input)
	Reloads a tree from a stream that was written with writeToStream(). More...

Private Member Functions
	ValueTree (ReferenceCountedObjectPtr< SharedObject >) noexcept

	ValueTree (SharedObject &) noexcept

void	createListOfChildren (OwnedArray< ValueTree > &) const

void	reorderChildren (const OwnedArray< ValueTree > &, UndoManager *)

Private Attributes
ListenerList< Listener >	listeners

ReferenceCountedObjectPtr< SharedObject >	object

Friends
class	SharedObject

Detailed Description

A powerful tree structure that can be used to hold free-form data, and which can handle its own undo and redo behaviour.

A ValueTree contains a list of named properties as var objects, and also holds any number of sub-trees.

Create ValueTree objects on the stack, and don't be afraid to copy them around, as they're simply a lightweight reference to a shared data container. Creating a copy of another ValueTree simply creates a new reference to the same underlying object - to make a separate, deep copy of a tree you should explicitly call createCopy().

Each ValueTree has a type name, in much the same way as an XmlElement has a tag name, and much of the structure of a ValueTree is similar to an XmlElement tree. You can convert a ValueTree to and from an XmlElement, and as long as the XML doesn't contain text elements, the conversion works well and makes a good serialisation format. They can also be serialised to a binary format, which is very fast and compact.

All the methods that change data take an optional UndoManager, which will be used to track any changes to the object. For this to work, you have to be careful to consistently always use the same UndoManager for all operations to any sub-tree inside the tree.

A ValueTree can only be a child of one parent at a time, so if you're moving one from one tree to another, be careful to always remove it first, before adding it. This could also mess up your undo/redo chain, so be wary! In a debug build you should hit assertions if you try to do anything dangerous, but there are still plenty of ways it could go wrong.

Note that although the children in a tree have a fixed order, the properties are not guaranteed to be stored in any particular order, so don't expect that a property's index will correspond to the order in which the property was added, or that it will remain constant when other properties are added or removed.

Listeners can be added to a ValueTree to be told when properties change and when sub-trees are added or removed.

See also: var, XmlElement

@tags{DataStructures}

Constructor & Destructor Documentation

◆ ValueTree() [1/7]

juce::ValueTree::ValueTree ( )

noexcept

Creates an empty, invalid ValueTree.

A ValueTree that is created with this constructor can't actually be used for anything, it's just a default 'null' ValueTree that can be returned to indicate some sort of failure. To create a real one, use the constructor that takes a string.

◆ ValueTree() [2/7]

juce::ValueTree::ValueTree ( const Identifier & type )

explicit

Creates an empty ValueTree with the given type name.

Like an XmlElement, each ValueTree has a type, which you can access with getType() and hasType().

◆ ValueTree() [3/7]

juce::ValueTree::ValueTree	(	const Identifier &	type,
		std::initializer_list< NamedValueSet::NamedValue >	properties,
		std::initializer_list< ValueTree >	subTrees = `{}`
	)

Creates a value tree from nested lists of properties and ValueTrees.

This code,

ValueTree groups
{ "ParameterGroups", {},
  {
    { "Group", {{ "name", "Tone Controls" }},
      {
        { "Parameter", {{ "id", "distortion" }, { "value", 0.5 }}},
        { "Parameter", {{ "id", "reverb" },     { "value", 0.5 }}}
      }
    },
    { "Group", {{ "name", "Other Controls" }},
      {
        { "Parameter", {{ "id", "drywet" }, { "value", 0.5 }}},
        { "Parameter", {{ "id", "gain" },   { "value", 0.5 }}}
      }
    }
  }
};

produces this tree:

<ParameterGroups>
  <Group name="Tone Controls">
    <Parameter id="distortion" value="0.5"/>
    <Parameter id="reverb" value="0.5"/>
  </Group>
  <Group name="Other Controls">
    <Parameter id="drywet" value="0.5"/>
    <Parameter id="gain" value="0.5"/>
  </Group>
</ParameterGroups>

◆ ValueTree() [4/7]

juce::ValueTree::ValueTree ( const ValueTree & )

noexcept

Creates a reference to another ValueTree.

◆ ValueTree() [5/7]

juce::ValueTree::ValueTree ( ValueTree && )

noexcept

Move constructor.

◆ ~ValueTree()

juce::ValueTree::~ValueTree ( )

Destructor.

◆ ValueTree() [6/7]

juce::ValueTree::ValueTree ( ReferenceCountedObjectPtr< SharedObject > )

explicitprivatenoexcept

◆ ValueTree() [7/7]

juce::ValueTree::ValueTree ( SharedObject & )

explicitprivatenoexcept

Member Function Documentation

◆ addChild()

void juce::ValueTree::addChild	(	const ValueTree &	child,
		int	index,
		UndoManager *	undoManager
	)

Adds a child to this tree.

Make sure that the child being added has first been removed from any former parent before calling this, or else you'll hit an assertion. If the index is < 0 or greater than the current number of sub-trees, the new one will be added at the end of the list. If the undoManager parameter is not nullptr, its UndoManager::perform() method will be used, so that this change can be undone. Be very careful not to mix undoable and non-undoable changes!

See also: appendChild, removeChild

◆ addListener()

void juce::ValueTree::addListener ( Listener * listener )

Adds a listener to receive callbacks when this tree is changed in some way.

The listener is added to this specific ValueTree object, and not to the shared object that it refers to. When this object is deleted, all the listeners will be lost, even if other references to the same ValueTree still exist. And if you use the operator= to make this refer to a different ValueTree, any listeners will begin listening to changes to the new tree instead of the old one.

When you're adding a listener, make sure that you add it to a ValueTree instance that will last for as long as you need the listener. In general, you'd never want to add a listener to a local stack-based ValueTree, and would usually add one to a member variable.

See also: removeListener

Referenced by juce::CachedValue< Type >::CachedValue().

◆ appendChild()

void juce::ValueTree::appendChild	(	const ValueTree &	child,
		UndoManager *	undoManager
	)

Appends a new child sub-tree to this tree.

This is equivalent to calling addChild() with an index of -1. See addChild() for more details.

See also: addChild, removeChild

◆ begin()

Iterator juce::ValueTree::begin ( ) const

noexcept

Returns a start iterator for the children in this tree.

◆ copyPropertiesAndChildrenFrom()

void juce::ValueTree::copyPropertiesAndChildrenFrom	(	const ValueTree &	source,
		UndoManager *	undoManager
	)

Replaces all children and properties of this object with copies of those from the source object.

See also: copyPropertiesFrom

◆ copyPropertiesFrom()

void juce::ValueTree::copyPropertiesFrom	(	const ValueTree &	source,
		UndoManager *	undoManager
	)

Overwrites all the properties in this tree with the properties of the source tree.

Any properties that already exist will be updated; and new ones will be added, and any that are not present in the source tree will be removed.

See also: copyPropertiesAndChildrenFrom

◆ createCopy()

ValueTree juce::ValueTree::createCopy ( ) const

Returns a deep copy of this tree and all its sub-trees.

◆ createListOfChildren()

void juce::ValueTree::createListOfChildren ( OwnedArray< ValueTree > & ) const

private

◆ createXml()

std::unique_ptr<XmlElement> juce::ValueTree::createXml ( ) const

Creates an XmlElement that holds a complete image of this tree and all its children.

If this tree is invalid, this may return nullptr. Otherwise, the XML that is produced can be used to recreate a similar tree by calling ValueTree::fromXml().

See also: fromXml, toXmlString

◆ end()

Iterator juce::ValueTree::end ( ) const

noexcept

Returns an end iterator for the children in this tree.

◆ fromXml() [1/2]

static ValueTree juce::ValueTree::fromXml ( const String & xmlText )

static

Tries to recreate a tree from its XML representation.

This isn't designed to cope with random XML data - it should only be fed XML that was created by the createXml() method.

◆ fromXml() [2/2]

static ValueTree juce::ValueTree::fromXml ( const XmlElement & xml )

static

Tries to recreate a tree from its XML representation.

This isn't designed to cope with random XML data - it should only be fed XML that was created by the createXml() method.

◆ getChild()

ValueTree juce::ValueTree::getChild ( int index ) const

Returns one of this tree's sub-trees.

If the index is out of range, it'll return an invalid tree. (You can use isValid() to check whether a tree is valid)

◆ getChildWithName()

ValueTree juce::ValueTree::getChildWithName ( const Identifier & type ) const

Returns the first sub-tree with the specified type name.

If no such child tree exists, it'll return an invalid tree. (You can use isValid() to check whether a tree is valid)

See also: getOrCreateChildWithName

◆ getChildWithProperty()

ValueTree juce::ValueTree::getChildWithProperty	(	const Identifier &	propertyName,
		const var &	propertyValue
	)		const

Looks for the first sub-tree that has the specified property value.

This will scan the child trees in order, until it finds one that has property that matches the specified value. If no such tree is found, it'll return an invalid object. (You can use isValid() to check whether a tree is valid)

◆ getNumChildren()

int juce::ValueTree::getNumChildren ( ) const

noexcept

Returns the number of child trees inside this one.

See also: getChild

◆ getNumProperties()

int juce::ValueTree::getNumProperties ( ) const

noexcept

Returns the total number of properties that the tree contains.

See also: getProperty.

◆ getOrCreateChildWithName()

ValueTree juce::ValueTree::getOrCreateChildWithName	(	const Identifier &	type,
		UndoManager *	undoManager
	)

Returns the first sub-tree with the specified type name, creating and adding a child with this name if there wasn't already one there.

The only time this will return an invalid object is when the object that you're calling the method on is itself invalid.

See also: getChildWithName

◆ getParent()

ValueTree juce::ValueTree::getParent ( ) const

noexcept

Returns the parent tree that contains this one.

If the tree has no parent, this will return an invalid object. (You can use isValid() to check whether a tree is valid)

◆ getProperty() [1/2]

const var& juce::ValueTree::getProperty ( const Identifier & name ) const

noexcept

Returns the value of a named property.

If no such property has been set, this will return a void variant. You can also use operator[] to get a property.

See also: var, setProperty, getPropertyPointer, hasProperty

◆ getProperty() [2/2]

var juce::ValueTree::getProperty	(	const Identifier &	name,
		const var &	defaultReturnValue
	)		const

Returns the value of a named property, or the value of defaultReturnValue if the property doesn't exist.

You can also use operator[] and getProperty to get a property.

See also: var, getProperty, getPropertyPointer, setProperty, hasProperty

◆ getPropertyAsValue()

Value juce::ValueTree::getPropertyAsValue	(	const Identifier &	name,
		UndoManager *	undoManager,
		bool	shouldUpdateSynchronously = `false`
	)

Returns a Value object that can be used to control and respond to one of the tree's properties.

The Value object will maintain a reference to this tree, and will use the undo manager when it needs to change the value. Attaching a Value::Listener to the value object will provide callbacks whenever the property changes. If shouldUpdateSynchronously is true the Value::Listener will be updated synchronously.

See also: ValueSource::sendChangeMessage (bool)

◆ getPropertyName()

Identifier juce::ValueTree::getPropertyName ( int index ) const

noexcept

Returns the identifier of the property with a given index.

Note that properties are not guaranteed to be stored in any particular order, so don't expect that the index will correspond to the order in which the property was added, or that it will remain constant when other properties are added or removed.

See also: getNumProperties

◆ getPropertyPointer()

const var* juce::ValueTree::getPropertyPointer ( const Identifier & name ) const

noexcept

Returns a pointer to the value of a named property, or nullptr if the property doesn't exist.

See also: var, getProperty, setProperty, hasProperty

◆ getReferenceCount()

int juce::ValueTree::getReferenceCount ( ) const

noexcept

Returns the total number of references to the shared underlying data structure that this ValueTree is using.

◆ getRoot()

ValueTree juce::ValueTree::getRoot ( ) const

noexcept

Recursively finds the highest-level parent tree that contains this one.

If the tree has no parent, this will return itself.

◆ getSibling()

ValueTree juce::ValueTree::getSibling ( int delta ) const

noexcept

Returns one of this tree's siblings in its parent's child list.

The delta specifies how far to move through the list, so a value of 1 would return the tree that follows this one, -1 would return the tree before it, 0 will return this one, etc. If the requested position is beyond the start or end of the child list, this will return an invalid object.

◆ getType()

Identifier juce::ValueTree::getType ( ) const

noexcept

Returns the type of this tree.

The type is specified when the ValueTree is created.

See also: hasType

◆ hasProperty()

bool juce::ValueTree::hasProperty ( const Identifier & name ) const

noexcept

Returns true if the tree contains a named property.

◆ hasType()

bool juce::ValueTree::hasType ( const Identifier & typeName ) const

noexcept

Returns true if the tree has this type.

The comparison is case-sensitive.

See also: getType

◆ indexOf()

int juce::ValueTree::indexOf ( const ValueTree & child ) const

noexcept

Returns the index of a child item in this parent.

If the child isn't found, this returns -1.

◆ isAChildOf()

bool juce::ValueTree::isAChildOf ( const ValueTree & possibleParent ) const

noexcept

Returns true if this tree is a sub-tree (at any depth) of the given parent.

This searches recursively, so returns true if it's a sub-tree at any level below the parent.

◆ isEquivalentTo()

bool juce::ValueTree::isEquivalentTo ( const ValueTree & ) const

Performs a deep comparison between the properties and children of two trees.

If all the properties and children of the two trees are the same (recursively), this returns true. The normal operator==() only checks whether two trees refer to the same shared data structure, so use this method if you need to do a proper value comparison.

◆ isValid()

bool juce::ValueTree::isValid ( ) const

inlinenoexcept

Returns true if this tree refers to some valid data.

An invalid tree is one that was created with the default constructor.

◆ moveChild()

void juce::ValueTree::moveChild	(	int	currentIndex,
		int	newIndex,
		UndoManager *	undoManager
	)

Moves one of the sub-trees to a different index.

This will move the child to a specified index, shuffling along any intervening items as required. So for example, if you have a list of { 0, 1, 2, 3, 4, 5 }, then calling move (2, 4) would result in { 0, 1, 3, 4, 2, 5 }.

Parameters

currentIndex	the index of the item to be moved. If this isn't a valid index, then nothing will be done
newIndex	the index at which you'd like this item to end up. If this is less than zero, the value will be moved to the end of the list
undoManager	the optional UndoManager to use to store this transaction

◆ operator!=()

bool juce::ValueTree::operator!= ( const ValueTree & ) const

noexcept

Returns true if this and the other tree refer to different underlying structures.

Note that this isn't a value comparison - two independently-created trees which contain identical data are not considered equal.

◆ operator=()

ValueTree& juce::ValueTree::operator= ( const ValueTree & )

Changes this object to be a reference to the given tree.

Note that calling this just points this at the new object and invokes the Listener::valueTreeRedirected callback, but it's not an undoable operation. If you're trying to replace an entire tree in an undoable way, you probably want to use copyPropertiesAndChildrenFrom() instead.

◆ operator==()

bool juce::ValueTree::operator== ( const ValueTree & ) const

noexcept

Returns true if both this and the other tree refer to the same underlying structure.

Note that this isn't a value comparison - two independently-created trees which contain identical data are NOT considered equal.

◆ operator[]()

const var& juce::ValueTree::operator[] ( const Identifier & name ) const

noexcept

Returns the value of a named property.

If no such property has been set, this will return a void variant. This is the same as calling getProperty().

See also: getProperty

◆ readFromData()

static ValueTree juce::ValueTree::readFromData	(	const void *	data,
		size_t	numBytes
	)

static

Reloads a tree from a data block that was written with writeToStream().

◆ readFromGZIPData()

static ValueTree juce::ValueTree::readFromGZIPData	(	const void *	data,
		size_t	numBytes
	)

static

Reloads a tree from a data block that was written with writeToStream() and then zipped using GZIPCompressorOutputStream.

◆ readFromStream()

static ValueTree juce::ValueTree::readFromStream ( InputStream & input )

static

Reloads a tree from a stream that was written with writeToStream().

◆ removeAllChildren()

void juce::ValueTree::removeAllChildren ( UndoManager * undoManager )

Removes all child-trees.

If the undoManager parameter is not nullptr, its UndoManager::perform() method will be used, so that this change can be undone. Be very careful not to mix undoable and non-undoable changes!

◆ removeAllProperties()

void juce::ValueTree::removeAllProperties ( UndoManager * undoManager )

Removes all properties from the tree.

If the undoManager parameter is not nullptr, its UndoManager::perform() method will be used, so that this change can be undone. Be very careful not to mix undoable and non-undoable changes!

◆ removeChild() [1/2]

void juce::ValueTree::removeChild	(	const ValueTree &	child,
		UndoManager *	undoManager
	)

Removes the specified child from this tree's child-list.

If the undoManager parameter is not nullptr, its UndoManager::perform() method will be used, so that this change can be undone. Be very careful not to mix undoable and non-undoable changes!

◆ removeChild() [2/2]

void juce::ValueTree::removeChild	(	int	childIndex,
		UndoManager *	undoManager
	)

Removes a sub-tree from this tree.

If the index is out-of-range, nothing will be changed. If the undoManager parameter is not nullptr, its UndoManager::perform() method will be used, so that this change can be undone. Be very careful not to mix undoable and non-undoable changes!

◆ removeListener()

void juce::ValueTree::removeListener ( Listener * listener )

Removes a listener that was previously added with addListener().

◆ removeProperty()

void juce::ValueTree::removeProperty	(	const Identifier &	name,
		UndoManager *	undoManager
	)

Removes a property from the tree.

If the undoManager parameter is not nullptr, its UndoManager::perform() method will be used, so that this change can be undone. Be very careful not to mix undoable and non-undoable changes!

◆ reorderChildren()

void juce::ValueTree::reorderChildren	(	const OwnedArray< ValueTree > &	,
		UndoManager *
	)

private

◆ sendPropertyChangeMessage()

void juce::ValueTree::sendPropertyChangeMessage ( const Identifier & property )

Causes a property-change callback to be triggered for the specified property, calling any listeners that are registered.

◆ setProperty()

ValueTree& juce::ValueTree::setProperty	(	const Identifier &	name,
		const var &	newValue,
		UndoManager *	undoManager
	)

Changes a named property of the tree.

The name identifier must not be an empty string. If the undoManager parameter is not nullptr, its UndoManager::perform() method will be used, so that this change can be undone. Be very careful not to mix undoable and non-undoable changes!

See also: var, getProperty, removeProperty

Returns: a reference to the value tree, so that you can daisy-chain calls to this method.

◆ setPropertyExcludingListener()

ValueTree& juce::ValueTree::setPropertyExcludingListener	(	Listener *	listenerToExclude,
		const Identifier &	name,
		const var &	newValue,
		UndoManager *	undoManager
	)

Changes a named property of the tree, but will not notify a specified listener of the change.

See also: setProperty

◆ sort()

template<typename ElementComparator >

void juce::ValueTree::sort	(	ElementComparator &	comparator,
		UndoManager *	undoManager,
		bool	retainOrderOfEquivalentItems
	)

inline

This method uses a comparator object to sort the tree's children into order.

The object provided must have a method of the form:

int compareElements (const ValueTree& first, const ValueTree& second);

..and this method must return:

a value of < 0 if the first comes before the second
a value of 0 if the two objects are equivalent
a value of > 0 if the second comes before the first

To improve performance, the compareElements() method can be declared as static or const.

Parameters

comparator	the comparator to use for comparing elements.
undoManager	optional UndoManager for storing the changes
retainOrderOfEquivalentItems	if this is true, then items which the comparator says are equivalent will be kept in the order in which they currently appear in the array. This is slower to perform, but may be important in some cases. If it's false, a faster algorithm is used, but equivalent elements may be rearranged.

References juce::OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::sort().

◆ toXmlString()

String juce::ValueTree::toXmlString ( const XmlElement::TextFormat & format = {} ) const

This returns a string containing an XML representation of the tree.

This is quite handy for debugging purposes, as it provides a quick way to view a tree.

See also: createXml()

◆ writeToStream()

void juce::ValueTree::writeToStream ( OutputStream & output ) const

Stores this tree (and all its children) in a binary format.

Once written, the data can be read back with readFromStream().

It's much faster to load/save your tree in binary form than as XML, but obviously isn't human-readable.

Friends And Related Function Documentation

◆ SharedObject

friend class SharedObject

friend

Member Data Documentation

◆ listeners

ListenerList<Listener> juce::ValueTree::listeners

private

◆ object

ReferenceCountedObjectPtr<SharedObject> juce::ValueTree::object

private

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

juce_ValueTree.h

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ValueTree() [1/7]

◆ ValueTree() [2/7]

◆ ValueTree() [3/7]

◆ ValueTree() [4/7]

◆ ValueTree() [5/7]

◆ ~ValueTree()

◆ ValueTree() [6/7]

◆ ValueTree() [7/7]

Member Function Documentation

◆ addChild()

◆ addListener()

◆ appendChild()

◆ begin()

◆ copyPropertiesAndChildrenFrom()

◆ copyPropertiesFrom()

◆ createCopy()

◆ createListOfChildren()

◆ createXml()

◆ end()

◆ fromXml() [1/2]

◆ fromXml() [2/2]

◆ getChild()

◆ getChildWithName()

◆ getChildWithProperty()

◆ getNumChildren()

◆ getNumProperties()

◆ getOrCreateChildWithName()

◆ getParent()

◆ getProperty() [1/2]

◆ getProperty() [2/2]

◆ getPropertyAsValue()

◆ getPropertyName()

◆ getPropertyPointer()

◆ getReferenceCount()

◆ getRoot()

◆ getSibling()

◆ getType()

◆ hasProperty()

◆ hasType()

◆ indexOf()

◆ isAChildOf()

◆ isEquivalentTo()

◆ isValid()

◆ moveChild()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ operator[]()

◆ readFromData()

◆ readFromGZIPData()

◆ readFromStream()

◆ removeAllChildren()

◆ removeAllProperties()

◆ removeChild() [1/2]

◆ removeChild() [2/2]

◆ removeListener()

◆ removeProperty()

◆ reorderChildren()

◆ sendPropertyChangeMessage()

◆ setProperty()

◆ setPropertyExcludingListener()

◆ sort()

◆ toXmlString()

◆ writeToStream()

Friends And Related Function Documentation

◆ SharedObject

Member Data Documentation

◆ listeners

◆ object