PrefsDialog.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  PrefsDialog.h
 
  Joshua Haberman
  James Crook
 
**********************************************************************/
 
#ifndef __AUDACITY_PREFS_DIALOG__
#define __AUDACITY_PREFS_DIALOG__
 
#include <functional>
#include <vector>
#include "wxPanelWrapper.h" // to inherit
#include "PrefsPanel.h"
 
class AudacityProject;
class wxTreebook;
class wxTreeEvent;
class SettingTransaction;
class ShuttleGui;
 
class AudacityProject;
 
class AUDACITY_DLL_API PrefsDialog /* not final */ : public wxDialogWrapper
{
 public:
   PrefsDialog(wxWindow * parent,
      AudacityProject *pProject, // may be null
      const TranslatableString &titlePrefix = XO("Preferences:"),
      PrefsPanel::Factories &factories =
         PrefsPanel::DefaultFactories());
   virtual ~PrefsDialog();
 
   // Defined this so a protected virtual can be invoked after the constructor
   int ShowModal() override;
   void ShuttleAll( ShuttleGui & S);
 
   void OnCategoryChange(wxCommandEvent & e);
   void OnOK(wxCommandEvent & e);
   void OnCancel(wxCommandEvent & e);
   void OnPreview(wxCommandEvent & e);
   void OnHelp(wxCommandEvent & e);
   void OnTreeKeyDown(wxTreeEvent & e); // Used to dismiss the dialog when enter is pressed with focus on tree
 
   void SelectPageByName(const wxString &pageName);
 
   // Accessor to help implementations of SavePreferredPage(),
   // such as by saving a preference after DoModal() returns
   int GetSelectedPage() const;
 
 protected:
    // Decide which page to open first; return -1 for undecided
    virtual long GetPreferredPage() = 0;
 
    // Called after OK is clicked and all pages validate
    virtual void SavePreferredPage() = 0;
 
private:
   void RecordExpansionState();
   PrefsPanel * GetCurrentPanel();
   wxTreebook *mCategories{};
   PrefsPanel *mUniquePage{};
   PrefsPanel::Factories &mFactories;
   const TranslatableString mTitlePrefix;
 
   std::unique_ptr< SettingTransaction > mTransaction;
 
   DECLARE_EVENT_TABLE()
};
 
// This adds code appropriate only to the original use of PrefsDialog for
// global settings -- not its reuses elsewhere as in View Settings
class AUDACITY_DLL_API GlobalPrefsDialog final : public PrefsDialog
{
public:
   GlobalPrefsDialog(
      wxWindow * parent, AudacityProject *pProject,
      PrefsPanel::Factories &factories =
         PrefsPanel::DefaultFactories());
   virtual ~GlobalPrefsDialog();
   long GetPreferredPage() override;
   void SavePreferredPage() override;
};
 
class AudacityProject;
void AUDACITY_DLL_API DoReloadPreferences( AudacityProject &project );
 
#endif