juce::NamedValueSet Class Reference

#include <juce_core.h>

Classes
struct	NamedValue

Public Member Functions
	NamedValueSet () noexcept
	NamedValueSet (const NamedValueSet &)
NamedValueSet &	operator= (const NamedValueSet &)
	~NamedValueSet () noexcept
bool	operator== (const NamedValueSet &) const
bool	operator!= (const NamedValueSet &) const
int	size () const noexcept
const var &	operator[] (const Identifier &name) const noexcept
var	getWithDefault (const Identifier &name, const var &defaultReturnValue) const
bool	set (const Identifier &name, const var &newValue)
bool	contains (const Identifier &name) const noexcept
bool	remove (const Identifier &name)
Identifier	getName (int index) const noexcept
var *	getVarPointer (const Identifier &name) const noexcept
const var &	getValueAt (int index) const noexcept
var *	getVarPointerAt (int index) const noexcept
int	indexOf (const Identifier &name) const noexcept
void	clear ()
void	setFromXmlAttributes (const XmlElement &xml)
void	copyToXmlAttributes (XmlElement &xml) const

Detailed Description

Holds a set of named var objects.

This can be used as a basic structure to hold a set of var object, which can be retrieved by using their identifier.

Constructor & Destructor Documentation

NamedValueSet() [1/2]

NamedValueSet::NamedValueSet ( )

noexcept

Creates an empty set.

NamedValueSet() [2/2]

NamedValueSet::NamedValueSet

(

const NamedValueSet &

other

)

Creates a copy of another set.

~NamedValueSet()

NamedValueSet::~NamedValueSet ( )

noexcept

Destructor.

Member Function Documentation

clear()

void NamedValueSet::clear

(

)

Removes all values.

contains()

bool NamedValueSet::contains ( const Identifier &  name ) const

noexcept

Returns true if the set contains an item with the specified name.

copyToXmlAttributes()

void NamedValueSet::copyToXmlAttributes

(

XmlElement &

xml

)

const

Sets attributes in an XML element corresponding to each of this object's properties.

getName()

Identifier NamedValueSet::getName ( int  index ) const

noexcept

Returns the name of the value at a given index. The index must be between 0 and size() - 1.

getValueAt()

const var & NamedValueSet::getValueAt ( int  index ) const

noexcept

Returns the value of the item at a given index. The index must be between 0 and size() - 1.

getVarPointer()

var * NamedValueSet::getVarPointer ( const Identifier &  name ) const

noexcept

Returns a pointer to the var that holds a named value, or null if there is no value with this name.

Do not use this method unless you really need access to the internal var object for some reason - for normal reading and writing always prefer operator[]() and set().

getVarPointerAt()

var * NamedValueSet::getVarPointerAt ( int  index ) const

noexcept

Returns the value of the item at a given index. The index must be between 0 and size() - 1, or this will return a nullptr

getWithDefault()

var NamedValueSet::getWithDefault	(	const Identifier &	name,
		const var &	defaultReturnValue
	)		const

Tries to return the named value, but if no such value is found, this will instead return the supplied default value.

indexOf()

int NamedValueSet::indexOf ( const Identifier &  name ) const

noexcept

Returns the index of the given name, or -1 if it's not found.

operator!=()

bool NamedValueSet::operator!=

(

const NamedValueSet &

other

)

const

operator=()

NamedValueSet & NamedValueSet::operator=

(

const NamedValueSet &

other

)

Replaces this set with a copy of another set.

operator==()

bool NamedValueSet::operator==

(

const NamedValueSet &

other

)

const

operator[]()

const var & NamedValueSet::operator[] ( const Identifier &  name ) const

noexcept

Returns the value of a named item. If the name isn't found, this will return a void variant.

See also

getProperty

remove()

bool NamedValueSet::remove

(

const Identifier &

name

)

Removes a value from the set.

Returns

true if a value was removed; false if there was no value with the name that was given.

set()

bool NamedValueSet::set	(	const Identifier &	name,
		const var &	newValue
	)

Changes or adds a named value.

Returns

true if a value was changed or added; false if the value was already set the value passed-in.

setFromXmlAttributes()

void NamedValueSet::setFromXmlAttributes

(

const XmlElement &

xml

)

Sets properties to the values of all of an XML element's attributes.

size()

int NamedValueSet::size ( ) const

noexcept

Returns the total number of values that the set contains.

---

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

• juce_core.h
• juce_core.cpp