53 connect( mNewFieldGroupBox, &QGroupBox::toggled,
this, &QgsFieldCalculator::mNewFieldGroupBox_toggled );
54 connect( mUpdateExistingGroupBox, &QGroupBox::toggled,
this, &QgsFieldCalculator::mUpdateExistingGroupBox_toggled );
55 connect( mCreateVirtualFieldCheckbox, &QCheckBox::stateChanged,
this, &QgsFieldCalculator::mCreateVirtualFieldCheckbox_stateChanged );
56 connect( mOutputFieldNameLineEdit, &QLineEdit::textChanged,
this, &QgsFieldCalculator::mOutputFieldNameLineEdit_textChanged );
57 connect( mOutputFieldTypeComboBox,
static_cast<void ( QComboBox::* )(
int )
>( &QComboBox::activated ),
this, &QgsFieldCalculator::mOutputFieldTypeComboBox_activated );
77 populateOutputFieldTypes();
80 connect( mOutputFieldWidthSpinBox, &QAbstractSpinBox::editingFinished,
this, &QgsFieldCalculator::setPrecisionMinMax );
81 connect( mButtonBox, &QDialogButtonBox::helpRequested,
this, &QgsFieldCalculator::showHelp );
82 connect( mButtonBox->button( QDialogButtonBox::Apply ), &QAbstractButton::clicked,
this, &QgsFieldCalculator::calculate );
87 builder->setGeomCalculator( myDa );
90 mOutputFieldWidthSpinBox->setValue( 10 );
91 mOutputFieldWidthSpinBox->setClearValue( 10 );
92 mOutputFieldPrecisionSpinBox->setValue( 3 );
93 mOutputFieldPrecisionSpinBox->setClearValue( 3 );
98 mOutputFieldNameLineEdit->setMaxLength( 10 );
101 if ( !mCanAddAttribute )
103 mCreateVirtualFieldCheckbox->setChecked(
true );
104 mCreateVirtualFieldCheckbox->setEnabled(
false );
105 mOnlyVirtualFieldsInfoLabel->setVisible(
true );
106 mInfoIcon->setVisible(
true );
110 mOnlyVirtualFieldsInfoLabel->setVisible(
false );
111 mInfoIcon->setVisible(
false );
114 if ( !mCanChangeAttributeValue )
116 mUpdateExistingGroupBox->setEnabled(
false );
117 mCreateVirtualFieldCheckbox->setChecked(
true );
118 mCreateVirtualFieldCheckbox->setEnabled(
false );
121 Q_ASSERT( mNewFieldGroupBox->isEnabled() || mUpdateExistingGroupBox->isEnabled() );
123 if ( mNewFieldGroupBox->isEnabled() )
125 mNewFieldGroupBox->setChecked(
true );
129 mNewFieldGroupBox->setToolTip( tr(
"Not available for layer" ) );
130 mUpdateExistingGroupBox->setChecked(
true );
131 mUpdateExistingGroupBox->setCheckable(
false );
134 if ( mUpdateExistingGroupBox->isEnabled() )
136 mUpdateExistingGroupBox->setChecked( !mNewFieldGroupBox->isEnabled() );
140 mUpdateExistingGroupBox->setToolTip( tr(
"Not available for layer" ) );
141 mNewFieldGroupBox->setChecked(
true );
142 mNewFieldGroupBox->setCheckable(
false );
145 if ( ( mNewFieldGroupBox->isChecked() && mCreateVirtualFieldCheckbox->isChecked() ) || mVectorLayer->
isEditable() )
147 mEditModeAutoTurnOnLabel->setVisible(
false );
148 mInfoIcon->setVisible(
false );
152 mInfoIcon->setVisible(
true );
156 mOnlyUpdateSelectedCheckBox->setChecked( mCanChangeAttributeValue && hasselection );
157 mOnlyUpdateSelectedCheckBox->setEnabled( mCanChangeAttributeValue && hasselection );
158 mOnlyUpdateSelectedCheckBox->setText( tr(
"Only update %n selected feature(s)",
nullptr, vl->
selectedFeatureCount() ) );
160 builder->initWithLayer( vl, expContext, QStringLiteral(
"fieldcalc" ) );
162 mInfoIcon->setPixmap( style()->standardPixmap( QStyle::SP_MessageBoxInformation ) );
164 setWindowTitle( tr(
"%1 — Field Calculator" ).arg( mVectorLayer->
name() ) );
168 mMsgBar->setSizePolicy( QSizePolicy::Minimum, QSizePolicy::Fixed );
169 this->vLayout->insertWidget( 0, mMsgBar );
171 setDialogButtonState();
180void QgsFieldCalculator::calculate()
182 builder->expressionTree()->saveToRecent( builder->expressionText(), QStringLiteral(
"fieldcalc" ) );
193 const QString calcString = builder->expressionText();
195 exp.setGeomCalculator( &myDa );
201 if ( !exp.prepare( &expContext ) )
203 QMessageBox::critical(
nullptr, tr(
"Evaluation Error" ), exp.evalErrorString() );
207 bool updatingGeom =
false;
213 if ( ! mUpdateExistingGroupBox->isChecked() && mCreateVirtualFieldCheckbox->isChecked() )
227 if ( mUpdateExistingGroupBox->isChecked() || !mNewFieldGroupBox->isEnabled() )
229 if ( mExistingFieldComboBox->currentData().toString() == QLatin1String(
"geom" ) )
238 const int id = mExistingFieldComboBox->currentData().toInt( &ok );
246 const QgsField newField = fieldDefinition();
250 cursorOverride.release();
251 QMessageBox::critical(
nullptr, tr(
"Create New Field" ), tr(
"Could not add the new field to the provider." ) );
259 for (
int idx = 0; idx < fields.
count(); ++idx )
261 if ( fields.
at( idx ).
name() == mOutputFieldNameLineEdit->text() )
269 expContext.setFields( mVectorLayer->
fields() );
270 if ( ! exp.prepare( &expContext ) )
272 cursorOverride.release();
273 QMessageBox::critical(
nullptr, tr(
"Evaluation Error" ), exp.evalErrorString() );
278 if ( mAttributeId == -1 && !updatingGeom )
286 bool calculationSuccess =
true;
289 const bool useGeometry = exp.needsGeometry();
294 const bool newField = !mUpdateExistingGroupBox->isChecked();
295 QVariant emptyAttribute;
300 QSet< QString > referencedColumns = exp.referencedColumns();
301 referencedColumns.insert( field.
name() );
303 if ( mOnlyUpdateSelectedCheckBox->isChecked() )
309 std::unique_ptr< QgsScopedProxyProgressTask > task = std::make_unique< QgsScopedProxyProgressTask >( tr(
"Calculating field" ) );
315 task->setProgress( i /
static_cast< double >( count ) * 100 );
317 expContext.setFeature( feature );
320 QVariant value = exp.evaluate( &expContext );
321 if ( exp.hasEvalError() )
323 calculationSuccess =
false;
324 error = exp.evalErrorString();
327 else if ( updatingGeom )
329 if ( value.userType() == qMetaTypeId< QgsGeometry>() )
344 if ( !calculationSuccess )
346 cursorOverride.release();
348 QMessageBox::critical(
nullptr, tr(
"Evaluation Error" ), tr(
"An error occurred while evaluating the calculation string:\n%1" ).arg( error ) );
354 if ( mNewFieldGroupBox->isChecked() )
356 pushMessage( tr(
"Field \"%1\" created successfully" ).arg( mOutputFieldNameLineEdit->text() ) );
358 else if ( mUpdateExistingGroupBox->isChecked() )
360 pushMessage( tr(
"Field \"%1\" updated successfully" ).arg( mExistingFieldComboBox->currentText() ) ) ;
365void QgsFieldCalculator::populateOutputFieldTypes()
378 const int oldDataType = mOutputFieldTypeComboBox->currentData( Qt::UserRole +
FTC_TYPE_ROLE_IDX ).toInt();
380 mOutputFieldTypeComboBox->blockSignals(
true );
383 const QList< QgsVectorDataProvider::NativeType > &typelist = mCreateVirtualFieldCheckbox->isChecked() ?
384 ( QList< QgsVectorDataProvider::NativeType >()
398 provider->nativeTypes();
400 mOutputFieldTypeComboBox->clear();
401 for (
int i = 0; i < typelist.size(); i++ )
403 mOutputFieldTypeComboBox->addItem(
QgsFields::iconForFieldType( typelist[i].mType, typelist[i].mSubType, typelist[i].mTypeName ), typelist[i].mTypeDesc );
404 mOutputFieldTypeComboBox->setItemData( i,
static_cast<int>( typelist[i].mType ), Qt::UserRole +
FTC_TYPE_ROLE_IDX );
405 mOutputFieldTypeComboBox->setItemData( i, typelist[i].mTypeName, Qt::UserRole +
FTC_TYPE_NAME_IDX );
406 mOutputFieldTypeComboBox->setItemData( i, typelist[i].mMinLen, Qt::UserRole +
FTC_MINLEN_IDX );
407 mOutputFieldTypeComboBox->setItemData( i, typelist[i].mMaxLen, Qt::UserRole +
FTC_MAXLEN_IDX );
408 mOutputFieldTypeComboBox->setItemData( i, typelist[i].mMinPrec, Qt::UserRole +
FTC_MINPREC_IDX );
409 mOutputFieldTypeComboBox->setItemData( i, typelist[i].mMaxPrec, Qt::UserRole +
FTC_MAXPREC_IDX );
410 mOutputFieldTypeComboBox->setItemData( i,
static_cast<int>( typelist[i].mSubType ), Qt::UserRole +
FTC_SUBTYPE_IDX );
412 mOutputFieldTypeComboBox->blockSignals(
false );
414 const int idx = mOutputFieldTypeComboBox->findData( oldDataType, Qt::UserRole +
FTC_TYPE_ROLE_IDX );
417 mOutputFieldTypeComboBox->setCurrentIndex( idx );
418 mOutputFieldTypeComboBox_activated( idx );
422 mOutputFieldTypeComboBox->setCurrentIndex( 0 );
423 mOutputFieldTypeComboBox_activated( 0 );
427void QgsFieldCalculator::mNewFieldGroupBox_toggled(
bool on )
429 mUpdateExistingGroupBox->setChecked( !on );
430 if ( on && !mCanAddAttribute )
432 mOnlyVirtualFieldsInfoLabel->setVisible(
true );
436 mOnlyVirtualFieldsInfoLabel->setVisible(
false );
439 if ( ( mNewFieldGroupBox->isChecked() && mCreateVirtualFieldCheckbox->isChecked() ) || mVectorLayer->
isEditable() )
441 mEditModeAutoTurnOnLabel->setVisible(
false );
445 mEditModeAutoTurnOnLabel->setVisible(
true );
448 mInfoIcon->setVisible( mOnlyVirtualFieldsInfoLabel->isVisible() || mEditModeAutoTurnOnLabel->isVisible() );
451void QgsFieldCalculator::mUpdateExistingGroupBox_toggled(
bool on )
453 mNewFieldGroupBox->setChecked( !on );
454 setDialogButtonState();
462 mCreateVirtualFieldCheckbox_stateChanged( mCreateVirtualFieldCheckbox->checkState() );
466void QgsFieldCalculator::mCreateVirtualFieldCheckbox_stateChanged(
int state )
468 mOnlyUpdateSelectedCheckBox->setChecked(
false );
469 mOnlyUpdateSelectedCheckBox->setEnabled( state != Qt::Checked && mVectorLayer->
selectedFeatureCount() > 0 );
471 if ( ( mNewFieldGroupBox->isChecked() && mCreateVirtualFieldCheckbox->isChecked() ) || mVectorLayer->
isEditable() )
473 mEditModeAutoTurnOnLabel->setVisible(
false );
477 mEditModeAutoTurnOnLabel->setVisible(
true );
479 populateOutputFieldTypes();
480 mInfoIcon->setVisible( mOnlyVirtualFieldsInfoLabel->isVisible() || mEditModeAutoTurnOnLabel->isVisible() );
484void QgsFieldCalculator::mOutputFieldNameLineEdit_textChanged(
const QString &text )
487 setDialogButtonState();
491void QgsFieldCalculator::mOutputFieldTypeComboBox_activated(
int index )
493 mOutputFieldWidthSpinBox->setMinimum( mOutputFieldTypeComboBox->itemData( index, Qt::UserRole +
FTC_MINLEN_IDX ).toInt() );
494 mOutputFieldWidthSpinBox->setMaximum( mOutputFieldTypeComboBox->itemData( index, Qt::UserRole +
FTC_MAXLEN_IDX ).toInt() );
495 mOutputFieldWidthSpinBox->setEnabled( mOutputFieldWidthSpinBox->minimum() < mOutputFieldWidthSpinBox->maximum() );
496 if ( mOutputFieldWidthSpinBox->value() < mOutputFieldWidthSpinBox->minimum() )
497 mOutputFieldWidthSpinBox->setValue( mOutputFieldWidthSpinBox->minimum() );
498 if ( mOutputFieldWidthSpinBox->value() > mOutputFieldWidthSpinBox->maximum() )
499 mOutputFieldWidthSpinBox->setValue( mOutputFieldWidthSpinBox->maximum() );
501 setPrecisionMinMax();
504void QgsFieldCalculator::populateFields()
510 for (
int idx = 0; idx < fields.
count(); ++idx )
542 const QString fieldName = fields.
at( idx ).
name();
545 mExistingFieldComboBox->addItem( fields.
iconForField( idx ), fieldName, idx );
550 mExistingFieldComboBox->addItem( tr(
"<geometry>" ),
"geom" );
552 QFont font = mExistingFieldComboBox->itemData( mExistingFieldComboBox->count() - 1, Qt::FontRole ).value<QFont>();
553 font.setItalic(
true );
554 mExistingFieldComboBox->setItemData( mExistingFieldComboBox->count() - 1, font, Qt::FontRole );
556 mExistingFieldComboBox->setCurrentIndex( -1 );
559void QgsFieldCalculator::setDialogButtonState()
561 QList<QPushButton *> buttons =
563 mButtonBox->button( QDialogButtonBox::Ok ),
564 mButtonBox->button( QDialogButtonBox::Apply )
567 bool enableButtons =
true;
570 if ( ( mNewFieldGroupBox->isChecked() || !mUpdateExistingGroupBox->isEnabled() )
571 && mOutputFieldNameLineEdit->text().isEmpty() )
573 tooltip = tr(
"Please enter a field name" );
574 enableButtons =
false;
576 else if ( !builder->isExpressionValid() )
578 tooltip = tr(
"The expression is invalid see \"(more info)\" for details" );
579 enableButtons =
false;
582 for ( QPushButton *button : buttons )
586 button->setEnabled( enableButtons );
587 button->setToolTip( tooltip );
592void QgsFieldCalculator::setPrecisionMinMax()
594 const int idx = mOutputFieldTypeComboBox->currentIndex();
595 const int minPrecType = mOutputFieldTypeComboBox->itemData( idx, Qt::UserRole +
FTC_MINPREC_IDX ).toInt();
596 const int maxPrecType = mOutputFieldTypeComboBox->itemData( idx, Qt::UserRole +
FTC_MAXPREC_IDX ).toInt();
597 const bool precisionIsEnabled = minPrecType < maxPrecType;
598 mOutputFieldPrecisionSpinBox->setEnabled( precisionIsEnabled );
602 if ( precisionIsEnabled )
604 mOutputFieldPrecisionSpinBox->setMinimum( minPrecType );
605 mOutputFieldPrecisionSpinBox->setMaximum( std::max( minPrecType, std::min( maxPrecType, mOutputFieldWidthSpinBox->value() ) ) );
609void QgsFieldCalculator::showHelp()
611 QgsHelp::openHelp( QStringLiteral(
"working_with_vector/attribute_table.html#editing-attribute-values" ) );
614QgsField QgsFieldCalculator::fieldDefinition()
616 return QgsField( mOutputFieldNameLineEdit->text(),
617 static_cast< QMetaType::Type
>( mOutputFieldTypeComboBox->currentData( Qt::UserRole +
FTC_TYPE_ROLE_IDX ).toInt() ),
618 mOutputFieldTypeComboBox->currentData( Qt::UserRole +
FTC_TYPE_NAME_IDX ).toString(),
619 mOutputFieldWidthSpinBox->value(),
620 mOutputFieldPrecisionSpinBox->isEnabled() ? mOutputFieldPrecisionSpinBox->value() : 0,
622 static_cast< QMetaType::Type >( mOutputFieldTypeComboBox->currentData( Qt::UserRole +
FTC_SUBTYPE_IDX ).toInt() )
626void QgsFieldCalculator::pushMessage(
const QString &text,
Qgis::MessageLevel level,
int duration )
The Qgis class provides global constants for use throughout the application.
@ AddAttributes
Allows addition of new attributes (fields)
@ ChangeAttributeValues
Allows modification of attribute values.
@ NoFlags
No flags are set.
MessageLevel
Level for messages This will be used both for message log and message bar in application.
QFlags< VectorProviderCapability > VectorProviderCapabilities
Vector data provider capabilities.
@ Provider
Field originates from the underlying data provider of the vector layer.
@ Edit
Field has been temporarily added in editing mode.
@ Unknown
The field origin has not been specified.
@ Expression
Field is calculated from an expression.
@ Join
Field originates from a joined layer.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
void setSourceCrs(const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context)
Sets source spatial reference system crs.
bool setEllipsoid(const QString &ellipsoid)
Sets the ellipsoid by its acronym.
void addVariable(const QgsExpressionContextScope::StaticVariable &variable)
Adds a variable into the context scope.
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
QgsExpressionContextScope * lastScope()
Returns the last scope added to the context.
void setHighlightedVariables(const QStringList &variableNames)
Sets the list of variable names within the context intended to be highlighted to the user.
Class for parsing and evaluation of expressions (formerly called "search strings").
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
This class wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFlags(Qgis::FeatureRequestFlags flags)
Sets flags that affect how features will be fetched.
QgsFeatureRequest & setFilterFids(const QgsFeatureIds &fids)
Sets the feature IDs that should be fetched.
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
QgsFieldCalculator(QgsVectorLayer *vl, QWidget *parent=nullptr)
Encapsulate a field in an attribute table or data source.
bool convertCompatible(QVariant &v, QString *errorMessage=nullptr) const
Converts the provided variant to a compatible format.
QgsEditorWidgetSetup editorWidgetSetup() const
Gets the editor widget setup for the field.
Container of fields for a vector layer.
static QIcon iconForFieldType(QMetaType::Type type, QMetaType::Type subType=QMetaType::Type::UnknownType, const QString &typeString=QString())
Returns an icon corresponding to a field type.
Qgis::FieldOrigin fieldOrigin(int fieldIdx) const
Returns the field's origin (value from an enumeration).
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
QIcon iconForField(int fieldIdx, bool considerOrigin=false) const
Returns an icon corresponding to a field index, based on the field's type and source.
A geometry is the spatial representation of a feature.
static void enableAutoGeometryRestore(QWidget *widget, const QString &key=QString())
Register the widget to allow its position to be automatically saved and restored when open and closed...
static void openHelp(const QString &key)
Opens help topic for the given help key using default system web browser.
QString providerType() const
Returns the provider type (provider key) for this layer.
QgsCoordinateReferenceSystem crs
A bar for displaying non-blocking messages to the user.
void pushMessage(const QString &text, Qgis::MessageLevel level=Qgis::MessageLevel::Info, int duration=-1)
A convenience method for pushing a message with the specified text to the bar.
static QgsProject * instance()
Returns the QgsProject singleton instance.
QgsCoordinateTransformContext transformContext
Temporarily sets a cursor override for the QApplication for the lifetime of the object.
static QString typeToDisplayString(QMetaType::Type type, QMetaType::Type subType=QMetaType::Type::UnknownType)
Returns a user-friendly translated string representing a QVariant type.
static QVariant createNullVariant(QMetaType::Type metaType)
Helper method to properly create a null QVariant from a metaType Returns the created QVariant.
This is the base class for vector data providers.
virtual Q_INVOKABLE Qgis::VectorProviderCapabilities capabilities() const
Returns flags containing the supported capabilities.
const QgsVectorLayerJoinInfo * joinForFieldIndex(int index, const QgsFields &fields, int &sourceFieldIndex) const
Finds the vector join for a layer field index.
Defines left outer join from our vector layer to some other vector layer.
bool isEditable() const
Returns whether joined fields may be edited through the form of the target layer.
Represents a vector layer which manages a vector based data sets.
int addExpressionField(const QString &exp, const QgsField &fld)
Add a new field which is calculated by the expression specified.
Q_INVOKABLE bool startEditing()
Makes the layer editable.
Q_INVOKABLE bool changeAttributeValue(QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant(), bool skipDefaultValues=false, QgsVectorLayerToolsContext *context=nullptr)
Changes an attribute value for a feature (but does not immediately commit the changes).
bool addAttribute(const QgsField &field)
Add an attribute field (but does not commit it) returns true if the field was added.
long long featureCount(const QString &legendKey) const
Number of features rendered with specified legend key.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
int selectedFeatureCount() const
Returns the number of features that are selected in this layer.
void endEditCommand()
Finish edit command and add it to undo/redo stack.
void destroyEditCommand()
Destroy active command and reverts all changes in it.
Q_INVOKABLE const QgsFeatureIds & selectedFeatureIds() const
Returns a list of the selected features IDs in this layer.
bool isEditable() const FINAL
Returns true if the provider is in editing mode.
QString storageType() const
Returns the permanent storage type for this layer as a friendly name.
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
QgsVectorLayerJoinBuffer * joinBuffer()
Returns the join buffer object.
Q_INVOKABLE Qgis::GeometryType geometryType() const
Returns point, line or polygon.
void beginEditCommand(const QString &text)
Create edit command for undo/redo operations.
bool changeGeometry(QgsFeatureId fid, QgsGeometry &geometry, bool skipDefaultValue=false)
Changes a feature's geometry within the layer's edit buffer (but does not immediately commit the chan...
constexpr int FTC_TYPE_NAME_IDX
constexpr int FTC_MINLEN_IDX
constexpr int FTC_TYPE_ROLE_IDX
constexpr int FTC_MAXLEN_IDX
constexpr int FTC_MAXPREC_IDX
constexpr int FTC_MINPREC_IDX
constexpr int FTC_SUBTYPE_IDX
Single variable definition for use within a QgsExpressionContextScope.