#include <CloudProjectPropertiesDialog.h>

Inheritance diagram for audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog:

Collaboration diagram for audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog:

Public Types
enum class	Action { Cancel , SaveToCloud , SaveLocally }

Static Public Member Functions
static std::pair< Action, std::string >	Show (const ServiceConfig &serviceConfig, OAuthService &authService, UserService &userService, const wxString &projectName, wxWindow *parent, bool allowLocalSave)

Private Member Functions
	CloudProjectPropertiesDialog (const ServiceConfig &serviceConfig, OAuthService &authService, UserService &userService, const wxString &projectName, wxWindow *parent)

	~CloudProjectPropertiesDialog () override

bool	OnSubmit ()

void	LayoutControls ()

void	SetupEvents ()

std::string	GetProjectName () const

void	OnUpdateCloudSaveState ()

Private Attributes
UserPanel *	mUserPanel {}

wxTextCtrl *	mProjectName {}

wxButton *	mSaveToCloud {}

wxButton *	mSaveLocally {}

wxButton *	mCancel {}

wxStaticText *	mAnonStateText {}

Observer::Subscription	mUserStateChangedSubscription {}

Additional Inherited Members
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()

	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

void	SetTitle (const TranslatableString &title)

void	SetLabel (const TranslatableString &title)

void	SetName (const TranslatableString &title)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Detailed Description

Definition at line 36 of file CloudProjectPropertiesDialog.h.

Member Enumeration Documentation

◆ Action

enum class audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::Action

strong

Enumerator
Cancel
SaveToCloud
SaveLocally

Definition at line 44 of file CloudProjectPropertiesDialog.h.

   {
      Cancel,
      SaveToCloud,
      SaveLocally
   };

Constructor & Destructor Documentation

◆ CloudProjectPropertiesDialog()

audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::CloudProjectPropertiesDialog	(	const ServiceConfig &	serviceConfig,
		OAuthService &	authService,
		UserService &	userService,
		const wxString &	projectName,
		wxWindow *	parent
	)

private

Definition at line 29 of file CloudProjectPropertiesDialog.cpp.

    : wxDialogWrapper { parent, wxID_ANY, XO("Save to audio.com") }
{
   GetAuthorizationHandler().PushSuppressDialogs();
 
   mUserPanel =
      new UserPanel(serviceConfig, authService, userService, true, this);
 
   mUserStateChangedSubscription =
      mUserPanel->Subscribe([this](auto) { OnUpdateCloudSaveState(); });
 
   mProjectName = new wxTextCtrl { this,          wxID_ANY,
                                   projectName,   wxDefaultPosition,
                                   wxDefaultSize, wxTE_PROCESS_ENTER };
   mProjectName->SetName(XO("Project Name").Translation());
 
   mAnonStateText = safenew wxStaticText {
      this, wxID_ANY,
      XO("Cloud saving requires a free audio.com account linked to Audacity. Press \"Link account\" above to proceed.")
         .Translation()
   };
 
   mAnonStateText->Wrap(450 - 32);
 
   if (!projectName.empty())
   {
      mProjectName->SetValue(projectName);
      // mProjectName->SetInsertionPoint(-1);
   }
 
   const wxString choices[] = { XO("Private").Translation(),
                                XO("Unlisted").Translation(),
                                XO("Public").Translation() };
 
   mSaveToCloud = new wxButton { this, wxID_ANY, XO("Save").Translation() };
 
   mSaveLocally =
      new wxButton { this, wxID_ANY, XO("Save to computer...").Translation() };
   mCancel = new wxButton { this, wxID_ANY, XO("Cancel").Translation() };
 
   mProjectName->SetFocus();
 
   LayoutControls();
   OnUpdateCloudSaveState();
 
   SetupEvents();
 
   SetupAccessibility(this);
}

References audacity::cloud::audiocom::GetAuthorizationHandler(), LayoutControls(), mAnonStateText, mCancel, mProjectName, mSaveLocally, mSaveToCloud, mUserPanel, mUserStateChangedSubscription, OnUpdateCloudSaveState(), audacity::cloud::audiocom::AuthorizationHandler::PushSuppressDialogs(), safenew, SetupAccessibility(), SetupEvents(), Observer::Publisher< Message, NotifyAll >::Subscribe(), and XO().

Here is the call graph for this function:

◆ ~CloudProjectPropertiesDialog()

audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::~CloudProjectPropertiesDialog ( )

overrideprivate

Definition at line 81 of file CloudProjectPropertiesDialog.cpp.

{
   GetAuthorizationHandler().PopSuppressDialogs();
}

References audacity::cloud::audiocom::GetAuthorizationHandler(), and audacity::cloud::audiocom::AuthorizationHandler::PopSuppressDialogs().

Here is the call graph for this function:

Member Function Documentation

◆ GetProjectName()

std::string audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::GetProjectName ( ) const

private

Definition at line 202 of file CloudProjectPropertiesDialog.cpp.

{
   wxString result { mProjectName->GetValue() };
   result.Trim(true).Trim(false);
   return audacity::ToUTF8(result);
}

References mProjectName, and audacity::ToUTF8().

Referenced by OnSubmit(), and OnUpdateCloudSaveState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LayoutControls()

void audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::LayoutControls ( )

private

Definition at line 119 of file CloudProjectPropertiesDialog.cpp.

