IDocumentMetaInfo.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
 
 
// STL includes
#include <optional>
 
// Qt includes
#include <QtCore/QDebug>
#include <QtCore/QVariant>
 
// ACF includes
#include <istd/TInterfacePtr.h>
#include <istd/IChangeable.h>
 
 
namespace idoc
{
 
 
class IDocumentMetaInfo: virtual public istd::IChangeable
{
public:
 
       enum ChangeFlags
       {
              CF_METAINFO = 0xd83067d
       };
 
       enum MetaInfoType
       {
              MIT_TITLE,
 
              MIT_AUTHOR,
 
              MIT_CREATOR,
 
              MIT_DESCRIPTION,
 
              MIT_CREATION_TIME,
 
              MIT_MODIFICATION_TIME,
 
              MIT_CREATOR_VERSION,
 
              MIT_DOCUMENT_VERSION,
 
              MIT_CONTENT_CHECKSUM,
 
              MIT_USER = 1024
       };
 
       typedef QSet<int> MetaInfoTypes;
 
       virtual MetaInfoTypes GetMetaInfoTypes(bool allowReadOnly = true) const = 0;
 
       virtual QVariant GetMetaInfo(int metaInfoType) const = 0;
 
       virtual bool SetMetaInfo(int metaInfoType, const QVariant& metaInfo) = 0;
 
       virtual void RemoveMetaInfo(int metaInfoType) = 0;
 
       virtual QByteArray GetMetaInfoId(int metaInfoType) const = 0;
 
       virtual QString GetMetaInfoName(int metaInfoType) const = 0;
 
       virtual QString GetMetaInfoDescription(int metaInfoType) const = 0;
 
       virtual bool IsMetaInfoWritable(int metaInfoType) const = 0;
 
       template<class T>
       static std::optional<T> GetMetaInfoT(const idoc::IDocumentMetaInfo& metaInfo, int key);
};
 
 
typedef istd::TSharedInterfacePtr<IDocumentMetaInfo> MetaInfoPtr;
 
// inline methods
template<class T>
inline std::optional<T> IDocumentMetaInfo::GetMetaInfoT(const idoc::IDocumentMetaInfo& metaInfo, int key)
{
       QVariant metaData = metaInfo.GetMetaInfo(key);
       if (!metaData.isValid()) {
              return {};
       }
 
       const int metaTypeId =
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
              metaData.typeId();
#else
              metaData.userType();
#endif
 
       if (metaTypeId != qMetaTypeId<T>()) {
              I_IF_DEBUG(qWarning() << __FILE__ << __LINE__ << "Type mismatch for meta info key:" << key;)
 
              return {};
       }
 
       return metaData.value<T>();
}
 
} // namespace idoc