#include <AudioComDialogBase.h>

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

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

Public Member Functions
DialogButtonIdentifier	ShowDialog (std::function< DialogButtonIdentifier()> poller={})

Static Public Member Functions
static DialogButtonIdentifier	CancelButtonIdentifier ()

Protected Types
enum class	DialogMode { Opening , Saving }

enum	ButtonType { None = 0 , DefaultButton = 1 , EscButton = 2 }

Protected Member Functions
	AudioComDialogBase (const AudacityProject *project, const DialogIdentifier &optionalPrefsIdentifier={}, DialogMode dialogMode=DialogMode::Saving)

virtual	~AudioComDialogBase ()=default

void	AddTitle (const TranslatableString &title)

void	AddParagraph (const TranslatableString &paragraph)

void	AddButton (DialogButtonIdentifier identifier, const TranslatableString &text, int type=None)

void	SetDialogTitle (const TranslatableString &dialog)

virtual bool	HasSeparator () const

void	EndDialog (DialogButtonIdentifier identifier)

Private Attributes
const AudacityProject *	mProject

DialogIdentifier	mOptionalPrefsIdentifier

wxBoxSizer *	mDialogSizer

wxBoxSizer *	mButtonSizer

DialogButtonIdentifier	mEscButtonIdentifier { CancelButtonIdentifier() }

DialogButtonIdentifier	mResultButtonIdentifier

Additional Inherited Members
Private 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 ()

Private 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 37 of file AudioComDialogBase.h.

Member Enumeration Documentation

◆ ButtonType

enum audacity::cloud::audiocom::sync::AudioComDialogBase::ButtonType

protected

Enumerator
None
DefaultButton
EscButton

Definition at line 62 of file AudioComDialogBase.h.

   {
      None          = 0,
      DefaultButton = 1,
      EscButton     = 2,
   };

◆ DialogMode

enum class audacity::cloud::audiocom::sync::AudioComDialogBase::DialogMode

strongprotected

Enumerator
Opening
Saving

Definition at line 46 of file AudioComDialogBase.h.

   {
      Opening,
      Saving,
   };

Constructor & Destructor Documentation

◆ AudioComDialogBase()

audacity::cloud::audiocom::sync::AudioComDialogBase::AudioComDialogBase	(	const AudacityProject *	project,
		const DialogIdentifier &	optionalPrefsIdentifier = `{}`,
		DialogMode	dialogMode = `DialogMode::Saving`
	)

protected

Definition at line 118 of file AudioComDialogBase.cpp.

    : wxDialogWrapper { GetProjectWindow(project), wxID_ANY,
                        dialogMode == DialogMode::Saving ?
                           XO("Save to audio.com") :
                           XO("Open from audio.com") }
    , mProject { project }
    , mOptionalPrefsIdentifier { GetOptionalPrefsIdentifier(
         optionalPrefsIdentifier) }
    , mDialogSizer { new wxBoxSizer(wxVERTICAL) }
    , mButtonSizer { new wxBoxSizer(wxHORIZONTAL) }
{
   mDialogSizer->SetMinSize({ 420, 140 });
   if (!mOptionalPrefsIdentifier.empty())
   {
      const auto skipDialog =
         gPrefs->ReadBool(mOptionalPrefsIdentifier.GET(), false);
 
      auto checkbox =
         safenew wxCheckBox { this, wxID_ANY,
                              XO("Don't show this again").Translation() };
 
      checkbox->SetValue(skipDialog);
 
      mButtonSizer->Add(checkbox, wxSizerFlags {}.CenterVertical());
 
      checkbox->Bind(
         wxEVT_CHECKBOX,
         [this, checkbox](auto&)
         {
            gPrefs->Write(mOptionalPrefsIdentifier.GET(), checkbox->GetValue());
            gPrefs->Flush();
         });
   }
 
   mButtonSizer->AddStretchSpacer();
 
   Bind(
      wxEVT_CHAR_HOOK,
      [this](auto& evt)
      {
         if (!IsEscapeKey(evt))
         {
            evt.Skip();
            return;
         }
 
         EndDialog(mEscButtonIdentifier);
      });
}

