AudacityFileConfig Class Reference

Our own specialisation of FileConfig. More...

#include <AudacityFileConfig.h>

Inheritance diagram for AudacityFileConfig:

Collaboration diagram for AudacityFileConfig:

Public Member Functions
	~AudacityFileConfig () override
Public Member Functions inherited from FileConfig
	FileConfig (const wxString &appName=wxEmptyString, const wxString &vendorName=wxEmptyString, const wxString &localFilename=wxEmptyString, const wxString &globalFilename=wxEmptyString, long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE, const wxMBConv &conv=wxConvAuto())
void	Init ()
virtual	~FileConfig ()
virtual void	SetPath (const wxString &strPath) wxOVERRIDE
virtual const wxString &	GetPath () const wxOVERRIDE
virtual bool	GetFirstGroup (wxString &str, long &lIndex) const wxOVERRIDE
virtual bool	GetNextGroup (wxString &str, long &lIndex) const wxOVERRIDE
virtual bool	GetFirstEntry (wxString &str, long &lIndex) const wxOVERRIDE
virtual bool	GetNextEntry (wxString &str, long &lIndex) const wxOVERRIDE
virtual size_t	GetNumberOfEntries (bool bRecursive=false) const wxOVERRIDE
virtual size_t	GetNumberOfGroups (bool bRecursive=false) const wxOVERRIDE
virtual bool	HasGroup (const wxString &strName) const wxOVERRIDE
virtual bool	HasEntry (const wxString &strName) const wxOVERRIDE
virtual bool	Flush (bool bCurrentOnly=false) wxOVERRIDE
virtual bool	RenameEntry (const wxString &oldName, const wxString &newName) wxOVERRIDE
virtual bool	RenameGroup (const wxString &oldName, const wxString &newName) wxOVERRIDE
virtual bool	DeleteEntry (const wxString &key, bool bDeleteGroupIfEmpty=true) wxOVERRIDE
virtual bool	DeleteGroup (const wxString &key) wxOVERRIDE
virtual bool	DeleteAll () wxOVERRIDE
void	SetVersionKeysInit (int major, int minor, int micro)
void	GetVersionKeysInit (int &major, int &minor, int &micro) const

Static Public Member Functions
static std::unique_ptr< AudacityFileConfig >	Create (const wxString &appName={}, const wxString &vendorName={}, const wxString &localFilename={}, const wxString &globalFilename={}, long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE, const wxMBConv &conv=wxConvAuto())
	Require a call to this factory, to guarantee proper two-phase initialization. More...

Protected Member Functions
void	Warn () override
Protected Member Functions inherited from FileConfig
virtual bool	DoReadString (const wxString &key, wxString *pStr) const wxOVERRIDE
virtual bool	DoReadLong (const wxString &key, long *pl) const wxOVERRIDE
virtual bool	DoWriteString (const wxString &key, const wxString &szValue) wxOVERRIDE
virtual bool	DoWriteLong (const wxString &key, long lValue) wxOVERRIDE
virtual void	Warn ()
const FilePath &	GetFilePath () const

Private Member Functions
	AudacityFileConfig (const wxString &appName, const wxString &vendorName, const wxString &localFilename, const wxString &globalFilename, long style, const wxMBConv &conv)
	Disallow direct constructor call, because a two-phase initialization is required. More...

Detailed Description

Our own specialisation of FileConfig.

Definition at line 19 of file AudacityFileConfig.h.

Constructor & Destructor Documentation

~AudacityFileConfig()

AudacityFileConfig::~AudacityFileConfig ( )

overridedefault

AudacityFileConfig()

AudacityFileConfig::AudacityFileConfig ( const wxString &  appName, const wxString &  vendorName, const wxString &  localFilename, const wxString &  globalFilename, long  style, const wxMBConv &  conv  )

private

Disallow direct constructor call, because a two-phase initialization is required.

Definition at line 23 of file AudacityFileConfig.cpp.

: FileConfig{ appName, vendorName, localFilename, globalFilename, style, conv }
{}

Member Function Documentation

Create()

