Change virtual function interface of PrefsPanel

src/prefs/BatchPrefs.cpp

@@ -70,7 +70,7 @@ void BatchPrefs::PopulateOrExchange( ShuttleGui & S )
 }
 
 /// Send changed values back to Prefs, and update Audacity.
-bool BatchPrefs::Apply()
+bool BatchPrefs::Commit()
 {
    ShuttleGui S( this, eIsSavingToPrefs );
    PopulateOrExchange( S );

src/prefs/BatchPrefs.h

@@ -25,7 +25,7 @@ class BatchPrefs final : public PrefsPanel
 public:
    BatchPrefs(wxWindow * parent);
    ~BatchPrefs();
-   bool Apply() override;
+   bool Commit() override;
 
 private:
    void Populate();

src/prefs/DevicePrefs.cpp

@@ -370,7 +370,7 @@ void DevicePrefs::OnDevice(wxCommandEvent & WXUNUSED(event))
    Layout();
 }
 
-bool DevicePrefs::Apply()
+bool DevicePrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/DevicePrefs.h

@@ -28,7 +28,7 @@ class DevicePrefs final : public PrefsPanel
  public:
    DevicePrefs(wxWindow * parent);
    virtual ~DevicePrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
  private:

src/prefs/DirectoriesPrefs.cpp

@@ -256,7 +256,7 @@ bool DirectoriesPrefs::Validate()
    return true;
 }
 
-bool DirectoriesPrefs::Apply()
+bool DirectoriesPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/DirectoriesPrefs.h

@@ -23,7 +23,7 @@ class DirectoriesPrefs final : public PrefsPanel
  public:
    DirectoriesPrefs(wxWindow * parent);
    ~DirectoriesPrefs();
-   bool Apply() override;
+   bool Commit() override;
    bool Validate() override;
    wxString HelpPageName() override;
 

src/prefs/EffectsPrefs.cpp

@@ -160,7 +160,7 @@ void EffectsPrefs::PopulateOrExchange(ShuttleGui & S)
 #endif
 }
 
-bool EffectsPrefs::Apply()
+bool EffectsPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/EffectsPrefs.h

@@ -27,7 +27,7 @@ class EffectsPrefs final : public PrefsPanel
  public:
    EffectsPrefs(wxWindow * parent);
    ~EffectsPrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
  private:

src/prefs/ExtImportPrefs.cpp

@@ -185,7 +185,7 @@ void ExtImportPrefs::PopulateOrExchange(ShuttleGui & S)
    SetMinSize(GetSize());
 }
 
-bool ExtImportPrefs::Apply()
+bool ExtImportPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/ExtImportPrefs.h

@@ -48,7 +48,7 @@ class ExtImportPrefs final : public PrefsPanel
  public:
    ExtImportPrefs(wxWindow * parent);
    ~ExtImportPrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
    void OnPluginKeyDown(wxListEvent& event);

src/prefs/GUIPrefs.cpp

@@ -207,7 +207,7 @@ void GUIPrefs::PopulateOrExchange(ShuttleGui & S)
    S.EndStatic();
 }
 
-bool GUIPrefs::Apply()
+bool GUIPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/GUIPrefs.h

@@ -27,7 +27,7 @@ class GUIPrefs final : public PrefsPanel
  public:
    GUIPrefs(wxWindow * parent);
    ~GUIPrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
    static void GetRangeChoices(wxArrayString *pChoices, wxArrayString *pCodes);

src/prefs/ImportExportPrefs.cpp

@@ -102,7 +102,7 @@ void ImportExportPrefs::PopulateOrExchange(ShuttleGui & S)
 #endif
 }
 
-bool ImportExportPrefs::Apply()
+bool ImportExportPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/ImportExportPrefs.h

@@ -26,7 +26,7 @@ class ImportExportPrefs final : public PrefsPanel
  public:
    ImportExportPrefs(wxWindow * parent);
    ~ImportExportPrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
  private:

