JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Protected Member Functions | List of all members
PropertySet Class Reference

A set of named property values, which can be strings, integers, floating point, etc. More...

Inherited by PropertiesFile.

Public Member Functions

 PropertySet (bool ignoreCaseOfKeyNames=false)
 Creates an empty PropertySet.
 
 PropertySet (const PropertySet &other)
 Creates a copy of another PropertySet.
 
PropertySetoperator= (const PropertySet &other)
 Copies another PropertySet over this one.
 
virtual ~PropertySet ()
 Destructor.
 
String getValue (StringRef keyName, const String &defaultReturnValue=String()) const noexcept
 Returns one of the properties as a string.
 
int getIntValue (StringRef keyName, int defaultReturnValue=0) const noexcept
 Returns one of the properties as an integer.
 
double getDoubleValue (StringRef keyName, double defaultReturnValue=0.0) const noexcept
 Returns one of the properties as an double.
 
bool getBoolValue (StringRef keyName, bool defaultReturnValue=false) const noexcept
 Returns one of the properties as an boolean.
 
XmlElementgetXmlValue (StringRef keyName) const
 Returns one of the properties as an XML element.
 
void setValue (const String &keyName, const var &value)
 Sets a named property.
 
void setValue (const String &keyName, const XmlElement *xml)
 Sets a named property to an XML element.
 
void addAllPropertiesFrom (const PropertySet &source)
 This copies all the values from a source PropertySet to this one.
 
void removeValue (StringRef keyName)
 Deletes a property.
 
bool containsKey (StringRef keyName) const noexcept
 Returns true if the properies include the given key.
 
void clear ()
 Removes all values.
 
StringPairArraygetAllProperties () noexcept
 Returns the keys/value pair array containing all the properties.
 
const CriticalSectiongetLock () const noexcept
 Returns the lock used when reading or writing to this set.
 
XmlElementcreateXml (const String &nodeName) const
 Returns an XML element which encapsulates all the items in this property set.
 
void restoreFromXml (const XmlElement &xml)
 Reloads a set of properties that were previously stored as XML.
 
void setFallbackPropertySet (PropertySet *fallbackProperties) noexcept
 Sets up a second PopertySet that will be used to look up any values that aren't set in this one.
 
PropertySetgetFallbackPropertySet () const noexcept
 Returns the fallback property set.
 

Protected Member Functions

virtual void propertyChanged ()
 Subclasses can override this to be told when one of the properies has been changed.
 

Detailed Description

A set of named property values, which can be strings, integers, floating point, etc.

Effectively, this just wraps a StringPairArray in an interface that makes it easier to load and save types other than strings.

See the PropertiesFile class for a subclass of this, which automatically broadcasts change messages and saves/loads the list from a file.

Constructor & Destructor Documentation

PropertySet::PropertySet ( bool  ignoreCaseOfKeyNames = false)

Creates an empty PropertySet.

Parameters
ignoreCaseOfKeyNamesif true, the names of properties are compared in a case-insensitive way
PropertySet::PropertySet ( const PropertySet other)

Creates a copy of another PropertySet.

virtual PropertySet::~PropertySet ( )
virtual

Destructor.

Member Function Documentation

PropertySet& PropertySet::operator= ( const PropertySet other)

Copies another PropertySet over this one.

String PropertySet::getValue ( StringRef  keyName,
const String defaultReturnValue = String() 
) const
noexcept

Returns one of the properties as a string.

If the value isn't found in this set, then this will look for it in a fallback property set (if you've specified one with the setFallbackPropertySet() method), and if it can't find one there, it'll return the default value passed-in.

Parameters
keyNamethe name of the property to retrieve
defaultReturnValuea value to return if the named property doesn't actually exist

Referenced by StandaloneFilterWindow::loadState(), StandaloneFilterWindow::saveState(), and StandaloneFilterWindow::StandaloneFilterWindow().

int PropertySet::getIntValue ( StringRef  keyName,
int  defaultReturnValue = 0 
) const
noexcept

Returns one of the properties as an integer.

If the value isn't found in this set, then this will look for it in a fallback property set (if you've specified one with the setFallbackPropertySet() method), and if it can't find one there, it'll return the default value passed-in.

