qgsattributesformproperties.h

Go to the documentation of this file.

/***************************************************************************
    qgsattributesformproperties.h
    ---------------------
    begin                : August 2017
    copyright            : (C) 2017 by David Signer
    email                : david 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 QGSATTRIBUTESFORMPROPERTIES_H
#define QGSATTRIBUTESFORMPROPERTIES_H
 
// We don't want to expose this in the public API
#define SIP_NO_FILE
 
#include <QMimeData>
#include <QPushButton>
#include <QTableWidget>
#include <QTreeWidget>
#include <QWidget>
#include <QSpinBox>
#include <QTreeWidgetItem>
#include <QDropEvent>
#include <QTableWidgetItem>
#include <QMessageBox>
#include <QFileDialog>
#include <QHBoxLayout>
#include <QFormLayout>
#include <QPlainTextEdit>
 
#include "ui_qgsattributesformproperties.h"
#include "qgis_gui.h"
#include "qgsoptionalexpression.h"
#include "qgsexpressioncontextgenerator.h"
#include "qgsattributeeditorelement.h"
#include "qgspropertycollection.h"
 
class QgsAttributesDnDTree;
class QgsAttributeFormContainerEdit;
class QgsAttributeTypeDialog;
class QgsAttributeWidgetEdit;
 
class GUI_EXPORT QgsAttributesFormProperties : public QWidget, public QgsExpressionContextGenerator, private Ui_QgsAttributesFormProperties
{
    Q_OBJECT
 
  public:
    enum FieldPropertiesRoles
    {
      DnDTreeRole = Qt::UserRole,
      FieldConfigRole,
      FieldNameRole,
    };
 
    struct 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 DnDTreeItemData : public QTreeWidgetItem
    {
      public:
        enum Type
        {
          Field,
          Relation,
          Container, 
          QmlWidget,
          HtmlWidget,
          WidgetType,   
          Action,       
          TextWidget,   
          SpacerWidget, 
        };
 
        //do we need that
        DnDTreeItemData() = default;
 
        DnDTreeItemData( Type type, const QString &name, const QString &displayName, const QColor &backgroundColor = QColor() )
          : mType( type )
          , mName( name )
          , mDisplayName( displayName )
          , mBackgroundColor( backgroundColor )
        {}
 
        QString name() const { return mName; }
        void setName( const QString &name ) { mName = name; }
 
        QString displayName() const { return mDisplayName; }
        void setDisplayName( const QString &displayName ) { mDisplayName = displayName; }
 
        Type type() const { return mType; }
        void setType( Type type ) { mType = type; }
 
        operator QVariant() { return QVariant::fromValue<DnDTreeItemData>( *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:
        Type mType = Field;
        QString mName;
        QString mDisplayName;
        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;
    };
 
 
    struct 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;
 
        operator QVariant();
    };
 
  public:
    explicit QgsAttributesFormProperties( QgsVectorLayer *layer, QWidget *parent = nullptr );
 
    QgsAttributeEditorElement *createAttributeEditorWidget( QTreeWidgetItem *item, QgsAttributeEditorElement *parent, bool isTopLevel = false );
 
    void init();
 
    void apply();
 
    void store();
 
    void loadRelations();
 
    void initAvailableWidgetsTree();
    void initFormLayoutTree();
    void initLayoutConfig();
    void initInitPython();
    void initSuppressCombo();
 
    QgsExpressionContext createExpressionContext() const override;
 
  protected:
    void updateButtons();
 
    //QList<QgsRelation> mRelations;
    QgsVectorLayer *mLayer = nullptr;
 
    QgsAttributesDnDTree *mAvailableWidgetsTree = nullptr;
    QgsAttributesDnDTree *mFormLayoutTree = nullptr;
 
    QgsAttributeWidgetEdit *mAttributeWidgetEdit = nullptr;
    QgsAttributeTypeDialog *mAttributeTypeDialog = nullptr;
    QgsAttributeFormContainerEdit *mAttributeContainerEdit = nullptr;
    QLabel *mInfoTextWidget = nullptr;
 
  private slots:
    void addContainer();
    void removeTabOrGroupButton();
    void mEditorLayoutComboBox_currentIndexChanged( int index );
    void pbnSelectEditForm_clicked();
    void mTbInitCode_clicked();
 
    void onInvertSelectionButtonClicked( bool checked );
    void loadAttributeSpecificEditor( QgsAttributesDnDTree *emitter, QgsAttributesDnDTree *receiver );
    void onAttributeSelectionChanged();
    void onFormLayoutSelectionChanged();
 
    void updatedFields();
 
  private:
    void clearAttributeTypeFrame();
 
    void loadAttributeWidgetEdit();
    void storeAttributeWidgetEdit();
 
    void loadAttributeTypeDialog();
    void storeAttributeTypeDialog();
 
    void storeAttributeContainerEdit();
    void loadAttributeContainerEdit();
 
    void loadInfoWidget( const QString &infoText );
 
    QTreeWidgetItem *loadAttributeEditorTreeItem( QgsAttributeEditorElement *widgetDef, QTreeWidgetItem *parent, QgsAttributesDnDTree *tree );
 
    Qgis::AttributeFormPythonInitCodeSource mInitCodeSource = Qgis::AttributeFormPythonInitCodeSource::NoSource;
    QString mInitFunction;
    QString mInitFilePath;
    QString mInitCode;
    int mBlockUpdates = 0;
};
 
 
QDataStream &operator<<( QDataStream &stream, const QgsAttributesFormProperties::DnDTreeItemData &data );
QDataStream &operator>>( QDataStream &stream, QgsAttributesFormProperties::DnDTreeItemData &data );
 
 
class GUI_EXPORT QgsAttributesDnDTree : public QTreeWidget, private QgsExpressionContextGenerator
{
    Q_OBJECT
 
  public:
    explicit QgsAttributesDnDTree( QgsVectorLayer *layer, QWidget *parent = nullptr );
 
    QTreeWidgetItem *addItem( QTreeWidgetItem *parent, const QgsAttributesFormProperties::DnDTreeItemData &data, int index = -1, const QIcon &icon = QIcon() );
 
    QTreeWidgetItem *addContainer( QTreeWidgetItem *parent, const QString &title, int columnCount, Qgis::AttributeEditorContainerType type );
 
    enum Type
    {
      Drag,
      Drop
    };
 
 
    Type type() const;
    void setType( QgsAttributesDnDTree::Type value );
 
  public slots:
    void selectFirstMatchingItem( const QgsAttributesFormProperties::DnDTreeItemData &data );
 
  protected:
    void dragMoveEvent( QDragMoveEvent *event ) override;
    void dropEvent( QDropEvent *event ) override;
    bool dropMimeData( QTreeWidgetItem *parent, int index, const QMimeData *data, Qt::DropAction action ) override;
    /* Qt::DropActions supportedDropActions() const;*/
 
    // QTreeWidget interface
  protected:
    QStringList mimeTypes() const override;
 
#if QT_VERSION < QT_VERSION_CHECK( 6, 0, 0 )
    QMimeData *mimeData( const QList<QTreeWidgetItem *> items ) const override;
#else
    QMimeData *mimeData( const QList<QTreeWidgetItem *> &items ) const override;
#endif
 
  private slots:
    void onItemDoubleClicked( QTreeWidgetItem *item, int column );
 
  private:
    QgsVectorLayer *mLayer = nullptr;
    Type mType = QgsAttributesDnDTree::Type::Drag;
 
    // QgsExpressionContextGenerator interface
  public:
    QgsExpressionContext createExpressionContext() const override;
};
 
 
Q_DECLARE_METATYPE( QgsAttributesFormProperties::RelationEditorConfiguration )
Q_DECLARE_METATYPE( QgsAttributesFormProperties::FieldConfig )
Q_DECLARE_METATYPE( QgsAttributesFormProperties::DnDTreeItemData )
 
#endif // QGSATTRIBUTESFORMPROPERTIES_H