Public Types | Public Member Functions | List of all members
ifileproc::IFileConversion Class Referenceabstract

General interface for conversion of files. More...

#include <IFileConversion.h>

Inheritance diagram for ifileproc::IFileConversion:
istd::IPolymorphic ifileproc::CComposedCopyFilesComp ifileproc::CCopyFilesTreeComp ifileproc::CExternalFileConverterComp ifileproc::CFileConvertOverProcessorComp ifileproc::CFileCopyOverLoaderComp ifileproc::CFileInfoCopyComp ifileproc::CProcessingResultsReviewComp ifileproc::CSelectableFileConverterComp

Public Types

enum  MessageId { MI_INPUT_PATH = 0x5cd40, MI_OUTPUT_PATH }
 Types of messages which can be produced during execution of ConvertFiles method. More...
 

Public Member Functions

virtual int ConvertFiles (const QString &inputPath, QString &outputPath, const iprm::IParamsSet *paramsPtr=NULL, ibase::IProgressManager *progressManagerPtr=NULL) const =0
 Copy a file or files from inputPath to destination outputPath. More...
 

Detailed Description

General interface for conversion of files.

Definition at line 21 of file IFileConversion.h.

Member Enumeration Documentation

Types of messages which can be produced during execution of ConvertFiles method.

Enumerator
MI_INPUT_PATH 

Message ID if input path is invalid.

MI_OUTPUT_PATH 

Message ID if output path is invalid.

Definition at line 27 of file IFileConversion.h.

Member Function Documentation

virtual int ifileproc::IFileConversion::ConvertFiles ( const QString &  inputPath,
QString &  outputPath,
const iprm::IParamsSet paramsPtr = NULL,
ibase::IProgressManager progressManagerPtr = NULL 
) const
pure virtual

Copy a file or files from inputPath to destination outputPath.

Parameters
inputPathPath to the input file or directory.
outputPathPath to the output file or directory. Output file path can be calculated or modified inside of ConvertFiles method.
paramsPtrFile conversion parameters
progressManagerPtrProgress manager used for getting information about file conversion progress state and canceling.
Returns
Status of conversion operation.
See Also
iproc::IProcessor::TaskState

Implemented in ifileproc::CFileInfoCopyComp, ifileproc::CExternalFileConverterComp, ifileproc::CCopyFilesTreeComp, ifileproc::CFileConvertOverProcessorComp, ifileproc::CProcessingResultsReviewComp, ifileproc::CComposedCopyFilesComp, ifileproc::CSelectableFileConverterComp, and ifileproc::CFileCopyOverLoaderComp.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy