CSingleDocumentTemplateBase.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 <imod/IModel.h>
#include <idoc/IDocumentTemplate.h>
 
 
namespace idoc
{             
 
 
class IDocumentManager;
 
 
class CSingleDocumentTemplateBase: virtual public idoc::IDocumentTemplate
{
public:
       CSingleDocumentTemplateBase();
 
       const QByteArray& GetDocumentTypeId() const;
       virtual void SetSupportedFeatures(int featureFlags);
       virtual void SetDocumentTypeId(const QByteArray& id);
       virtual void SetDocumentTypeName(const QString& name);
       virtual void SetViewTypeId(const QByteArray& id);
       virtual void SetViewTypeName(const QString& name);
       virtual void SetDefaultDirectory(const QString& defaultDirectory);
 
       // reimplemented (idoc::IDocumentTypesInfo)
       virtual bool IsFeatureSupported(int featureFlags, const QByteArray& documentTypeId) const override;
       virtual Ids GetDocumentTypeIds() const override;
       virtual QString GetDocumentTypeName(const QByteArray& documentTypeId) const override;
       virtual ifile::IFileTypeInfo* GetDocumentFileTypeInfo(const QByteArray& documentTypeId) const override;
       virtual Ids GetDocumentTypeIdsForFile(const QString& filePath) const override;
       virtual QString GetDefaultDirectory(const QString& sugestedDir = "", const QByteArray* documentTypeIdPtr = NULL) const override;
 
       // reimplemented (idoc::IDocumentTemplate)
       virtual Ids GetViewTypeIds(const QByteArray& documentTypeId) const override;
       virtual QString GetViewTypeName(
                            const QByteArray& documentTypeId,
                            const QByteArray& viewTypeId) const override;
 
protected:
       bool IsDocumentTypeSupported(const QByteArray& documentTypeId) const;
       bool IsViewTypeSupported(const QByteArray& viewTypeId) const;
 
private:
       QString m_defaultDirectory;
 
       QByteArray m_documentTypeId;
       QString m_documentTypeName;
       QByteArray m_viewTypeId;
       QString m_viewTypeName;
 
       int m_supportedFeatures;
};
 
 
// inline methods
 
inline const QByteArray& CSingleDocumentTemplateBase::GetDocumentTypeId() const
{
       return m_documentTypeId;
}
 
 
// inline protected methods
 
inline bool CSingleDocumentTemplateBase::IsDocumentTypeSupported(const QByteArray& documentTypeId) const
{
       return documentTypeId.isEmpty() || (documentTypeId == m_documentTypeId);     // default or the same type is accepted
}
 
 
inline bool CSingleDocumentTemplateBase::IsViewTypeSupported(const QByteArray& viewTypeId) const
{
       return viewTypeId.isEmpty() || (viewTypeId == m_viewTypeId);   // default or the same type is accepted
}
 
 
} // namespace idoc