TransactionalSettingBase Class Reference

#include <Prefs.h>

Inheritance diagram for TransactionalSettingBase:

Collaboration diagram for TransactionalSettingBase:

Public Member Functions
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::BasicSettings *	GetConfig () const
const SettingPath &	GetPath () const
bool	Delete ()
	Delete the key if present, and return true iff it was. More...

Protected Member Functions
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

Friends
class	SettingTransaction
class	SettingScope

Additional Inherited Members
Protected Attributes inherited from SettingBase
const SettingPath	mPath

Detailed Description

Definition at line 98 of file Prefs.h.

Member Function Documentation

Commit()

virtual bool TransactionalSettingBase::Commit ( )

protectedpure virtual

Returns

true if successful

Implemented in Setting< T >, Setting< bool >, Setting< double >, Setting< int >, and Setting< wxString >.

EnterTransaction()

virtual void TransactionalSettingBase::EnterTransaction ( size_t  depth )

protectedpure virtual

Implemented in Setting< T >, Setting< bool >, Setting< double >, Setting< int >, and Setting< wxString >.

Invalidate()

virtual void TransactionalSettingBase::Invalidate ( )

pure virtual

Implemented in Setting< T >, Setting< bool >, Setting< double >, Setting< int >, and Setting< wxString >.

Referenced by ChoiceSetting::Write().

Here is the caller graph for this function:

Rollback()

virtual void TransactionalSettingBase::Rollback ( )

protectedpure virtualnoexcept

Implemented in Setting< T >, Setting< bool >, Setting< double >, Setting< int >, and Setting< wxString >.

SettingBase() [1/4]

SettingBase::SettingBase ( const char *  path )

inline

Definition at line 82 of file Prefs.h.

: mPath{ path } {}

SettingBase() [2/4]

SettingBase::SettingBase ( const SettingBase &  )

default

SettingBase() [3/4]

SettingBase::SettingBase ( const wxChar *  path )

inline

Definition at line 83 of file Prefs.h.

: mPath{ path } {}

SettingBase() [4/4]

SettingBase::SettingBase ( const wxString &  path )

inline

Definition at line 84 of file Prefs.h.

: mPath{ path } {}

Friends And Related Function Documentation

SettingScope

friend class SettingScope

friend

Definition at line 109 of file Prefs.h.

SettingTransaction

friend class SettingTransaction

friend

Definition at line 108 of file Prefs.h.

---

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

• Prefs.h