qgsrelationwidgetwrapper.h

Go to the documentation of this file.

/***************************************************************************
    qgsrelationwidgetwrapper.h
     --------------------------------------
    Date                 : 14.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 QGSRELATIONWIDGETWRAPPER_H
#define QGSRELATIONWIDGETWRAPPER_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsattributeeditorrelation.h"
#include "qgswidgetwrapper.h"
 
class QgsAbstractRelationEditorWidget;

class GUI_EXPORT QgsRelationWidgetWrapper : public QgsWidgetWrapper
{
    Q_OBJECT
 
  public:
    QgsRelationWidgetWrapper(
      QgsVectorLayer *vl,
      const QgsRelation &relation,
      QWidget *editor SIP_CONSTRAINED = nullptr,
      QWidget *parent SIP_TRANSFERTHIS SIP_CONSTRAINED = nullptr
    );

    QgsRelationWidgetWrapper(
      const QString &relationEditorName,
      QgsVectorLayer *vl,
      const QgsRelation &relation,
      QWidget *editor = nullptr,
      QWidget *parent SIP_TRANSFERTHIS = nullptr
    );

    Q_DECL_DEPRECATED bool showLabel() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setShowLabel( bool showLabel ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED bool showLinkButton() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setShowLinkButton( bool showLinkButton ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED bool showUnlinkButton() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setShowUnlinkButton( bool showUnlinkButton ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setShowSaveChildEditsButton( bool showChildEdits ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED bool showSaveChildEditsButton() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED QgsAttributeEditorRelation::Buttons visibleButtons() const SIP_DEPRECATED;
 

    void setWidgetConfig( const QVariantMap &config );

    QVariantMap widgetConfig() const;

    bool forceSuppressFormPopup() const;

    void setForceSuppressFormPopup( bool forceSuppressFormPopup );

    QVariant nmRelationId() const;

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

    Q_DECL_DEPRECATED QString label() const SIP_DEPRECATED;

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

    QgsRelation relation() const;

    void widgetValueChanged( const QString &attribute, const QVariant &newValue, bool attributeChanged );
 
 
  protected:
    QWidget *createWidget( QWidget *parent ) override;
    void initWidget( QWidget *editor ) override;
    bool valid() const override;
 
  signals:

    void relatedFeaturesChanged();
 
  public slots:
    void setFeature( const QgsFeature &feature ) override;

    void setMultiEditFeatureIds( const QgsFeatureIds &fids );

    void setVisible( bool visible );
 
  private:
    void aboutToSave() override;
    QgsRelation mRelation;
    QgsRelation mNmRelation;
    QString mRelationEditorId;
    QgsAbstractRelationEditorWidget *mWidget = nullptr;
};
 
#endif // QGSRELATIONWIDGETWRAPPER_H