QGIS API Documentation 3.29.0-Master (ade4f0cf0f)
qgseditorwidgetwrapper.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgseditorwidgetwrapper.cpp
3 --------------------------------------
4 Date : 20.4.2013
5 Copyright : (C) 2013 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#include "qgsvectorlayer.h"
19#include "qgsfields.h"
20#include "qgsvectorlayerutils.h"
23
24#include <QTableView>
25
26QgsEditorWidgetWrapper::QgsEditorWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent )
27 : QgsWidgetWrapper( vl, editor, parent )
28 , mFieldIdx( fieldIdx )
29 , mValidConstraint( true )
30 , mIsBlockingCommit( false )
31{
32}
33
35{
36 return mFieldIdx;
37}
38
40{
41 QgsVectorLayer *vl = layer();
42 if ( vl && mFieldIdx < vl->fields().count() )
43 return vl->fields().at( mFieldIdx );
44 else
45 return QgsField();
46}
47
49{
50 mDefaultValue = layer()->dataProvider()->defaultValueClause( mFieldIdx );
51
52 return mDefaultValue;
53}
54
56{
57 return qobject_cast<QgsEditorWidgetWrapper *>( widget->property( "EWV2Wrapper" ).value<QgsWidgetWrapper *>() );
58}
59
61{
62 QWidget *wdg = widget();
63 if ( wdg )
64 {
65 wdg->setEnabled( enabled );
66 }
67}
68
70{
71 setFormFeature( feature );
72 QVariantList newAdditionalFieldValues;
73 const QStringList constAdditionalFields = additionalFields();
74 for ( const QString &fieldName : constAdditionalFields )
75 newAdditionalFieldValues << feature.attribute( fieldName );
76 setValues( feature.attribute( mFieldIdx ), newAdditionalFieldValues );
77}
78
79void QgsEditorWidgetWrapper::setValue( const QVariant &value )
80{
81 isRunningDeprecatedSetValue = true;
82 updateValues( value, QVariantList() );
83 isRunningDeprecatedSetValue = false;
84}
85
86void QgsEditorWidgetWrapper::setValues( const QVariant &value, const QVariantList &additionalValues )
87{
88 updateValues( value, additionalValues );
89}
90
92{
94 emit valueChanged( value() );
97}
98
99void QgsEditorWidgetWrapper::parentFormValueChanged( const QString &attribute, const QVariant &value )
100{
101 Q_UNUSED( attribute )
102 Q_UNUSED( value )
103}
104
106{
107 if ( !mConstraintResultVisible )
108 {
109 widget()->setStyleSheet( QString() );
110 }
111 else
112 {
113 switch ( mConstraintResult )
114 {
116 widget()->setStyleSheet( QString() );
117 break;
118
120 widget()->setStyleSheet( QStringLiteral( "background-color: #FFE0B2;" ) );
121 break;
122
124 widget()->setStyleSheet( QStringLiteral( "background-color: #FFECB3;" ) );
125 break;
126 }
127 }
128}
129
130bool QgsEditorWidgetWrapper::setFormFeatureAttribute( const QString &attributeName, const QVariant &attributeValue )
131{
132 return mFormFeature.setAttribute( attributeName, attributeValue );
133}
134
135void QgsEditorWidgetWrapper::updateValues( const QVariant &value, const QVariantList &additionalValues )
136{
137 // this method should be made pure virtual in QGIS 4
138 Q_UNUSED( additionalValues );
140 // avoid infinite recursive loop
141 if ( !isRunningDeprecatedSetValue )
142 setValue( value );
144}
145
147{
148 return mConstraintResult;
149}
150
152{
153 return mConstraintResultVisible;
154}
155
156void QgsEditorWidgetWrapper::setConstraintResultVisible( bool constraintResultVisible )
157{
158 if ( mConstraintResultVisible == constraintResultVisible )
159 return;
160
161 mConstraintResultVisible = constraintResultVisible;
162
164
165 emit constraintResultVisibleChanged( mConstraintResultVisible );
166}
167
169{
170 updateConstraint( layer(), mFieldIdx, ft, constraintOrigin );
171}
172
174{
175 QStringList errors;
176 QStringList softErrors;
177 QStringList expressions;
178 QStringList descriptions;
179 bool toEmit( false );
180 bool hardConstraintsOk( true );
181 bool softConstraintsOk( true );
182
183 const QgsField field = layer->fields().at( index );
184 const QString expression = field.constraints().constraintExpression();
185
186 if ( ft.isValid() )
187 {
188 if ( ! expression.isEmpty() )
189 {
190 expressions << expression;
191 descriptions << field.constraints().constraintDescription();
192 toEmit = true;
193 }
194
196 {
197 descriptions << tr( "Not NULL" );
198 if ( !expression.isEmpty() )
199 {
200 expressions << field.name() + QStringLiteral( " IS NOT NULL" );
201 }
202 else
203 {
204 expressions << QStringLiteral( "IS NOT NULL" );
205 }
206 toEmit = true;
207 }
208
210 {
211 descriptions << tr( "Unique" );
212 if ( !expression.isEmpty() )
213 {
214 expressions << field.name() + QStringLiteral( " IS UNIQUE" );
215 }
216 else
217 {
218 expressions << QStringLiteral( "IS UNIQUE" );
219 }
220 toEmit = true;
221 }
222
223 hardConstraintsOk = QgsVectorLayerUtils::validateAttribute( layer, ft, index, errors, QgsFieldConstraints::ConstraintStrengthHard, constraintOrigin );
224
225 softConstraintsOk = QgsVectorLayerUtils::validateAttribute( layer, ft, index, softErrors, QgsFieldConstraints::ConstraintStrengthSoft, constraintOrigin );
226 errors << softErrors;
227 }
228 else // invalid feature
229 {
230 if ( ! expression.isEmpty() )
231 {
232 hardConstraintsOk = true;
233 softConstraintsOk = false;
234
235 errors << QStringLiteral( "Invalid feature" );
236
237 toEmit = true;
238 }
239 }
240
241 mValidConstraint = hardConstraintsOk && softConstraintsOk;
242 mIsBlockingCommit = !hardConstraintsOk;
243
244 mConstraintFailureReason = errors.join( QLatin1String( ", " ) );
245
246 if ( toEmit )
247 {
248 const QString errStr = errors.isEmpty() ? tr( "Constraint checks passed" ) : mConstraintFailureReason;
249
250 const QString description = descriptions.join( QLatin1String( ", " ) );
251 QString expressionDesc;
252 if ( expressions.size() > 1 )
253 expressionDesc = "( " + expressions.join( QLatin1String( " ) AND ( " ) ) + " )";
254 else if ( !expressions.isEmpty() )
255 expressionDesc = expressions.at( 0 );
256
257 const ConstraintResult result = !hardConstraintsOk ? ConstraintResultFailHard
258 : ( !softConstraintsOk ? ConstraintResultFailSoft : ConstraintResultPass );
259 //set the constraint result
260 mConstraintResult = result;
262 emit constraintStatusChanged( expressionDesc, description, errStr, result );
263 }
264}
265
267{
268 return mValidConstraint;
269}
270
272{
273 return mIsBlockingCommit;
274}
275
276
278{
279 return mConstraintFailureReason;
280}
281
282bool QgsEditorWidgetWrapper::isInTable( const QWidget *parent )
283{
284 if ( !parent ) return false;
285 if ( qobject_cast<const QTableView *>( parent ) ) return true;
286 return isInTable( parent->parentWidget() );
287}
288
289void QgsEditorWidgetWrapper::setHint( const QString &hintText )
290{
291 if ( QWidget *w = widget() )
292 w->setToolTip( hintText );
293}
Manages an editor widget Widget and wrapper share the same parent.
Q_DECL_DEPRECATED void valueChanged(const QVariant &value)
Emit this signal, whenever the value changed.
virtual void updateConstraintWidgetStatus()
This should update the widget with a visual cue if a constraint status changed.
void setFormFeature(const QgsFeature &feature)
Set the feature currently being edited to feature.
virtual QVariant value() const =0
Will be used to access the widget's value.
virtual QVariantList additionalFieldValues() const
Will be used to access the widget's values for potential additional fields handled by the widget.
int fieldIdx() const
Access the field index.
virtual void parentFormValueChanged(const QString &attribute, const QVariant &value)
Is called in embedded form widgets when an attribute value in the parent form has changed.
QgsEditorWidgetWrapper(QgsVectorLayer *vl, int fieldIdx, QWidget *editor=nullptr, QWidget *parent=nullptr)
Create a new widget wrapper.
void setFeature(const QgsFeature &feature) override
Will be called when the feature changes.
virtual QStringList additionalFields() const
Returns the list of additional fields which the editor handles.
ConstraintResult constraintResult
void constraintResultVisibleChanged(bool visible)
Emit this signal when the constraint result visibility changed.
QString constraintFailureReason() const
Returns the reason why a constraint check has failed (or an empty string if constraint check was succ...
QVariant defaultValue() const
Access the default value of the field.
void setEnabled(bool enabled) override
Is used to enable or disable the edit functionality of the managed widget.
void valuesChanged(const QVariant &value, const QVariantList &additionalFieldValues=QVariantList())
Emit this signal, whenever the value changed.
bool isValidConstraint() const
Gets the current constraint status.
void updateConstraint(const QgsFeature &featureContext, QgsFieldConstraints::ConstraintOrigin constraintOrigin=QgsFieldConstraints::ConstraintOriginNotSet)
Update constraint.
static bool isInTable(const QWidget *parent)
Check if the given widget or one of its parent is a QTableView.
void setValues(const QVariant &value, const QVariantList &additionalValues)
Is called when the value of the widget or additional field values needs to be changed.
bool setFormFeatureAttribute(const QString &attributeName, const QVariant &attributeValue)
Update the feature currently being edited by changing its attribute attributeName to attributeValue.
void emitValueChanged()
Will call the value() method to determine the emitted value.
virtual void setHint(const QString &hintText)
Add a hint text on the widget.
QgsField field() const
Access the field.
ConstraintResult
Result of constraint checks.
@ ConstraintResultFailSoft
Widget failed at least one soft (non-enforced) constraint.
@ ConstraintResultPass
Widget passed constraints successfully.
@ ConstraintResultFailHard
Widget failed at least one hard (enforced) constraint.
void constraintStatusChanged(const QString &constraint, const QString &desc, const QString &err, QgsEditorWidgetWrapper::ConstraintResult status)
Emit this signal when the constraint status changed.
virtual void setValue(const QVariant &value)
Is called when the value of the widget needs to be changed.
bool isBlockingCommit() const
Returns true if the widget is preventing the feature from being committed.
void setConstraintResultVisible(bool constraintResultVisible)
Sets whether the constraint result is visible.
static QgsEditorWidgetWrapper * fromWidget(QWidget *widget)
Will return a wrapper for a given widget.
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:265
bool isValid() const
Returns the validity of this feature.
Definition: qgsfeature.cpp:219
QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
Definition: qgsfeature.cpp:338
@ ConstraintStrengthSoft
User is warned if constraint is violated but feature can still be accepted.
@ ConstraintStrengthHard
Constraint must be honored before feature can be accepted.
ConstraintOrigin
Origin of constraints.
QString constraintExpression() const
Returns the constraint expression for the field, if set.
@ ConstraintNotNull
Field may not be null.
@ ConstraintUnique
Field must have a unique value.
QString constraintDescription() const
Returns the descriptive name for the constraint expression.
Q_GADGET Constraints constraints
Encapsulate a field in an attribute table or data source.
Definition: qgsfield.h:51
QString name
Definition: qgsfield.h:60
QgsFieldConstraints constraints
Definition: qgsfield.h:63
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
Definition: qgsfields.cpp:163
virtual QString defaultValueClause(int fieldIndex) const
Returns any default value clauses which are present at the provider for a specified field index.
static bool validateAttribute(const QgsVectorLayer *layer, const QgsFeature &feature, int attributeIndex, QStringList &errors, QgsFieldConstraints::ConstraintStrength strength=QgsFieldConstraints::ConstraintStrengthNotSet, QgsFieldConstraints::ConstraintOrigin origin=QgsFieldConstraints::ConstraintOriginNotSet)
Tests a feature attribute value to check whether it passes all constraints which are present on the c...
Represents a vector layer which manages a vector based data sets.
QgsFields fields() const FINAL
Returns the list of fields of this layer.
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
Manages an editor widget Widget and wrapper share the same parent.
QWidget * widget()
Access the widget managed by this wrapper.
QgsVectorLayer * layer() const
Returns the vector layer associated with the widget.
#define Q_NOWARN_DEPRECATED_POP
Definition: qgis.h:3366
#define Q_NOWARN_DEPRECATED_PUSH
Definition: qgis.h:3365