src/prefs/KeyConfigPrefs.cpp

@@ -688,7 +688,7 @@ void KeyConfigPrefs::OnViewBy(wxCommandEvent & e)
    mFilter->SetName(wxStripMenuCodes(mFilterLabel->GetLabel()));
 }
 
-bool KeyConfigPrefs::Apply()
+bool KeyConfigPrefs::Commit()
 {
    // On the Mac, preferences may be changed without any active
    // projects.  This means that the CommandManager isn't availabe
@@ -1233,7 +1233,7 @@ void KeyConfigPrefs::OnItemSelected(wxListEvent & e)
    mKey->AppendText(item.GetText());
 }
 
-bool KeyConfigPrefs::Apply()
+bool KeyConfigPrefs::Commit()
 {
    for (size_t i = 0; i < mNames.GetCount(); i++) {
 //    wxString dkey = KeyStringNormalize(mManager->GetDefaultKeyFromName(mNames[i]));

src/prefs/KeyConfigPrefs.h

@@ -39,7 +39,7 @@ class KeyConfigPrefs final : public PrefsPanel
 public:
    KeyConfigPrefs(wxWindow * parent);
    ~KeyConfigPrefs();
-   bool Apply() override;
+   bool Commit() override;
    void Cancel() override;
    wxString HelpPageName() override;
 
@@ -109,7 +109,7 @@ class KeyConfigPrefs final : public PrefsPanel
  public:
    KeyConfigPrefs(wxWindow * parent);
    ~KeyConfigPrefs();
-   bool Apply() override;
+   bool Commit() override;
    void Cancel() override;
    wxString HelpPageName() override;
 

src/prefs/LibraryPrefs.cpp

@@ -231,7 +231,7 @@ void LibraryPrefs::OnFFmpegDownButton(wxCommandEvent & WXUNUSED(event))
    HelpSystem::ShowHelpDialog(this, wxT("FAQ:Installation_and_Plug-Ins#ffdown"), true);
 }
 
-bool LibraryPrefs::Apply()
+bool LibraryPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/LibraryPrefs.h

@@ -27,7 +27,7 @@ class LibraryPrefs final : public PrefsPanel
  public:
    LibraryPrefs(wxWindow * parent);
    ~LibraryPrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
  private:

src/prefs/MidiIOPrefs.cpp

@@ -250,7 +250,7 @@ void MidiIOPrefs::OnHost(wxCommandEvent & e)
 //   OnDevice(e);
 }
 
-bool MidiIOPrefs::Apply()
+bool MidiIOPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/MidiIOPrefs.h

@@ -31,7 +31,7 @@ class MidiIOPrefs final : public PrefsPanel
  public:
    MidiIOPrefs(wxWindow * parent);
    virtual ~MidiIOPrefs();
-   bool Apply() override;
+   bool Commit() override;
    bool Validate() override;
    wxString HelpPageName() override;
 

src/prefs/ModulePrefs.cpp

@@ -126,7 +126,7 @@ void ModulePrefs::PopulateOrExchange(ShuttleGui & S)
    S.EndStatic();
 }
 
-bool ModulePrefs::Apply()
+bool ModulePrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/ModulePrefs.h

@@ -36,7 +36,7 @@ class ModulePrefs final : public PrefsPanel
  public:
    ModulePrefs(wxWindow * parent);
    ~ModulePrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
    static int GetModuleStatus( const wxString &fname );

src/prefs/MousePrefs.cpp

