DependencyDialog shows dependencies of an AudacityProject on AliasedFile s. More...

Inheritance diagram for DependencyDialog:

Collaboration diagram for DependencyDialog:

Public Member Functions
	DependencyDialog (wxWindow parent, wxWindowID id, AudacityProject project, AliasedFileArray &aliasedFiles, bool isSaving)

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

Private Member Functions
void	PopulateList ()

void	PopulateOrExchange (ShuttleGui &S)

void	OnCancel (wxCommandEvent &evt)

void	OnCopySelectedFiles (wxCommandEvent &evt)

void	OnList (wxListEvent &evt)

void	OnSize (wxSizeEvent &evt)

void	OnNo (wxCommandEvent &evt)

void	OnYes (wxCommandEvent &evt)

void	OnRightClick (wxListEvent &evt)

void	OnCopyToClipboard (wxCommandEvent &evt)

void	SaveFutureActionChoice ()

Private Attributes
AudacityProject *	mProject

AliasedFileArray &	mAliasedFiles

bool	mIsSaving

bool	mHasMissingFiles

bool	mHasNonMissingFiles

wxStaticText *	mMessageStaticText

wxListCtrl *	mFileListCtrl

wxButton *	mCopySelectedFilesButton

wxButton *	mCopyAllFilesButton

wxChoice *	mFutureActionChoice

Detailed Description

DependencyDialog shows dependencies of an AudacityProject on AliasedFile s.

Definition at line 242 of file Dependencies.cpp.

Constructor & Destructor Documentation

◆ DependencyDialog()

DependencyDialog::DependencyDialog	(	wxWindow *	parent,
		wxWindowID	id,
		AudacityProject *	project,
		AliasedFileArray &	aliasedFiles,
		bool	isSaving
	)

Member Function Documentation

◆ OnCancel()

void DependencyDialog::OnCancel ( wxCommandEvent & evt )

private

Definition at line 564 of file Dependencies.cpp.

{
   if (mIsSaving)
   {
      int ret = AudacityMessageBox(
         XO(
"If you proceed, your project will not be saved to disk. Is this what you want?"),
         XO("Cancel Save"),
         wxICON_QUESTION | wxYES_NO | wxNO_DEFAULT, this);
      if (ret != wxYES)
         return;
   }
 
   EndModal(wxID_CANCEL);
}

References AudacityMessageBox(), mIsSaving, and XO().

Here is the call graph for this function:

◆ OnCopySelectedFiles()

void DependencyDialog::OnCopySelectedFiles ( wxCommandEvent & evt )

private

Definition at line 507 of file Dependencies.cpp.

{
   AliasedFileArray aliasedFilesToDelete, remainingAliasedFiles;
 
   long i = 0;
   for( const auto &file : mAliasedFiles ) {
      if (mFileListCtrl->GetItemState(i, wxLIST_STATE_SELECTED))
         aliasedFilesToDelete.push_back( file );
      else
         remainingAliasedFiles.push_back( file );
      ++i;
   }
 
   // provides STRONG-GUARANTEE
   RemoveDependencies(mProject, aliasedFilesToDelete);
 
   // COMMIT OPERATIONS needing NOFAIL-GUARANTEE:
   mAliasedFiles.swap( remainingAliasedFiles );
   PopulateList();
 
   if (mAliasedFiles.empty() || !mHasNonMissingFiles)
   {
      SaveFutureActionChoice();
      EndModal(wxID_NO);  // Don't need to remove dependencies
   }
}

References mAliasedFiles, mFileListCtrl, mHasNonMissingFiles, mProject, PopulateList(), RemoveDependencies(), and SaveFutureActionChoice().

Here is the call graph for this function:

◆ OnCopyToClipboard()

void DependencyDialog::OnCopyToClipboard ( wxCommandEvent & evt )

private

Definition at line 542 of file Dependencies.cpp.

{
   TranslatableString Files;
   for (const auto &aliasedFile : mAliasedFiles) {
      const wxFileName & fileName = aliasedFile.mFileName;
      wxLongLong byteCount = (aliasedFile.mByteCount * 124) / 100;
      bool bOriginalExists = aliasedFile.mbOriginalExists;
      // All fields quoted, as e.g. size may contain a comma in the number.
      Files += XO( "\"%s\", \"%s\", \"%s\"\n").Format(
         fileName.GetFullPath(), 
         Internat::FormatSize( byteCount),
         bOriginalExists ? XO("OK") : XO("Missing") );
   }
 
   // copy data onto clipboard
   if (wxTheClipboard->Open()) {
      // Clipboard owns the data you give it
      wxTheClipboard->SetData(safenew wxTextDataObject(Files.Translation()));
      wxTheClipboard->Close();
   }
}