References Identifier::empty(), EndDialog(), audacity::BasicSettings::Flush(), Identifier::GET(), gPrefs, mButtonSizer, mDialogSizer, mEscButtonIdentifier, mOptionalPrefsIdentifier, audacity::BasicSettings::ReadBool(), safenew, audacity::BasicSettings::Write(), and XO().

Here is the call graph for this function:

◆ ~AudioComDialogBase()

virtual audacity::cloud::audiocom::sync::AudioComDialogBase::~AudioComDialogBase ( )

protectedvirtualdefault

Member Function Documentation

◆ AddButton()

void audacity::cloud::audiocom::sync::AudioComDialogBase::AddButton	(	DialogButtonIdentifier	identifier,
		const TranslatableString &	text,
		int	type = `None`
	)

protected

Definition at line 195 of file AudioComDialogBase.cpp.

{
   auto button = safenew wxButton { this, wxID_ANY, text.Translation() };
 
   mButtonSizer->Add(button, wxSizerFlags {}.Border(wxLEFT, 8));
 
   if (type & EscButton)
      mEscButtonIdentifier = identifier;
 
   button->Bind(
      wxEVT_BUTTON, [this, identifier = std::move(identifier)](auto&)
      { EndDialog(identifier); });
 
   if (type & DefaultButton)
      button->SetDefault();
}

References DefaultButton, EndDialog(), EscButton, mButtonSizer, mEscButtonIdentifier, safenew, and TranslatableString::Translation().

Referenced by audacity::cloud::audiocom::sync::LinkAccountDialog::LinkAccountDialog(), audacity::cloud::audiocom::sync::NotCloudProjectDialog::NotCloudProjectDialog(), audacity::cloud::audiocom::sync::ProjectLimitDialog::ProjectLimitDialog(), audacity::cloud::audiocom::sync::ProjectVersionConflictDialog::ProjectVersionConflictDialog(), audacity::cloud::audiocom::sync::SyncInBackroundDialog::SyncInBackroundDialog(), audacity::cloud::audiocom::sync::SyncSucceededDialog::SyncSucceededDialog(), audacity::cloud::audiocom::sync::UnsyncedProjectDialog::UnsyncedProjectDialog(), audacity::cloud::audiocom::sync::UploadCanceledDialog::UploadCanceledDialog(), and audacity::cloud::audiocom::sync::WaitForActionDialog::WaitForActionDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddParagraph()

void audacity::cloud::audiocom::sync::AudioComDialogBase::AddParagraph ( const TranslatableString & paragraph )

protected

Definition at line 184 of file AudioComDialogBase.cpp.

{
   auto statText =
      safenew wxStaticText { this, wxID_ANY, paragraph.Translation() };
 
   mDialogSizer->AddSpacer(16);
   mDialogSizer->Add(statText, wxSizerFlags {}.Border(wxLEFT | wxRIGHT, 16));
 
   statText->Wrap(400);
}

References mDialogSizer, safenew, and TranslatableString::Translation().

Referenced by audacity::cloud::audiocom::sync::LinkAccountDialog::LinkAccountDialog(), audacity::cloud::audiocom::sync::NotCloudProjectDialog::NotCloudProjectDialog(), audacity::cloud::audiocom::sync::ProjectLimitDialog::ProjectLimitDialog(), audacity::cloud::audiocom::sync::ProjectVersionConflictDialog::ProjectVersionConflictDialog(), audacity::cloud::audiocom::sync::SyncInBackroundDialog::SyncInBackroundDialog(), audacity::cloud::audiocom::sync::SyncSucceededDialog::SyncSucceededDialog(), audacity::cloud::audiocom::sync::UnsyncedProjectDialog::UnsyncedProjectDialog(), audacity::cloud::audiocom::sync::UploadCanceledDialog::UploadCanceledDialog(), and audacity::cloud::audiocom::sync::WaitForActionDialog::WaitForActionDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddTitle()

