Audacity 3.2.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CachingSettingBase< T > Class Template Reference

Class template adds an in-memory cache of a value to TransactionalSettingBase and support for SettingTransaction. More...

#include <Prefs.h>

Inheritance diagram for CachingSettingBase< T >:
[legend]
Collaboration diagram for CachingSettingBase< T >:
[legend]

Public Member Functions

 CachingSettingBase (const SettingBase &path)
 
- Public Member Functions inherited from TransactionalSettingBase
virtual void Invalidate ()=0
 
 SettingBase (const char *path)
 
 SettingBase (const wxChar *path)
 
 SettingBase (const wxString &path)
 
 SettingBase (const SettingBase &)=default
 
- Public Member Functions inherited from SettingBase
 SettingBase (const char *path)
 
 SettingBase (const wxChar *path)
 
 SettingBase (const wxString &path)
 
audacity::BasicSettingsGetConfig () const
 
const SettingPathGetPath () const
 
bool Delete ()
 Delete the key if present, and return true iff it was. More...
 

Protected Member Functions

 CachingSettingBase (const CachingSettingBase &)=default
 
- Protected Member Functions inherited from TransactionalSettingBase
virtual void EnterTransaction (size_t depth)=0
 
virtual bool Commit ()=0
 
virtual void Rollback () noexcept=0
 
- Protected Member Functions inherited from SettingBase
 SettingBase (const SettingBase &)=default
 

Protected Attributes

mCurrentValue {}
 
bool mValid {false}
 
- Protected Attributes inherited from SettingBase
const SettingPath mPath
 

Detailed Description

template<typename T>
class CachingSettingBase< T >

Class template adds an in-memory cache of a value to TransactionalSettingBase and support for SettingTransaction.

Definition at line 161 of file Prefs.h.

Constructor & Destructor Documentation

◆ CachingSettingBase() [1/2]

template<typename T >
CachingSettingBase< T >::CachingSettingBase ( const SettingBase path)
inlineexplicit

Definition at line 165 of file Prefs.h.

166 : TransactionalSettingBase{ path.GetPath() } {}
const SettingPath & GetPath() const
Definition: Prefs.h:88

◆ CachingSettingBase() [2/2]

template<typename T >
CachingSettingBase< T >::CachingSettingBase ( const CachingSettingBase< T > &  )
protecteddefault

Member Data Documentation

◆ mCurrentValue

template<typename T >
T CachingSettingBase< T >::mCurrentValue {}
mutableprotected

Definition at line 170 of file Prefs.h.

◆ mValid

template<typename T >
bool CachingSettingBase< T >::mValid {false}
mutableprotected

Definition at line 171 of file Prefs.h.


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