TracktionEngine
Public Member Functions | Static Public Member Functions | List of all members
tracktion::engine::PropertyStorage Class Reference

Create a subclass of PropertyStorage to customize how settings are saved and recalled. More...

Public Member Functions

 PropertyStorage (juce::String appName_)
 
virtual ~PropertyStorage ()
 
virtual juce::File getAppCacheFolder ()
 
virtual juce::File getAppPrefsFolder ()
 
virtual void flushSettingsToDisk ()
 
virtual void removeProperty (SettingID)
 
virtual juce::var getProperty (SettingID setting, const juce::var &defaultValue={})
 
virtual void setProperty (SettingID setting, const juce::var &value)
 
virtual std::unique_ptr< juce::XmlElement > getXmlProperty (SettingID setting)
 
virtual void setXmlProperty (SettingID setting, const juce::XmlElement &)
 
virtual void removePropertyItem (SettingID setting, juce::StringRef item)
 
virtual juce::var getPropertyItem (SettingID setting, juce::StringRef item, const juce::var &defaultValue={})
 
virtual void setPropertyItem (SettingID setting, juce::StringRef item, const juce::var &value)
 
virtual std::unique_ptr< juce::XmlElement > getXmlPropertyItem (SettingID setting, juce::StringRef item)
 
virtual void setXmlPropertyItem (SettingID setting, juce::StringRef item, const juce::XmlElement &)
 
virtual juce::File getDefaultLoadSaveDirectory (juce::StringRef label)
 
virtual void setDefaultLoadSaveDirectory (juce::StringRef label, const juce::File &newPath)
 
virtual juce::File getDefaultLoadSaveDirectory (ProjectItem::Category)
 
virtual juce::String getUserName ()
 
virtual juce::String getApplicationName ()
 
virtual juce::String getApplicationVersion ()
 

Static Public Member Functions

static juce::String settingToString (SettingID)
 

Detailed Description

Create a subclass of PropertyStorage to customize how settings are saved and recalled.

Constructor & Destructor Documentation

◆ PropertyStorage()

tracktion::engine::PropertyStorage::PropertyStorage ( juce::String  appName_)

◆ ~PropertyStorage()

virtual tracktion::engine::PropertyStorage::~PropertyStorage ( )
virtual

Member Function Documentation

◆ settingToString()

static juce::String tracktion::engine::PropertyStorage::settingToString ( SettingID  )
static

◆ getAppCacheFolder()

virtual juce::File tracktion::engine::PropertyStorage::getAppCacheFolder ( )
virtual

◆ getAppPrefsFolder()

virtual juce::File tracktion::engine::PropertyStorage::getAppPrefsFolder ( )
virtual

◆ flushSettingsToDisk()

virtual void tracktion::engine::PropertyStorage::flushSettingsToDisk ( )
virtual

◆ removeProperty()

virtual void tracktion::engine::PropertyStorage::removeProperty ( SettingID  )
virtual

◆ getProperty()

virtual juce::var tracktion::engine::PropertyStorage::getProperty ( SettingID  setting,
const juce::var &  defaultValue = {} 
)
virtual

◆ setProperty()

virtual void tracktion::engine::PropertyStorage::setProperty ( SettingID  setting,
const juce::var &  value 
)
virtual

◆ getXmlProperty()

virtual std::unique_ptr<juce::XmlElement> tracktion::engine::PropertyStorage::getXmlProperty ( SettingID  setting)
virtual

◆ setXmlProperty()

virtual void tracktion::engine::PropertyStorage::setXmlProperty ( SettingID  setting,
const juce::XmlElement &   
)
virtual

◆ removePropertyItem()

virtual void tracktion::engine::PropertyStorage::removePropertyItem ( SettingID  setting,
juce::StringRef  item 
)
virtual

◆ getPropertyItem()

virtual juce::var tracktion::engine::PropertyStorage::getPropertyItem ( SettingID  setting,
juce::StringRef  item,
const juce::var &  defaultValue = {} 
)
virtual

◆ setPropertyItem()

virtual void tracktion::engine::PropertyStorage::setPropertyItem ( SettingID  setting,
juce::StringRef  item,
const juce::var &  value 
)
virtual

◆ getXmlPropertyItem()

virtual std::unique_ptr<juce::XmlElement> tracktion::engine::PropertyStorage::getXmlPropertyItem ( SettingID  setting,
juce::StringRef  item 
)
virtual

◆ setXmlPropertyItem()

virtual void tracktion::engine::PropertyStorage::setXmlPropertyItem ( SettingID  setting,
juce::StringRef  item,
const juce::XmlElement &   
)
virtual

◆ getDefaultLoadSaveDirectory() [1/2]

virtual juce::File tracktion::engine::PropertyStorage::getDefaultLoadSaveDirectory ( juce::StringRef  label)
virtual

◆ setDefaultLoadSaveDirectory()

virtual void tracktion::engine::PropertyStorage::setDefaultLoadSaveDirectory ( juce::StringRef  label,
const juce::File &  newPath 
)
virtual

◆ getDefaultLoadSaveDirectory() [2/2]

virtual juce::File tracktion::engine::PropertyStorage::getDefaultLoadSaveDirectory ( ProjectItem::Category  )
virtual

◆ getUserName()

virtual juce::String tracktion::engine::PropertyStorage::getUserName ( )
virtual

◆ getApplicationName()

virtual juce::String tracktion::engine::PropertyStorage::getApplicationName ( )
virtual

◆ getApplicationVersion()

virtual juce::String tracktion::engine::PropertyStorage::getApplicationVersion ( )
virtual

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