QGIS API Documentation  3.23.0-Master (dd0cd13a00)
qgsrelationwidgetwrapper.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgsrelationwidgetwrapper.cpp
3  --------------------------------------
4  Date : 14.5.2014
5  Copyright : (C) 2014 Matthias Kuhn
6  Email : matthias at opengis dot ch
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
17 
20 #include "qgsproject.h"
21 #include "qgsrelationmanager.h"
24 #include "qgsgui.h"
25 #include <QWidget>
26 
27 QgsRelationWidgetWrapper::QgsRelationWidgetWrapper( QgsVectorLayer *vl, const QgsRelation &relation, QWidget *editor, QWidget *parent )
28  : QgsRelationWidgetWrapper( QStringLiteral( "relation_editor" ), vl, relation, editor, parent )
29 {
30 }
31 
32 QgsRelationWidgetWrapper::QgsRelationWidgetWrapper( const QString &relationEditorName, QgsVectorLayer *vl, const QgsRelation &relation, QWidget *editor, QWidget *parent )
33  : QgsWidgetWrapper( vl, editor, parent )
34  , mRelation( relation )
35  , mRelationEditorId( relationEditorName )
36 {
37 }
38 
39 QWidget *QgsRelationWidgetWrapper::createWidget( QWidget *parent )
40 {
41  QgsAttributeForm *form = qobject_cast<QgsAttributeForm *>( parent );
42  if ( form )
44 
45  QWidget *widget = QgsGui::instance()->relationWidgetRegistry()->create( mRelationEditorId, widgetConfig(), parent );
46 
47  if ( !widget )
48  {
49  QgsLogger::warning( QStringLiteral( "Failed to create relation widget \"%1\", fallback to \"basic\" relation widget" ).arg( mRelationEditorId ) );
50  widget = QgsGui::instance()->relationWidgetRegistry()->create( QStringLiteral( "relation_editor" ), widgetConfig(), parent );
51  }
52 
53  return widget;
54 }
55 
57 {
58  if ( mWidget && mRelation.isValid() )
59  mWidget->setFeature( feature );
60 }
61 
63 {
64  if ( mWidget && mRelation.isValid() )
65  mWidget->setMultiEditFeatureIds( fids );
66 }
67 
69 {
70  if ( mWidget )
71  mWidget->setVisible( visible );
72 }
73 
74 void QgsRelationWidgetWrapper::aboutToSave()
75 {
76  if ( !mRelation.isValid() || !widget() || !widget()->isVisible() || mRelation.referencingLayer() == mRelation.referencedLayer() )
77  return;
78 
79  // If the layer is already saved before, return
80  const QgsAttributeEditorContext *ctx = &context();
81  do
82  {
83  if ( ctx->relation().isValid() && ( ctx->relation().referencedLayer() == mRelation.referencingLayer()
84  || ( mNmRelation.isValid() && ctx->relation().referencedLayer() == mNmRelation.referencedLayer() ) )
85  )
86  {
87  return;
88  }
89  ctx = ctx->parentContext();
90  }
91  while ( ctx );
92 
93  // Calling isModified() will emit a beforeModifiedCheck()
94  // signal that will make the embedded form to send any
95  // outstanding widget changes to the edit buffer
96  mRelation.referencingLayer()->isModified();
97 
98  if ( mNmRelation.isValid() )
99  mNmRelation.referencedLayer()->isModified();
100 }
101 
103 {
104  return mRelation;
105 }
106 
107 void QgsRelationWidgetWrapper::widgetValueChanged( const QString &attribute, const QVariant &newValue, bool attributeChanged )
108 {
109  if ( mWidget && attributeChanged )
110  {
111  QgsFeature feature { mWidget->feature() };
112  if ( feature.attribute( attribute ) != newValue )
113  {
114  feature.setAttribute( attribute, newValue );
115  QgsAttributeEditorContext newContext { mWidget->editorContext() };
116  newContext.setParentFormFeature( feature );
117  mWidget->setEditorContext( newContext );
118  mWidget->setFeature( feature, false );
119  mWidget->parentFormValueChanged( attribute, newValue );
120  }
121  }
122 }
123 
125 {
127  return visibleButtons().testFlag( QgsAttributeEditorRelation::Button::Unlink );
129 }
130 
132 {
134  setVisibleButtons( visibleButtons().setFlag( QgsAttributeEditorRelation::Unlink, showUnlinkButton ) );
136 }
137 
138 void QgsRelationWidgetWrapper::setShowSaveChildEditsButton( bool showSaveChildEditsButton )
139 {
141  setVisibleButtons( visibleButtons().setFlag( QgsAttributeEditorRelation::SaveChildEdits, showSaveChildEditsButton ) );
143 }
144 
146 {
147  return false;
148 }
149 
151 {
152  Q_UNUSED( showLabel )
153 }
154 
156 {
157  QgsAbstractRelationEditorWidget *w = qobject_cast<QgsAbstractRelationEditorWidget *>( editor );
158 
159  // if the editor cannot be cast to relation editor, insert a new one
160  if ( !w )
161  {
162  w = QgsGui::instance()->relationWidgetRegistry()->create( mRelationEditorId, widgetConfig(), editor );
163  editor->layout()->addWidget( w );
164  }
165 
167 
168  // read the legacy config of force-suppress-popup to support settings made on autoconfigurated forms
169  // it will be overwritten on specific widget configuration
170  if ( config( QStringLiteral( "force-suppress-popup" ), false ).toBool() )
171  {
172  const_cast<QgsVectorLayerTools *>( myContext.vectorLayerTools() )->setForceSuppressFormPopup( true );
173  }
174 
175  /* TODO: this seems to have no effect
176  if ( config( QStringLiteral( "hide-save-child-edits" ), false ).toBool() )
177  {
178  w->setShowSaveChildEditsButton( false );
179  }
180  */
181 
182  // read the legacy config of nm-rel to support settings made on autoconfigurated forms
183  // it will be overwritten on specific widget configuration
184  mNmRelation = QgsProject::instance()->relationManager()->relation( config( QStringLiteral( "nm-rel" ) ).toString() );
185 
186  // If this widget is already embedded by the same relation, reduce functionality
187  const QgsAttributeEditorContext *ctx = &context();
188  do
189  {
190  if ( ( ctx->relation().id() == mRelation.id() && ctx->formMode() == QgsAttributeEditorContext::Embed )
191  || ( mNmRelation.isValid() && ctx->relation().id() == mNmRelation.id() ) )
192  {
193  w->setVisible( false );
194  break;
195  }
196  ctx = ctx->parentContext();
197  }
198  while ( ctx );
199 
200  w->setEditorContext( myContext );
201  w->setRelations( mRelation, mNmRelation );
202 
203  mWidget = w;
204 }
205 
207 {
208  return mWidget;
209 }
210 
212 {
214  return visibleButtons().testFlag( QgsAttributeEditorRelation::Button::Link );
216 }
217 
219 {
221  setVisibleButtons( visibleButtons().setFlag( QgsAttributeEditorRelation::Link, showLinkButton ) );
223 }
224 
226 {
228  return visibleButtons().testFlag( QgsAttributeEditorRelation::Button::SaveChildEdits );
230 }
231 
232 void QgsRelationWidgetWrapper::setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons )
233 {
234  if ( ! mWidget )
235  return;
236  QVariantMap config = mWidget->config();
237  config.insert( "buttons", qgsFlagValueToKeys( buttons ) );
238 
239  mWidget->setConfig( config );
240 }
241 
242 QgsAttributeEditorRelation::Buttons QgsRelationWidgetWrapper::visibleButtons() const
243 {
244  return qgsFlagKeysToValue( mWidget->config().value( QStringLiteral( "buttons" ) ).toString(), QgsAttributeEditorRelation::AllButtons );
245 }
246 
247 void QgsRelationWidgetWrapper::setForceSuppressFormPopup( bool forceSuppressFormPopup )
248 {
249  if ( mWidget )
250  {
252  //it's set to true if one widget is configured like this but the setting is done generally (influencing all widgets).
254  {
255  const_cast<QgsVectorLayerTools *>( mWidget->editorContext().vectorLayerTools() )->setForceSuppressFormPopup( true );
256  }
257  }
258 }
259 
261 {
262  if ( mWidget )
263  return mWidget->forceSuppressFormPopup();
264 
265  return false;
266 }
267 
268 void QgsRelationWidgetWrapper::setNmRelationId( const QVariant &nmRelationId )
269 {
270  if ( mWidget )
271  {
272  mNmRelation = QgsProject::instance()->relationManager()->relation( nmRelationId.toString() );
273 
274  // If this widget is already embedded by the same relation, reduce functionality
275  const QgsAttributeEditorContext *ctx = &context();
276  while ( ctx && ctx->relation().isValid() )
277  {
278  if ( ( ctx->relation().id() == mRelation.id() && ctx->formMode() == QgsAttributeEditorContext::Embed )
279  || ( mNmRelation.isValid() && ctx->relation().id() == mNmRelation.id() ) )
280  {
281  mWidget->setVisible( false );
282  break;
283  }
284  ctx = ctx->parentContext();
285  }
286 
287  mWidget->setRelations( mRelation, mNmRelation );
288  }
289 }
290 
292 {
293  if ( mWidget )
294  return mWidget->nmRelationId();
295  return QVariant();
296 }
297 
298 
299 void QgsRelationWidgetWrapper::setLabel( const QString &label )
300 {
301  Q_UNUSED( label )
302 }
303 
305 {
306  return QString();
307 }
308 
309 void QgsRelationWidgetWrapper::setWidgetConfig( const QVariantMap &config )
310 {
311  if ( mWidget )
312  mWidget->setConfig( config );
313 }
314 
316 {
317  return mWidget ? mWidget->config() : QVariantMap();
318 }
Base class to build new relation widgets.
void setMultiEditFeatureIds(const QgsFeatureIds &fids)
Set multiple feature to edit simultaneously.
virtual void setConfig(const QVariantMap &config)=0
Defines the widget configuration.
bool forceSuppressFormPopup() const
Determines the force suppress form popup status that is configured for this widget.
virtual void setEditorContext(const QgsAttributeEditorContext &context)
Sets the editor context.
void setRelations(const QgsRelation &relation, const QgsRelation &nmrelation)
Sets the relation(s) for this widget If only one relation is set, it will act as a simple 1:N relatio...
QgsAttributeEditorContext editorContext() const
Returns the attribute editor context.
virtual QVariantMap config() const =0
Returns the widget configuration.
virtual void parentFormValueChanged(const QString &attribute, const QVariant &newValue)=0
Called when an attribute value in the parent widget has changed to newValue.
void setFeature(const QgsFeature &feature, bool update=true)
Sets the feature being edited and updates the UI unless update is set to false.
QgsFeature feature() const
Returns the widget's current feature.
QVariant nmRelationId() const
Determines the relation id of the second relation involved in an N:M relation.
void setForceSuppressFormPopup(bool forceSuppressFormPopup)
Sets force suppress form popup status with forceSuppressFormPopup configured for this widget.
This class contains context information for attribute editor widgets.
const QgsAttributeEditorContext * parentContext() const
FormMode formMode() const
Returns the form mode.
const QgsRelation & relation() const
Returns the attribute relation.
@ Multiple
When showing a list of features (e.g. houses as an embedded form in a district form)
@ Embed
A form was embedded as a widget on another form.
void setParentFormFeature(const QgsFeature &feature)
Sets the feature of the currently edited parent form.
const QgsVectorLayerTools * vectorLayerTools() const
Returns the associated vector layer tools.
void widgetValueChanged(const QString &attribute, const QVariant &value, bool attributeChanged)
Notifies about changes of attributes.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
bool setAttribute(int field, const QVariant &attr)
Sets an attribute's value by field index.
Definition: qgsfeature.cpp:255
static QgsGui * instance()
Returns a pointer to the singleton instance.
Definition: qgsgui.cpp:67
static QgsRelationWidgetRegistry * relationWidgetRegistry()
Returns the global relation widget registry, used for managing all known relation widget factories.
Definition: qgsgui.cpp:88
static void warning(const QString &msg)
Goes to qWarning.
Definition: qgslogger.cpp:122
QgsRelationManager * relationManager
Definition: qgsproject.h:111
static QgsProject * instance()
Returns the QgsProject singleton instance.
Definition: qgsproject.cpp:468
Q_INVOKABLE QgsRelation relation(const QString &id) const
Gets access to a relation by its id.
QgsAbstractRelationEditorWidget * create(const QString &widgetType, const QVariantMap &config, QWidget *parent=nullptr) const
Create a relation widget of a given type for a given field.
Q_DECL_DEPRECATED bool showLabel() const
Defines if a title label should be shown for this widget.
void setVisible(bool visible)
Sets the visibility of the wrapper's widget.
Q_DECL_DEPRECATED void setVisibleButtons(const QgsAttributeEditorRelation::Buttons &buttons)
Defines the buttons which are shown.
QgsRelation relation() const
The relation for which this wrapper is created.
QVariantMap widgetConfig() const
Returns the whole widget config.
Q_DECL_DEPRECATED void setShowLabel(bool showLabel)
Defines if a title label should be shown for this widget.
Q_DECL_DEPRECATED void setLabel(const QString &label=QString())
Sets label for this element If it's empty it takes the relation id as label.
void setWidgetConfig(const QVariantMap &config)
Will set the config of this widget wrapper to the specified config.
void widgetValueChanged(const QString &attribute, const QVariant &newValue, bool attributeChanged)
Will be called when a value in the current edited form or table row changes.
void setForceSuppressFormPopup(bool forceSuppressFormPopup)
Sets force suppress form popup status to forceSuppressFormPopup for this widget and for the vectorLay...
void initWidget(QWidget *editor) override
This method should initialize the editor widget with runtime data.
Q_DECL_DEPRECATED bool showLinkButton() const
Determines if the "link feature" button should be shown.
Q_DECL_DEPRECATED bool showUnlinkButton() const
Determines if the "unlink feature" button should be shown.
bool forceSuppressFormPopup() const
Determines the force suppress form popup status that is configured for this widget.
bool valid() const override
Returns true if the widget has been properly initialized.
QWidget * createWidget(QWidget *parent) override
This method should create a new widget with the provided parent.
void setMultiEditFeatureIds(const QgsFeatureIds &fids)
Set multiple feature to edit simultaneously.
Q_DECL_DEPRECATED void setShowUnlinkButton(bool showUnlinkButton)
Determines if the "unlink feature" button should be shown.
Q_DECL_DEPRECATED QgsAttributeEditorRelation::Buttons visibleButtons() const
Returns the buttons which are shown.
QgsRelationWidgetWrapper(QgsVectorLayer *vl, const QgsRelation &relation, QWidget *editor=nullptr, QWidget *parent=nullptr)
Constructor for QgsRelationWidgetWrapper.
Q_DECL_DEPRECATED QString label() const
Determines the label of this element.
void setNmRelationId(const QVariant &nmRelationId=QVariant())
Sets nmRelationId for the relation id of the second relation involved in an N:M relation.
QVariant nmRelationId() const
Determines the relation id of the second relation involved in an N:M relation.
Q_DECL_DEPRECATED bool showSaveChildEditsButton() const
Determines if the "Save child layer edits" button should be shown.
Q_DECL_DEPRECATED void setShowSaveChildEditsButton(bool showChildEdits)
Determines if the "Save child layer edits" button should be shown.
Q_DECL_DEPRECATED void setShowLinkButton(bool showLinkButton)
Determines if the "link feature" button should be shown.
void setFeature(const QgsFeature &feature) override
QgsVectorLayer * referencedLayer
Definition: qgsrelation.h:48
Q_GADGET QString id
Definition: qgsrelation.h:46
QgsVectorLayer * referencingLayer
Definition: qgsrelation.h:47
bool isValid
Definition: qgsrelation.h:50
Methods in this class are used to handle basic operations on vector layers.
Represents a vector layer which manages a vector based data sets.
bool isModified() const override
Returns true if the provider has been modified since the last commit.
Manages an editor widget Widget and wrapper share the same parent.
QWidget * widget()
Access the widget managed by this wrapper.
const QgsAttributeEditorContext & context() const
Returns information about the context in which this widget is shown.
QVariantMap config() const
Returns the whole config.
#define Q_NOWARN_DEPRECATED_POP
Definition: qgis.h:2000
#define Q_NOWARN_DEPRECATED_PUSH
Definition: qgis.h:1999
T qgsFlagKeysToValue(const QString &keys, const T &defaultValue)
Returns the value corresponding to the given keys of a flag.
Definition: qgis.h:1718
QString qgsFlagValueToKeys(const T &value)
Returns the value for the given keys of a flag.
Definition: qgis.h:1706
QSet< QgsFeatureId > QgsFeatureIds
Definition: qgsfeatureid.h:37