void audacity::cloud::audiocom::sync::AudioComDialogBase::AddTitle ( const TranslatableString & title )

protected

Definition at line 170 of file AudioComDialogBase.cpp.

{
   auto font = GetFont().Bold();
 
   font.SetFractionalPointSize(font.GetFractionalPointSize() * 1.5f);
 
   auto statText = safenew wxStaticText { this, wxID_ANY, title.Translation() };
 
   statText->SetFont(font);
 
   mDialogSizer->AddSpacer(16);
   mDialogSizer->Add(statText, wxSizerFlags {}.Border(wxLEFT | wxRIGHT, 16));
}

References mDialogSizer, safenew, and title.

Referenced by audacity::cloud::audiocom::sync::LinkAccountDialog::LinkAccountDialog(), audacity::cloud::audiocom::sync::NotCloudProjectDialog::NotCloudProjectDialog(), audacity::cloud::audiocom::sync::ProjectLimitDialog::ProjectLimitDialog(), audacity::cloud::audiocom::sync::ProjectVersionConflictDialog::ProjectVersionConflictDialog(), audacity::cloud::audiocom::sync::SyncInBackroundDialog::SyncInBackroundDialog(), audacity::cloud::audiocom::sync::SyncSucceededDialog::SyncSucceededDialog(), audacity::cloud::audiocom::sync::UnsyncedProjectDialog::UnsyncedProjectDialog(), and audacity::cloud::audiocom::sync::WaitForActionDialog::WaitForActionDialog().

Here is the caller graph for this function:

◆ CancelButtonIdentifier()

DialogButtonIdentifier audacity::cloud::audiocom::sync::AudioComDialogBase::CancelButtonIdentifier ( )

static

Definition at line 113 of file AudioComDialogBase.cpp.

{
   return { L"Cancel" };
}

Referenced by audacity::cloud::audiocom::sync::anonymous_namespace{CloudProjectOpenUtils.cpp}::GetConfilctResolution(), audacity::cloud::audiocom::sync::LinkAccountDialog::LinkAccountDialog(), audacity::cloud::audiocom::sync::ProjectsListDialog::OnOpen(), audacity::cloud::audiocom::sync::ProjectVersionConflictDialog::ProjectVersionConflictDialog(), audacity::cloud::audiocom::sync::UnsyncedProjectDialog::UnsyncedProjectDialog(), and audacity::cloud::audiocom::sync::WaitForActionDialog::WaitForActionDialog().

Here is the caller graph for this function:

◆ EndDialog()

void audacity::cloud::audiocom::sync::AudioComDialogBase::EndDialog ( DialogButtonIdentifier identifier )

protected

Definition at line 223 of file AudioComDialogBase.cpp.

{
   mResultButtonIdentifier = std::move(identifier);
   Close();
}

References mResultButtonIdentifier.

Referenced by AddButton(), and AudioComDialogBase().

Here is the caller graph for this function:

◆ HasSeparator()

bool audacity::cloud::audiocom::sync::AudioComDialogBase::HasSeparator ( ) const

protectedvirtual

Reimplemented in audacity::cloud::audiocom::sync::UploadCanceledDialog, and audacity::cloud::audiocom::sync::WaitForActionDialog.

Definition at line 218 of file AudioComDialogBase.cpp.

{
   return true;
}

◆ SetDialogTitle()

void audacity::cloud::audiocom::sync::AudioComDialogBase::SetDialogTitle ( const TranslatableString & dialog )

protected

Definition at line 213 of file AudioComDialogBase.cpp.

{
   SetTitle(dialog);
}

References wxDialogWrapper::SetTitle().

Here is the call graph for this function:

◆ ShowDialog()

DialogButtonIdentifier audacity::cloud::audiocom::sync::AudioComDialogBase::ShowDialog ( std::function< DialogButtonIdentifier()> poller = {} )

Definition at line 55 of file AudioComDialogBase.cpp.