References Internat::FormatSize(), mAliasedFiles, safenew, TranslatableString::Translation(), and XO().

Here is the call graph for this function:

◆ OnList()

void DependencyDialog::OnList ( wxListEvent & evt )

private

Definition at line 465 of file Dependencies.cpp.

{
   if (!mCopySelectedFilesButton || !mFileListCtrl)
      return;
 
   wxString itemStr = evt.GetText();
   if (evt.GetData() == 0)
      // This list item is one of mAliasedFiles for which
      // the original is missing, i.e., moved or deleted.
      // wxListCtrl does not provide for items that are not
      // allowed to be selected, so always deselect these items.
      mFileListCtrl->SetItemState(evt.GetIndex(), 0, wxLIST_STATE_SELECTED); // Deselect.
 
   mCopySelectedFilesButton->Enable(
      mFileListCtrl->GetSelectedItemCount() > 0);
}

References mCopySelectedFilesButton, and mFileListCtrl.

◆ OnNo()

void DependencyDialog::OnNo ( wxCommandEvent & evt )

private

Definition at line 495 of file Dependencies.cpp.

{
   SaveFutureActionChoice();
   EndModal(wxID_NO);
}

References SaveFutureActionChoice().

Here is the call graph for this function:

◆ OnRightClick()

void DependencyDialog::OnRightClick ( wxListEvent & evt )

private

Definition at line 534 of file Dependencies.cpp.

{
   static_cast<void>(event);
   wxMenu menu;
   menu.Append(CopyNamesToClipboardID, _("&Copy Names to Clipboard"));
   PopupMenu(&menu);
}

References _, and CopyNamesToClipboardID.

◆ OnSize()

void DependencyDialog::OnSize ( wxSizeEvent & evt )

private

Definition at line 482 of file Dependencies.cpp.

{
   int fileListCtrlWidth, fileListCtrlHeight;
   mFileListCtrl->GetSize(&fileListCtrlWidth, &fileListCtrlHeight);
 
   // File path is column 0. File size is column 1.
   // File size column is always 120 px wide.
   // Also subtract 8 from file path column width for borders.
   mFileListCtrl->SetColumnWidth(0, fileListCtrlWidth - 120 - 8);
   mFileListCtrl->SetColumnWidth(1, 120);
   wxDialogWrapper::OnSize(evt);
}

References mFileListCtrl, and OnSize().

Here is the call graph for this function:

◆ OnYes()

void DependencyDialog::OnYes ( wxCommandEvent & evt )

private

Definition at line 501 of file Dependencies.cpp.

{
   SaveFutureActionChoice();
   EndModal(wxID_YES);
}

References SaveFutureActionChoice().

Here is the call graph for this function:

◆ PopulateList()

void DependencyDialog::PopulateList ( )

private

Definition at line 424 of file Dependencies.cpp.

