StringSetting Class Reference

Specialization of Setting for strings. More...

#include <Prefs.h>

Inheritance diagram for StringSetting:

Collaboration diagram for StringSetting:

Public Member Functions
	Setting (const SettingBase &path, const T &defaultValue)
	Usual overload supplies a default value. More...
	Setting (const SettingBase &path, DefaultValueFunction function)
	This overload causes recomputation of the default each time it is needed. More...
Public Member Functions inherited from Setting< wxString >
	Setting (const SettingBase &path, const wxString &defaultValue)
	Usual overload supplies a default value. More...
	Setting (const SettingBase &path, DefaultValueFunction function)
	This overload causes recomputation of the default each time it is needed. More...
const wxString &	GetDefault () const
bool	Read (wxString *pVar) const
	overload of Read returning a boolean that is true if the value was previously defined *‍/ More...
wxString	Read () const
	overload of Read, always returning a value More...
bool	ReadWithDefault (wxString *pVar, const wxString &defaultValue) const
	overload of ReadWithDefault returning a boolean that is true if the value was previously defined *‍/ More...
wxString	ReadWithDefault (const wxString &defaultValue) const
	new direct use is discouraged but it may be needed in legacy code More...
bool	Write (const wxString &value)
	Write value to config and return true if successful. More...
bool	Reset ()
	Reset to the default value. More...
void	Invalidate () override
Public Member Functions inherited from CachingSettingBase< wxString >
	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::BasicSettings *	GetConfig () const
const SettingPath &	GetPath () const
bool	Delete ()
	Delete the key if present, and return true iff it was. More...

Additional Inherited Members
Public Types inherited from Setting< wxString >
using	ValueType = wxString
using	DefaultValueFunction = std::function< wxString() >
Protected Member Functions inherited from Setting< wxString >
bool	DoWrite ()
	Write cached value to config and return true if successful. More...
Protected Member Functions inherited from CachingSettingBase< wxString >
	CachingSettingBase (const CachingSettingBase &)=default
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 inherited from Setting< wxString >
const DefaultValueFunction	mFunction
wxString	mDefaultValue
std::vector< wxString >	mPreviousValues
Protected Attributes inherited from CachingSettingBase< wxString >
wxString	mCurrentValue
bool	mValid
Protected Attributes inherited from SettingBase
const SettingPath	mPath

Detailed Description

Specialization of Setting for strings.

Definition at line 369 of file Prefs.h.

Member Function Documentation

Setting() [1/2]

Setting< T >::Setting ( const SettingBase &  path, const T &  defaultValue  )

inline

Usual overload supplies a default value.

Definition at line 187 of file Prefs.h.

      : CachingSettingBase< T >{ path }
      , mDefaultValue{ defaultValue }
   {}

Setting() [2/2]

Setting< T >::Setting ( const SettingBase &  path, DefaultValueFunction  function  )

inline

This overload causes recomputation of the default each time it is needed.

Definition at line 193 of file Prefs.h.

      : CachingSettingBase< T >{ path }
      , mFunction{ function }
   {}

---

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

• Prefs.h