CMultiDocumentManagerBase.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/QList>
 
// ACF includes
#include <istd/TPointerVector.h>
#include <istd/TDelPtr.h>
#include <imod/CMultiModelDispatcherBase.h>
#include <idoc/IUndoManager.h>
#include <idoc/IDocumentTemplate.h>
#include <idoc/CTmplBasedDocumentManagerBase.h>
#include <iser/IArchive.h>
 
 
namespace idoc
{
 
 
class CMultiDocumentManagerBase: public idoc::CTmplBasedDocumentManagerBase
{
public:
       enum ModelId
       {
              MI_UNDO_MANAGER = 1,
              MI_DOCUMENT
       };
 
       CMultiDocumentManagerBase();
 
       // 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 void SetActiveView(istd::IPolymorphic* viewPtr) 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:
       typedef istd::IChangeableSharedPtr DocumentPtr;
       typedef idoc::IUndoManagerSharedPtr UndoManagerPtr;
       typedef idoc::IDocumentTemplate::ViewSharedPtr ViewPtr;
       struct ViewInfo
       {
              ViewPtr viewPtr;
              QByteArray viewTypeId;
       };
       typedef QList<ViewInfo> Views;
 
 
       struct SingleDocumentData: public DocumentInfo, public imod::CMultiModelDispatcherBase
       {
              SingleDocumentData(
                                   CMultiDocumentManagerBase* parentPtr,
                                   const QByteArray& documentTypeId,
                                   DocumentPtr& documentPtr);
 
              virtual ~SingleDocumentData();
 
              CMultiDocumentManagerBase* parentPtr;
              DocumentPtr documentPtr;
              UndoManagerPtr undoManagerPtr;
              Views views;
 
       protected:
              // reimplemented (imod::CMultiModelDispatcherBase)
              virtual void OnModelChanged(int modelId, const istd::IChangeable::ChangeSet& changeSet) override;
       };
 
       virtual istd::IChangeableSharedPtr OpenSingleDocument(
                            const QString& filePath,
                            bool createView,
                            const QByteArray& viewTypeId,
                            QByteArray& documentTypeId,
                            bool beQuiet,
                            bool* ignoredPtr,
                            ibase::IProgressManager* progressManagerPtr);
 
       virtual void CloseAllDocuments();
 
       SingleDocumentData& GetSingleDocumentData(int index) const;
 
       SingleDocumentData* GetActiveDocumentInfo() const;
 
       SingleDocumentData* GetDocumentInfoFromView(const istd::IPolymorphic& view) const;
 
       SingleDocumentData* GetDocumentInfoFromPath(const QString& filePath) const;
 
       int GetDocumentIndex(const SingleDocumentData& document) const;
 
       virtual SingleDocumentData* CreateUnregisteredDocument(
                            const QByteArray& documentTypeId,
                            bool createView,
                            const QByteArray& viewTypeId,
                            bool initialize,
                            bool beQuiet,
                            bool* ignoredPtr) const;
 
       bool RegisterDocument(SingleDocumentData* documentPtr);
 
       // abstract methods
 
       virtual void OnViewRegistered(istd::IPolymorphic* viewPtr, const SingleDocumentData& documentData) = 0;
 
       virtual void OnViewRemoved(istd::IPolymorphic* viewPtr) = 0;
 
       virtual QStringList GetOpenFilePaths(const QByteArray* documentTypeIdPtr = NULL) const  = 0;
 
       virtual QString GetSaveFilePath(const QByteArray& documentTypeId, const istd::IChangeable* dataObjectPtr, const QString& currentFilePath) const = 0;
 
       virtual bool QueryDocumentSave(const SingleDocumentData& info, bool* ignoredPtr) = 0;
 
       bool SerializeOpenDocumentList(iser::IArchive& archive);
 
       virtual void OnDocumentSaved();
 
protected:
       typedef istd::TPointerVector<SingleDocumentData> DocumentInfos;
 
       DocumentInfos m_documentInfos;
 
       istd::IPolymorphic* m_activeViewPtr;
};
 
 
} // namespace idoc