{
   mDialogSizer->AddStretchSpacer(1);
 
   if (HasSeparator())
   {
      mDialogSizer->Add(
         safenew wxStaticLine { this },
         wxSizerFlags {}.Border(wxTOP, 16).Expand());
      mDialogSizer->AddSpacer(8);
   }
   else
      mDialogSizer->AddSpacer(16);
 
   mDialogSizer->Add(
      mButtonSizer, wxSizerFlags {}.Border(wxLEFT | wxRIGHT, 16).Expand());
   mDialogSizer->AddSpacer(8);
 
   SetSizerAndFit(mDialogSizer);
   SetupAccessibility(this);
   Center();
 
   // We cannot do it earlier to avoid licking the sizers and children
   if (!mOptionalPrefsIdentifier.empty())
   {
      if (gPrefs->ReadBool(mOptionalPrefsIdentifier.GET(), false))
         return mEscButtonIdentifier;
   }
 
   Show();
   Raise();
 
   {
      wxWindowDisabler disabler { this };
 
      if (!poller)
         poller = [] { return DialogButtonIdentifier {}; };
 
      while (IsShown())
      {
         wxYield();
 
         if (auto result = poller(); !result.empty())
            return result;
      }
   }
 
   // On Windows, parent window will lose focus after the wxWindowDisabler is destroyed
   if (auto parent = GetParent())
      parent->Raise();
 
   // mResultButtonIdentifier is empty if the dialog was closed using the
   // cross button
   return mResultButtonIdentifier.empty() ? mEscButtonIdentifier :
                                            mResultButtonIdentifier;
}

References gPrefs, audacity::BasicSettings::ReadBool(), safenew, SetupAccessibility(), and ExportProgressUI::Show().

Referenced by audacity::cloud::audiocom::sync::anonymous_namespace{CloudProjectOpenUtils.cpp}::HandleFailure(), and audacity::cloud::audiocom::sync::ProjectCloudUIExtension::OnCloudStatusChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mButtonSizer

wxBoxSizer* audacity::cloud::audiocom::sync::AudioComDialogBase::mButtonSizer

private

Definition at line 84 of file AudioComDialogBase.h.

Referenced by AddButton(), and AudioComDialogBase().

◆ mDialogSizer

wxBoxSizer* audacity::cloud::audiocom::sync::AudioComDialogBase::mDialogSizer

private

Definition at line 83 of file AudioComDialogBase.h.

Referenced by AddParagraph(), AddTitle(), and AudioComDialogBase().

◆ mEscButtonIdentifier

DialogButtonIdentifier audacity::cloud::audiocom::sync::AudioComDialogBase::mEscButtonIdentifier { CancelButtonIdentifier() }

private

Definition at line 86 of file AudioComDialogBase.h.

Referenced by AddButton(), and AudioComDialogBase().

◆ mOptionalPrefsIdentifier

DialogIdentifier audacity::cloud::audiocom::sync::AudioComDialogBase::mOptionalPrefsIdentifier

private

Definition at line 81 of file AudioComDialogBase.h.

Referenced by AudioComDialogBase().

◆ mProject

const AudacityProject* audacity::cloud::audiocom::sync::AudioComDialogBase::mProject

private

Definition at line 80 of file AudioComDialogBase.h.

◆ mResultButtonIdentifier

DialogButtonIdentifier audacity::cloud::audiocom::sync::AudioComDialogBase::mResultButtonIdentifier

private

Definition at line 87 of file AudioComDialogBase.h.

Referenced by EndDialog().

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ButtonType

◆ DialogMode

Constructor & Destructor Documentation

◆ AudioComDialogBase()

◆ ~AudioComDialogBase()

Member Function Documentation

◆ AddButton()

◆ AddParagraph()

◆ AddTitle()

◆ CancelButtonIdentifier()

◆ EndDialog()

◆ HasSeparator()

◆ SetDialogTitle()

◆ ShowDialog()

Member Data Documentation

◆ mButtonSizer

◆ mDialogSizer

◆ mEscButtonIdentifier

◆ mOptionalPrefsIdentifier

◆ mProject

◆ mResultButtonIdentifier