ICollectionInfo.h

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ImtCore-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QByteArray>
#include <QtCore/QVector>
#include <QtCore/QVariant>
 
// ACF includes
#include <ilog/IMessageConsumer.h>
#include <idoc/IDocumentMetaInfo.h>
#include <iprm/IParamsSet.h>
#include <istd/IChangeable.h>
#include <istd/TSmartPtr.h>
 
 
namespace imtbase
{
 
 
class ICollectionInfo: virtual public istd::IChangeable
{
public:
       typedef QByteArray Id;
       typedef QVector<Id> Ids;
 
       struct NotifierInfo
       {
              QByteArray elementId;
       };
 
       struct MultiElementNotifierInfo
       {
              imtbase::ICollectionInfo::Ids elementIds;
       };
 
       static const QByteArray CN_ALL_CHANGED;
 
       static const QByteArray CN_ELEMENT_INSERTED;
       typedef NotifierInfo ElementInsertInfo;
 
       static const QByteArray CN_ELEMENT_RENAMED;
       typedef NotifierInfo ElementRenamedInfo;
 
       static const QByteArray CN_ELEMENT_DESCRIPTION_CHANGED;
       typedef NotifierInfo ElementDescriptionChangedInfo;
 
       static const QByteArray CN_ELEMENT_STATE;
       typedef NotifierInfo ElementStateChangeInfo;
 
       static const QByteArray CN_ELEMENTS_REMOVED;
       typedef MultiElementNotifierInfo ElementsRemoveInfo;
 
       static const QByteArray CN_ELEMENTS_RESTORED;
       typedef MultiElementNotifierInfo ElementsRestoreInfo;
 
       enum ChangeFlags
       {
              CF_ADDED = 10000,
 
              CF_ELEMENT_RENAMED,
 
              CF_ELEMENT_DESCRIPTION_CHANGED,
 
              CF_ELEMENT_STATE,
 
              CF_REMOVED,
 
              CF_RESTORED,
 
              CF_LAST
       };
 
       enum ElementInfoType
       {
              EIT_NAME,
 
              EIT_DESCRIPTION,
 
              EIT_ENABLED,
 
              EIT_USER = 1000
       };
 
       enum MetaInfoType
       {
              MIT_INSERTION_USER = idoc::IDocumentMetaInfo::MIT_USER + 10000,
 
              MIT_INSERTION_TIME,
 
              MIT_LAST_OPERATION_USER,
 
              MIT_LAST_OPERATION_TIME,
 
              MIT_PREVIEW_THUMBNAIL,
 
              MIT_REVISION = idoc::IDocumentMetaInfo::MIT_USER + 20000
       };
 
 
       virtual int GetElementsCount(
                            const iprm::IParamsSet* selectionParamsPtr = nullptr,
                            ilog::IMessageConsumer* logPtr = nullptr) const = 0;
 
       virtual Ids GetElementIds(
                            int offset = 0,
                            int count = -1,
                            const iprm::IParamsSet* selectionParamsPtr = nullptr,
                            ilog::IMessageConsumer* logPtr = nullptr) const = 0;
       virtual bool GetSubsetInfo(
                            ICollectionInfo& subsetInfo,
                            int offset = 0,
                            int count = -1,
                            const iprm::IParamsSet* selectionParamsPtr = nullptr,
                            ilog::IMessageConsumer* logPtr = nullptr) const = 0;
 
       virtual QVariant GetElementInfo(const Id& elementId, int infoType, ilog::IMessageConsumer* logPtr = nullptr) const = 0;
 
       virtual idoc::MetaInfoPtr GetElementMetaInfo(const Id& elementId, ilog::IMessageConsumer* logPtr = nullptr) const = 0;
 
       virtual bool SetElementName(const Id& elementId, const QString& name, ilog::IMessageConsumer* logPtr = nullptr) = 0;
 
       virtual bool SetElementDescription(const Id& elementId, const QString& description, ilog::IMessageConsumer* logPtr = nullptr) = 0;
 
       virtual bool SetElementEnabled(const Id& elementId, bool isEnabled = true, ilog::IMessageConsumer* logPtr = nullptr) = 0;
};
 
 
} // namespace imtbase
 
 
Q_DECLARE_METATYPE(imtbase::ICollectionInfo::NotifierInfo);
Q_DECLARE_METATYPE(imtbase::ICollectionInfo::MultiElementNotifierInfo);