CSingleDocumentManagerBase.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/QByteArray>
#include <QtCore/QString>
 
// ACF includes
#include <istd/TDelPtr.h>
#include <iser/IArchive.h>
#include <imod/CSingleModelObserverBase.h>
#include <idoc/IDocumentTemplate.h>
#include <idoc/CTmplBasedDocumentManagerBase.h>
 
 
namespace idoc
{
 
 
class CSingleDocumentManagerBase:
                     public idoc::CTmplBasedDocumentManagerBase,
                     protected imod::CSingleModelObserverBase
{
public:
       CSingleDocumentManagerBase();
 
       // reimplemented (idoc::IDocumentManager)
       virtual idoc::IUndoManager* GetUndoManagerForDocument(const istd::IChangeable* documentPtr) const override;
       virtual int GetDocumentsCount() const override;
       virtual istd::IChangeable& GetDocumentFromIndex(int index, DocumentInfo* documentInfoPtr = NULL) const override;
       virtual int GetViewsCount(int documentIndex) const override;
       virtual istd::IPolymorphic* GetViewFromIndex(int documentIndex, int viewIndex) const override;
       virtual istd::IPolymorphic* GetActiveView() const override;
       virtual istd::IChangeable* GetDocumentFromView(const istd::IPolymorphic& view, DocumentInfo* documentInfoPtr = NULL) const override;
       virtual istd::IPolymorphic* AddViewToDocument(const istd::IChangeable& document, const QByteArray& viewTypeId = QByteArray()) override;
       virtual QByteArray GetDocumentTypeId(const istd::IChangeable& document) const override;
       virtual bool InsertNewDocument(
                            const QByteArray& documentTypeId,
                            bool createView = true,
                            const QByteArray& viewTypeId = "",
                            istd::IChangeableSharedPtr* newDocumentPtr = nullptr,
                            bool beQuiet = false,
                            bool* ignoredPtr = NULL) override;
       virtual bool OpenDocument(
                            const QByteArray* documentTypeIdPtr,
                            const QString* fileNamePtr = NULL,
                            bool createView = true,
                            const QByteArray& viewTypeId = "",
                            istd::IChangeableSharedPtr* documentPtr = nullptr,
                            FileToTypeMap* loadedMapPtr = NULL,
                            bool beQuiet = false,
                            bool* ignoredPtr = NULL,
                            ibase::IProgressManager* progressManagerPtr = NULL) override;
       virtual bool SaveDocument(
                            int documentIndex = -1,
                            bool requestFileName = false,
                            FileToTypeMap* savedMapPtr = NULL,
                            bool beQuiet = false,
                            bool* ignoredPtr = NULL,
                            ibase::IProgressManager* progressManagerPtr = NULL) override;
       virtual bool SaveDirtyDocuments(bool beQuiet = false, bool* ignoredPtr = NULL) override;
       virtual bool CloseDocument(int documentIndex = -1, bool beQuiet = false, bool* ignoredPtr = NULL) override;
       virtual bool CloseView(istd::IPolymorphic* viewPtr = NULL, bool beQuiet = false, bool* ignoredPtr = NULL) override;
 
protected:
       virtual void BeforeSavingDocument(const QString& filePath);
 
       virtual void AfterSavingDocument(bool saveState);
 
       virtual bool OpenSingleDocument(
                            const QString& filePath,
                            bool createView,
                            const QByteArray& viewTypeId,
                            QByteArray& documentTypeId,
                            bool beQuiet,
                            bool* ignoredPtr,
                            ibase::IProgressManager* progressManagerPtr);
 
       bool NewDocument(
                            const QByteArray& documentTypeId,
                            bool createView,
                            const QByteArray& viewTypeId,
                            bool initialize,
                            bool beQuiet,
                            bool* ignoredPtr);
       bool RegisterDocument();
 
       void EnsureViewRemoved();
 
       QString GetCurrentDocumentFilePath() const;
 
       bool HasDocumentPendingChanges() const;
 
       void OnUndoManagerUpdate(const istd::IChangeable::ChangeSet& changeSet);
 
       // reimplemented (imod::CSingleModelObserverBase)
       virtual void OnUpdate(const istd::IChangeable::ChangeSet& changeSet) override;
 
       // abstract methods
 
       virtual void OnViewRegistered(istd::IPolymorphic* viewPtr) = 0;
 
       virtual void OnViewRemoved(istd::IPolymorphic* viewPtr) = 0;
 
       virtual void OnDocumentRegistered() = 0;
 
       virtual void OnDocumentClosed() = 0;
 
       virtual QString GetOpenFilePath(const QByteArray* documentTypeIdPtr = NULL) const  = 0;
 
       virtual QString GetSaveFilePath(const QByteArray& documentTypeId, const istd::IChangeable* dataObjectPtr, const QString& currentFilePath) const = 0;
 
       virtual bool QueryDocumentSave(bool* ignoredPtr) = 0;
 
       bool SerializeOpenDocument(iser::IArchive& archive);
 
private:
       class UndoManagerObserver: public imod::CSingleModelObserverBase
       {
       public:
              UndoManagerObserver(CSingleDocumentManagerBase& parent);
 
       protected:
              // reimplemented (imod::CSingleModelObserverBase)
              virtual void OnUpdate(const istd::IChangeable::ChangeSet& changeSet) override;
 
       private:
              CSingleDocumentManagerBase& m_parent;
       };
 
private:
       QString m_filePath;
       QByteArray m_documentTypeId;
       QByteArray m_viewTypeId;
       istd::IChangeableSharedPtr m_documentPtr;
       idoc::IUndoManagerSharedPtr m_undoManagerPtr;
       idoc::IDocumentTemplate::ViewSharedPtr m_viewPtr;
       UndoManagerObserver m_undoManagerObserver;
 
       bool m_isDirty;
};
 
 
} // namespace idoc