ImportProgressListener Class Reference

Interface used to report on import state and progress. More...

#include <ImportProgressListener.h>

Inheritance diagram for ImportProgressListener:

Public Types
enum class	ImportResult { Success , Error , Cancelled , Stopped }

Public Member Functions
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...

Detailed Description

Interface used to report on import state and progress.

Definition at line 18 of file ImportProgressListener.h.

Member Enumeration Documentation

ImportResult

enum class ImportProgressListener::ImportResult

strong

Enumerator
Success
Error
Cancelled
Stopped

Definition at line 21 of file ImportProgressListener.h.

                           {
      Success,
      Error,
      Cancelled,
      Stopped
   };

Constructor & Destructor Documentation

~ImportProgressListener()

ImportProgressListener::~ImportProgressListener ( )

virtual

Definition at line 13 of file ImportProgressListener.cpp.

{ }

Member Function Documentation

OnImportFileOpened()

virtual bool ImportProgressListener::OnImportFileOpened ( ImportFileHandle &  importFileHandle )

pure virtual

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

Implemented in anonymous_namespace{Import.cpp}::ImportProgressResultProxy, and anonymous_namespace{ProjectFileManager.cpp}::ImportProgress.

OnImportProgress()

virtual void ImportProgressListener::OnImportProgress ( double  progress )

pure virtual

Used to report on import progress [optional]

Parameters

progress

import progress in range [0, 1]

Implemented in anonymous_namespace{Import.cpp}::ImportProgressResultProxy, and anonymous_namespace{ProjectFileManager.cpp}::ImportProgress.

Referenced by AUPImportFileHandle::Import(), FFmpegImportFileHandle::Import(), anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle::Import(), OggImportFileHandle::Import(), OpusImportFileHandle::Import(), PCMImportFileHandle::Import(), WavPackImportFileHandle::Import(), and MyFLACFile::write_callback().

Here is the caller graph for this function:

OnImportResult()

virtual void ImportProgressListener::OnImportResult ( ImportResult  result )

pure virtual

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

Implemented in anonymous_namespace{Import.cpp}::ImportProgressResultProxy, and anonymous_namespace{ProjectFileManager.cpp}::ImportProgress.

Referenced by AUPImportFileHandle::Import(), FFmpegImportFileHandle::Import(), FLACImportFileHandle::Import(), LOFImportFileHandle::Import(), anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle::Import(), OggImportFileHandle::Import(), OpusImportFileHandle::Import(), PCMImportFileHandle::Import(), WavPackImportFileHandle::Import(), anonymous_namespace{ImportMIDI.cpp}::MIDIImportFileHandle::Import(), and OpusImportFileHandle::NotifyImportFailed().

Here is the caller graph for this function:

---

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

• ImportProgressListener.h
• ImportProgressListener.cpp