CMultiPageDocumentFilePersistenceComp.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
 
 
// ACF includes
#include <ifile/IFilePersistence.h>
#include <ilog/TLoggerCompWrap.h>
#include <idoc/IMultiPageDocument.h>
 
 
namespace idoc
{
 
 
class CMultiPageDocumentFilePersistenceComp:
                     public ilog::CLoggerComponentBase,
                     virtual public ifile::IFilePersistence
{
public:
       typedef ilog::CLoggerComponentBase BaseClass;
 
       enum OperationMode
       {
              OM_FLAT,
              OM_FOLDER,
              OM_COMPRESSED_FOLDER
       };
 
       I_BEGIN_COMPONENT(CMultiPageDocumentFilePersistenceComp);
              I_REGISTER_INTERFACE(ifile::IFileTypeInfo);
              I_REGISTER_INTERFACE(ifile::IFilePersistence);
              I_ASSIGN(m_pageObjectPersistenceCompPtr, "BitmapPersistence", "Component used for persistence of the single page of the bitmap document", true, "BitmapPersistence");
              I_ASSIGN(m_operationModeAttrPtr, "OperationMode", "Operation mode. 0 - flat structure, all files will be placed into the target folder\n1 - Files will be placed into the document's own folder\n2 - Same as 1, but the folder wll be compressed", true, OM_FOLDER);
              I_ASSIGN(m_defaultPageSuffixAttrPtr, "DefaultPageFileExtension", "Default extension used for the page files", false, "png");  
              I_ASSIGN(m_defaultDocumentSuffixAttrPtr, "DefaultDocumentFileExtension", "Default extension used for the document files", true, "mbd");
       I_END_COMPONENT;
 
       // reimplemented (ifile::IFilePersistence)
       virtual bool IsOperationSupported(
                            const istd::IChangeable* dataObjectPtr,
                            const QString* filePathPtr = NULL,
                            int flags = -1,
                            bool beQuiet = true) const override;
       virtual ifile::IFilePersistence::OperationState LoadFromFile(
                            istd::IChangeable& data,
                            const QString& filePath = QString(),
                            ibase::IProgressManager* progressManagerPtr = NULL) const override;
       virtual ifile::IFilePersistence::OperationState SaveToFile(
                            const istd::IChangeable& data,
                            const QString& filePath = QString(),
                            ibase::IProgressManager* progressManagerPtr = NULL) const override;
 
       // reimplemented (ifile::IFileTypeInfo)
       virtual bool GetFileExtensions(QStringList& result, const istd::IChangeable* dataObjectPtr = NULL, int flags = -1, bool doAppend = false) const override;
       virtual QString GetTypeDescription(const QString* extensionPtr = NULL) const override;
 
protected:
       // reimplemented (icomp::CComponentBase)
       virtual void OnComponentCreated() override;
 
protected:
       virtual bool SerializeDocumentMetaInfo(const idoc::IMultiPageDocument& document, iser::IArchive& archive) const;
       virtual bool SerializePageMetaInfo(idoc::IMultiPageDocument& document, int pageIndex, iser::IArchive& archive) const;
private:
       QString GetInfoFilePath(const QString documentFilePath) const;
 
private:
       I_REF(ifile::IFilePersistence, m_pageObjectPersistenceCompPtr);
       I_ATTR(int, m_operationModeAttrPtr);
       I_ATTR(QByteArray, m_defaultDocumentSuffixAttrPtr);
       I_ATTR(QByteArray, m_defaultPageSuffixAttrPtr);
 
       QString m_defaultSuffix;
       QString m_defaultPageSuffix;
 
       static iser::CArchiveTag s_pagesTag;
       static iser::CArchiveTag s_pageFileTag;
};
 
 
} // namespace idoc