anonymous_namespace{ProjectFileManager.cpp}::ImportProgress Class Reference

Inheritance diagram for anonymous_namespace{ProjectFileManager.cpp}::ImportProgress:

Collaboration diagram for anonymous_namespace{ProjectFileManager.cpp}::ImportProgress:

Public Member Functions
	ImportProgress (AudacityProject &project)
bool	OnImportFileOpened (ImportFileHandle &importFileHandle) override
void	OnImportProgress (double progress) override
void	OnImportResult (ImportResult result) override
	Used to report on import result for file handle passed as argument to OnImportFileOpened. More...
Public Member Functions inherited from ImportProgressListener
virtual	~ImportProgressListener ()
virtual bool	OnImportFileOpened (ImportFileHandle &importFileHandle)=0
virtual void	OnImportProgress (double progress)=0
virtual void	OnImportResult (ImportResult result)=0
	Used to report on import result for file handle passed as argument to OnImportFileOpened. More...

Private Attributes
wxWeakRef< AudacityProject >	mProject
ImportFileHandle *	mImportFileHandle {nullptr}
std::unique_ptr< BasicUI::ProgressDialog >	mProgressDialog

Additional Inherited Members
Public Types inherited from ImportProgressListener
enum class	ImportResult { Success , Error , Cancelled , Stopped }

Detailed Description

Definition at line 1280 of file ProjectFileManager.cpp.

Constructor & Destructor Documentation

ImportProgress()

anonymous_namespace{ProjectFileManager.cpp}::ImportProgress::ImportProgress ( AudacityProject &  project )

inline

Definition at line 1286 of file ProjectFileManager.cpp.

      : mProject(&project)
   {
 
   }

Member Function Documentation

OnImportFileOpened()

bool anonymous_namespace{ProjectFileManager.cpp}::ImportProgress::OnImportFileOpened ( ImportFileHandle &  importFileHandle )

inlineoverridevirtual

Called by Importer when it attempts to import file using registered ImportPlugin instance Could be called more than once, but for each call there will be a complementary call to OnImportResult

Parameters

importFileHandle

file handle created by ImportPlugin instance

Returns

Implementation may return false to abort import process

Implements ImportProgressListener.

Definition at line 1292 of file ProjectFileManager.cpp.

   {
      mImportFileHandle = &importFileHandle;
      // File has more than one stream - display stream selector
      if (importFileHandle.GetStreamCount() > 1)
      {
         ImportStreamDialog ImportDlg(&importFileHandle, NULL, -1, XO("Select stream(s) to import"));
 
         if (ImportDlg.ShowModal() == wxID_CANCEL)
            return false;
      }
      // One stream - import it by default
      else
         importFileHandle.SetStreamUsage(0,TRUE);
      return true;
   }

References ImportFileHandle::GetStreamCount(), ImportFileHandle::SetStreamUsage(), and XO().

Here is the call graph for this function:

OnImportProgress()

void anonymous_namespace{ProjectFileManager.cpp}::ImportProgress::OnImportProgress ( double  progress )

inlineoverridevirtual

Used to report on import progress [optional]

Parameters

progress

import progress in range [0, 1]

Implements ImportProgressListener.

Definition at line 1309 of file ProjectFileManager.cpp.

   {
      constexpr double ProgressSteps { 1000.0 };
      if(!mProgressDialog)
      {
         wxFileName ff( mImportFileHandle->GetFilename() );
         auto title = XO("Importing %s").Format(  mImportFileHandle->GetFileDescription() );
         mProgressDialog = BasicUI::MakeProgress(title, Verbatim(ff.GetFullName()));
      }
      auto result = mProgressDialog->Poll(progress * ProgressSteps, ProgressSteps);
      if(result == BasicUI::ProgressResult::Cancelled)
         mImportFileHandle->Cancel();
      else if(result == BasicUI::ProgressResult::Stopped)
         mImportFileHandle->Stop();
   }

References BasicUI::Cancelled, BasicUI::MakeProgress(), BasicUI::Stopped, title, Verbatim(), and XO().

Here is the call graph for this function:

OnImportResult()

void anonymous_namespace{ProjectFileManager.cpp}::ImportProgress::OnImportResult ( ImportResult  result )

inlineoverridevirtual

Used to report on import result for file handle passed as argument to OnImportFileOpened.

Implements ImportProgressListener.

Definition at line 1325 of file ProjectFileManager.cpp.

   {
      mProgressDialog.reset();
      if(result == ImportResult::Error)
      {
         auto message = mImportFileHandle->GetErrorMessage();
         if(!message.empty())
         {
            AudacityMessageBox(message, XO("Import"), wxOK | wxCENTRE | wxICON_ERROR,
                               mProject ? &GetProjectFrame(*mProject) : nullptr);
         }
      }
   }

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

Here is the call graph for this function:

Member Data Documentation

mImportFileHandle

ImportFileHandle* anonymous_namespace{ProjectFileManager.cpp}::ImportProgress::mImportFileHandle {nullptr}

private

Definition at line 1341 of file ProjectFileManager.cpp.

mProgressDialog

std::unique_ptr<BasicUI::ProgressDialog> anonymous_namespace{ProjectFileManager.cpp}::ImportProgress::mProgressDialog

private

Definition at line 1342 of file ProjectFileManager.cpp.

mProject

wxWeakRef<AudacityProject> anonymous_namespace{ProjectFileManager.cpp}::ImportProgress::mProject

private

Definition at line 1283 of file ProjectFileManager.cpp.

---

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

• ProjectFileManager.cpp