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 "qgsfeature.h"
#include "qgsvectorlayer.h"
#include "qgsattributeeditorcontext.h"

#include <QWidget>
#include <QLabel>
#include <QDialogButtonBox>

class QgsAttributeFormInterface;
class QgsAttributeFormEditorWidget;
class QgsMessageBar;
class QgsMessageBarItem;
class QgsWidgetWrapper;
class QgsTabWidget;

class GUI_EXPORT QgsAttributeForm : public QWidget
{
    Q_OBJECT

  public:

    enum Mode
    {
      SingleEditMode, 
      AddFeatureMode, 
      MultiEditMode, 
      SearchMode, 
    };

    enum FilterType
    {
      ReplaceFilter, 
      FilterAnd, 
      FilterOr, 
    };

    explicit QgsAttributeForm( QgsVectorLayer* vl, const QgsFeature &feature = QgsFeature(),
                               const QgsAttributeEditorContext& context = QgsAttributeEditorContext(), QWidget *parent = nullptr );
    ~QgsAttributeForm();

    const QgsFeature& feature() { return mFeature; }

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

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

    // TODO QGIS 3.0 - make private
    void disconnectButtonBox();

    void addInterface( QgsAttributeFormInterface* iface );

    QgsVectorLayer* layer() { return mLayer; }

    bool editable();

    Mode mode() const { return mMode; }

    void setMode( Mode mode );

    Q_DECL_DEPRECATED void setIsAddDialog( bool isAddDialog );

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

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

    void setMultiEditFeatureIds( const QgsFeatureIds& fids );

    void setMessageBar( QgsMessageBar* messageBar );

  signals:
    void attributeChanged( const QString& attribute, const QVariant& value );

    void beforeSave( bool& ok );

    void featureSaved( const QgsFeature& feature );

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

    void modeChanged( QgsAttributeForm::Mode mode );

    void closed();

  public slots:
    void changeAttribute( const QString& field, const QVariant& value );

    void setFeature( const QgsFeature& feature );

    bool save();

    Q_DECL_DEPRECATED void accept() { save(); }

    Q_DECL_DEPRECATED void reject() { resetValues(); }

    void resetValues();

    void resetSearch();

    void refreshFeature();

  private slots:
    void onAttributeChanged( const QVariant& value );
    void onAttributeAdded( int idx );
    void onAttributeDeleted( int idx );
    void onUpdatedFields();
    void onConstraintStatusChanged( const QString& constraint,
                                    const QString& description, const QString& err, bool ok );
    void preventFeatureRefresh();
    void synchronizeEnabledState( bool synchronizeWidgetWrapper = true );
    void layerSelectionChanged();

    bool saveMultiEdits();
    void resetMultiEdit( bool promptToSave = false );
    void multiEditMessageClicked( const QString& link );

    void filterAndTriggered();
    void filterOrTriggered();
    void filterTriggered();

    void searchSetSelection();
    void searchAddToSelection();
    void searchRemoveFromSelection();
    void searchIntersectSelection();

  private:
    void init();

    void cleanPython();

    void initPython();

    struct WidgetInfo
    {
      WidgetInfo()
          : widget( nullptr )
          , labelOnTop( false )
          , labelAlignRight( false )
          , showLabel( true )
      {}

      QWidget* widget;
      QString labelText;
      bool labelOnTop;
      bool labelAlignRight;
      bool showLabel;
    };

    WidgetInfo createWidgetFromDef( const QgsAttributeEditorElement* widgetDef, QWidget* parent, QgsVectorLayer* vl, QgsAttributeEditorContext& context );

    void addWidgetWrapper( QgsEditorWidgetWrapper* eww );

    void createWrappers();
    void afterWidgetInit();

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

    bool saveEdits();

    int messageTimeout();
    void clearMultiEditMessages();
    void pushSelectedFeaturesMessage();
    void runSearchSelect( QgsVectorLayer::SelectBehaviour behaviour );

    QString createFilterExpression() const;

    void updateAllConstaints();
    void updateConstraints( QgsEditorWidgetWrapper* w );
    bool currentFormFeature( QgsFeature& feature );
    bool currentFormValidConstraints( QStringList& invalidFields, QStringList& descriptions );
    void constraintDependencies( QgsEditorWidgetWrapper* w, QList<QgsEditorWidgetWrapper*>& wDeps );
    void clearInvalidConstraintsMessage();
    void displayInvalidConstraintMessage( const QStringList& invalidFields,
                                          const QStringList& description );

    QgsVectorLayer* mLayer;
    QgsFeature mFeature;
    QgsMessageBar* mMessageBar;
    bool mOwnsMessageBar;
    QgsMessageBarItem* mMultiEditUnsavedMessageBarItem;
    QgsMessageBarItem* mMultiEditMessageBarItem;
    QLabel* mInvalidConstraintMessage;
    QWidget* mTopMessageWidget;
    QList<QgsWidgetWrapper*> mWidgets;
    QgsAttributeEditorContext mContext;
    QDialogButtonBox* mButtonBox;
    QWidget* mSearchButtonBox;
    QList<QgsAttributeFormInterface*> mInterfaces;
    QMap< int, QgsAttributeFormEditorWidget* > mFormEditorWidgets;
    QgsExpressionContext mExpressionContext;

    struct ContainerInformation
    {
      ContainerInformation( QgsTabWidget* tabWidget, QWidget* widget, QgsExpression expression )
          : tabWidget( tabWidget )
          , widget( widget )
          , expression( expression )
          , isVisible( true )
      {}

      ContainerInformation( QWidget* widget, QgsExpression expression )
          : tabWidget( nullptr )
          , widget( widget )
          , expression( expression )
          , isVisible( true )
      {}

      QgsTabWidget* tabWidget;
      QWidget* widget;
      QgsExpression expression;
      bool isVisible;

      void apply( QgsExpressionContext* expressionContext );
    };

    void registerContainerInformation( ContainerInformation* info );

    // Contains information about tabs and groupboxes, their visibility state visibility conditions
    QVector<ContainerInformation*> mContainerVisibilityInformation;
    QMap<QString, QVector<ContainerInformation*> > mContainerInformationDependency;

    // Variables below are used for python
    static int sFormCounter;
    int mFormNr;
    QString mPyFormVarName;

    bool mIsSaving;

    bool mPreventFeatureRefresh;

    bool mIsSettingFeature;
    bool mIsSettingMultiEditFeatures;

    QgsFeatureIds mMultiEditFeatureIds;
    bool mUnsavedMultiEditChanges;

    QString mEditCommandMessage;

    Mode mMode;

    QMap<QWidget*, QLabel*> mBuddyMap;

    friend class TestQgsDualView;
    friend class TestQgsAttributeForm;
};

#endif // QGSATTRIBUTEFORM_H