{
   auto* topSizer = new wxBoxSizer { wxVERTICAL };
 
   constexpr auto spacerHeight = 8;
 
   topSizer->AddSpacer(spacerHeight);
 
   topSizer->Add(mUserPanel, 0, wxEXPAND | wxLEFT | wxRIGHT, 16);
   topSizer->AddSpacer(spacerHeight);
 
   topSizer->Add(new wxStaticLine { this }, 0, wxEXPAND | wxLEFT | wxRIGHT, 16);
   topSizer->AddSpacer(spacerHeight);
 
   topSizer->Add(
      new wxStaticText { this, wxID_ANY, XO("Project Name").Translation() }, 0,
      wxEXPAND | wxLEFT | wxRIGHT, 16);
   topSizer->AddSpacer(spacerHeight);
 
   topSizer->Add(mProjectName, 0, wxEXPAND | wxLEFT | wxRIGHT, 16);
 
   topSizer->AddSpacer(spacerHeight);
 
   topSizer->Add(mAnonStateText, 0, wxEXPAND | wxLEFT | wxRIGHT, 16);
 
   topSizer->AddSpacer(2 * spacerHeight);
 
   auto buttonSizer = new wxBoxSizer { wxHORIZONTAL };
 
   buttonSizer->Add(mSaveLocally, 0, wxLEFT, 16);
   buttonSizer->AddStretchSpacer();
   buttonSizer->Add(mCancel, 0, wxRIGHT, 4);
   buttonSizer->Add(mSaveToCloud, 0, wxRIGHT, 16);
 
   topSizer->Add(buttonSizer, 0, wxEXPAND | wxALL, 0);
   topSizer->AddSpacer(spacerHeight);
 
   SetMinSize({ 450, -1 });
   SetSizer(topSizer);
   Fit();
   Centre(wxBOTH);
 
   mAnonStateText->Show(!mUserPanel->IsAuthorized());
}

References audacity::cloud::audiocom::UserPanel::IsAuthorized(), mAnonStateText, mCancel, mProjectName, mSaveLocally, mSaveToCloud, mUserPanel, and XO().

Referenced by CloudProjectPropertiesDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnSubmit()

bool audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::OnSubmit ( )

private

Definition at line 107 of file CloudProjectPropertiesDialog.cpp.

{
   const bool canSubmit =
      mUserPanel->IsAuthorized() && !GetProjectName().empty();
 
   if (!canSubmit)
      return false;
 
   EndModal(wxID_OK);
   return true;
}

References GetProjectName(), audacity::cloud::audiocom::UserPanel::IsAuthorized(), and mUserPanel.

Referenced by SetupEvents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnUpdateCloudSaveState()

void audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::OnUpdateCloudSaveState ( )

private

Definition at line 209 of file CloudProjectPropertiesDialog.cpp.

{
   mSaveToCloud->Enable(
      mUserPanel->IsAuthorized() && !GetProjectName().empty());
 
   mAnonStateText->Show(!mUserPanel->IsAuthorized());
   Fit();
   Layout();
}

References GetProjectName(), audacity::cloud::audiocom::UserPanel::IsAuthorized(), mAnonStateText, mSaveToCloud, and mUserPanel.

Referenced by CloudProjectPropertiesDialog(), and SetupEvents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetupEvents()

void audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::SetupEvents ( )

private

Definition at line 164 of file CloudProjectPropertiesDialog.cpp.

{
   mSaveToCloud->Bind(wxEVT_BUTTON, [this](auto&) { EndModal(wxID_OK); });
   mSaveLocally->Bind(wxEVT_BUTTON, [this](auto&) { EndModal(wxID_SAVE); });
   mCancel->Bind(wxEVT_BUTTON, [this](auto&) { EndModal(wxID_CANCEL); });
 
   Bind(
      wxEVT_CHAR_HOOK,
      [this](auto& evt)
      {
         if (!IsEscapeKey(evt))
         {
            evt.Skip();
            return;
         }
 
         EndModal(wxID_CANCEL);
      });
 
   Bind(
      wxEVT_KEY_UP,
      [this](auto& evt)
      {
         const auto keyCode = evt.GetKeyCode();
         if (keyCode != WXK_RETURN && keyCode != WXK_NUMPAD_ENTER)
         {
            evt.Skip();
            return;
         }
 
         if (!OnSubmit())
            evt.Skip();
      });
 
   mProjectName->Bind(wxEVT_TEXT, [this](auto&) { OnUpdateCloudSaveState(); });
   mProjectName->Bind(wxEVT_TEXT_ENTER, [this](auto&) { OnSubmit(); });
}

References mCancel, mProjectName, mSaveLocally, mSaveToCloud, OnSubmit(), and OnUpdateCloudSaveState().

Referenced by CloudProjectPropertiesDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Show()

std::pair< CloudProjectPropertiesDialog::Action, std::string > audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::Show	(	const ServiceConfig &	serviceConfig,
		OAuthService &	authService,
		UserService &	userService,
		const wxString &	projectName,
		wxWindow *	parent,
		bool	allowLocalSave
	)

static

Definition at line 87 of file CloudProjectPropertiesDialog.cpp.

{
   CloudProjectPropertiesDialog dialog { serviceConfig, authService,
                                         userService, projectName, parent };
 
   dialog.mSaveLocally->Show(allowLocalSave);
 
   const auto resultCode = dialog.ShowModal();
 
   const auto action =
      resultCode == wxID_OK ?
         Action::SaveToCloud :
         (resultCode == wxID_CANCEL ? Action::Cancel : Action::SaveLocally);
 
   return { action, dialog.GetProjectName() };
}