Inheritance diagram for ModuleSettingsResetHandler:

Collaboration diagram for ModuleSettingsResetHandler:

Public Member Functions
	~ModuleSettingsResetHandler () override

void	OnSettingResetBegin () override
	Happens before preferences reset. More...

void	OnSettingResetEnd () override
	Happens after preferences reset. More...

Public Member Functions inherited from PreferencesResetHandler
virtual	~PreferencesResetHandler ()

virtual void	OnSettingResetBegin ()=0
	Happens before preferences reset. More...

virtual void	OnSettingResetEnd ()=0
	Happens after preferences reset. More...

Private Types
using	KeyValueStorage = std::vector< std::pair< wxString, wxString > >

Private Attributes
std::optional< KeyValueStorage >	mStorage

Detailed Description

Definition at line 20 of file ModuleSettings.cpp.

Member Typedef Documentation

◆ KeyValueStorage

using ModuleSettingsResetHandler::KeyValueStorage = std::vector<std::pair<wxString, wxString> >

private

Definition at line 22 of file ModuleSettings.cpp.

Constructor & Destructor Documentation

◆ ~ModuleSettingsResetHandler()

ModuleSettingsResetHandler::~ModuleSettingsResetHandler ( )

inlineoverride

Definition at line 26 of file ModuleSettings.cpp.

   {
      assert(!mStorage.has_value());
   }

References mStorage.

Member Function Documentation

◆ OnSettingResetBegin()

void ModuleSettingsResetHandler::OnSettingResetBegin ( )

inlineoverridevirtual

Happens before preferences reset.

Implements PreferencesResetHandler.

Definition at line 31 of file ModuleSettings.cpp.

   {
      assert(!mStorage.has_value());
 
      static const wxString modulePrefsGroups[] = {
         "/ModulePath/",
         "/Module/",
         "/ModuleDateTime/"
      };
      KeyValueStorage storage;
      for(const auto& group : modulePrefsGroups)
      {
         if(!gPrefs->HasGroup(group))
            continue;
 
         const auto groupScope = gPrefs->BeginGroup(group);
         for(const auto& key : gPrefs->GetChildKeys())
         {
            wxString value;
            if(gPrefs->Read(key, &value))
               storage.emplace_back(group + key, value);
         }
      }
      mStorage = std::move(storage);
   }

References audacity::BasicSettings::BeginGroup(), audacity::BasicSettings::GetChildKeys(), gPrefs, audacity::BasicSettings::HasGroup(), key, mStorage, and audacity::BasicSettings::Read().

Here is the call graph for this function:

◆ OnSettingResetEnd()

void ModuleSettingsResetHandler::OnSettingResetEnd ( )

inlineoverridevirtual

Happens after preferences reset.

Implements PreferencesResetHandler.

Definition at line 57 of file ModuleSettings.cpp.

   {
      if(!mStorage.has_value())
         return;
      const auto Do = finally([=]{ mStorage = std::nullopt; });
      for(const auto& [key, value] : *mStorage)
         gPrefs->Write(key, value);
   }

References gPrefs, key, mStorage, and audacity::BasicSettings::Write().

Here is the call graph for this function:

Member Data Documentation

◆ mStorage

std::optional<KeyValueStorage> ModuleSettingsResetHandler::mStorage

private

Definition at line 23 of file ModuleSettings.cpp.

Referenced by OnSettingResetBegin(), OnSettingResetEnd(), and ~ModuleSettingsResetHandler().

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

ModuleSettings.cpp

Public Member Functions

Private Types

Private Attributes