qgsrelationreferencewidget.h

Go to the documentation of this file.

/***************************************************************************
    qgsrelationreferencewidget.h
     --------------------------------------
    Date                 : 20.4.2013
    Copyright            : (C) 2013 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 QGSRELATIONREFERENCEWIDGET_H
#define QGSRELATIONREFERENCEWIDGET_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsattributeeditorcontext.h"
#include "qgsfeature.h"
#include "qobjectuniqueptr.h"
 
#include <QComboBox>
#include <QHBoxLayout>
#include <QLineEdit>
#include <QStandardItemModel>
#include <QToolButton>
 
class QgsAttributeForm;
class QgsVectorLayerTools;
class QgsMapCanvas;
class QgsMessageBar;
class QgsHighlight;
class QgsMapTool;
class QgsMapToolIdentifyFeature;
class QgsMapToolDigitizeFeature;
class QgsMessageBarItem;
class QgsFeatureListComboBox;
class QgsCollapsibleGroupBox;
class QLabel;
 
#ifdef SIP_RUN
//%ModuleHeaderCode
// fix to allow compilation with sip that for some reason
// doesn't add this include to the file where the code from
// ConvertToSubClassCode goes.
#include <qgsrelationreferencewidget.h>
//%End
#endif

class GUI_EXPORT QgsRelationReferenceWidget : public QWidget
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsRelationReferenceWidget *>( sipCpp ) )
      sipType = sipType_QgsRelationReferenceWidget;
    else
      sipType = NULL;
    SIP_END
#endif
 
    Q_OBJECT
    Q_PROPERTY( bool openFormButtonVisible READ openFormButtonVisible WRITE setOpenFormButtonVisible )
 
  public:
    enum CanvasExtent
    {
      Fixed,
      Pan,
      Scale
    };
 
    explicit QgsRelationReferenceWidget( QWidget *parent SIP_TRANSFERTHIS );
 
    ~QgsRelationReferenceWidget() override;
 
    void setRelation( const QgsRelation &relation, bool allowNullValue );
 
    void setRelationEditable( bool editable );

    Q_DECL_DEPRECATED void setForeignKey( const QVariant &value ) SIP_DEPRECATED;

    void setForeignKeys( const QVariantList &values );

    Q_DECL_DEPRECATED QVariant foreignKey() const SIP_DEPRECATED;


    QVariantList foreignKeys() const;

    void setEditorContext( const QgsAttributeEditorContext &context, QgsMapCanvas *canvas, QgsMessageBar *messageBar );

    bool embedForm() const { return mEmbedForm; }
    void setEmbedForm( bool display );

    bool readOnlySelector() const { return mReadOnlySelector; }
    void setReadOnlySelector( bool readOnly );

    bool allowMapIdentification() const { return mAllowMapIdentification; }
    void setAllowMapIdentification( bool allowMapIdentification );

    void setFilterFields( const QStringList &filterFields );

    bool openFormButtonVisible() const { return mOpenFormButtonVisible; }
    void setOpenFormButtonVisible( bool openFormButtonVisible );

    bool chainFilters() const { return mChainFilters; }

    void setChainFilters( bool chainFilters );

    QString filterExpression() const { return mFilterExpression; };

    void setFilterExpression( const QString &filterExpression );

    QgsFeature referencedFeature() const;

    void showIndeterminateState();

    bool allowAddFeatures() const;

    void setAllowAddFeatures( bool allowAddFeatures );

    QgsRelation relation() const;

    void setFormFeature( const QgsFeature &formFeature );

    void setParentFormFeature( const QgsFeature &parentFormFeature );

    QString referencedLayerDataSource() const;

    void setReferencedLayerDataSource( const QString &referencedLayerDataSource );

    QString referencedLayerProviderKey() const;

    void setReferencedLayerProviderKey( const QString &referencedLayerProviderKey );

    QString referencedLayerId() const;

    void setReferencedLayerId( const QString &referencedLayerId );

    QString referencedLayerName() const;

    void setReferencedLayerName( const QString &referencedLayerName );

    int fetchLimit() const { return mFetchLimit; }

    void setFetchLimit( int fetchLimit ) { mFetchLimit = fetchLimit; }

    QString orderExpression() const { return mOrderExpression; }

    void setOrderExpression( const QString &orderExpression ) { mOrderExpression = orderExpression; }

    Qt::SortOrder sortOrder() const { return mSortOrder; }

    void setSortOrder( const Qt::SortOrder sortOrder ) { mSortOrder = sortOrder; }
 
  public slots:
    void openForm();

    void mapIdentification();

    void deleteForeignKeys();

    bool saveReferencedAttributeForm();
 
  protected:
    void showEvent( QShowEvent *e ) override;
 
    void init();
 
  signals:

    Q_DECL_DEPRECATED void foreignKeyChanged( const QVariant &key ) SIP_DEPRECATED;

    void foreignKeysChanged( const QVariantList &keys );
 
  private slots:
    void highlightActionTriggered( QAction *action );
    void deleteHighlight();
    void comboReferenceChanged();
    void comboReferenceFoundChanged( bool found );
    void featureIdentified( const QgsFeature &feature );
    void setMapTool( QgsMapTool *mapTool );
    void unsetMapTool();
    void mapToolDeactivated();
    void filterChanged();
    void addEntry();
    void updateAddEntryButton();
    void entryAdded( const QgsFeature &f );
    void onKeyPressed( QKeyEvent *e );
 
  private:
    void highlightFeature( QgsFeature f = QgsFeature(), CanvasExtent canvasExtent = Fixed );
    void updateAttributeEditorFrame( const QgsFeature &feature );
    void disableChainedComboBoxes( const QComboBox *cb );
    void emitForeignKeysChanged( const QVariantList &foreignKeys, bool force = false );
 
    // initialized
    QgsAttributeEditorContext mEditorContext;
    QgsMapCanvas *mCanvas = nullptr;
    QgsMessageBar *mMessageBar = nullptr;
    QVariantList mForeignKeys;
    QgsFeature mFeature;
    // Index of the referenced layer key
    QStringList mReferencedFields;
    bool mAllowNull = true;
    QgsHighlight *mHighlight = nullptr;
    QgsMapTool *mCurrentMapTool = nullptr;
    QObjectUniquePtr<QgsMapToolIdentifyFeature> mMapToolIdentify;
    QObjectUniquePtr<QgsMapToolDigitizeFeature> mMapToolDigitize;
    QgsMessageBarItem *mMessageBarItem = nullptr;
    QgsAttributeForm *mReferencedAttributeForm = nullptr;
    QgsVectorLayer *mReferencedLayer = nullptr;
    QgsVectorLayer *mReferencingLayer = nullptr;
    QgsFeatureListComboBox *mComboBox = nullptr;
    QList<QComboBox *> mFilterComboBoxes;
    QString mFilterExpression;
    QWidget *mWindowWidget = nullptr;
    bool mShown = false;
    QgsRelation mRelation;
    bool mIsEditable = true;
    QStringList mFilterFields;
    QMap<QString, QMap<QString, QSet<QString>>> mFilterCache;
    bool mInitialized = false;
    int mFetchLimit = 0;
 
    // Q_PROPERTY
    bool mEmbedForm = false;
    bool mReadOnlySelector = false;
    bool mAllowMapIdentification = false;
    bool mOpenFormButtonVisible = true;
    bool mChainFilters = false;
    bool mAllowAddFeatures = false;
    QString mReferencedLayerId;
    QString mReferencedLayerName;
    QString mReferencedLayerDataSource;
    QString mReferencedLayerProviderKey;
    QString mOrderExpression;
    Qt::SortOrder mSortOrder = Qt::AscendingOrder;
 
    // UI
    QVBoxLayout *mTopLayout = nullptr;
    QToolButton *mMapIdentificationButton = nullptr;
    QToolButton *mRemoveFKButton = nullptr;
    QToolButton *mOpenFormButton = nullptr;
    QToolButton *mHighlightFeatureButton = nullptr;
    QToolButton *mAddEntryButton = nullptr;
    QAction *mHighlightFeatureAction = nullptr;
    QAction *mScaleHighlightFeatureAction = nullptr;
    QAction *mPanHighlightFeatureAction = nullptr;
    QWidget *mChooserContainer = nullptr;
    QWidget *mFilterContainer = nullptr;
    QHBoxLayout *mFilterLayout = nullptr;
    QgsCollapsibleGroupBox *mAttributeEditorFrame = nullptr;
    QVBoxLayout *mAttributeEditorLayout = nullptr;
    QLabel *mInvalidLabel = nullptr;
 
    friend class TestQgsRelationReferenceWidget;
};
 
#endif // QGSRELATIONREFERENCEWIDGET_H