{
   mFileListCtrl->DeleteAllItems();
 
   mHasMissingFiles = false;
   mHasNonMissingFiles = false;
   long i = 0;
   for (const auto &aliasedFile : mAliasedFiles) {
      const wxFileName &fileName = aliasedFile.mFileName;
      wxLongLong byteCount = (aliasedFile.mByteCount * 124) / 100;
      bool bOriginalExists = aliasedFile.mbOriginalExists;
 
      if (bOriginalExists)
      {
         mFileListCtrl->InsertItem(i, fileName.GetFullPath());
         mHasNonMissingFiles = true;
         mFileListCtrl->SetItemState(i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
      }
      else
      {
         mFileListCtrl->InsertItem(i,
            wxString::Format( _("MISSING %s"), fileName.GetFullPath() ) );
         mHasMissingFiles = true;
         mFileListCtrl->SetItemState(i, 0, wxLIST_STATE_SELECTED); // Deselect.
         mFileListCtrl->SetItemTextColour(i, *wxRED);
      }
      mFileListCtrl->SetItem(i, 1, Internat::FormatSize(byteCount).Translation());
      mFileListCtrl->SetItemData(i, long(bOriginalExists));
 
      ++i;
   }
 
   auto msg = kStdMsg();
   if (mHasMissingFiles)
      msg += kExtraMsgForMissingFiles();
   mMessageStaticText->SetLabel(msg.Translation());
 
   if (mCopyAllFilesButton)
      mCopyAllFilesButton->Enable(!mHasMissingFiles);
}

References _, Internat::FormatSize(), kExtraMsgForMissingFiles(), kStdMsg(), mAliasedFiles, mCopyAllFilesButton, mFileListCtrl, mHasMissingFiles, mHasNonMissingFiles, mMessageStaticText, and TranslatableString::Translation().

Referenced by OnCopySelectedFiles(), and PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PopulateOrExchange()

void DependencyDialog::PopulateOrExchange ( ShuttleGui & S )

private

Definition at line 345 of file Dependencies.cpp.

{
   S.SetBorder(5);
   S.StartVerticalLay();
   {
      mMessageStaticText = S.AddVariableText(kStdMsg(), false);
 
      S.StartStatic(XO("Project Dependencies"),1);
      {
         mFileListCtrl = S.Id(FileListID).AddListControlReportMode({
            { XO("Audio File"), wxLIST_FORMAT_LEFT, 220 },
            { XO("Disk Space"), wxLIST_FORMAT_LEFT, 120 }
         });
         PopulateList();
 
         mCopySelectedFilesButton =
            S.Id(CopySelectedFilesButtonID)
               .Focus()
               .Disable(mFileListCtrl->GetSelectedItemCount() <= 0)
               .AddButton(
                  XXO("Copy Selected Files"),
                  wxALIGN_LEFT, true);
      }
      S.EndStatic();
 
      S.StartHorizontalLay(wxALIGN_CENTRE,0);
      {
         if (mIsSaving) {
            S.Id(wxID_CANCEL).AddButton(XXO("Cancel Save"));
            S.Id(wxID_NO).AddButton(XXO("Save Without Copying"));
         }
         else
            S.Id(wxID_NO).AddButton(XXO("Do Not Copy"));
 
         mCopyAllFilesButton =
            S.Id(wxID_YES)
               // Enabling mCopyAllFilesButton is also done in PopulateList,
               // but at its call above, mCopyAllFilesButton does not yet exist.
               .Disable(mHasMissingFiles)
               .AddButton(XXO("Copy All Files (Safer)"));
 
      }
      S.EndHorizontalLay();
 
      if (mIsSaving)
      {
         S.StartHorizontalLay(wxALIGN_LEFT,0);
         {
            mFutureActionChoice =
               S.Id(FutureActionChoiceID).AddChoice(
                  XXO("Whenever a project depends on other files:"),
                  {
                     /*i18n-hint: One of the choices of what you want Audacity to do when
                     * Audacity finds a project depends on another file.*/
                     XO("Ask me") ,
                     /*i18n-hint: One of the choices of what you want Audacity to do when
                     * Audacity finds a project depends on another file.*/
                     XO("Always copy all files (safest)") ,
                     /*i18n-hint: One of the choices of what you want Audacity to do when
                     * Audacity finds a project depends on another file.*/
                     XO("Never copy any files") ,
                  },
                  0 // "Ask me"
               );
         }
         S.EndHorizontalLay();
      }
      else
      {
         mFutureActionChoice = NULL;
      }
   }
   S.EndVerticalLay();
   Layout();
   Fit();
   SetMinSize(GetSize());
   Center();
}

References CopySelectedFilesButtonID, FileListID, FutureActionChoiceID, kStdMsg(), mCopyAllFilesButton, mCopySelectedFilesButton, mFileListCtrl, mFutureActionChoice, mHasMissingFiles, mIsSaving, mMessageStaticText, PopulateList(), S, XO(), and XXO().

Here is the call graph for this function:

◆ SaveFutureActionChoice()

void DependencyDialog::SaveFutureActionChoice ( )

private

Definition at line 580 of file Dependencies.cpp.

{
   if (mFutureActionChoice)
   {
      wxString savePref;
      int sel = mFutureActionChoice->GetSelection();
      switch (sel)
      {
      case 1: savePref = wxT("copy"); break;
      case 2: savePref = wxT("never"); break;
      default: savePref = wxT("ask");
      }
      FileFormatsSaveWithDependenciesSetting.Write( savePref );
      gPrefs->Flush();
   }
}