qgsattributesformmodel.h

Go to the documentation of this file.

/***************************************************************************
    qgsattributesformmodel.h
    ---------------------
    begin                : March 2025
    copyright            : (C) 2025 by Germán Carrillo
    email                : german at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSATTRIBUTESFORMMODEL_H
#define QGSATTRIBUTESFORMMODEL_H
 
// We don't want to expose this in the public API
#define SIP_NO_FILE
 
#include "qgsaction.h"
#include "qgsaddtaborgroup.h"
#include "qgsattributeeditorelement.h"
#include "qgsoptionalexpression.h"
#include "qgsvectorlayer.h"
 
#include <QAbstractItemModel>
#include <QPushButton>
#include <QSortFilterProxyModel>
 
class GUI_EXPORT QgsAttributesFormData
{
  public:
    enum AttributesFormItemType
    {
      Field,        
      Relation,     
      Container,    
      QmlWidget,    
      HtmlWidget,   
      WidgetType,   
      Action,       
      TextWidget,   
      SpacerWidget, 
    };
 
    struct GUI_EXPORT FieldConfig
    {
        FieldConfig() = default;
        FieldConfig( QgsVectorLayer *layer, int idx );
 
        bool mEditable = true;
        bool mLabelOnTop = false;
        bool mReuseLastValues = false;
        QgsFieldConstraints mFieldConstraints;
        QPushButton *mButton = nullptr;
        QString mEditorWidgetType;
        QMap<QString, QVariant> mEditorWidgetConfig;
        QString mAlias;
        QgsPropertyCollection mDataDefinedProperties;
        QString mComment;
        Qgis::FieldDomainSplitPolicy mSplitPolicy = Qgis::FieldDomainSplitPolicy::Duplicate;
        Qgis::FieldDuplicatePolicy mDuplicatePolicy = Qgis::FieldDuplicatePolicy::Duplicate;
        Qgis::FieldDomainMergePolicy mMergePolicy = Qgis::FieldDomainMergePolicy::DefaultValue;
 
        operator QVariant();
    };
 
    struct GUI_EXPORT RelationEditorConfiguration
    {
        operator QVariant();
 
        QString mRelationWidgetType;
        QVariantMap mRelationWidgetConfig;
        QVariant nmRelationId;
        bool forceSuppressFormPopup = false;
        QString label;
    };
 
    struct QmlElementEditorConfiguration
    {
        QString qmlCode;
    };
 
    struct HtmlElementEditorConfiguration
    {
        QString htmlCode;
    };
 
    struct TextElementEditorConfiguration
    {
        QString text;
    };
 
    struct SpacerElementEditorConfiguration
    {
        bool drawLine = false;
    };
 
    class GUI_EXPORT AttributeFormItemData
    {
      public:
        AttributeFormItemData() = default;
 
        operator QVariant() { return QVariant::fromValue<AttributeFormItemData>( *this ); }
 
        int columnCount() const { return mColumnCount; }
 
        void setColumnCount( int count ) { mColumnCount = count; }
 
        Qgis::AttributeEditorContainerType containerType() const;
 
        void setContainerType( Qgis::AttributeEditorContainerType type );
 
        bool collapsed() const { return mCollapsed; };
 
        void setCollapsed( bool collapsed ) { mCollapsed = collapsed; };
 
        const QgsAttributeEditorElement::LabelStyle labelStyle() const;
 
        void setLabelStyle( const QgsAttributeEditorElement::LabelStyle &labelStyle );
 
        bool showLabel() const;
 
        void setShowLabel( bool showLabel );
 
        int horizontalStretch() const { return mHorizontalStretch; }
 
        void setHorizontalStretch( int stretch ) { mHorizontalStretch = stretch; }
 
        int verticalStretch() const { return mVerticalStretch; }
 
        void setVerticalStretch( int stretch ) { mVerticalStretch = stretch; }
 
        QgsOptionalExpression visibilityExpression() const;
 
        void setVisibilityExpression( const QgsOptionalExpression &visibilityExpression );
 
        QgsOptionalExpression collapsedExpression() const;
 
        void setCollapsedExpression( const QgsOptionalExpression &collapsedExpression );
 
        RelationEditorConfiguration relationEditorConfiguration() const;
 
        void setRelationEditorConfiguration( const RelationEditorConfiguration &relationEditorConfiguration );
 
        QmlElementEditorConfiguration qmlElementEditorConfiguration() const;
 
        void setQmlElementEditorConfiguration( const QmlElementEditorConfiguration &qmlElementEditorConfiguration );
 
        HtmlElementEditorConfiguration htmlElementEditorConfiguration() const;
 
        void setHtmlElementEditorConfiguration( const HtmlElementEditorConfiguration &htmlElementEditorConfiguration );
 
        SpacerElementEditorConfiguration spacerElementEditorConfiguration() const;
 
        void setSpacerElementEditorConfiguration( SpacerElementEditorConfiguration spacerElementEditorConfiguration );
 
        QColor backgroundColor() const;
 
        void setBackgroundColor( const QColor &backgroundColor );
 
        TextElementEditorConfiguration textElementEditorConfiguration() const;
 
        void setTextElementEditorConfiguration( const TextElementEditorConfiguration &textElementEditorConfiguration );
 
      private:
        int mColumnCount = 1;
        Qgis::AttributeEditorContainerType mContainerType = Qgis::AttributeEditorContainerType::Tab;
        bool mShowLabel = true;
        int mHorizontalStretch = 0;
        int mVerticalStretch = 0;
        QgsOptionalExpression mVisibilityExpression;
        RelationEditorConfiguration mRelationEditorConfiguration;
        QmlElementEditorConfiguration mQmlElementEditorConfiguration;
        HtmlElementEditorConfiguration mHtmlElementEditorConfiguration;
        TextElementEditorConfiguration mTextElementEditorConfiguration;
        SpacerElementEditorConfiguration mSpacerElementEditorConfiguration;
        QColor mBackgroundColor;
        bool mCollapsed = false;
        QgsOptionalExpression mCollapsedExpression;
        QgsAttributeEditorElement::LabelStyle mLabelStyle;
    };
};
 
 
class GUI_EXPORT QgsAttributesFormItem : public QObject
{
    Q_OBJECT
 
  public:
    QgsAttributesFormItem() = default;
 
    explicit QgsAttributesFormItem( QgsAttributesFormData::AttributesFormItemType itemType, const QString &name, const QString &displayName = QString(), QgsAttributesFormItem *parent = nullptr );
 
    explicit QgsAttributesFormItem( QgsAttributesFormData::AttributesFormItemType itemType, const QgsAttributesFormData::AttributeFormItemData &data, const QString &name, const QString &displayName = QString(), QgsAttributesFormItem *parent = nullptr );
 
    QgsAttributesFormItem *child( int row );
 
    QgsAttributesFormItem *firstTopChild( const QgsAttributesFormData::AttributesFormItemType itemType, const QString &itemId ) const;
 
    QgsAttributesFormItem *firstChildRecursive( const QgsAttributesFormData::AttributesFormItemType &itemType, const QString &itemId ) const;
 
    int childCount() const;
 
    QgsAttributesFormItem *parent() { return mParent; }
 
    int row() const;
 
    QVariant data( int role ) const;
 
    bool setData( int role, const QVariant &value );
 
    void addChild( std::unique_ptr< QgsAttributesFormItem > &&child );
 
    void insertChild( int position, std::unique_ptr< QgsAttributesFormItem > &&item );
 
    void deleteChildAtIndex( int index );
 
    void deleteChildren();
 
    QgsAttributesFormData::AttributesFormItemType type() const { return mType; }
 
    QString id() const { return mId; }
 
    QString name() const { return mName; }
 
    QString displayName() const { return mDisplayName; }
 
    QIcon icon() const { return mIcon; }
 
    void setIcon( const QIcon &icon ) { mIcon = icon; }
 
  private:
    QString mName = QString();
    QString mDisplayName = QString();
    QIcon mIcon;
    QgsAttributesFormData::AttributesFormItemType mType = QgsAttributesFormData::Field;
    QString mId = QString();
    QgsAttributesFormData::AttributeFormItemData mData;
    QgsAttributesFormData::FieldConfig mFieldConfigData;
 
    std::vector< std::unique_ptr< QgsAttributesFormItem > > mChildren;
    QgsAttributesFormItem *mParent = nullptr;
 
    Q_DISABLE_COPY( QgsAttributesFormItem )
};
 
 
class GUI_EXPORT QgsAttributesFormModel : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    enum ItemRoles
    {
      ItemDataRole = Qt::UserRole, 
      ItemFieldConfigRole,         
      ItemNameRole,                
      ItemIdRole,                  
      ItemTypeRole,                
      ItemDisplayRole,             
    };
 
    explicit QgsAttributesFormModel( QgsVectorLayer *layer, QgsProject *project, QObject *parent = nullptr );
 
    ~QgsAttributesFormModel() override;
 
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &index ) const override;
 
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
 
    QModelIndex firstTopMatchingModelIndex( const QgsAttributesFormData::AttributesFormItemType &itemType, const QString &itemId ) const;
 
    QModelIndex firstRecursiveMatchingModelIndex( const QgsAttributesFormData::AttributesFormItemType &itemType, const QString &itemId ) const;
 
    bool showAliases() const;
 
    void setShowAliases( bool show );
 
  public slots:
    virtual void populate() = 0;
 
  protected:
    QgsAttributesFormItem *itemForIndex( const QModelIndex &index ) const;
 
    bool indexLessThan( const QModelIndex &a, const QModelIndex &b ) const;
 
    QVector<int> rootToLeafPath( QgsAttributesFormItem *item ) const;
 
 
    void emitDataChangedRecursively( const QModelIndex &parent = QModelIndex(), const QVector<int> &roles = QVector<int>() );
 
    std::unique_ptr< QgsAttributesFormItem > mRootItem;
    QgsVectorLayer *mLayer;
    QgsProject *mProject;
 
    bool mShowAliases = false;
};
 
 
class GUI_EXPORT QgsAttributesAvailableWidgetsModel : public QgsAttributesFormModel
{
    Q_OBJECT
 
  public:
    explicit QgsAttributesAvailableWidgetsModel( QgsVectorLayer *layer, QgsProject *project, QObject *parent = nullptr );
 
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;
 
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;
 
    Qt::DropActions supportedDragActions() const override;
    QStringList mimeTypes() const override;
    QMimeData *mimeData( const QModelIndexList &indexes ) const override;
 
    QModelIndex fieldContainer() const;
 
    QModelIndex relationContainer() const;
 
    QModelIndex actionContainer() const;
 
    QModelIndex fieldModelIndex( const QString &fieldName ) const;
 
  public slots:
    void populate() override;
 
    void populateLayerActions( const QList< QgsAction > actions );
 
  private:
    void populateActionItems( const QList<QgsAction> actions );
};
 
 
class GUI_EXPORT QgsAttributesFormLayoutModel : public QgsAttributesFormModel
{
    Q_OBJECT
 
  public:
    explicit QgsAttributesFormLayoutModel( QgsVectorLayer *layer, QgsProject *project, QObject *parent = nullptr );
 
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;
 
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;
 
    bool removeRow( int row, const QModelIndex &parent = QModelIndex() );
 
    Qt::DropActions supportedDragActions() const override;
    Qt::DropActions supportedDropActions() const override;
    QStringList mimeTypes() const override;
    QMimeData *mimeData( const QModelIndexList &indexes ) const override;
    bool dropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent ) override;
    bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;
 
    QgsAttributeEditorElement *createAttributeEditorWidget( const QModelIndex &index, QgsAttributeEditorElement *parent ) const;
 
    QList< QgsAddAttributeFormContainerDialog::ContainerPair > listOfContainers() const;
 
    void addContainer( QModelIndex &parent, const QString &name, int columnCount, Qgis::AttributeEditorContainerType type );
 
    void updateAliasForFieldItems( const QString &fieldName, const QString &fieldAlias );
 
    void insertChild( const QModelIndex &parent, int row, const QString &itemId, QgsAttributesFormData::AttributesFormItemType itemType, const QString &itemName );
 
  public slots:
    void populate() override;
 
  signals:
    void externalItemDropped( QModelIndex &index );
    void internalItemDropped( QModelIndex &index );
 
  private:
    void updateAliasForFieldItemsRecursive( QgsAttributesFormItem *parent, const QString &fieldName, const QString &fieldAlias );
    QList< QgsAddAttributeFormContainerDialog::ContainerPair > recursiveListOfContainers( QgsAttributesFormItem *parent ) const;
    void loadAttributeEditorElementItem( QgsAttributeEditorElement *const editorElement, QgsAttributesFormItem *parent, const int position = -1 );
 
    QModelIndexList curateIndexesForMimeData( const QModelIndexList &indexes ) const;
};
 
 
class GUI_EXPORT QgsAttributesFormProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:
    QgsAttributesFormProxyModel( QObject *parent = nullptr );
 
    void setAttributesFormSourceModel( QgsAttributesFormModel *model );
 
    const QString filterText() const;
 
  public slots:
    void setFilterText( const QString &filterText = QString() );
 
  protected:
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;
 
  private:
    QgsAttributesFormModel *mModel = nullptr;
    QString mFilterText;
};
 
 
Q_DECLARE_METATYPE( QgsAttributesFormData::RelationEditorConfiguration )
Q_DECLARE_METATYPE( QgsAttributesFormData::FieldConfig )
Q_DECLARE_METATYPE( QgsAttributesFormData::AttributeFormItemData )
 
#endif // QGSATTRIBUTESFORMMODEL_H