ChoiceSetting Class Reference

#include <Prefs.h>

Inheritance diagram for ChoiceSetting:

Collaboration diagram for ChoiceSetting:

Public Member Functions
	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
size_t	Find (const wxString &value) const
virtual void	Migrate (wxString &)

Protected Attributes
const wxString	mKey
const EnumValueSymbols	mSymbols
TransactionalSettingBase *const	mpOtherSettings {}
bool	mMigrated { false }
long	mDefaultSymbol

Detailed Description

Packages a table of user-visible choices each with an internal code string, a preference key path, and a default choice

Definition at line 409 of file Prefs.h.

Constructor & Destructor Documentation

ChoiceSetting() [1/3]

ChoiceSetting::ChoiceSetting ( const SettingPath &  , EnumValueSymbols  , long  = -1  )

delete

Disallow construction from the GetPath() of another SettingBase object; instead require that object to be passed as reference to the next ctor

ChoiceSetting() [2/3]

ChoiceSetting::ChoiceSetting ( TransactionalSettingBase &  key, EnumValueSymbols  symbols, long  defaultSymbol = -1  )

inline

Precondition

defaultSymbol < static_cast<long>(mSymbols.size())

Definition at line 417 of file Prefs.h.

      : mKey{ key.GetPath() }
      , mSymbols{ move(symbols) }
      , mpOtherSettings{ &key }
      , mDefaultSymbol{ defaultSymbol }
   {
      assert(defaultSymbol < static_cast<long>(mSymbols.size()));
   }

ChoiceSetting() [3/3]

ChoiceSetting::ChoiceSetting ( const SettingBase &  key, EnumValueSymbols  symbols, long  defaultSymbol = -1  )

inline

Precondition

defaultSymbol < static_cast<long>(symbols.size())

Definition at line 428 of file Prefs.h.

      : mKey{ key.GetPath() }
      , mSymbols{ move(symbols) }
      , mDefaultSymbol{ defaultSymbol }
   {
      assert(defaultSymbol < static_cast<long>(mSymbols.size()));
   }

Member Function Documentation

Default()

const EnumValueSymbol & ChoiceSetting::Default

(

)

const

Definition at line 361 of file Prefs.cpp.

{
   if ( mDefaultSymbol >= 0 && mDefaultSymbol < (long)mSymbols.size() )
      return mSymbols[ mDefaultSymbol ];
   static EnumValueSymbol empty;
   return empty;
}

References mDefaultSymbol, and mSymbols.

Referenced by Read(), HelpSystem::ShowHelp(), ShuttleGuiBase::TieChoice(), and anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieChoice().

Here is the caller graph for this function:

Find()

size_t ChoiceSetting::Find ( const wxString &  value ) const

protected

Definition at line 392 of file Prefs.cpp.

{
   auto start = GetSymbols().begin();
   return size_t(
      std::find( start, GetSymbols().end(), EnumValueSymbol{ value, {} } )
         - start );
}

References PackedArray::end(), and GetSymbols().

Referenced by EnumSettingBase::ReadInt(), EnumSettingBase::ReadIntWithDefault(), ReadWithDefault(), and Write().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSymbols()

const EnumValueSymbols & ChoiceSetting::GetSymbols ( ) const

inline

Definition at line 439 of file Prefs.h.

{ return mSymbols; }

Referenced by Find(), AudioPasteDialog::PopulateOrExchange(), TracksBehaviorsPrefs::PopulateOrExchange(), ShuttleGuiBase::TieChoice(), and anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieChoice().

Here is the caller graph for this function:

Key()

const wxString & ChoiceSetting::Key ( ) const

inline

Definition at line 437 of file Prefs.h.

{ return mKey; }

Referenced by ShuttleGuiBase::TieChoice(), and anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieChoice().

Here is the caller graph for this function:

Migrate()

void ChoiceSetting::Migrate ( wxString &  value )

protectedvirtual

Reimplemented in EnumSettingBase, SpectrogramSettings::ColorSchemeEnumSetting, and TracksViewModeEnumSetting.

Definition at line 400 of file Prefs.cpp.

{
   (void)value;// Compiler food
}

Referenced by ReadWithDefault().

Here is the caller graph for this function:

