AutoRecoveryDialog Class Reference

Inheritance diagram for AutoRecoveryDialog:

Collaboration diagram for AutoRecoveryDialog:

Public Member Functions
	AutoRecoveryDialog (AudacityProject *proj)
bool	HasRecoverables () const
FilePaths	GetRecoverables ()
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	PopulateOrExchange (ShuttleGui &S)
void	PopulateList ()
bool	HaveChecked ()
void	OnQuitAudacity (wxCommandEvent &evt)
void	OnDiscardSelected (wxCommandEvent &evt)
void	OnRecoverSelected (wxCommandEvent &evt)
void	OnSkip (wxCommandEvent &evt)
void	OnColumnClicked (wxListEvent &evt)
void	OnItemActivated (wxListEvent &evt)
void	OnListKeyDown (wxKeyEvent &evt)

Private Attributes
FilePaths	mFiles
wxListCtrl *	mFileList
AudacityProject *	mProject

Detailed Description

Definition at line 36 of file AutoRecoveryDialog.cpp.

Constructor & Destructor Documentation

AutoRecoveryDialog()

AutoRecoveryDialog::AutoRecoveryDialog ( AudacityProject *  proj )

explicit

Definition at line 74 of file AutoRecoveryDialog.cpp.

:  wxDialogWrapper(nullptr, wxID_ANY, XO("Automatic Crash Recovery"),
                   wxDefaultPosition, wxDefaultSize,
                   (wxDEFAULT_DIALOG_STYLE & (~wxCLOSE_BOX)) | wxRESIZE_BORDER), // no close box
   mProject(project)
{
   SetName();
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
}

References eIsCreating, and S.

Member Function Documentation

GetRecoverables()

FilePaths AutoRecoveryDialog::GetRecoverables

(

)

Definition at line 90 of file AutoRecoveryDialog.cpp.

{
   return mFiles;
}

References mFiles.

Referenced by ShowAutoRecoveryDialogIfNeeded().

Here is the caller graph for this function:

HasRecoverables()

bool AutoRecoveryDialog::HasRecoverables

(

)

const

Definition at line 85 of file AutoRecoveryDialog.cpp.

{
   return mFiles.size() > 0;
}

References mFiles.

Referenced by ShowAutoRecoveryDialogIfNeeded().

Here is the caller graph for this function:

HaveChecked()

bool AutoRecoveryDialog::HaveChecked ( )

private

Definition at line 210 of file AutoRecoveryDialog.cpp.

{
   long item = -1;
   while (true)
   {
      item = mFileList->GetNextItem(item, wxLIST_NEXT_ALL, wxLIST_STATE_DONTCARE);
      if (item == wxNOT_FOUND)
      {
         break;
      }
      if (mFileList->IsItemChecked(item))
      {
         return true;
      }
   }
 
   AudacityMessageBox(XO("No projects selected"), XO("Automatic Crash Recovery"));
 
   return false;
}

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

Referenced by OnDiscardSelected(), and OnRecoverSelected().

Here is the call graph for this function:

Here is the caller graph for this function:

OnColumnClicked()

void AutoRecoveryDialog::OnColumnClicked ( wxListEvent &  evt )

private

Definition at line 359 of file AutoRecoveryDialog.cpp.

{
   if (evt.GetColumn() != 0)
   {
      return;
   }
 
   long item = -1;
   while (true)
   {
      item = mFileList->GetNextItem(item, wxLIST_NEXT_ALL, wxLIST_STATE_DONTCARE);
      if (item == wxNOT_FOUND)
      {
         break;
      }
      mFileList->CheckItem(item, !mFileList->IsItemChecked(item));
   }
}

References mFileList.

OnDiscardSelected()

void AutoRecoveryDialog::OnDiscardSelected ( wxCommandEvent &  evt )

private

Definition at line 236 of file AutoRecoveryDialog.cpp.

