qgsattributeeditorrelation.h

Go to the documentation of this file.

/***************************************************************************
  qgsattributeeditorrelation.h - QgsAttributeEditorElement
 
 ---------------------
 begin                : 12.01.2021
 copyright            : (C) 2021 by Denis Rouzaud
 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 QGSATTRIBUTEEDITORRELATION_H
#define QGSATTRIBUTEEDITORRELATION_H
 
#include "qgis_core.h"
#include "qgsattributeeditorelement.h"
#include "qgsrelation.h"
 
#include <QColor>
 
class QgsRelationManager;

class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement
{
    Q_GADGET
  public:
    enum Button SIP_ENUM_BASETYPE( IntFlag )
    {
      Link = 1 << 1,                  
      Unlink = 1 << 2,                
      SaveChildEdits = 1 << 3,        
      AddChildFeature = 1 << 4,       
      DuplicateChildFeature = 1 << 5, 
      DeleteChildFeature = 1 << 6,    
      ZoomToChildFeature = 1 << 7,    
      AllButtons = Link | Unlink | SaveChildEdits | AddChildFeature | DuplicateChildFeature | DeleteChildFeature | ZoomToChildFeature 
    };
    // TODO QGIS 5: remove
    // this could not be tagged with Q_DECL_DEPRECATED due to Doxygen warning
 
    Q_ENUM( Button )
    Q_DECLARE_FLAGS( Buttons, Button )
    Q_FLAG( Buttons )

    Q_DECL_DEPRECATED QgsAttributeEditorRelation( const QString &name, const QString &relationId, QgsAttributeEditorElement *parent )
      : QgsAttributeEditorElement( Qgis::AttributeEditorType::Relation, name, parent )
      , mRelationId( relationId )
    {}

    Q_DECL_DEPRECATED QgsAttributeEditorRelation( const QString &name, const QgsRelation &relation, QgsAttributeEditorElement *parent )
      : QgsAttributeEditorElement( Qgis::AttributeEditorType::Relation, name, parent )
      , mRelationId( relation.id() )
      , mRelation( relation )
    {}

    QgsAttributeEditorRelation( const QString &relationId, QgsAttributeEditorElement *parent )
      : QgsAttributeEditorElement( Qgis::AttributeEditorType::Relation, relationId, parent )
      , mRelationId( relationId )
    {}

    QgsAttributeEditorRelation( const QgsRelation &relation, QgsAttributeEditorElement *parent )
      : QgsAttributeEditorElement( Qgis::AttributeEditorType::Relation, relation.id(), parent )
      , mRelationId( relation.id() )
      , mRelation( relation )
    {}
 

    const QgsRelation &relation() const { return mRelation; }

    bool init( QgsRelationManager *relManager );
 
    QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const override SIP_FACTORY;

    bool forceSuppressFormPopup() const;

    void setForceSuppressFormPopup( bool forceSuppressFormPopup );

    QVariant nmRelationId() const;

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

    QString label() const;

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

    QString relationWidgetTypeId() const;

    void setRelationWidgetTypeId( const QString &relationWidgetTypeId );

    QVariantMap relationEditorConfiguration() const;

    void setRelationEditorConfiguration( const QVariantMap &config );
 
  private:
    void saveConfiguration( QDomElement &elem, QDomDocument &doc ) const override;
    void loadConfiguration( const QDomElement &element, const QString &layerId, const QgsReadWriteContext &context, const QgsFields &fields ) override;
    QString typeIdentifier() const override;
    QString mRelationId;
    QgsRelation mRelation;
    Q_NOWARN_DEPRECATED_PUSH
    Buttons mButtons = Buttons( Button::AllButtons );
    Q_NOWARN_DEPRECATED_POP
    bool mForceSuppressFormPopup = false;
    QVariant mNmRelationId;
    QString mLabel;
    QString mRelationWidgetTypeId;
    QVariantMap mRelationEditorConfig;
};
 
Q_NOWARN_DEPRECATED_PUSH
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsAttributeEditorRelation::Buttons )
Q_NOWARN_DEPRECATED_POP
 
#endif // QGSATTRIBUTEEDITORRELATION_H