ICollectionViewDelegate.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/QString>
#include <QtCore/QVector>
#include <QtCore/QVariant>
#include <QtWidgets/QAbstractItemDelegate>
#include <QtWidgets/QMenu>
 
// ACF includes
#include <ibase/ICommandsProvider.h>
#include <iqtgui/IVisualStatus.h>
#include <iqtgui/IGuiObject.h>
 
// ImtCore includes
#include <imtbase/IObjectCollection.h>
#include <imtbase/ICollectionFilter.h>
 
 
namespace imtgui
{
 
 
class ICollectionViewDelegate: virtual public ibase::ICommandsProvider
{
public:
       enum ViewState
       {
              VS_NONE = 0,
 
              VS_ENABLED = 1,
 
              VS_EDITOR_AVAILABLE = 2
       };
 
       enum CommandIdentifier
       {
              CI_USER = 1000
       };
 
       enum DataRole
       {
              DR_TYPE_ID = Qt::UserRole,
              DR_OBJECT_ID,
              DR_SORT_VALUE
       };
 
       struct ObjectInfo
       {
              ObjectInfo()
                     :objectPtr(nullptr)
              {
              }
 
              istd::IChangeableSharedPtr objectPtr;
              QByteArray uuid;
              QString name;
              QString description;
              QByteArray typeId;
              QString typeName;
       };
 
       struct HeaderInfo
       {
              enum InformationFlags
              {
                     IF_NONE = 0,
                     IF_FILTERABLE = 1,
                     IF_SORTABLE = 2,
                     IF_SORT_BY_DEFAULT = 4
              };
 
              HeaderInfo(bool setIsFixed = false, int headerFlags = IF_SORTABLE, Qt::SortOrder setDefaultSortOrder = Qt::AscendingOrder, quint16 setMinWidth = 0, quint16 setMaxWidth = 0xFFFF)
                     : isFixed(setIsFixed),
                     flags(headerFlags),
                     defaultSortOrder(setDefaultSortOrder),
                     minWidth(setMinWidth),
                     maxWidth(setMaxWidth)
              {
              }
 
              int flags;
              bool isFixed;
              Qt::SortOrder defaultSortOrder;
              quint16 minWidth;
              quint16 maxWidth;
       };
       
       struct SummaryInformation
       {
              QByteArray infoId;
              QString text;
              QIcon icon;
              QVariant sortValue;
       };
 
       virtual bool InitializeDelegate(
                            imtbase::IObjectCollection* collectionPtr,
                            iqtgui::IGuiObject* parentGuiPtr,
                            const iprm::IParamsSet* filterParamsPtr) = 0;
 
       virtual const iqtgui::IVisualStatus& GetDocumentTypeStatus() const = 0;
 
       virtual QByteArray GetSupportedTypeId() const = 0;
 
       virtual QAbstractItemDelegate* GetColumnItemDelegate(const QByteArray& columnId) const = 0;
 
       virtual void OnColumnItemDelegateEditFinished(const QByteArray& objectId, const QByteArray& columnId, const QVariant& newValue) const = 0;
 
       virtual bool IsEditorEnabled(const QByteArray& columnId) const = 0;
 
       virtual void UpdateItemSelection(const imtbase::ICollectionInfo::Ids& selectedItems, const QByteArray& selectedTypeId) = 0;
 
       virtual QByteArray CreateNewObject(
                            const QByteArray& typeId,
                            const QString& objectName,
                            const QString& description,
                            const istd::IChangeable* defaultDataPtr = nullptr) const = 0;
 
       virtual QByteArray ImportObject(const QByteArray& typeId, const QString& sourcePath = QString()) const = 0;
 
       virtual bool ExportObject(const QByteArray& objectId, const QString& targetPath = QString()) const = 0;
 
       virtual void RemoveObjects(const imtbase::ICollectionInfo::Ids& objectIds)  const = 0;
 
       virtual bool UpdateObject(const QByteArray& objectId, const istd::IChangeable& contents) const = 0;
 
       virtual QString RenameObject(const QByteArray& objectId, const QString& newName) const = 0;
 
       virtual const imtbase::ICollectionInfo& GetSummaryInformationTypes() const = 0;
 
       typedef QVector<ICollectionViewDelegate::SummaryInformation> ObjectMetaInfo;
 
       virtual bool GetSummaryInformation(
                            const QByteArray& objectId,
                            const QVector<QByteArray>& fieldIds,
                            ObjectMetaInfo& objectMetaInfo) const = 0;
 
       virtual HeaderInfo GetSummaryInformationHeaderInfo(const QByteArray& informationId) const = 0;
 
       virtual bool OpenDocumentEditor(const QByteArray& objectId, const QByteArray& viewTypeId = QByteArray()) const = 0;
 
       virtual iqtgui::IGuiObject* GetInformationView() const = 0;
 
       virtual bool IsCommandSupported(int commandId) const = 0;
 
       virtual void SetupContextMenu(QMenu& menu) const = 0;
};
 
 
} // namespace imtgui