anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel Class Reference

Inheritance diagram for anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel:

Collaboration diagram for anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel:

Public Member Functions
	AudioComPrefsPanel (wxWindow *parent, wxWindowID winid)
bool	Commit () override
void	Cancel () override
void	PopulateOrExchange (ShuttleGui &S) override
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
void	Browse ()
Public Member Functions inherited from PrefsPanel
	PrefsPanel (wxWindow *parent, wxWindowID winid, const TranslatableString &title)
virtual	~PrefsPanel ()
virtual void	Preview ()
virtual bool	Commit ()=0
virtual PluginPath	GetPath () const override
virtual VendorSymbol	GetVendor () const override
virtual wxString	GetVersion () const override
virtual bool	ShowsPreviewButton ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual ManualPageID	HelpPageName ()
	If not empty string, the Help button is added below the panel. More...
virtual void	Cancel ()
Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()
	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
void	SetLabel (const TranslatableString &label)
void	SetName (const TranslatableString &name)
void	SetToolTip (const TranslatableString &toolTip)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Attributes
wxTextCtrl *	mCloudProjectsSavePath {}
Observer::Subscription	mFrequencySubscription
sync::CloudLocationMode	mSaveLocationMode
sync::CloudLocationMode	mExportLocationMode

Additional Inherited Members
Public Types inherited from PrefsPanel
using	Factories = std::vector< PrefsPanel::PrefsNode >
using	Factory = std::function< PrefsPanel *(wxWindow *parent, wxWindowID winid, AudacityProject *) >
Static Public Member Functions inherited from PrefsPanel
static Factories &	DefaultFactories ()

Detailed Description

Definition at line 37 of file AudioComPrefsPanel.cpp.

Constructor & Destructor Documentation

AudioComPrefsPanel()

anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::AudioComPrefsPanel ( wxWindow *  parent, wxWindowID  winid  )

inline

Definition at line 40 of file AudioComPrefsPanel.cpp.

       : PrefsPanel { parent, winid, XO("Cloud") }
   {
      ShuttleGui S(this, eIsCreatingFromPrefs);
      PopulateOrExchange(S);
 
      mSaveLocationMode   = sync::SaveLocationMode.ReadEnum();
      mExportLocationMode = sync::ExportLocationMode.ReadEnum();
   }

References eIsCreatingFromPrefs, audacity::cloud::audiocom::sync::ExportLocationMode, EnumSetting< Enum >::ReadEnum(), S, and audacity::cloud::audiocom::sync::SaveLocationMode.

Here is the call graph for this function:

Member Function Documentation

Browse()

void anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::Browse ( )

inline

Definition at line 188 of file AudioComPrefsPanel.cpp.

   {
      const auto currentPath = CloudProjectsSavePath.Read();
 
      wxDirDialogWrapper dlog(
         this, XO("Choose a location to place the temporary directory"),
         currentPath);
      int retval = dlog.ShowModal();
 
      if (retval != wxID_CANCEL && !dlog.GetPath().empty())
      {
         wxFileName tmpDirPath;
         tmpDirPath.AssignDir(dlog.GetPath());
 
         if (TempDirectory::FATFilesystemDenied(
                tmpDirPath.GetFullPath(),
                XO("Temporary files directory cannot be on a FAT drive.")))
         {
            return;
         }
 
         if (!FileNames::WritableLocationCheck(
                dlog.GetPath(), XO("Cannot set the preference.")))
         {
            return;
         }
 
         mCloudProjectsSavePath->SetValue(
            tmpDirPath.GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR));
      }
   }

References audacity::cloud::audiocom::CloudProjectsSavePath, TempDirectory::FATFilesystemDenied(), Setting< T >::Read(), FileNames::WritableLocationCheck(), and XO().

Here is the call graph for this function:

Cancel()

void anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::Cancel ( )

inlineoverridevirtual

Reimplemented from PrefsPanel.

Definition at line 66 of file AudioComPrefsPanel.cpp.

   {
      // ChoiceSetting ignores transactions, so we need to reset the values
      sync::SaveLocationMode.WriteEnum(mSaveLocationMode);
      sync::ExportLocationMode.WriteEnum(mExportLocationMode);
   }

References audacity::cloud::audiocom::sync::ExportLocationMode, audacity::cloud::audiocom::sync::SaveLocationMode, and EnumSetting< Enum >::WriteEnum().

Here is the call graph for this function:

Commit()

bool anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::Commit ( )

inlineoverridevirtual

Implements PrefsPanel.

Definition at line 50 of file AudioComPrefsPanel.cpp.

   {
      ShuttleGui S(this, eIsSavingToPrefs);
      PopulateOrExchange(S);
 
      CloudProjectsSavePath.Invalidate();
      DaysToKeepFiles.Invalidate();
 
      // Enum settings are not cacheable, so we need to invalidate them
      // sync::SaveLocationMode.Invalidate();
      // sync::ExportLocationMode.Invalidate();
      sync::MixdownDialogShown.Invalidate();
 
      return true;
   }

References audacity::cloud::audiocom::CloudProjectsSavePath, audacity::cloud::audiocom::DaysToKeepFiles, eIsSavingToPrefs, Setting< T >::Invalidate(), audacity::cloud::audiocom::sync::MixdownDialogShown, and S.

Here is the call graph for this function:

GetDescription()