{
   if (!HaveChecked())
   {
      return;
   }
 
   long item = -1;
   bool selectedTemporary = false;
   while (!selectedTemporary)
   {
      item = mFileList->GetNextItem(item, wxLIST_NEXT_ALL, wxLIST_STATE_DONTCARE);
      if (item == wxNOT_FOUND)
         break;
      if (!mFileList->IsItemChecked(item))
         continue;
      FilePath fileName = mFiles[item];
      wxFileName file(fileName);
      if (file.GetExt().IsSameAs(FileNames::UnsavedProjectExtension()))
         selectedTemporary = true;
   }
 
   // Don't give this warning message if all of the checked items are
   // previously saved, non-temporary projects.
   if (selectedTemporary) {
      int ret = AudacityMessageBox(
         XO("Are you sure you want to discard the selected projects?\n\n"
            "Choosing \"Yes\" permanently deletes the selected projects immediately."),
         XO("Automatic Crash Recovery"),
         wxICON_QUESTION | wxYES_NO | wxNO_DEFAULT, this);
 
      if (ret == wxNO)
         return;
   }
 
   item = -1;
   FilePaths files;
   while (true)
   {
      item = mFileList->GetNextItem(item, wxLIST_NEXT_ALL, wxLIST_STATE_DONTCARE);
      if (item == wxNOT_FOUND)
      {
         break;
      }
      if (!mFileList->IsItemChecked(item))
      {
         // Keep in list
         files.push_back(mFiles[item]);
         continue;
      }
      FilePath fileName = mFiles[item];
 
      // Only remove it from disk if it appears to be a temporary file.
      wxFileName file(fileName);
      if (file.GetExt().IsSameAs(FileNames::UnsavedProjectExtension()))
      {
         file.SetFullName(wxT(""));
 
         wxFileName temp(TempDirectory::TempDir(), wxT(""));
         if (file == temp)
            ProjectFileIO::RemoveProject(fileName);
      }
      else
         // Don't remove from disk, but do (later) open the database
         // of this saved file, and discard edits
         files.push_back(fileName);
 
      // Forget all about it
      ActiveProjects::Remove(fileName);
   }
 
   PopulateList();
 
   mFiles = files;
 
   if (mFileList->GetItemCount() == 0)
   {
      EndModal(ID_DISCARD_SELECTED);
   }
}

References AudacityMessageBox(), HaveChecked(), ID_DISCARD_SELECTED, mFileList, mFiles, PopulateList(), ActiveProjects::Remove(), ProjectFileIO::RemoveProject(), TempDirectory::TempDir(), FileNames::UnsavedProjectExtension(), wxT(), and XO().

Here is the call graph for this function:

OnItemActivated()

void AutoRecoveryDialog::OnItemActivated ( wxListEvent &  evt )

private

Definition at line 378 of file AutoRecoveryDialog.cpp.

{
   long item = evt.GetIndex();
   mFileList->CheckItem(item, !mFileList->IsItemChecked(item));
}

References mFileList.

OnListKeyDown()

void AutoRecoveryDialog::OnListKeyDown ( wxKeyEvent &  evt )

private

Definition at line 384 of file AutoRecoveryDialog.cpp.

