qgsattributeform.h

Go to the documentation of this file.

/***************************************************************************
    qgsattributeform.h
     --------------------------------------
    Date                 : 3.5.2014
    Copyright            : (C) 2014 Matthias Kuhn
    Email                : matthias 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 QGSATTRIBUTEFORM_H
#define QGSATTRIBUTEFORM_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsattributeeditorcontext.h"
#include "qgsattributeeditorelement.h"
#include "qgseditorwidgetwrapper.h"
#include "qgsfeature.h"
 
#include <QDialogButtonBox>
#include <QLabel>
#include <QMultiMap>
#include <QToolButton>
#include <QWidget>
 
class QgsAttributeFormInterface;
class QgsAttributeFormEditorWidget;
class QgsMessageBar;
class QgsMessageBarItem;
class QgsWidgetWrapper;
class QgsTabWidget;
class QgsAttributeFormWidget;
class QgsRelationWidgetWrapper;
class QSvgWidget;

class GUI_EXPORT QgsAttributeForm : public QWidget
{
    Q_OBJECT
 
  public:
    enum Mode
    {
      SingleEditMode,      
      AddFeatureMode,      
      MultiEditMode,       
      SearchMode,          
      AggregateSearchMode, 
      IdentifyMode         
    };

    enum FilterType
    {
      ReplaceFilter, 
      FilterAnd,     
      FilterOr,      
    };
 
    explicit QgsAttributeForm(
      QgsVectorLayer *vl, const QgsFeature &feature = QgsFeature(), const QgsAttributeEditorContext &context = QgsAttributeEditorContext(), QWidget *parent SIP_TRANSFERTHIS = nullptr
    );
    ~QgsAttributeForm() override;

    const QgsFeature &feature() const { return mFeature; }

    QgsFeature currentFormFeature() const { return mCurrentFormFeature; }

    void displayWarning( const QString &message );
 
    // TODO QGIS 5.0 - make private

    void hideButtonBox();
 
    // TODO QGIS 5.0 - make private

    void showButtonBox();
 
    // TODO QGIS 5.0 - make private

    void disconnectButtonBox();

    void addInterface( QgsAttributeFormInterface *iface SIP_TRANSFER );

    QgsVectorLayer *layer() { return mLayer; }

    bool editable();

    QgsAttributeEditorContext::Mode mode() const { return mMode; }

    void setMode( QgsAttributeEditorContext::Mode mode );

    void setEditCommandMessage( const QString &message ) { mEditCommandMessage = message; }

    bool eventFilter( QObject *object, QEvent *event ) override;

    void setMultiEditFeatureIds( const QgsFeatureIds &fids );

    void setMessageBar( QgsMessageBar *messageBar );

    QString aggregateFilter() const;

    void setExtraContextScope( QgsExpressionContextScope *extraScope SIP_TRANSFER );

    bool needsGeometry() const;

    static QgsFeature createFeature( QgsVectorLayer *layer, const QgsGeometry &geometry, const QgsAttributeMap &attributes, QgsExpressionContext &context );
 
  signals:

    Q_DECL_DEPRECATED void attributeChanged( const QString &attribute, const QVariant &value ) SIP_DEPRECATED;

    void widgetValueChanged( const QString &attribute, const QVariant &value, bool attributeChanged );

    void rememberLastWidgetValueChanged( const QString &attribute, bool remember );

    void beforeSave( bool &ok ) SIP_SKIP;

    void featureSaved( const QgsFeature &feature );

    void filterExpressionSet( const QString &expression, QgsAttributeForm::FilterType type );

    void modeChanged( QgsAttributeEditorContext::Mode mode );

    void closed();

    void zoomToFeatures( const QString &filter );

    void flashFeatures( const QString &filter );

    void openFilteredFeaturesAttributeTable( const QString &filter );
 
  public slots:

    void changeAttribute( const QString &field, const QVariant &value, const QString &hintText = QString() );

    void changeGeometry( const QgsGeometry &geometry );

    void setFeature( const QgsFeature &feature );

    bool save();

    bool saveWithDetails( QString *error SIP_OUT = nullptr );

    void resetValues();

    void resetSearch();

    void refreshFeature();

    void parentFormValueChanged( const QString &attribute, const QVariant &newValue );
 
  private slots:
    void onAttributeChanged( const QVariant &value, const QVariantList &additionalFieldValues );
    void onAttributeAdded( int idx );
    void onAttributeDeleted( int idx );
    void onRelatedFeaturesChanged();
    void onUpdatedFields();
    void onConstraintStatusChanged( const QString &constraint, const QString &description, const QString &err, QgsEditorWidgetWrapper::ConstraintResult result );
    void preventFeatureRefresh();
    void synchronizeState();
    void layerSelectionChanged();

    bool saveMultiEdits();
    void resetMultiEdit( bool promptToSave = false );
    void multiEditMessageClicked( const QString &link );
 
    void filterAndTriggered();
    void filterOrTriggered();
    void filterTriggered();
 
    void searchZoomTo();
    void searchFlash();
    void searchSetSelection();
    void searchAddToSelection();
    void searchRemoveFromSelection();
    void searchIntersectSelection();
 
  private:
    void init();
 
    void cleanPython();
 
    void initPython();
 
    void updateJoinedFields( const QgsEditorWidgetWrapper &eww );
 
    bool fieldIsEditable( int fieldIndex ) const;
 
    bool fieldIsEditable( const QgsVectorLayer &layer, int fieldIndex, QgsFeatureId fid ) const;
 
    void updateFieldDependencies();
    void updateFieldDependenciesDefaultValue( QgsEditorWidgetWrapper *eww );
    void updateFieldDependenciesVirtualFields( QgsEditorWidgetWrapper *eww );
    void updateRelatedLayerFieldsDependencies( QgsEditorWidgetWrapper *eww = nullptr );
    void updateFieldDependenciesParent( QgsEditorWidgetWrapper *eww );
 
    void setMultiEditFeatureIdsRelations( const QgsFeatureIds &fids );
 
    struct WidgetInfo
    {
        QWidget *widget = nullptr;
        bool expandingNeeded = false;
        QString labelText;
        QString toolTip;
        QString hint;
        bool labelOnTop = false;
        bool labelAlignRight = false;
        bool showLabel = true;
        QgsAttributeEditorElement::LabelStyle labelStyle;
    };
 
    WidgetInfo createWidgetFromDef( const QgsAttributeEditorElement *widgetDef, QWidget *parent, QgsVectorLayer *vl, QgsAttributeEditorContext &context );

    void createWrappers();
    void afterWidgetInit();
 
    void scanForEqualAttributes( QgsFeatureIterator &fit, QSet<int> &mixedValueFields, QHash<int, QVariant> &fieldSharedValues ) const;

    bool saveEdits( QString *error );
 
    QgsFeature getUpdatedFeature() const;

    void updateValuesDependencies( const int originIdx );
    void updateValuesDependenciesDefaultValues( const int originIdx );
    void updateValuesDependenciesVirtualFields( const int originIdx );
    void updateValuesDependenciesParent();
    void updateRelatedLayerFields();
 
    void clearMultiEditMessages();
    void pushSelectedFeaturesMessage();
    void runSearchSelect( Qgis::SelectBehavior behavior );
 
    QString createFilterExpression() const;
 
    QgsExpressionContext createExpressionContext( const QgsFeature &feature ) const;

    void updateAllConstraints();
    void updateConstraints( QgsEditorWidgetWrapper *w );
    void updateContainersVisibility();
    void updateConstraint( const QgsFeature &ft, QgsEditorWidgetWrapper *eww );
    void updateLabels();
    void updateEditableState();
    bool currentFormValuesFeature( QgsFeature &feature );
    bool currentFormValidConstraints( QStringList &invalidFields, QStringList &descriptions ) const;
    bool currentFormValidHardConstraints( QStringList &invalidFields, QStringList &descriptions ) const;
    QList<QgsEditorWidgetWrapper *> constraintDependencies( QgsEditorWidgetWrapper *w );
 
    Q_DECL_DEPRECATED QgsRelationWidgetWrapper *setupRelationWidgetWrapper( const QgsRelation &rel, const QgsAttributeEditorContext &context ) SIP_DEPRECATED;
    QgsRelationWidgetWrapper *setupRelationWidgetWrapper( const QString &relationWidgetTypeId, const QgsRelation &rel, const QgsAttributeEditorContext &context );
 
    QToolButton *createCommentInfoButton( QWidget *labelWidget );
 
    QgsVectorLayer *mLayer = nullptr;
    QgsFeature mFeature;
    QgsFeature mCurrentFormFeature;
    QgsMessageBar *mMessageBar = nullptr;
    bool mOwnsMessageBar = true;
    QgsMessageBarItem *mMultiEditUnsavedMessageBarItem = nullptr;
    QgsMessageBarItem *mMultiEditMessageBarItem = nullptr;
    QList<QgsWidgetWrapper *> mWidgets;
    QgsAttributeEditorContext mContext;
    std::unique_ptr<QgsExpressionContextScope> mExtraContextScope;
    QDialogButtonBox *mButtonBox = nullptr;
    QWidget *mSearchButtonBox = nullptr;
    QList<QgsAttributeFormInterface *> mInterfaces;
    QMultiMap<int, QgsAttributeFormEditorWidget *> mFormEditorWidgets;
    QList<QgsAttributeFormWidget *> mFormWidgets;
    QMap<const QgsVectorLayerJoinInfo *, QgsFeature> mJoinedFeatures;
    QMap<QLabel *, QgsProperty> mLabelDataDefinedProperties;
    QMap<QWidget *, QgsProperty> mEditableDataDefinedProperties;
    QMap<QWidget *, QgsProperty> mCustomCommentDataDefinedProperties;
    bool mValuesInitialized = false;
    bool mDirty = false;
    bool mIsSettingFeature = false;
 
    bool mValidConstraints = true;
    QgsMessageBarItem *mConstraintsFailMessageBarItem = nullptr;
 
    struct ContainerInformation
    {
        ContainerInformation( QgsTabWidget *tabWidget, QWidget *widget, const QgsExpression &expression )
          : tabWidget( tabWidget )
          , widget( widget )
          , expression( expression )
          , isVisible( true )
        {}
 
        ContainerInformation( QWidget *widget, const QgsExpression &expression )
          : widget( widget )
          , expression( expression )
          , isVisible( true )
        {}
 
        ContainerInformation( QWidget *widget, const QgsExpression &visibilityExpression, bool collapsed, const QgsExpression &collapsedExpression )
          : widget( widget )
          , expression( visibilityExpression )
          , isVisible( true )
          , isCollapsed( collapsed )
          , collapsedExpression( collapsedExpression )
        {}
 
 
        QgsTabWidget *tabWidget = nullptr;
        QWidget *widget = nullptr;
        QgsExpression expression;
        bool isVisible;
        bool isCollapsed = false;
        QgsExpression collapsedExpression;
 
        void apply( QgsExpressionContext *expressionContext );
    };
 
    void registerContainerInformation( ContainerInformation *info );
 
    void updateIcon( QgsEditorWidgetWrapper *eww );
 
    void reloadIcon( const QString &file, const QString &tooltip, QSvgWidget *sw );
 
    // Contains information about tabs and groupboxes, their visibility/collapsed state conditions
    QVector<ContainerInformation *> mContainerVisibilityCollapsedInformation;
    QMap<QString, QVector<ContainerInformation *>> mContainerInformationDependency;
 
    // Variables below are used for Python
    static int sFormCounter;
    int mFormNr;
    QString mPyFormVarName;

    bool mIsSaving = false;

    bool mPreventFeatureRefresh = false;
 
    bool mIsSettingMultiEditFeatures = false;
 
    QgsFeatureIds mMultiEditFeatureIds;
    bool mUnsavedMultiEditChanges = false;
 
    QString mEditCommandMessage;
 
    QgsAttributeEditorContext::Mode mMode = QgsAttributeEditorContext::SingleEditMode;
 
    QMap<QWidget *, QSvgWidget *> mIconMap;

    QMultiMap<int, QgsWidgetWrapper *> mDefaultValueDependencies;

    QMultiMap<int, QgsWidgetWrapper *> mVirtualFieldsDependencies;

    QSet<QgsEditorWidgetWrapper *> mRelatedLayerFieldsDependencies;
 
    QSet<QgsEditorWidgetWrapper *> mParentDependencies;

    QList<int> mAlreadyUpdatedFields;
 
    bool mNeedsGeometry = false;
 
    friend class TestQgsDualView;
    friend class TestQgsAttributeForm;
    friend class TestQgsValueRelationWidgetWrapper;
};
 
#endif // QGSATTRIBUTEFORM_H