juce_PropertySet.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   The code included in this file is provided under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license. Permission
   To use, copy, modify, and/or distribute this software for any purpose with or
   without fee is hereby granted provided that the above copyright notice and
   this permission notice appear in all copies.
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  PropertySet
{
public:
    //==============================================================================
    PropertySet (bool ignoreCaseOfKeyNames = false);

    PropertySet (const PropertySet& other);

    PropertySet& operator= (const PropertySet& other);

    virtual ~PropertySet();
 
    //==============================================================================
    String getValue (StringRef keyName, const String& defaultReturnValue = String()) const noexcept;

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

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

    bool getBoolValue (StringRef keyName, bool defaultReturnValue = false) const noexcept;

    std::unique_ptr<XmlElement> getXmlValue (StringRef keyName) const;
 
    //==============================================================================
    void setValue (StringRef keyName, const var& value);

    void setValue (StringRef keyName, const XmlElement* xml);

    void addAllPropertiesFrom (const PropertySet& source);
 
    //==============================================================================
    void removeValue (StringRef keyName);

    bool containsKey (StringRef keyName) const noexcept;

    void clear();
 
    //==============================================================================
    StringPairArray& getAllProperties() noexcept                        { return properties; }

    const CriticalSection& getLock() const noexcept                     { return lock; }
 
    //==============================================================================
    std::unique_ptr<XmlElement> createXml (const String& nodeName) const;

    void restoreFromXml (const XmlElement& xml);
 
    //==============================================================================
    void setFallbackPropertySet (PropertySet* fallbackProperties) noexcept;

    PropertySet* getFallbackPropertySet() const noexcept                { return fallbackProperties; }
 
protected:
    virtual void propertyChanged();
 
private:
    StringPairArray properties;
    PropertySet* fallbackProperties;
    CriticalSection lock;
    bool ignoreCaseOfKeys;
 
    JUCE_LEAK_DETECTOR (PropertySet)
};
 
} // namespace juce