juce_ApplicationProperties.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_APPLICATIONPROPERTIES_H_INCLUDED
#define JUCE_APPLICATIONPROPERTIES_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  ApplicationProperties
{
public:
    //==============================================================================
    ApplicationProperties();
 
    ~ApplicationProperties();
 
    //==============================================================================
    void setStorageParameters (const PropertiesFile::Options& options);
 
    const PropertiesFile::Options& getStorageParameters() const noexcept        { return options; }
 
    //==============================================================================
    PropertiesFile* getUserSettings();
 
    PropertiesFile* getCommonSettings (bool returnUserPropsIfReadOnly);
 
    //==============================================================================
    bool saveIfNeeded();
 
    void closeFiles();
 
 
private:
    //==============================================================================
    PropertiesFile::Options options;
    ScopedPointer <PropertiesFile> userProps, commonProps;
    int commonSettingsAreReadOnly;
 
    void openFiles();
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ApplicationProperties)
};
 
 
#endif   // JUCE_APPLICATIONPROPERTIES_H_INCLUDED