IDocumentManager.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/QMap>
 
// Qt includes
#include <QtCore/QString>
 
// ACF includes
#include <istd/IChangeable.h>
#include <idoc/IUndoManager.h>
#include <idoc/IDocumentTypesInfo.h>
 
 
namespace ibase
{
       class IProgressManager;
}
 
 
namespace idoc
{
 
 
class IDocumentManager:
                     virtual public istd::IChangeable,
                     virtual public IDocumentTypesInfo
{
public:
       enum ChangeFlags
       {
              CF_DOCUMENT_RENAMED = 0x834d670,
              CF_DOCUMENT_CREATED,
              CF_DOCUMENT_REMOVED,
              CF_DOCUMENT_COUNT_CHANGED,
              CF_VIEW_ACTIVATION_CHANGED
       };
 
       struct DocumentInfo
       {
              QString filePath;                  
              QByteArray documentTypeId;  
              bool isDirty;                      
       };
 
       enum OperationFlags
       {
              OF_FILE_NEW = 0x0001,              
              OF_FILE_OPEN = 0x0002,             
              OF_FILE_SAVE = 0x0004,             
              OF_FILE_SAVE_AS = 0x0008,   
              OF_KNOWN_PATH = 0x0010             
       };
 
       typedef QMap<QString, QByteArray> FileToTypeMap;
 
       virtual int GetAllowedOperationFlags(const istd::IPolymorphic* viewPtr = NULL) const = 0;
 
       virtual idoc::IUndoManager* GetUndoManagerForDocument(const istd::IChangeable* documentPtr) const = 0;
 
       virtual int GetDocumentsCount() const = 0;
 
       virtual istd::IChangeable& GetDocumentFromIndex(int index, DocumentInfo* documentInfoPtr = NULL) const = 0;
 
       virtual int GetViewsCount(int documentIndex) const = 0;
 
       virtual istd::IPolymorphic* GetViewFromIndex(int documentIndex, int viewIndex) const = 0;
 
       virtual istd::IPolymorphic* GetActiveView() const = 0;
 
       virtual void SetActiveView(istd::IPolymorphic* viewPtr) = 0;
 
       virtual istd::IChangeable* GetDocumentFromView(const istd::IPolymorphic& view, DocumentInfo* documentInfoPtr = NULL) const = 0;
 
       virtual istd::IPolymorphic* AddViewToDocument(const istd::IChangeable& document, const QByteArray& viewTypeId = QByteArray()) = 0;
 
       virtual QByteArray GetDocumentTypeId(const istd::IChangeable& document) const = 0;
 
       virtual bool InsertNewDocument(
                            const QByteArray& documentTypeId, 
                            bool createView = true, 
                            const QByteArray& viewTypeId = "",
                            istd::IChangeableSharedPtr* newDocumentPtr = nullptr,
                            bool beQuiet = false,
                            bool* ignoredPtr = NULL) = 0;
 
       virtual bool OpenDocument(
                            const QByteArray* documentTypeIdPtr = NULL,
                            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) = 0;
 
       virtual bool SaveDocument(
                            int documentIndex = -1,
                            bool requestFileName = false,
                            FileToTypeMap* savedMapPtr = NULL,
                            bool beQuiet = false,
                            bool* ignoredPtr = NULL,
                            ibase::IProgressManager* progressManagerPtr = NULL) = 0;
 
       virtual bool SaveDirtyDocuments(bool beQuiet = false, bool* ignoredPtr = NULL) = 0;
 
       virtual bool CloseDocument(int documentIndex = -1, bool beQuiet = false, bool* ignoredPtr = NULL) = 0;
 
       virtual bool CloseView(istd::IPolymorphic* viewPtr = NULL, bool beQuiet = false, bool* ignoredPtr = NULL) = 0;
};
 
 
} // namespace idoc