IFilePersistence.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QString>
 
// ACF includes
#include <istd/IChangeable.h>
#include <ifile/IFileTypeInfo.h>
 
 
namespace ibase
{
       class IProgressManager;
}
 
 
namespace ifile
{
 
 
class IFilePersistence: virtual public IFileTypeInfo
{
public:
       enum OperationState
       {
              OS_OK,
 
              OS_CANCELED,
 
              OS_FAILED
       };
 
       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 = NULL,
                            int flags = -1,
                            bool beQuiet = true) const = 0;
 
       virtual OperationState LoadFromFile(
                            istd::IChangeable& data,
                            const QString& filePath = QString(),
                            ibase::IProgressManager* progressManagerPtr = NULL) const = 0;
 
       virtual OperationState SaveToFile(
                            const istd::IChangeable& data,
                            const QString& filePath = QString(),
                            ibase::IProgressManager* progressManagerPtr = NULL) const = 0;
};
 
 
} // namespace ifile