tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications
« « « Anklang Documentation
Loading...
Searching...
No Matches
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...

#include "tracktion_PropertyStorage.h"

Public Member Functions

 PropertyStorage (juce::String appName_)
 
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 ()
 
virtual juce::PropertiesFile & getPropertiesFile ()
 

Static Public Member Functions

static juce::StringRef settingToString (SettingID)
 

Detailed Description

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

Definition at line 18 of file tracktion_PropertyStorage.h.

Constructor & Destructor Documentation

◆ PropertyStorage()

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

Definition at line 22 of file tracktion_PropertyStorage.h.

◆ ~PropertyStorage()

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

Definition at line 23 of file tracktion_PropertyStorage.h.

Member Function Documentation

◆ flushSettingsToDisk()

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

Definition at line 31 of file tracktion_PropertyStorage.h.

◆ getAppCacheFolder()

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

Definition at line 142 of file tracktion_PropertyStorage.cpp.

◆ getApplicationName()

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

Definition at line 59 of file tracktion_PropertyStorage.h.

◆ getApplicationVersion()

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

Definition at line 60 of file tracktion_PropertyStorage.h.

◆ getAppPrefsFolder()

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

Definition at line 147 of file tracktion_PropertyStorage.cpp.

◆ getDefaultLoadSaveDirectory() [1/2]

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

Definition at line 231 of file tracktion_PropertyStorage.cpp.

◆ getDefaultLoadSaveDirectory() [2/2]

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

Definition at line 240 of file tracktion_PropertyStorage.cpp.

◆ getPropertiesFile()

juce::PropertiesFile & tracktion::engine::PropertyStorage::getPropertiesFile ( )
virtual

Definition at line 162 of file tracktion_PropertyStorage.cpp.

◆ getProperty()

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

Definition at line 184 of file tracktion_PropertyStorage.cpp.

◆ getPropertyItem()

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

Definition at line 210 of file tracktion_PropertyStorage.cpp.

◆ getUserName()

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

Definition at line 157 of file tracktion_PropertyStorage.cpp.

◆ getXmlProperty()

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

Definition at line 194 of file tracktion_PropertyStorage.cpp.

◆ getXmlPropertyItem()

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

Definition at line 220 of file tracktion_PropertyStorage.cpp.

◆ removeProperty()

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

Definition at line 179 of file tracktion_PropertyStorage.cpp.

◆ removePropertyItem()

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

Definition at line 205 of file tracktion_PropertyStorage.cpp.

◆ setDefaultLoadSaveDirectory()

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

Definition at line 236 of file tracktion_PropertyStorage.cpp.

◆ setProperty()

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

Definition at line 189 of file tracktion_PropertyStorage.cpp.

◆ setPropertyItem()

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

Definition at line 215 of file tracktion_PropertyStorage.cpp.

◆ settingToString()

juce::StringRef tracktion::engine::PropertyStorage::settingToString ( SettingID  setting)
static

Definition at line 14 of file tracktion_PropertyStorage.cpp.

◆ setXmlProperty()

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

Definition at line 199 of file tracktion_PropertyStorage.cpp.

◆ setXmlPropertyItem()

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

Definition at line 225 of file tracktion_PropertyStorage.cpp.

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