@@ -189,7 +189,7 @@ void MousePrefs::AddItem(wxString const & buttons, wxString const & tool,
 
 /// Update the preferences stored on disk.
 /// Currently does nothing as Mouse Preferences don't change.
-bool MousePrefs::Apply()
+bool MousePrefs::Commit()
 {
 // Not yet required...
 //   ShuttleGui S(this, eIsSavingToPrefs);

src/prefs/MousePrefs.h

@@ -24,7 +24,7 @@ class MousePrefs final : public PrefsPanel
  public:
    MousePrefs(wxWindow * parent);
    ~MousePrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
  private:

src/prefs/PlaybackPrefs.cpp

@@ -115,7 +115,7 @@ void PlaybackPrefs::PopulateOrExchange(ShuttleGui & S)
    S.EndStatic();
 }
 
-bool PlaybackPrefs::Apply()
+bool PlaybackPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/PlaybackPrefs.h

@@ -25,7 +25,7 @@ class PlaybackPrefs final : public PrefsPanel
  public:
    PlaybackPrefs(wxWindow * parent);
    virtual ~PlaybackPrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
  private:

src/prefs/PrefsDialog.cpp

@@ -415,7 +415,7 @@ PrefsPanel * PrefsDialog::GetCurrentPanel()
 
 void PrefsDialog::OnPreview(wxCommandEvent & WXUNUSED(event))
 {
-   GetCurrentPanel()->Apply();
+   GetCurrentPanel()->Preview();
 }
 
 void PrefsDialog::OnHelp(wxCommandEvent & WXUNUSED(event))
@@ -467,11 +467,14 @@ void PrefsDialog::OnOK(wxCommandEvent & WXUNUSED(event))
       for (size_t i = 0; i < mCategories->GetPageCount(); i++) {
          PrefsPanel *panel = (PrefsPanel *)mCategories->GetPage(i);
 
-         panel->Apply();
+         panel->Preview();
+         panel->Commit();
       }
    }
-   else
-      mUniquePage->Apply();
+   else {
+      mUniquePage->Preview();
+      mUniquePage->Commit();
+   }
 
    gPrefs->Flush();
 

src/prefs/PrefsPanel.h

@@ -53,7 +53,8 @@ class PrefsPanel /* not final */ : public wxPanelWrapper
    virtual ~PrefsPanel();
 
    // NEW virtuals
-   virtual bool Apply() = 0;
+   virtual bool Preview() {} // Make tentative changes
+   virtual bool Commit() = 0; // used to be called "Apply"
 
    // If it returns True, the Preview button is added below the panel
    // Default returns false

src/prefs/ProjectsPrefs.cpp

@@ -72,7 +72,7 @@ void ProjectsPrefs::PopulateOrExchange(ShuttleGui & S)
    S.EndStatic();
 }
 
-bool ProjectsPrefs::Apply()
+bool ProjectsPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/ProjectsPrefs.h

@@ -26,7 +26,7 @@ class ProjectsPrefs final : public PrefsPanel
  public:
    ProjectsPrefs(wxWindow * parent);
    ~ProjectsPrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
  private:

src/prefs/QualityPrefs.cpp

@@ -210,7 +210,7 @@ void QualityPrefs::OnSampleRateChoice(wxCommandEvent & WXUNUSED(e))
    mOtherSampleRate->Enable(sel == (int)mSampleRates->GetCount() - 1);
 }
 
-bool QualityPrefs::Apply()
+bool QualityPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/QualityPrefs.h

@@ -29,7 +29,7 @@ class QualityPrefs final : public PrefsPanel
    QualityPrefs(wxWindow * parent);
    virtual ~QualityPrefs();
 
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
  private:

src/prefs/RecordingPrefs.cpp

@@ -207,7 +207,7 @@ void RecordingPrefs::PopulateOrExchange(ShuttleGui & S)
    #endif
 }
 
-bool RecordingPrefs::Apply()
+bool RecordingPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/RecordingPrefs.h

@@ -26,7 +26,7 @@ class RecordingPrefs final : public PrefsPanel
  public:
    RecordingPrefs(wxWindow * parent);
    virtual ~RecordingPrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
  private:

src/prefs/SpectrumPrefs.cpp

@@ -365,7 +365,7 @@ bool SpectrumPrefs::Validate()
    return result;
 }
 