TranslatableString anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::GetDescription ( ) const

inlineoverridevirtual

Implements ComponentInterface.

Definition at line 183 of file AudioComPrefsPanel.cpp.

   {
      return XO("Preferences for Cloud");
   }

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::GetSymbol ( ) const

inlineoverridevirtual

Implements ComponentInterface.

Definition at line 178 of file AudioComPrefsPanel.cpp.

   {
      return ComponentInterfaceSymbol { XO("Cloud") };
   }

References XO().

Here is the call graph for this function:

PopulateOrExchange()

void anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::PopulateOrExchange ( ShuttleGui &  S )

inlineoverride

Definition at line 73 of file AudioComPrefsPanel.cpp.

   {
      S.SetBorder(2);
      S.StartScroller();
      {
         S.SetBorder(8);
 
         S.StartStatic(XO("Account"));
         {
            S.SetBorder(8);
            S.AddWindow(
               safenew UserPanel { GetServiceConfig(), GetOAuthService(),
                                   GetUserService(), true,
                                   AudiocomTrace::PrefsPanel, S.GetParent() },
               wxEXPAND);
         }
         S.EndStatic();
 
         S.StartStatic(XO("Export behavior"));
         {
            S.SetBorder(8);
            auto checkBox = S.AddCheckBox(
               XO("S&how 'How would you like to export?' dialog"),
               sync::ExportLocationMode.ReadEnum() ==
                  sync::CloudLocationMode::Ask);
 
            checkBox->Bind(
               wxEVT_CHECKBOX,
               [this](auto& event)
               {
                  sync::ExportLocationMode.WriteEnum(
                     event.IsChecked() ? sync::CloudLocationMode::Ask :
                                         sync::CloudLocationMode::Local);
               });
         }
         S.EndStatic();
 
         S.StartStatic(XO("Save behavior"));
         {
            S.SetBorder(4);
 
            const auto initialMode =
               static_cast<int>(sync::SaveLocationMode.ReadEnum());
 
            auto BindRadioButton = [](auto* button, auto mode)
            {
               button->Bind(
                  wxEVT_RADIOBUTTON,
                  [mode](auto& event)
                  {
                     sync::SaveLocationMode.WriteEnum(
                        static_cast<sync::CloudLocationMode>(mode));
                  });
            };
 
            S.StartInvisiblePanel(4);
            {
               BindRadioButton(S.AddRadioButton(
                  XO("Always &ask"),
                     static_cast<int>(sync::CloudLocationMode::Ask),
                     initialMode),
                  sync::CloudLocationMode::Ask);
               BindRadioButton(S.AddRadioButtonToGroup(
                  XO("Always &save to cloud"),
                  static_cast<int>(sync::CloudLocationMode::Cloud),
                     initialMode),
                  sync::CloudLocationMode::Cloud);
               BindRadioButton(S.AddRadioButtonToGroup(
                  XO("Always save to the co&mputer"),
                  static_cast<int>(sync::CloudLocationMode::Local),
                     initialMode),
                  sync::CloudLocationMode::Local);
            }
            S.EndInvisiblePanel();
         }
         S.EndStatic();
 
         S.StartStatic(XO("Temporary Cloud files directory"));
         {
            S.SetBorder(8);
            S.StartMultiColumn(3, wxEXPAND);
            {
               S.SetStretchyCol(1);
 
               mCloudProjectsSavePath = S.TieTextBox(XXO("&Location:"), CloudProjectsSavePath, 30);
               S.AddButton(XXO("&Browse..."))
                  ->Bind(wxEVT_BUTTON, [this](auto&) { Browse(); });
            }
            S.EndMultiColumn();
 
            S.SetBorder(8);
            S.StartMultiColumn(3);
            {
               S.NameSuffix(XO("days"))
                  .TieIntegerTextBox(
                  XXO("&Remove temporary files after:"), DaysToKeepFiles, 10);
               S.AddFixedText(XO("days"), true);
            }
            S.EndMultiColumn();
         }
         S.EndStatic();
      }
      S.EndScroller();
   }

References audacity::cloud::audiocom::CloudProjectsSavePath, audacity::cloud::audiocom::DaysToKeepFiles, audacity::cloud::audiocom::sync::ExportLocationMode, audacity::cloud::audiocom::GetOAuthService(), audacity::cloud::audiocom::GetServiceConfig(), audacity::cloud::audiocom::GetUserService(), PrefsPanel, EnumSetting< Enum >::ReadEnum(), S, safenew, audacity::cloud::audiocom::sync::SaveLocationMode, EnumSetting< Enum >::WriteEnum(), XO(), and XXO().

Here is the call graph for this function:

Member Data Documentation

mCloudProjectsSavePath

wxTextCtrl* anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::mCloudProjectsSavePath {}

private

Definition at line 221 of file AudioComPrefsPanel.cpp.

mExportLocationMode

sync::CloudLocationMode anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::mExportLocationMode

private

Definition at line 225 of file AudioComPrefsPanel.cpp.

mFrequencySubscription

Observer::Subscription anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::mFrequencySubscription

private

Definition at line 222 of file AudioComPrefsPanel.cpp.

mSaveLocationMode

sync::CloudLocationMode anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::mSaveLocationMode

private

Definition at line 224 of file AudioComPrefsPanel.cpp.

---

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

• AudioComPrefsPanel.cpp