IFilePersistence.h

Go to the documentation of this file.

/********************************************************************************
**  This file is part of the ICF Framework. Copyright (C) Witold Gantzke & Kirill Lepskiy
**  ICF Framework may be used under the terms of the LGPL License v. 2.1 by the Free Software Foundation.
********************************************************************************/
 
#pragma once
 
 
// Qt includes
#include <QtCore/QString>
 
// ICF includes
#include <istd/IChangeable.h>
#include <iproc/CTaskState.h>
#include <ifile/IFileTypeInfo.h>
 
 
namespace iproc
{
    class IProgressManager;
}
 
 
namespace ifile
{
 
 
class IFilePersistence: virtual public IFileTypeInfo
{
public:
    enum ErrorType
    {
        ET_NO_WRITE_PERMISSIONS,
 
        ET_NO_READ_PERMISSIONS,
 
        ET_FILE_NOT_EXIST
    };
 
    enum MessageId
    {
        MI_BAD_OBJECT_TYPE = 0xabf0,
 
        MI_CANNOT_LOAD,
 
        MI_CANNOT_SAVE,
 
        MI_BAD_EXTENSION,
 
        MI_FILE_NOT_EXIST,
        /*
            Version of file in no more supported.
        */
        MI_UNSUPPORTED_VERSION
    };
 
    virtual bool IsOperationSupported(
                const istd::IChangeable* dataObjectPtr,
                const QString* filePathPtr = nullptr,
                int flags = -1,
                bool beQuiet = true) const = 0;
 
    virtual iproc::CTaskState LoadFromFile(
                istd::IChangeable& data,
                const QString& filePath = QString(),
                iproc::IProgressManager* progressManagerPtr = nullptr) const = 0;
 
    virtual iproc::CTaskState SaveToFile(
                const istd::IChangeable& data,
                const QString& filePath = QString(),
                iproc::IProgressManager* progressManagerPtr = nullptr) const = 0;
};
 
 
} // namespace ifile