-bool SpectrumPrefs::Apply()
+bool SpectrumPrefs::Commit()
 {
    if (!Validate())
       return false;

src/prefs/SpectrumPrefs.h

@@ -43,7 +43,7 @@ class SpectrumPrefs final : public PrefsPanel
  public:
    SpectrumPrefs(wxWindow * parent, WaveTrack *wt);
    virtual ~SpectrumPrefs();
-   bool Apply() override;
+   bool Commit() override;
    bool ShowsPreviewButton() override;
    bool Validate() override;
    wxString HelpPageName() override;

src/prefs/ThemePrefs.cpp

@@ -186,7 +186,7 @@ void ThemePrefs::OnSaveThemeAsCode(wxCommandEvent & WXUNUSED(event))
 }
 
 /// Update the preferences stored on disk.
-bool ThemePrefs::Apply()
+bool ThemePrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/ThemePrefs.h

@@ -26,7 +26,7 @@ class ThemePrefs final : public PrefsPanel
  public:
    ThemePrefs(wxWindow * parent);
    ~ThemePrefs(void);
-   bool Apply() override;
+   bool Commit() override;
 
  private:
    void Populate();

src/prefs/TracksBehaviorsPrefs.cpp

@@ -101,7 +101,7 @@ void TracksBehaviorsPrefs::PopulateOrExchange(ShuttleGui & S)
    S.EndStatic();
 }
 
-bool TracksBehaviorsPrefs::Apply()
+bool TracksBehaviorsPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/TracksBehaviorsPrefs.h

@@ -23,7 +23,7 @@ class TracksBehaviorsPrefs final : public PrefsPanel
  public:
    TracksBehaviorsPrefs(wxWindow * parent);
    ~TracksBehaviorsPrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
    static const wxChar *ScrollingPreferenceKey();

src/prefs/TracksPrefs.cpp

@@ -158,7 +158,7 @@ void TracksPrefs::SetPinnedHeadPreference(bool value, bool flush)
       gPrefs->Flush();
 }
 
-bool TracksPrefs::Apply()
+bool TracksPrefs::Commit()
 {
    // Bug 1583: Clear the caching of the preference pinned state.
    iPreferencePinned = -1;

src/prefs/TracksPrefs.h

@@ -27,7 +27,7 @@ class TracksPrefs final : public PrefsPanel
  public:
    TracksPrefs(wxWindow * parent);
    ~TracksPrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
    static bool GetPinnedHeadPreference();

src/prefs/WarningsPrefs.cpp

@@ -79,7 +79,7 @@ void WarningsPrefs::PopulateOrExchange(ShuttleGui & S)
    S.EndStatic();
 }
 
-bool WarningsPrefs::Apply()
+bool WarningsPrefs::Commit()
 {
    ShuttleGui S(this, eIsSavingToPrefs);
    PopulateOrExchange(S);

src/prefs/WarningsPrefs.h

@@ -26,7 +26,7 @@ class WarningsPrefs final : public PrefsPanel
  public:
    WarningsPrefs(wxWindow * parent);
    ~WarningsPrefs();
-   bool Apply() override;
+   bool Commit() override;
    wxString HelpPageName() override;
 
  private:

src/prefs/WaveformPrefs.cpp

@@ -134,7 +134,7 @@ bool WaveformPrefs::Validate()
    return result;
 }
 
-bool WaveformPrefs::Apply()
+bool WaveformPrefs::Commit()
 {
    const bool isOpenPage = this->IsShown();
 

src/prefs/WaveformPrefs.h

@@ -25,7 +25,7 @@ class WaveformPrefs final : public PrefsPanel
 public:
    WaveformPrefs(wxWindow * parent, WaveTrack *wt);
    virtual ~WaveformPrefs();
-   bool Apply() override;
+   bool Commit() override;
    bool ShowsPreviewButton() override;
    bool Validate() override;