Read()

wxString ChoiceSetting::Read

(

)

const

Definition at line 369 of file Prefs.cpp.

{
   const auto &defaultValue = Default().Internal();
   return ReadWithDefault( defaultValue );
}

References Default(), ComponentInterfaceSymbol::Internal(), and ReadWithDefault().

Referenced by anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), anonymous_namespace{PluginMenus.cpp}::EffectMenu(), ExportAudioDialog::ExportAudioDialog(), anonymous_namespace{EditMenus.cpp}::FindSourceTracks(), anonymous_namespace{PluginMenus.cpp}::GenerateMenu(), ThemeBase::LoadPreferredTheme(), AudioPasteDialog::OnContinue(), EnumSettingBase::ReadInt(), ThemeBase::SwitchTheme(), ShuttleGuiBase::TieChoice(), anonymous_namespace{PluginMenus.cpp}::ToolsMenu(), and RealtimeEffectListWindow::UpdateEffectMenuItems().

Here is the call graph for this function:

Here is the caller graph for this function:

ReadWithDefault()

wxString ChoiceSetting::ReadWithDefault

(

const wxString &

defaultValue

)

const

Definition at line 375 of file Prefs.cpp.

{
   wxString value;
   if ( !gPrefs->Read(mKey, &value, defaultValue) )
      if (!mMigrated) {
         const_cast<ChoiceSetting*>(this)->Migrate( value );
         mMigrated = true;
      }
 
   // Remap to default if the string is not known -- this avoids surprises
   // in case we try to interpret config files from future versions
   auto index = Find( value );
   if ( index >= mSymbols.size() )
      value = defaultValue;
   return value;
}

References Find(), gPrefs, Migrate(), mKey, mMigrated, mSymbols, and audacity::BasicSettings::Read().

Referenced by Read(), and EnumSettingBase::ReadIntWithDefault().

Here is the call graph for this function:

Here is the caller graph for this function:

SetDefault()

void ChoiceSetting::SetDefault

(

long

value

)

Precondition

defaultSymbol < static_cast<long>(GetSymbols().size())

Definition at line 420 of file Prefs.cpp.

{
   mDefaultSymbol = value;
}

References mDefaultSymbol.

Write()

bool ChoiceSetting::Write

(

const wxString &

value

)

Definition at line 405 of file Prefs.cpp.

{
   auto index = Find( value );
   if (index >= mSymbols.size())
      return false;
 
   auto result = gPrefs->Write( mKey, value );
   mMigrated = true;
 
   if (mpOtherSettings)
      mpOtherSettings->Invalidate();
 
   return result;
}

References Find(), gPrefs, TransactionalSettingBase::Invalidate(), mKey, mMigrated, mpOtherSettings, mSymbols, and audacity::BasicSettings::Write().

Referenced by EnumSettingBase::Migrate(), SpectrogramSettings::ColorSchemeEnumSetting::Migrate(), TracksViewModeEnumSetting::Migrate(), AudioPasteDialog::OnContinue(), HelpSystem::ShowHelp(), ShuttleGuiBase::TieChoice(), and EnumSettingBase::WriteInt().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mDefaultSymbol

long ChoiceSetting::mDefaultSymbol

protected

Definition at line 464 of file Prefs.h.

Referenced by Default(), EnumSettingBase::Migrate(), and SetDefault().

mKey

const wxString ChoiceSetting::mKey

protected

Definition at line 457 of file Prefs.h.

Referenced by ReadWithDefault(), and Write().

mMigrated

bool ChoiceSetting::mMigrated { false }

mutableprotected

Definition at line 462 of file Prefs.h.

Referenced by ReadWithDefault(), and Write().

mpOtherSettings

TransactionalSettingBase* const ChoiceSetting::mpOtherSettings {}

protected

Definition at line 459 of file Prefs.h.

Referenced by Write().

mSymbols

const EnumValueSymbols ChoiceSetting::mSymbols

protected

Definition at line 458 of file Prefs.h.

Referenced by Default(), EnumSettingBase::Migrate(), EnumSettingBase::ReadIntWithDefault(), ReadWithDefault(), Write(), and EnumSettingBase::WriteInt().

---

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

• Prefs.h
• Prefs.cpp