qgsabstractrelationeditorwidget.h

Go to the documentation of this file.

/***************************************************************************
                         qgsabstractrelationeditorwidget.h
                         ----------------------
    begin                : October 2020
    copyright            : (C) 2020 by Ivan Ivanov
    email                : [email protected]
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSABSTRACTRELATIONEDITORWIDGET_H
#define QGSABSTRACTRELATIONEDITORWIDGET_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsattributeeditorcontext.h"
#include "qgsrelation.h"
#include "qobjectuniqueptr.h"
 
#include <QWidget>
 
#ifdef SIP_RUN
// this is needed for the "convert to subclass" code below to compile
//%ModuleHeaderCode
#include "qgsrelationeditorwidget.h"
//%End
#endif
 
class QgsFeature;
class QgsVectorLayer;

class GUI_EXPORT QgsAbstractRelationEditorWidget : public QWidget
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsRelationEditorWidget *>( sipCpp ) )
      sipType = sipType_QgsRelationEditorWidget;
    else
      sipType = 0;
    SIP_END
#endif
 
    Q_OBJECT
 
  public:

    QgsAbstractRelationEditorWidget( const QVariantMap &config, QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void setRelationFeature( const QgsRelation &relation, const QgsFeature &feature );

    void setRelations( const QgsRelation &relation, const QgsRelation &nmrelation );

    QgsRelation relation() const { return mRelation; }

    QgsRelation nmRelation() const { return mNmRelation; }

    void setFeature( const QgsFeature &feature, bool update = true );

    void setMultiEditFeatureIds( const QgsFeatureIds &fids );

    virtual void setEditorContext( const QgsAttributeEditorContext &context );

    QgsAttributeEditorContext editorContext() const;

    Q_DECL_DEPRECATED bool showLabel() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setShowLabel( bool showLabel ) SIP_DEPRECATED;

    QVariant nmRelationId() const;

    void setNmRelationId( const QVariant &nmRelationId = QVariant() );

    Q_DECL_DEPRECATED QString label() const SIP_DEPRECATED;

    void setLabel( const QString &label = QString() );

    QgsFeature feature() const;

    QList<QgsFeature> features() const;

    bool forceSuppressFormPopup() const;

    void setForceSuppressFormPopup( bool forceSuppressFormPopup );

    virtual QVariantMap config() const = 0;

    virtual void setConfig( const QVariantMap &config ) = 0;

    bool multiEditModeActive() const;
 
  signals:

    void relatedFeaturesChanged();
 
  public slots:

    virtual void parentFormValueChanged( const QString &attribute, const QVariant &newValue ) = 0;
 
  protected slots:

    void toggleEditing( bool state );

    void saveEdits();

    QgsFeatureIds addFeature( const QgsGeometry &geometry = QgsGeometry() );

    void deleteFeature( QgsFeatureId fid = QgsFeatureId() );

    void linkFeature( const QString &filterExpression = QString() );

    void onLinkFeatureDlgAccepted();

    void unlinkFeature( QgsFeatureId fid = QgsFeatureId() );

    void duplicateFeature( const QgsFeatureId &fid );

    void duplicateFeatures( const QgsFeatureIds &fids );
 
  protected:
    QgsAttributeEditorContext mEditorContext;
    QgsRelation mRelation;
    QgsRelation mNmRelation;
    QgsFeatureList mFeatureList;
 
    bool mLayerInSameTransactionGroup = false;
 
    bool mForceSuppressFormPopup = false;

    void showEvent( QShowEvent * ) override;

    Q_DECL_DEPRECATED void updateTitle() SIP_DEPRECATED;

    void deleteFeatures( const QgsFeatureIds &fids );

    void unlinkFeatures( const QgsFeatureIds &fids );
 
    // Following virtual methods need to be protected so they can be overridden in bindings

    virtual void updateUi();

    Q_DECL_DEPRECATED virtual void setTitle( const QString &title ) SIP_DEPRECATED;

    virtual void beforeSetRelationFeature( const QgsRelation &newRelation, const QgsFeature &newFeature );

    virtual void afterSetRelationFeature();

    virtual void beforeSetRelations( const QgsRelation &newRelation, const QgsRelation &newNmRelation );

    virtual void afterSetRelations();
};
 

class GUI_EXPORT QgsAbstractRelationEditorConfigWidget : public QWidget
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsRelationEditorConfigWidget *>( sipCpp ) )
      sipType = sipType_QgsRelationEditorConfigWidget;
    else
      sipType = 0;
    SIP_END
#endif
 
    Q_OBJECT
  public:

    explicit QgsAbstractRelationEditorConfigWidget( const QgsRelation &relation, QWidget *parent SIP_TRANSFERTHIS );

    virtual QVariantMap config() = 0;

    virtual void setConfig( const QVariantMap &config ) = 0;

    QgsVectorLayer *layer();

    QgsRelation relation() const;

    virtual void setNmRelation( const QgsRelation &nmRelation );

    virtual QgsRelation nmRelation() const;
 
  private:
    QgsVectorLayer *mLayer = nullptr;
    QgsRelation mRelation;
    QgsRelation mNmRelation;
};
 

 

class GUI_EXPORT QgsAbstractRelationEditorWidgetFactory
{
  public:

    QgsAbstractRelationEditorWidgetFactory();
 
    virtual ~QgsAbstractRelationEditorWidgetFactory() = default;

    virtual QString type() const = 0;

    virtual QString name() const = 0;

    virtual QgsAbstractRelationEditorWidget *create( const QVariantMap &config, QWidget *parent = nullptr ) const = 0 SIP_FACTORY;

    virtual QgsAbstractRelationEditorConfigWidget *configWidget( const QgsRelation &relation, QWidget *parent ) const = 0 SIP_FACTORY;
};
 
#endif // QGSABSTRACTRELATIONEDITORWIDGET_H