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

#include <QWidget>
#include <QDialogButtonBox>

class QgsAttributeFormInterface;

class GUI_EXPORT QgsAttributeForm : public QWidget
{
    Q_OBJECT

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

    const QgsFeature& feature() { return mFeature; }

    void hideButtonBox();

    void showButtonBox();

    void disconnectButtonBox();

    void addInterface( QgsAttributeFormInterface* iface );

    QgsVectorLayer* layer() { return mLayer; }

    bool editable();

    void setIsAddDialog( bool isAddDialog );

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

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

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

    void beforeSave( bool& ok );

    void featureSaved( const QgsFeature& feature );

  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 refreshFeature();

  private slots:
    void onAttributeChanged( const QVariant& value );
    void onAttributeAdded( int idx );
    void onAttributeDeleted( int idx );
    void onUpdatedFields();

    void preventFeatureRefresh();
    void synchronizeEnabledState();

  private:
    void init();

    void cleanPython();

    void initPython();

    QWidget* createWidgetFromDef( const QgsAttributeEditorElement* widgetDef, QWidget* parent, QgsVectorLayer* vl, QgsAttributeEditorContext& context, QString& labelText, bool& labelOnTop );

    void addWidgetWrapper( QgsEditorWidgetWrapper* eww );

    void createWrappers();
    void connectWrappers();

    QgsVectorLayer* mLayer;
    QgsFeature mFeature;
    QList<QgsWidgetWrapper*> mWidgets;
    QgsAttributeEditorContext mContext;
    QDialogButtonBox* mButtonBox;
    QList<QgsAttributeFormInterface*> mInterfaces;

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

    bool mIsSaving;
    bool mIsAddDialog;

    bool mPreventFeatureRefresh;

    QString mEditCommandMessage;
};

#endif // QGSATTRIBUTEFORM_H