ImportFileHandleEx Class Reference

#include <ImportPlugin.h>

Inheritance diagram for ImportFileHandleEx:

Collaboration diagram for ImportFileHandleEx:

Public Member Functions
	ImportFileHandleEx (const FilePath &filename)
FilePath	GetFilename () const override
void	Cancel () override
void	Stop () override
Public Member Functions inherited from ImportFileHandle
virtual	~ImportFileHandle ()
virtual FilePath	GetFilename () const =0
virtual TranslatableString	GetErrorMessage () const
virtual TranslatableString	GetFileDescription ()=0
virtual ByteCount	GetFileUncompressedBytes ()=0
virtual wxInt32	GetStreamCount ()=0
virtual const TranslatableStrings &	GetStreamInfo ()=0
virtual void	SetStreamUsage (wxInt32 StreamID, bool Use)=0
virtual void	Import (ImportProgressListener &progressListener, WaveTrackFactory *trackFactory, TrackHolders &outTracks, Tags *tags, std::optional< LibFileFormats::AcidizerTags > &acidTags)=0
virtual void	Cancel ()=0
virtual void	Stop ()=0

Protected Member Functions
void	BeginImport ()
bool	IsCancelled () const noexcept
bool	IsStopped () const noexcept

Private Attributes
FilePath	mFilename
bool	mCancelled {false}
bool	mStopped {false}

Additional Inherited Members
Public Types inherited from ImportFileHandle
using	ByteCount = unsigned long long

Detailed Description

Definition at line 158 of file ImportPlugin.h.

Constructor & Destructor Documentation

ImportFileHandleEx()

ImportFileHandleEx::ImportFileHandleEx

(

const FilePath &

filename

)

Definition at line 41 of file ImportPlugin.cpp.

:  mFilename(filename)
{
}

Member Function Documentation

BeginImport()

void ImportFileHandleEx::BeginImport ( )

protected

Definition at line 63 of file ImportPlugin.cpp.

{
   mCancelled = false;
   mStopped = false;
}

References mCancelled, and mStopped.

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

Here is the caller graph for this function:

Cancel()

void ImportFileHandleEx::Cancel ( )

overridevirtual

Implements ImportFileHandle.

Definition at line 51 of file ImportPlugin.cpp.

{
   if(!mStopped)
      mCancelled = true;
}

References mCancelled, and mStopped.

GetFilename()

FilePath ImportFileHandleEx::GetFilename ( ) const

overridevirtual

Implements ImportFileHandle.

Definition at line 46 of file ImportPlugin.cpp.

{
   return mFilename;
}

References mFilename.

Referenced by AUPImportFileHandle::HandleImport(), AUPImportFileHandle::HandleProject(), AUPImportFileHandle::Import(), OggImportFileHandle::Import(), PCMImportFileHandle::Import(), FLACImportFileHandle::Init(), AUPImportFileHandle::Open(), and anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle::Open().

Here is the caller graph for this function:

IsCancelled()

bool ImportFileHandleEx::IsCancelled ( ) const

protectednoexcept

Definition at line 69 of file ImportPlugin.cpp.

{
   return mCancelled;
}

References mCancelled.

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

Here is the caller graph for this function:

IsStopped()

bool ImportFileHandleEx::IsStopped ( ) const

protectednoexcept

Definition at line 74 of file ImportPlugin.cpp.

{
   return mStopped;
}

References mStopped.

Referenced by AUPImportFileHandle::Import(), FLACImportFileHandle::Import(), OggImportFileHandle::Import(), OpusImportFileHandle::Import(), PCMImportFileHandle::Import(), WavPackImportFileHandle::Import(), OpusImportFileHandle::NotifyImportFailed(), and MyFLACFile::write_callback().

Here is the caller graph for this function:

Stop()

void ImportFileHandleEx::Stop ( )

overridevirtual

Implements ImportFileHandle.

Definition at line 57 of file ImportPlugin.cpp.

{
   if(!mCancelled)
      mStopped = true;
}

References mCancelled, and mStopped.

Member Data Documentation

mCancelled

bool ImportFileHandleEx::mCancelled {false}

private

Definition at line 161 of file ImportPlugin.h.

Referenced by BeginImport(), Cancel(), IsCancelled(), and Stop().

mFilename

FilePath ImportFileHandleEx::mFilename

private

Definition at line 160 of file ImportPlugin.h.

Referenced by GetFilename(), and FLACImportFileHandle::Init().

mStopped

bool ImportFileHandleEx::mStopped {false}

private

Definition at line 162 of file ImportPlugin.h.

Referenced by BeginImport(), Cancel(), IsStopped(), and Stop().

---

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

• ImportPlugin.h
• ImportPlugin.cpp