Parameters
keyNamethe name of the property to retrieve
defaultReturnValuea value to return if the named property doesn't actually exist

Referenced by StandaloneFilterWindow::StandaloneFilterWindow().

double PropertySet::getDoubleValue ( StringRef  keyName,
double  defaultReturnValue = 0.0 
) const
noexcept

Returns one of the properties as an double.

If the value isn't found in this set, then this will look for it in a fallback property set (if you've specified one with the setFallbackPropertySet() method), and if it can't find one there, it'll return the default value passed-in.

Parameters
keyNamethe name of the property to retrieve
defaultReturnValuea value to return if the named property doesn't actually exist
bool PropertySet::getBoolValue ( StringRef  keyName,
bool  defaultReturnValue = false 
) const
noexcept

Returns one of the properties as an boolean.

The result will be true if the string found for this key name can be parsed as a non-zero integer.

If the value isn't found in this set, then this will look for it in a fallback property set (if you've specified one with the setFallbackPropertySet() method), and if it can't find one there, it'll return the default value passed-in.

Parameters
keyNamethe name of the property to retrieve
defaultReturnValuea value to return if the named property doesn't actually exist
XmlElement* PropertySet::getXmlValue ( StringRef  keyName) const

Returns one of the properties as an XML element.

The result will a new XMLElement object that the caller must delete. If may return nullptr if the key isn't found, or if the entry contains an string that isn't valid XML.

If the value isn't found in this set, then this will look for it in a fallback property set (if you've specified one with the setFallbackPropertySet() method), and if it can't find one there, it'll return the default value passed-in.

Parameters
keyNamethe name of the property to retrieve

Referenced by StandaloneFilterWindow::StandaloneFilterWindow().

void PropertySet::setValue ( const String keyName,
const var value 
)

Sets a named property.

Parameters
keyNamethe name of the property to set. (This mustn't be an empty string)
valuethe new value to set it to

Referenced by StandaloneFilterWindow::~StandaloneFilterWindow().

void PropertySet::setValue ( const String keyName,
const XmlElement xml 
)

Sets a named property to an XML element.

Parameters
keyNamethe name of the property to set. (This mustn't be an empty string)
xmlthe new element to set it to. If this is zero, the value will be set to an empty string
See Also
getXmlValue
void PropertySet::addAllPropertiesFrom ( const PropertySet source)

This copies all the values from a source PropertySet to this one.

This won't remove any existing settings, it just adds any that it finds in the source set.

void PropertySet::removeValue ( StringRef  keyName)

Deletes a property.

Parameters
keyNamethe name of the property to delete. (This mustn't be an empty string)

Referenced by StandaloneFilterWindow::resetFilter().

bool PropertySet::containsKey ( StringRef  keyName) const
noexcept

Returns true if the properies include the given key.

void PropertySet::clear ( )

Removes all values.

StringPairArray& PropertySet::getAllProperties ( )
noexcept

Returns the keys/value pair array containing all the properties.

const CriticalSection& PropertySet::getLock ( ) const
noexcept

Returns the lock used when reading or writing to this set.

XmlElement* PropertySet::createXml ( const String nodeName) const

Returns an XML element which encapsulates all the items in this property set.

The string parameter is the tag name that should be used for the node.

See Also
restoreFromXml
void PropertySet::restoreFromXml ( const XmlElement xml)

Reloads a set of properties that were previously stored as XML.

The node passed in must have been created by the createXml() method.

See Also
createXml
void PropertySet::setFallbackPropertySet ( PropertySet fallbackProperties)
noexcept

Sets up a second PopertySet that will be used to look up any values that aren't set in this one.

If you set this up to be a pointer to a second property set, then whenever one of the getValue() methods fails to find an entry in this set, it will look up that value in the fallback set, and if it finds it, it will return that.

Make sure that you don't delete the fallback set while it's still being used by another set! To remove the fallback set, just call this method with a null pointer.

See Also
getFallbackPropertySet
PropertySet* PropertySet::getFallbackPropertySet ( ) const
noexcept

Returns the fallback property set.

See Also
setFallbackPropertySet
virtual void PropertySet::propertyChanged ( )
protectedvirtual

Subclasses can override this to be told when one of the properies has been changed.

Reimplemented in PropertiesFile.


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