std::unique_ptr< AudacityFileConfig > AudacityFileConfig::Create ( const wxString &  appName = {}, const wxString &  vendorName = {}, const wxString &  localFilename = {}, const wxString &  globalFilename = {}, long  style = wxCONFIG_USE_LOCAL_FILE | wxCONFIG_USE_GLOBAL_FILE, const wxMBConv &  conv = wxConvAuto()  )

static

Require a call to this factory, to guarantee proper two-phase initialization.

Definition at line 36 of file AudacityFileConfig.cpp.

{
   // Private ctor means make_unique can't compile, so this verbosity:
   auto result = std::unique_ptr<AudacityFileConfig>{
      safenew AudacityFileConfig{
         appName, vendorName, localFilename, globalFilename, style, conv } };
   result->Init();
   return result;
}

References FileConfig::Init(), and safenew.

Referenced by AudacityApp::InitPart2(), AudacityApp::OnInit(), and anonymous_namespace{AudacityApp.cpp}::PopulatePreferences().

Here is the call graph for this function:

Here is the caller graph for this function:

Warn()

void AudacityFileConfig::Warn ( )

overrideprotectedvirtual

Override to notify the user of error conditions involving writability of config files. Default implementation does nothing

Reimplemented from FileConfig.

Definition at line 53 of file AudacityFileConfig.cpp.

{
   wxDialogWrapper dlg(nullptr, wxID_ANY, XO("Audacity Configuration Error"));
 
   ShuttleGui S(&dlg, eIsCreating);
 
   wxButton *retryButton;
   wxButton *quitButton;
 
   S.SetBorder(5);
   S.StartVerticalLay(wxEXPAND, 1);
   {
      S.SetBorder(15);
      S.StartHorizontalLay(wxALIGN_RIGHT, 0);
      {
         S.AddFixedText(
            XO("The following configuration file could not be accessed:\n\n"
               "\t%s\n\n"
               "This could be caused by many reasons, but the most likely are that "
               "the disk is full or you do not have write permissions to the file. "
               "More information can be obtained by clicking the help button below.\n\n"
               "You can attempt to correct the issue and then click \"Retry\" to continue.\n\n"
               "If you choose to \"Quit Audacity\", your project may be left in an unsaved "
               "state which will be recovered the next time you open it.")
            .Format(GetFilePath()),
            false,
            500);
      }
      S.EndHorizontalLay();
 
      S.SetBorder(5);
      S.StartHorizontalLay(wxALIGN_RIGHT, 0);
      {
         // Can't use themed bitmap since the theme manager might not be
         // initialized yet and it requires a configuration file.
         wxButton *b = S.Id(wxID_HELP).AddBitmapButton(wxBitmap(Help_xpm));
         b->SetToolTip( XO("Help").Translation() );
         b->SetLabel(XO("Help").Translation());       // for screen readers
 
         b = S.Id(wxID_CANCEL).AddButton(XXO("&Quit Audacity"));
         b = S.Id(wxID_OK).AddButton(XXO("&Retry"));
         dlg.SetAffirmativeId(wxID_OK);
 
         b->SetDefault();
         b->SetFocus();
      }
      S.EndHorizontalLay();
   }
   S.EndVerticalLay();
 
   dlg.Layout();
   dlg.GetSizer()->Fit(&dlg);
   dlg.SetMinSize(dlg.GetSize());
   dlg.Center();
 
   auto onButton = [&](wxCommandEvent &e)
   {
      dlg.EndModal(e.GetId());
   };
 
   dlg.Bind(wxEVT_BUTTON, onButton);
 
   switch (dlg.ShowModal())
   {
      case wxID_HELP:
         // Can't use the HelpSystem since the theme manager may not
         // yet be initialized and it requires a configuration file.
         OpenInDefaultBrowser("https://" +
                              HelpSystem::HelpHostname +
                              HelpSystem::HelpServerHomeDir +
                              "Error:_Audacity_settings_file_unwritable");
      break;
 
      case wxID_CANCEL:
         _exit(-1);
      break;
   }
 
   dlg.Unbind(wxEVT_BUTTON, onButton);
}

References eIsCreating, FileConfig::GetFilePath(), HelpSystem::HelpHostname, HelpSystem::HelpServerHomeDir, BasicUI::OpenInDefaultBrowser(), S, XO(), and XXO().

Here is the call graph for this function:

---

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

• AudacityFileConfig.h
• AudacityFileConfig.cpp