EnumSettingBase Class Reference

#include <Prefs.h>

Inheritance diagram for EnumSettingBase:

Collaboration diagram for EnumSettingBase:

Public Member Functions
template<typename Key >
	EnumSettingBase (Key &&key, EnumValueSymbols symbols, long defaultSymbol, std::vector< int > intValues, const wxString &oldKey={})
Public Member Functions inherited from ChoiceSetting
	ChoiceSetting (const SettingPath &, EnumValueSymbols, long=-1)=delete
	ChoiceSetting (TransactionalSettingBase &key, EnumValueSymbols symbols, long defaultSymbol=-1)
	ChoiceSetting (const SettingBase &key, EnumValueSymbols symbols, long defaultSymbol=-1)
const wxString &	Key () const
const EnumValueSymbol &	Default () const
const EnumValueSymbols &	GetSymbols () const
wxString	Read () const
wxString	ReadWithDefault (const wxString &) const
bool	Write (const wxString &value)
void	SetDefault (long value)

Protected Member Functions
int	ReadInt () const
int	ReadIntWithDefault (int defaultValue) const
bool	WriteInt (int code)
size_t	FindInt (int code) const
void	Migrate (wxString &) override
Protected Member Functions inherited from ChoiceSetting
size_t	Find (const wxString &value) const
virtual void	Migrate (wxString &)

Private Attributes
std::vector< int >	mIntValues
const wxString	mOldKey

Additional Inherited Members
Protected Attributes inherited from ChoiceSetting
const wxString	mKey
const EnumValueSymbols	mSymbols
TransactionalSettingBase *const	mpOtherSettings {}
bool	mMigrated { false }
long	mDefaultSymbol

Detailed Description

Extends ChoiceSetting with a corresponding table of integer codes (generally not equal to their table positions), and optionally an old preference key path that stored integer codes, to be migrated into one that stores internal string values instead

Definition at line 473 of file Prefs.h.

Constructor & Destructor Documentation

EnumSettingBase()

template<typename Key >

EnumSettingBase::EnumSettingBase ( Key &&  key, EnumValueSymbols  symbols, long  defaultSymbol, std::vector< int >  intValues, const wxString &  oldKey = {}  )

inline

Precondition

intValues.size() == symbols.size()

Definition at line 477 of file Prefs.h.

                               {}
   )  : ChoiceSetting{ std::forward<Key>(key), move(symbols), defaultSymbol }
      , mIntValues{ move(intValues) }
      , mOldKey{ oldKey }
   {
      assert (mIntValues.size() == mSymbols.size());
   }

Member Function Documentation

FindInt()

size_t EnumSettingBase::FindInt ( int  code ) const

protected

Definition at line 467 of file Prefs.cpp.

{
   const auto start = mIntValues.begin();
   return size_t(
      std::find( start, mIntValues.end(), code )
         - start );
}

References mIntValues.

Referenced by Migrate(), ReadIntWithDefault(), and WriteInt().

Here is the caller graph for this function:

Migrate()

void EnumSettingBase::Migrate ( wxString &  value )

overrideprotectedvirtual

Reimplemented from ChoiceSetting.

Reimplemented in SpectrogramSettings::ColorSchemeEnumSetting.

Definition at line 475 of file Prefs.cpp.

{
   int intValue = 0;
   if ( !mOldKey.empty() &&
        gPrefs->Read(mOldKey, &intValue, 0) ) {
      // Make the migration, only once and persistently.
      // Do not DELETE the old key -- let that be read if user downgrades
      // Audacity.  But further changes will be stored only to the NEW key
      // and won't be seen then.
      auto index = (long) FindInt( intValue );
      if ( index >= (long)mSymbols.size() )
         index = mDefaultSymbol;
      if ( index >= 0 && index < (long)mSymbols.size() ) {
         value = mSymbols[index].Internal();
         Write(value);
         gPrefs->Flush();
      }
   }
}

References FindInt(), audacity::BasicSettings::Flush(), gPrefs, ChoiceSetting::mDefaultSymbol, mOldKey, ChoiceSetting::mSymbols, audacity::BasicSettings::Read(), and ChoiceSetting::Write().

Here is the call graph for this function:

ReadInt()

int EnumSettingBase::ReadInt ( ) const

protected

Definition at line 444 of file Prefs.cpp.

{
   auto index = Find( Read() );
 
   wxASSERT( index < mIntValues.size() );
   return mIntValues[ index ];
}

References ChoiceSetting::Find(), mIntValues, and ChoiceSetting::Read().

Here is the call graph for this function:

ReadIntWithDefault()

int EnumSettingBase::ReadIntWithDefault ( int  defaultValue ) const

protected

Definition at line 452 of file Prefs.cpp.

{
   wxString defaultString;
   auto index0 = FindInt( defaultValue );
   if ( index0 < mSymbols.size() )
      defaultString = mSymbols[ index0 ].Internal();
   else
      wxASSERT( false );
 
   auto index = Find( ReadWithDefault( defaultString ) );
 
   wxASSERT( index < mSymbols.size() );
   return mIntValues[ index ];
}

References ChoiceSetting::Find(), FindInt(), mIntValues, ChoiceSetting::mSymbols, and ChoiceSetting::ReadWithDefault().

Here is the call graph for this function:

WriteInt()

bool EnumSettingBase::WriteInt ( int  code )

protected

Definition at line 502 of file Prefs.cpp.

{
   auto index = FindInt( code );
   if ( index >= mSymbols.size() )
      return false;
   return Write( mSymbols[index].Internal() );
}

References FindInt(), Internal, ChoiceSetting::mSymbols, and ChoiceSetting::Write().

Here is the call graph for this function:

Member Data Documentation

mIntValues

std::vector<int> EnumSettingBase::mIntValues

private

Definition at line 507 of file Prefs.h.

Referenced by FindInt(), ReadInt(), and ReadIntWithDefault().

mOldKey

const wxString EnumSettingBase::mOldKey

private

Definition at line 508 of file Prefs.h.

Referenced by Migrate().

---

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

• Prefs.h
• Prefs.cpp