{
   switch (evt.GetKeyCode())
   {
      case WXK_SPACE:
      {
         bool selected = false;
         long item = -1;
         while (true)
         {
            item = mFileList->GetNextItem(item, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
            if (item == wxNOT_FOUND)
            {
               break;
            }
 
            mFileList->CheckItem(item, !mFileList->IsItemChecked(item));
         }
      }
      break;
 
      case WXK_RETURN:
         // Don't know why wxListCtrls prevent default dialog action,
         // but they do, so handle it.
         EmulateButtonClickIfPresent(GetAffirmativeId());
      break;
 
      default:
         evt.Skip();
      break;
   }
}

References mFileList.

Referenced by PopulateOrExchange().

Here is the caller graph for this function:

OnQuitAudacity()

void AutoRecoveryDialog::OnQuitAudacity ( wxCommandEvent &  evt )

private

Definition at line 231 of file AutoRecoveryDialog.cpp.

{
   EndModal(ID_QUIT_AUDACITY);
}

References ID_QUIT_AUDACITY.

OnRecoverSelected()

void AutoRecoveryDialog::OnRecoverSelected ( wxCommandEvent &  evt )

private

Definition at line 317 of file AutoRecoveryDialog.cpp.

{
   if (!HaveChecked())
   {
      return;
   }
 
   FilePaths files;
 
   bool selected = false;
   long item = -1;
   while (true)
   {
      item = mFileList->GetNextItem(item, wxLIST_NEXT_ALL, wxLIST_STATE_DONTCARE);
      if (item == wxNOT_FOUND)
      {
         if (!selected)
         {
            AudacityMessageBox(XO("No projects selected"), XO("Automatic Crash Recovery"));
         }
         break;
      }
      selected = true;
 
      if (!mFileList->IsItemChecked(item))
      {
         continue;
      }
 
      files.push_back(mFiles[item]);
   }
 
   mFiles = files;
 
   EndModal(ID_RECOVER_SELECTED);
}

References AudacityMessageBox(), HaveChecked(), ID_RECOVER_SELECTED, mFileList, mFiles, and XO().

Here is the call graph for this function:

OnSkip()

void AutoRecoveryDialog::OnSkip ( wxCommandEvent &  evt )

private

Definition at line 354 of file AutoRecoveryDialog.cpp.

{
   EndModal(ID_SKIP);
}

References ID_SKIP.

PopulateList()

void AutoRecoveryDialog::PopulateList ( )

private

Definition at line 147 of file AutoRecoveryDialog.cpp.

{
   wxString tempdir = TempDirectory::TempDir();
   wxString pattern = wxT("*.") + FileNames::UnsavedProjectExtension();
   FilePaths files;
 
   wxDir::GetAllFiles(tempdir, &files, pattern, wxDIR_FILES);
 
   FilePaths active = ActiveProjects::GetAll();
 
   for (auto file : active)
   {
      wxFileName fn = file;
      if (fn.FileExists())
      {
         FilePath fullPath = fn.GetFullPath();
         if (files.Index(fullPath) == wxNOT_FOUND)
         {
            files.push_back(fullPath);
         }
      }
      else
      {
         ActiveProjects::Remove(file);
      }
   }
 
   FilePath activeFile;
   if (mProject)
   {
      auto &projectFileIO = ProjectFileIO::Get(*mProject);
      activeFile = projectFileIO.GetFileName();
   }
 
   mFiles.clear();
   mFileList->DeleteAllItems();
   long item = 0;
 
   for (auto file : files)
   {
      wxFileName fn = file;
      if (fn != activeFile)
      {
         mFiles.push_back(fn.GetFullPath());
         mFileList->InsertItem(item, wxT(""));
         mFileList->SetItem(item, 1, fn.GetName());
         mFileList->CheckItem(item, true);
         item++;
      }
   }
   mFileList->SetMinSize(mFileList->GetBestSize());
   mFileList->SetColumnWidth(0, wxLIST_AUTOSIZE_USEHEADER);
   mFileList->SetColumnWidth(1, 500);
 
   if (item)
   {
      mFileList->SetItemState(0,
                              wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED,
                              wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED);
      mFileList->SetFocus();
   }
}

References fn, ProjectFileIO::Get(), ActiveProjects::GetAll(), mFileList, mFiles, mProject, ActiveProjects::Remove(), TempDirectory::TempDir(), FileNames::UnsavedProjectExtension(), and wxT().

Referenced by OnDiscardSelected(), and PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void AutoRecoveryDialog::PopulateOrExchange ( ShuttleGui &  S )

private

Definition at line 95 of file AutoRecoveryDialog.cpp.

{
   S.SetBorder(5);
   S.StartVerticalLay(wxEXPAND, 1);
   {
      S.AddFixedText(
         XO("The following projects were not saved properly the last time Audacity was run and "
            "can be automatically recovered.\n\n"
            "After recovery, save the projects to ensure changes are written to disk."),
         false,
         500);
 
      S.StartStatic(XO("Recoverable &projects"), 1);
      {
         mFileList = S.Id(ID_FILE_LIST)
            .ConnectRoot(wxEVT_KEY_DOWN, &AutoRecoveryDialog::OnListKeyDown)
            .AddListControlReportMode(
            {
               /*i18n-hint: (verb).  It instruct the user to select items.*/
               XO("Select"),
               /*i18n-hint: (noun).  It's the name of the project to recover.*/
               XO("Name")
            });
         mFileList->EnableCheckBoxes();
         PopulateList();
      }
      S.EndStatic();
 
      S.StartHorizontalLay(wxALIGN_CENTRE, 0);
      {
         S.Id(ID_QUIT_AUDACITY).AddButton(XXO("&Quit Audacity"));
         S.Id(ID_DISCARD_SELECTED).AddButton(XXO("&Discard Selected"));
         S.Id(ID_RECOVER_SELECTED).AddButton(XXO("&Recover Selected"), wxALIGN_CENTRE, true);
         S.Id(ID_SKIP).AddButton(XXO("&Skip"));
 
         SetAffirmativeId(ID_RECOVER_SELECTED);
         SetEscapeId(ID_SKIP);
      }
      S.EndHorizontalLay();
   }
   S.EndVerticalLay();
 
   Layout();
   Fit();
   SetMinSize(GetSize());
 
   // Sometimes it centers on wxGTK and sometimes it doesn't.
   // Yielding before centering seems to be a good workaround,
   // but will leave to implement on a rainy day.
   Center();
}

References ID_DISCARD_SELECTED, ID_FILE_LIST, ID_QUIT_AUDACITY, ID_RECOVER_SELECTED, ID_SKIP, mFileList, OnListKeyDown(), PopulateList(), S, XO(), and XXO().

Here is the call graph for this function:

Member Data Documentation

mFileList

wxListCtrl* AutoRecoveryDialog::mFileList

private

Definition at line 58 of file AutoRecoveryDialog.cpp.

Referenced by HaveChecked(), OnColumnClicked(), OnDiscardSelected(), OnItemActivated(), OnListKeyDown(), OnRecoverSelected(), PopulateList(), and PopulateOrExchange().

mFiles

FilePaths AutoRecoveryDialog::mFiles

private

Definition at line 57 of file AutoRecoveryDialog.cpp.

Referenced by GetRecoverables(), HasRecoverables(), OnDiscardSelected(), OnRecoverSelected(), and PopulateList().

mProject

AudacityProject* AutoRecoveryDialog::mProject

private

Definition at line 59 of file AutoRecoveryDialog.cpp.

Referenced by PopulateList().

---

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

• AutoRecoveryDialog.cpp