TracksViewModeEnumSetting Class Reference

Inheritance diagram for TracksViewModeEnumSetting:

Collaboration diagram for TracksViewModeEnumSetting:

Public Member Functions
void	Migrate (wxString &value) override
Public Member Functions inherited from EnumSetting< WaveChannelViewConstants::Display >
	EnumSetting (Key &&key, EnumValueSymbols symbols, long defaultSymbol, std::vector< WaveChannelViewConstants::Display > values, const wxString &oldKey={})
WaveChannelViewConstants::Display	ReadEnum () const
WaveChannelViewConstants::Display	ReadEnumWithDefault (WaveChannelViewConstants::Display defaultValue) const
bool	WriteEnum (WaveChannelViewConstants::Display value)
Public Member Functions inherited from EnumSettingBase
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)

Additional Inherited Members
Protected Member Functions inherited from EnumSettingBase
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 &)
Protected Attributes inherited from ChoiceSetting
const wxString	mKey
const EnumValueSymbols	mSymbols
TransactionalSettingBase *const	mpOtherSettings {}
bool	mMigrated { false }
long	mDefaultSymbol

Detailed Description

Definition at line 73 of file TracksPrefs.cpp.

Member Function Documentation

Migrate()

void TracksViewModeEnumSetting::Migrate ( wxString &  value )

inlineoverridevirtual

Reimplemented from ChoiceSetting.

Definition at line 78 of file TracksPrefs.cpp.

   {
      // Special logic for this preference which was three times migrated!
 
      // PRL:  Bugs 1043, 1044
      // 2.1.1 writes a NEW key for this preference, which got NEW values,
      // to avoid confusing version 2.1.0 if it reads the preference file afterwards.
      // Prefer the NEW preference key if it is present
 
      static const EnumValueSymbol waveformSymbol{ XO("Waveform") };
      static const EnumValueSymbol spectrumSymbol{ XO("Spectrogram") };
 
      WaveChannelViewConstants::Display viewMode;
      int oldMode;
      wxString newValue;
      auto stringValue =
         [](WaveChannelViewConstants::Display display) {
         switch (display) {
            case WaveChannelViewConstants::Spectrum:
               return spectrumSymbol.Internal();
            case WaveChannelViewConstants::obsoleteWaveformDBDisplay:
               return obsoleteValue;
            default:
               return waveformSymbol.Internal();
         }
      };
 
      if (gPrefs->Read(key0, // The very old key
         &oldMode,
         (int)(WaveChannelViewConstants::Waveform))) {
         viewMode = WaveChannelViewConstants::ConvertLegacyDisplayValue(oldMode);
         newValue = stringValue(viewMode);
      }
      else if ( gPrefs->Read(key1,
         &oldMode,
         (int)(WaveChannelViewConstants::Waveform))) {
         viewMode = static_cast<WaveChannelViewConstants::Display>(oldMode);
         newValue = stringValue(viewMode);
      }
      else
         gPrefs->Read( key2, &newValue );
 
      if ( !gPrefs->Read( key3, &value ) ) {
         if (newValue == obsoleteValue) {
            newValue = waveformSymbol.Internal();
            gPrefs->Write(
               WaveformSettings::waveformScaleKey,
               WaveformSettings::dbLogValueString);
         }
 
         Write( value = newValue );
         gPrefs->Flush();
         return;
      }
   }

References WaveChannelViewConstants::ConvertLegacyDisplayValue(), WaveformSettings::dbLogValueString, audacity::BasicSettings::Flush(), gPrefs, anonymous_namespace{TracksPrefs.cpp}::key0, anonymous_namespace{TracksPrefs.cpp}::key1, anonymous_namespace{TracksPrefs.cpp}::key2, anonymous_namespace{TracksPrefs.cpp}::key3, anonymous_namespace{TracksPrefs.cpp}::obsoleteValue, WaveChannelViewConstants::obsoleteWaveformDBDisplay, audacity::BasicSettings::Read(), WaveChannelViewConstants::Spectrum, WaveChannelViewConstants::Waveform, WaveformSettings::waveformScaleKey, audacity::BasicSettings::Write(), ChoiceSetting::Write(), and XO().

Here is the call graph for this function:

---

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

• TracksPrefs.cpp