QGIS API Documentation 4.3.0-Master (7d9941090cd)
Loading...
Searching...
No Matches
qgsvectorlayer.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsvectorlayer.cpp
3 --------------------
4 begin : Oct 29, 2003
5 copyright : (C) 2003 by Gary E.Sherman
6 email : sherman at mrcc.com
7
8 This class implements a generic means to display vector layers. The features
9 and attributes are read from the data store using a "data provider" plugin.
10 QgsVectorLayer can be used with any data store for which an appropriate
11 plugin is available.
12
13***************************************************************************/
14
15/***************************************************************************
16 * *
17 * This program is free software; you can redistribute it and/or modify *
18 * it under the terms of the GNU General Public License as published by *
19 * the Free Software Foundation; either version 2 of the License, or *
20 * (at your option) any later version. *
21 * *
22 ***************************************************************************/
23
24#include "qgsvectorlayer.h"
25
26#include <limits>
27#include <memory>
28#include <optional>
29
30#include "qgis.h"
31#include "qgsactionmanager.h"
32#include "qgsapplication.h"
33#include "qgsauxiliarystorage.h"
34#include "qgsconditionalstyle.h"
36#include "qgscurve.h"
37#include "qgscurvepolygon.h"
38#include "qgsdatasourceuri.h"
39#include "qgsdiagramrenderer.h"
44#include "qgsfeature.h"
46#include "qgsfeaturerequest.h"
47#include "qgsfeedback.h"
48#include "qgsfields.h"
49#include "qgsgeometry.h"
50#include "qgsgeometryoptions.h"
53#include "qgslogger.h"
54#include "qgsmaplayerfactory.h"
55#include "qgsmaplayerlegend.h"
57#include "qgsmessagelog.h"
59#include "qgsobjectvisitor.h"
60#include "qgsogcutils.h"
61#include "qgspainting.h"
62#include "qgspallabeling.h"
63#include "qgspoint.h"
64#include "qgspointxy.h"
65#include "qgsprofilerequest.h"
66#include "qgsproject.h"
67#include "qgsproviderregistry.h"
68#include "qgsrectangle.h"
69#include "qgsrelationmanager.h"
70#include "qgsrendercontext.h"
71#include "qgsrenderer.h"
73#include "qgsruntimeprofiler.h"
76#include "qgssettingstree.h"
77#include "qgssldexportcontext.h"
79#include "qgssymbollayer.h"
80#include "qgssymbollayerutils.h"
81#include "qgstaskmanager.h"
82#include "qgsthreadingutils.h"
83#include "qgstransaction.h"
97#include "qgsvectorlayerutils.h"
98#include "qgsweakrelation.h"
99#include "qgsxmlutils.h"
100
101#include <QDir>
102#include <QDomNode>
103#include <QFile>
104#include <QImage>
105#include <QPainter>
106#include <QPainterPath>
107#include <QPolygonF>
108#include <QProgressDialog>
109#include <QRegularExpression>
110#include <QString>
111#include <QStringBuilder>
112#include <QTimer>
113#include <QUndoCommand>
114#include <QUrl>
115#include <QUrlQuery>
116#include <QUuid>
117#include <QVector>
118
119#include "moc_qgsvectorlayer.cpp"
120
121using namespace Qt::StringLiterals;
122
130
131
132#ifdef TESTPROVIDERLIB
133#include <dlfcn.h>
134#endif
135
136typedef bool saveStyle_t(
137 const QString &uri, const QString &qmlStyle, const QString &sldStyle, const QString &styleName, const QString &styleDescription, const QString &uiFileContent, bool useAsDefault, QString &errCause
138);
139
140typedef QString loadStyle_t( const QString &uri, QString &errCause );
141
142typedef int listStyles_t( const QString &uri, QStringList &ids, QStringList &names, QStringList &descriptions, QString &errCause );
143
144typedef QString getStyleById_t( const QString &uri, QString styleID, QString &errCause );
145
146typedef bool deleteStyleById_t( const QString &uri, QString styleID, QString &errCause );
147
148
149QgsVectorLayer::QgsVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey, const QgsVectorLayer::LayerOptions &options )
150 : QgsMapLayer( Qgis::LayerType::Vector, baseName, vectorLayerPath )
151 , mSelectionProperties( new QgsVectorLayerSelectionProperties( this ) )
152 , mTemporalProperties( new QgsVectorLayerTemporalProperties( this ) )
153 , mElevationProperties( new QgsVectorLayerElevationProperties( this ) )
154 , mAuxiliaryLayer( nullptr )
155 , mAuxiliaryLayerKey( QString() )
156 , mReadExtentFromXml( options.readExtentFromXml )
157 , mRefreshRendererTimer( new QTimer( this ) )
158{
160 mLoadAllStoredStyle = options.loadAllStoredStyles;
161
162 if ( options.fallbackCrs.isValid() )
163 setCrs( options.fallbackCrs, false );
164 mWkbType = options.fallbackWkbType;
165
166 setProviderType( providerKey );
167
168 mGeometryOptions = std::make_unique<QgsGeometryOptions>();
169 mActions = new QgsActionManager( this );
170 mActions->setParent( this );
171 mConditionalStyles = new QgsConditionalLayerStyles( this );
172 mStoredExpressionManager = new QgsStoredExpressionManager();
173 mStoredExpressionManager->setParent( this );
174
175 mJoinBuffer = new QgsVectorLayerJoinBuffer( this );
176 mJoinBuffer->setParent( this );
177 connect( mJoinBuffer, &QgsVectorLayerJoinBuffer::joinedFieldsChanged, this, &QgsVectorLayer::onJoinedFieldsChanged );
178
179 mExpressionFieldBuffer = std::make_unique<QgsExpressionFieldBuffer>();
180 // if we're given a provider type, try to create and bind one to this layer
181 if ( !vectorLayerPath.isEmpty() && !mProviderKey.isEmpty() )
182 {
183 QgsDataProvider::ProviderOptions providerOptions { options.transformContext };
184 Qgis::DataProviderReadFlags providerFlags;
185 if ( options.loadDefaultStyle )
186 {
188 }
189 if ( options.forceReadOnly )
190 {
192 mDataSourceReadOnly = true;
193 }
194 setDataSource( vectorLayerPath, baseName, providerKey, providerOptions, providerFlags );
195 }
196
197 for ( const QgsField &field : std::as_const( mFields ) )
198 {
199 if ( !mAttributeAliasMap.contains( field.name() ) )
200 mAttributeAliasMap.insert( field.name(), QString() );
201 }
202
203 if ( isValid() )
204 {
205 mTemporalProperties->setDefaultsFromDataProviderTemporalCapabilities( mDataProvider->temporalCapabilities() );
206 if ( !mTemporalProperties->isActive() )
207 {
208 // didn't populate temporal properties from provider metadata, so at least try to setup some initially nice
209 // selections
210 mTemporalProperties->guessDefaultsFromFields( mFields );
211 }
212
213 mElevationProperties->setDefaultsFromLayer( this );
214 }
215
216 connect( this, &QgsVectorLayer::selectionChanged, this, [this] { triggerRepaint(); } );
217 connect( QgsProject::instance()->relationManager(), &QgsRelationManager::relationsLoaded, this, &QgsVectorLayer::onRelationsLoaded ); // skip-keyword-check
218
222
223 // Default simplify drawing settings
224 mSimplifyMethod.setSimplifyHints( QgsVectorLayer::settingsSimplifyDrawingHints->valueWithDefaultOverride( mSimplifyMethod.simplifyHints() ) );
225 mSimplifyMethod.setSimplifyAlgorithm( QgsVectorLayer::settingsSimplifyAlgorithm->valueWithDefaultOverride( mSimplifyMethod.simplifyAlgorithm() ) );
226 mSimplifyMethod.setThreshold( QgsVectorLayer::settingsSimplifyDrawingTol->valueWithDefaultOverride( mSimplifyMethod.threshold() ) );
227 mSimplifyMethod.setForceLocalOptimization( QgsVectorLayer::settingsSimplifyLocal->valueWithDefaultOverride( mSimplifyMethod.forceLocalOptimization() ) );
228 mSimplifyMethod.setMaximumScale( QgsVectorLayer::settingsSimplifyMaxScale->valueWithDefaultOverride( mSimplifyMethod.maximumScale() ) );
229
230 connect( mRefreshRendererTimer, &QTimer::timeout, this, [this] { triggerRepaint( true ); } );
231}
232
234{
235 emit willBeDeleted();
236
237 setValid( false );
238
239 if ( mFeatureCounter )
240 mFeatureCounter->cancel();
241
242 qDeleteAll( mRendererGenerators );
243}
244
246{
248
250 // We get the data source string from the provider when
251 // possible because some providers may have changed it
252 // directly (memory provider does that).
253 QString dataSource;
254 if ( mDataProvider )
255 {
256 dataSource = mDataProvider->dataSourceUri();
257 options.transformContext = mDataProvider->transformContext();
258 }
259 else
260 {
261 dataSource = source();
262 }
263 options.forceReadOnly = mDataSourceReadOnly;
264 QgsVectorLayer *layer = new QgsVectorLayer( dataSource, name(), mProviderKey, options );
265 if ( mDataProvider && layer->dataProvider() )
266 {
267 layer->dataProvider()->handlePostCloneOperations( mDataProvider );
268 }
269 QgsMapLayer::clone( layer );
270 layer->mXmlExtent2D = mXmlExtent2D;
271 layer->mLazyExtent2D = mLazyExtent2D;
272 layer->mValidExtent2D = mValidExtent2D;
273 layer->mXmlExtent3D = mXmlExtent3D;
274 layer->mLazyExtent3D = mLazyExtent3D;
275 layer->mValidExtent3D = mValidExtent3D;
276
277 QList<QgsVectorLayerJoinInfo> joins = vectorJoins();
278 const auto constJoins = joins;
279 for ( const QgsVectorLayerJoinInfo &join : constJoins )
280 {
281 // do not copy join information for auxiliary layer
282 if ( !auxiliaryLayer() || ( auxiliaryLayer() && auxiliaryLayer()->id() != join.joinLayerId() ) )
283 layer->addJoin( join );
284 }
285
286 if ( mDataProvider )
287 layer->setProviderEncoding( mDataProvider->encoding() );
288 layer->setSubsetString( subsetString() );
292 layer->setReadOnly( isReadOnly() );
297
298 const auto constActions = actions()->actions();
299 for ( const QgsAction &action : constActions )
300 {
301 layer->actions()->addAction( action );
302 }
303
304 if ( auto *lRenderer = renderer() )
305 {
306 layer->setRenderer( lRenderer->clone() );
307 }
308
309 if ( auto *lLabeling = labeling() )
310 {
311 layer->setLabeling( lLabeling->clone() );
312 }
314
316
317 if ( auto *lDiagramRenderer = diagramRenderer() )
318 {
319 layer->setDiagramRenderer( lDiagramRenderer->clone() );
320 }
321
322 if ( auto *lDiagramLayerSettings = diagramLayerSettings() )
323 {
324 layer->setDiagramLayerSettings( *lDiagramLayerSettings );
325 }
326
327 for ( int i = 0; i < fields().count(); i++ )
328 {
329 layer->setFieldAlias( i, attributeAlias( i ) );
331 layer->setEditorWidgetSetup( i, editorWidgetSetup( i ) );
334
335 QMap< QgsFieldConstraints::Constraint, QgsFieldConstraints::ConstraintStrength> constraints = fieldConstraintsAndStrength( i );
336 auto constraintIt = constraints.constBegin();
337 for ( ; constraintIt != constraints.constEnd(); ++constraintIt )
338 {
339 layer->setFieldConstraint( i, constraintIt.key(), constraintIt.value() );
340 }
341
342 if ( fields().fieldOrigin( i ) == Qgis::FieldOrigin::Expression )
343 {
344 layer->addExpressionField( expressionField( i ), fields().at( i ) );
345 }
346 }
347
349
350 if ( auto *lAuxiliaryLayer = auxiliaryLayer() )
351 layer->setAuxiliaryLayer( lAuxiliaryLayer->clone( layer ) );
352
353 layer->mElevationProperties = mElevationProperties->clone();
354 layer->mElevationProperties->setParent( layer );
355
356 layer->mSelectionProperties = mSelectionProperties->clone();
357 layer->mSelectionProperties->setParent( layer );
358
359 return layer;
360}
361
363{
365
366 if ( mDataProvider )
367 {
368 return mDataProvider->storageType();
369 }
370 return QString();
371}
372
373
375{
377
378 if ( mDataProvider )
379 {
380 return mDataProvider->capabilitiesString();
381 }
382 return QString();
383}
384
386{
388
389 return mDataProvider && mDataProvider->isSqlQuery();
390}
391
393{
395
396 return mDataProvider ? mDataProvider->vectorLayerTypeFlags() : Qgis::VectorLayerTypeFlags();
397}
398
400{
402
403 if ( mDataProvider )
404 {
405 return mDataProvider->dataComment();
406 }
407 return QString();
408}
409
416
418{
420
421 return name();
422}
423
425{
426 // non fatal for now -- the QgsVirtualLayerTask class is not thread safe and calls this
428
429 if ( mDataProvider )
430 {
431 mDataProvider->reloadData();
432 updateFields();
433 }
434}
435
437{
438 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
440
441 return new QgsVectorLayerRenderer( this, rendererContext );
442}
443
444
445void QgsVectorLayer::drawVertexMarker( double x, double y, QPainter &p, Qgis::VertexMarkerType type, int m )
446{
447 switch ( type )
448 {
450 p.setPen( QColor( 50, 100, 120, 200 ) );
451 p.setBrush( QColor( 200, 200, 210, 120 ) );
452 p.drawEllipse( x - m, y - m, m * 2 + 1, m * 2 + 1 );
453 break;
454
456 p.setPen( QColor( 255, 0, 0 ) );
457 p.drawLine( x - m, y + m, x + m, y - m );
458 p.drawLine( x - m, y - m, x + m, y + m );
459 break;
460
462 break;
463 }
464}
465
467{
469
470 mSelectedFeatureIds.insert( fid );
471 mPreviousSelectedFeatureIds.clear();
472
473 emit selectionChanged( QgsFeatureIds() << fid, QgsFeatureIds(), false );
474}
475
476void QgsVectorLayer::select( const QgsFeatureIds &featureIds )
477{
479
480 mSelectedFeatureIds.unite( featureIds );
481 mPreviousSelectedFeatureIds.clear();
482
483 emit selectionChanged( featureIds, QgsFeatureIds(), false );
484}
485
487{
489
490 mSelectedFeatureIds.remove( fid );
491 mPreviousSelectedFeatureIds.clear();
492
493 emit selectionChanged( QgsFeatureIds(), QgsFeatureIds() << fid, false );
494}
495
497{
499
500 mSelectedFeatureIds.subtract( featureIds );
501 mPreviousSelectedFeatureIds.clear();
502
503 emit selectionChanged( QgsFeatureIds(), featureIds, false );
504}
505
507{
509
510 // normalize the rectangle
511 QgsRectangle normalizedRect = rect;
512 normalizedRect.normalize();
513
514 QgsFeatureIds newSelection;
515
518 );
519
520 QgsFeature feat;
521 while ( features.nextFeature( feat ) )
522 {
523 newSelection << feat.id();
524 }
525 features.close();
526
527 selectByIds( newSelection, behavior );
528}
529
530void QgsVectorLayer::selectByExpression( const QString &expression, Qgis::SelectBehavior behavior, QgsExpressionContext *context )
531{
533
534 QgsFeatureIds newSelection;
535
536 std::optional< QgsExpressionContext > defaultContext;
537 if ( !context )
538 {
539 defaultContext.emplace( QgsExpressionContextUtils::globalProjectLayerScopes( this ) );
540 context = &defaultContext.value();
541 }
542 else
543 {
545 }
546
547 QgsExpression exp( expression );
548 exp.prepare( context );
549
551 {
554
555 if ( !exp.needsGeometry() )
557
558 QgsFeatureIterator features = getFeatures( request );
559
560 if ( behavior == Qgis::SelectBehavior::AddToSelection )
561 {
562 newSelection = selectedFeatureIds();
563 }
564 QgsFeature feat;
565 while ( features.nextFeature( feat ) )
566 {
567 newSelection << feat.id();
568 }
569 features.close();
570 }
572 {
573 QgsFeatureIds oldSelection = selectedFeatureIds();
574 QgsFeatureRequest request = QgsFeatureRequest().setFilterFids( oldSelection );
575
576 //refine request
577 if ( !exp.needsGeometry() )
580
581 QgsFeatureIterator features = getFeatures( request );
582 QgsFeature feat;
583 while ( features.nextFeature( feat ) )
584 {
585 context->setFeature( feat );
586 bool matches = exp.evaluate( context ).toBool();
587
588 if ( matches && behavior == Qgis::SelectBehavior::IntersectSelection )
589 {
590 newSelection << feat.id();
591 }
592 else if ( !matches && behavior == Qgis::SelectBehavior::RemoveFromSelection )
593 {
594 newSelection << feat.id();
595 }
596 }
597 }
598
599 selectByIds( newSelection );
600}
601
602void QgsVectorLayer::selectByIds( const QgsFeatureIds &ids, Qgis::SelectBehavior behavior, bool validateIds )
603{
605
606 // Opt-in validation: filter invalid IDs if requested
607 QgsFeatureIds idsToSelect = ids;
608 if ( validateIds )
609 {
611 }
612
613 QgsFeatureIds newSelection;
614
615 switch ( behavior )
616 {
618 newSelection = idsToSelect;
619 break;
620
622 newSelection = mSelectedFeatureIds + idsToSelect;
623 break;
624
626 newSelection = mSelectedFeatureIds - idsToSelect;
627 break;
628
630 newSelection = mSelectedFeatureIds.intersect( idsToSelect );
631 break;
632 }
633
634 QgsFeatureIds deselectedFeatures = mSelectedFeatureIds - newSelection;
635 mSelectedFeatureIds = newSelection;
636 mPreviousSelectedFeatureIds.clear();
637
638 emit selectionChanged( newSelection, deselectedFeatures, true );
639}
640
641void QgsVectorLayer::modifySelection( const QgsFeatureIds &selectIds, const QgsFeatureIds &deselectIds )
642{
644
645 QgsFeatureIds intersectingIds = selectIds & deselectIds;
646 if ( !intersectingIds.isEmpty() )
647 {
648 QgsDebugMsgLevel( u"Trying to select and deselect the same item at the same time. Unsure what to do. Selecting dubious items."_s, 3 );
649 }
650
651 mSelectedFeatureIds -= deselectIds;
652 mSelectedFeatureIds += selectIds;
653 mPreviousSelectedFeatureIds.clear();
654
655 emit selectionChanged( selectIds, deselectIds - intersectingIds, false );
656}
657
659{
661
663 ids.subtract( mSelectedFeatureIds );
664 selectByIds( ids );
665}
666
673
675{
677
678 // normalize the rectangle
679 QgsRectangle normalizedRect = rect;
680 normalizedRect.normalize();
681
683
684 QgsFeatureIds selectIds;
685 QgsFeatureIds deselectIds;
686
687 QgsFeature fet;
688 while ( fit.nextFeature( fet ) )
689 {
690 if ( mSelectedFeatureIds.contains( fet.id() ) )
691 {
692 deselectIds << fet.id();
693 }
694 else
695 {
696 selectIds << fet.id();
697 }
698 }
699
700 modifySelection( selectIds, deselectIds );
701}
702
704{
706
707 if ( mSelectedFeatureIds.isEmpty() )
708 return;
709
710 const QgsFeatureIds previous = mSelectedFeatureIds;
712 mPreviousSelectedFeatureIds = previous;
713}
714
716{
718
719 if ( mPreviousSelectedFeatureIds.isEmpty() || !mSelectedFeatureIds.empty() )
720 return;
721
722 selectByIds( mPreviousSelectedFeatureIds );
723}
724
726{
727 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
729
730 return mDataProvider;
731}
732
734{
735 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
737
738 return mDataProvider;
739}
740
742{
743 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
745
746 return mSelectionProperties;
747}
748
755
762
764{
766
767 QgsProfileRequest modifiedRequest( request );
768 modifiedRequest.expressionContext().appendScope( createExpressionContextScope() );
769 return new QgsVectorLayerProfileGenerator( this, modifiedRequest );
770}
771
772void QgsVectorLayer::setProviderEncoding( const QString &encoding )
773{
775
776 if ( isValid() && mDataProvider && mDataProvider->encoding() != encoding )
777 {
778 mDataProvider->setEncoding( encoding );
779 updateFields();
780 }
781}
782
784{
786
787 mDiagramRenderer.reset( r );
788 emit rendererChanged();
789 emit styleChanged();
790}
791
793{
794 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
796
797 return QgsWkbTypes::geometryType( mWkbType );
798}
799
801{
803
804 return mWkbType;
805}
806
808{
810
811 if ( !isValid() || !isSpatial() || mSelectedFeatureIds.isEmpty() || !mDataProvider ) //no selected features
812 {
813 return QgsRectangle( 0, 0, 0, 0 );
814 }
815
816 QgsRectangle r, retval;
817 retval.setNull();
818
819 QgsFeature fet;
820 if ( mDataProvider->capabilities() & Qgis::VectorProviderCapability::SelectAtId )
821 {
822 QgsFeatureIterator fit = getFeatures( QgsFeatureRequest().setFilterFids( mSelectedFeatureIds ).setNoAttributes() );
823
824 while ( fit.nextFeature( fet ) )
825 {
826 if ( !fet.hasGeometry() )
827 continue;
828 r = fet.geometry().boundingBox();
829 retval.combineExtentWith( r );
830 }
831 }
832 else
833 {
834 QgsFeatureIterator fit = getFeatures( QgsFeatureRequest().setNoAttributes() );
835
836 while ( fit.nextFeature( fet ) )
837 {
838 if ( mSelectedFeatureIds.contains( fet.id() ) )
839 {
840 if ( fet.hasGeometry() )
841 {
842 r = fet.geometry().boundingBox();
843 retval.combineExtentWith( r );
844 }
845 }
846 }
847 }
848
849 if ( retval.width() == 0.0 || retval.height() == 0.0 )
850 {
851 // If all of the features are at the one point, buffer the
852 // rectangle a bit. If they are all at zero, do something a bit
853 // more crude.
854
855 if ( retval.xMinimum() == 0.0 && retval.xMaximum() == 0.0 && retval.yMinimum() == 0.0 && retval.yMaximum() == 0.0 )
856 {
857 retval.set( -1.0, -1.0, 1.0, 1.0 );
858 }
859 }
860
861 return retval;
862}
863
865{
866 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
868
869 return mLabelsEnabled && static_cast< bool >( mLabeling );
870}
871
873{
875
876 mLabelsEnabled = enabled;
877}
878
880{
881 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
883
884 if ( !mDiagramRenderer || !mDiagramLayerSettings )
885 return false;
886
887 QList<QgsDiagramSettings> settingList = mDiagramRenderer->diagramSettings();
888 if ( !settingList.isEmpty() )
889 {
890 return settingList.at( 0 ).enabled;
891 }
892 return false;
893}
894
895long long QgsVectorLayer::featureCount( const QString &legendKey ) const
896{
898
899 if ( !mSymbolFeatureCounted )
900 return -1;
901
902 return mSymbolFeatureCountMap.value( legendKey, -1 );
903}
904
905QgsFeatureIds QgsVectorLayer::symbolFeatureIds( const QString &legendKey ) const
906{
908
909 if ( !mSymbolFeatureCounted )
910 return QgsFeatureIds();
911
912 return mSymbolFeatureIdMap.value( legendKey, QgsFeatureIds() );
913}
915{
917
918 if ( ( mSymbolFeatureCounted || mFeatureCounter ) && !( storeSymbolFids && mSymbolFeatureIdMap.isEmpty() ) )
919 return mFeatureCounter;
920
921 mSymbolFeatureCountMap.clear();
922 mSymbolFeatureIdMap.clear();
923
924 if ( !isValid() )
925 {
926 QgsDebugMsgLevel( u"invoked with invalid layer"_s, 3 );
927 return mFeatureCounter;
928 }
929 if ( !mDataProvider )
930 {
931 QgsDebugMsgLevel( u"invoked with null mDataProvider"_s, 3 );
932 return mFeatureCounter;
933 }
934 if ( !mRenderer )
935 {
936 QgsDebugMsgLevel( u"invoked with null mRenderer"_s, 3 );
937 return mFeatureCounter;
938 }
939
940 if ( !mFeatureCounter || ( storeSymbolFids && mSymbolFeatureIdMap.isEmpty() ) )
941 {
942 mFeatureCounter = new QgsVectorLayerFeatureCounter( this, QgsExpressionContext(), storeSymbolFids );
943 connect( mFeatureCounter, &QgsTask::taskCompleted, this, &QgsVectorLayer::onFeatureCounterCompleted, Qt::UniqueConnection );
944 connect( mFeatureCounter, &QgsTask::taskTerminated, this, &QgsVectorLayer::onFeatureCounterTerminated, Qt::UniqueConnection );
945 QgsApplication::taskManager()->addTask( mFeatureCounter );
946 }
947
948 return mFeatureCounter;
949}
950
952{
954
955 // do not update extent by default when trust project option is activated
956 if ( force || !mReadExtentFromXml || ( mReadExtentFromXml && mXmlExtent2D.isNull() && mXmlExtent3D.isNull() ) )
957 {
958 mValidExtent2D = false;
959 mValidExtent3D = false;
960 }
961}
962
964{
966
968 mValidExtent2D = true;
969}
970
972{
974
976 mValidExtent3D = true;
977}
978
979void QgsVectorLayer::updateDefaultValues( QgsFeatureId fid, QgsFeature feature, QgsExpressionContext *context )
980{
982
983 if ( !mDefaultValueOnUpdateFields.isEmpty() )
984 {
985 if ( !feature.isValid() )
986 feature = getFeature( fid );
987
988 int size = mFields.size();
989 for ( int idx : std::as_const( mDefaultValueOnUpdateFields ) )
990 {
991 if ( idx < 0 || idx >= size )
992 continue;
993 feature.setAttribute( idx, defaultValue( idx, feature, context ) );
994 updateFeature( feature, true );
995 }
996 }
997}
998
1000{
1002
1003 QgsRectangle rect;
1004 rect.setNull();
1005
1006 if ( !isSpatial() )
1007 return rect;
1008
1009 // Don't do lazy extent if the layer is currently in edit mode
1010 if ( mLazyExtent2D && isEditable() )
1011 mLazyExtent2D = false;
1012
1013 if ( mDataProvider && mDataProvider->isValid() && ( mDataProvider->flags() & Qgis::DataProviderFlag::FastExtent2D ) )
1014 {
1015 // Provider has a trivial 2D extent calculation => always get extent from provider.
1016 // Things are nice and simple this way, e.g. we can always trust that this extent is
1017 // accurate and up to date.
1018 updateExtent( mDataProvider->extent() );
1019 mValidExtent2D = true;
1020 mLazyExtent2D = false;
1021 }
1022 else
1023 {
1024 if ( !mValidExtent2D && mLazyExtent2D && mReadExtentFromXml && !mXmlExtent2D.isNull() )
1025 {
1026 updateExtent( mXmlExtent2D );
1027 mValidExtent2D = true;
1028 mLazyExtent2D = false;
1029 }
1030
1031 if ( !mValidExtent2D && mLazyExtent2D && mDataProvider && mDataProvider->isValid() )
1032 {
1033 // store the extent
1034 updateExtent( mDataProvider->extent() );
1035 mValidExtent2D = true;
1036 mLazyExtent2D = false;
1037
1038 // show the extent
1039 QgsDebugMsgLevel( u"2D Extent of layer: %1"_s.arg( mExtent2D.toString() ), 3 );
1040 }
1041 }
1042
1043 if ( mValidExtent2D )
1044 return QgsMapLayer::extent();
1045
1046 if ( !isValid() || !mDataProvider )
1047 {
1048 QgsDebugMsgLevel( u"invoked with invalid layer or null mDataProvider"_s, 3 );
1049 return rect;
1050 }
1051
1052 if ( !mEditBuffer
1053 || ( !mDataProvider->transaction() && ( mEditBuffer->deletedFeatureIds().isEmpty() && mEditBuffer->changedGeometries().isEmpty() ) )
1054 || QgsDataSourceUri( mDataProvider->dataSourceUri() ).useEstimatedMetadata() )
1055 {
1056 mDataProvider->updateExtents();
1057
1058 // get the extent of the layer from the provider
1059 // but only when there are some features already
1060 if ( mDataProvider->featureCount() != 0 )
1061 {
1062 const QgsRectangle r = mDataProvider->extent();
1063 rect.combineExtentWith( r );
1064 }
1065
1066 if ( mEditBuffer && !mDataProvider->transaction() )
1067 {
1068 const auto addedFeatures = mEditBuffer->addedFeatures();
1069 for ( QgsFeatureMap::const_iterator it = addedFeatures.constBegin(); it != addedFeatures.constEnd(); ++it )
1070 {
1071 if ( it->hasGeometry() )
1072 {
1073 const QgsRectangle r = it->geometry().boundingBox();
1074 rect.combineExtentWith( r );
1075 }
1076 }
1077 }
1078 }
1079 else
1080 {
1081 QgsFeatureIterator fit = getFeatures( QgsFeatureRequest().setNoAttributes() );
1082
1083 QgsFeature fet;
1084 while ( fit.nextFeature( fet ) )
1085 {
1086 if ( fet.hasGeometry() && fet.geometry().type() != Qgis::GeometryType::Unknown )
1087 {
1088 const QgsRectangle bb = fet.geometry().boundingBox();
1089 rect.combineExtentWith( bb );
1090 }
1091 }
1092 }
1093
1094 if ( rect.xMinimum() > rect.xMaximum() && rect.yMinimum() > rect.yMaximum() )
1095 {
1096 // special case when there are no features in provider nor any added
1097 rect = QgsRectangle(); // use rectangle with zero coordinates
1098 }
1099
1100 updateExtent( rect );
1101 mValidExtent2D = true;
1102
1103 // Send this (hopefully) up the chain to the map canvas
1104 emit recalculateExtents();
1105
1106 return rect;
1107}
1108
1110{
1112
1113 // if data is 2D, redirect to 2D extend computation, and save it as 2D extent (in 3D bbox)
1114 if ( mDataProvider && mDataProvider->elevationProperties() && !mDataProvider->elevationProperties()->containsElevationData() )
1115 {
1116 return QgsBox3D( extent() );
1117 }
1118
1120 extent.setNull();
1121
1122 if ( !isSpatial() )
1123 return extent;
1124
1125 if ( mDataProvider && mDataProvider->isValid() && ( mDataProvider->flags() & Qgis::DataProviderFlag::FastExtent3D ) )
1126 {
1127 // Provider has a trivial 3D extent calculation => always get extent from provider.
1128 // Things are nice and simple this way, e.g. we can always trust that this extent is
1129 // accurate and up to date.
1130 updateExtent( mDataProvider->extent3D() );
1131 mValidExtent3D = true;
1132 mLazyExtent3D = false;
1133 }
1134 else
1135 {
1136 if ( !mValidExtent3D && mLazyExtent3D && mReadExtentFromXml && !mXmlExtent3D.isNull() )
1137 {
1138 updateExtent( mXmlExtent3D );
1139 mValidExtent3D = true;
1140 mLazyExtent3D = false;
1141 }
1142
1143 if ( !mValidExtent3D && mLazyExtent3D && mDataProvider && mDataProvider->isValid() )
1144 {
1145 // store the extent
1146 updateExtent( mDataProvider->extent3D() );
1147 mValidExtent3D = true;
1148 mLazyExtent3D = false;
1149
1150 // show the extent
1151 QgsDebugMsgLevel( u"3D Extent of layer: %1"_s.arg( mExtent3D.toString() ), 3 );
1152 }
1153 }
1154
1155 if ( mValidExtent3D )
1156 return QgsMapLayer::extent3D();
1157
1158 if ( !isValid() || !mDataProvider )
1159 {
1160 QgsDebugMsgLevel( u"invoked with invalid layer or null mDataProvider"_s, 3 );
1161 return extent;
1162 }
1163
1164 if ( !mEditBuffer
1165 || ( !mDataProvider->transaction() && ( mEditBuffer->deletedFeatureIds().isEmpty() && mEditBuffer->changedGeometries().isEmpty() ) )
1166 || QgsDataSourceUri( mDataProvider->dataSourceUri() ).useEstimatedMetadata() )
1167 {
1168 mDataProvider->updateExtents();
1169
1170 // get the extent of the layer from the provider
1171 // but only when there are some features already
1172 if ( mDataProvider->featureCount() != 0 )
1173 {
1174 const QgsBox3D ext = mDataProvider->extent3D();
1175 extent.combineWith( ext );
1176 }
1177
1178 if ( mEditBuffer && !mDataProvider->transaction() )
1179 {
1180 const auto addedFeatures = mEditBuffer->addedFeatures();
1181 for ( QgsFeatureMap::const_iterator it = addedFeatures.constBegin(); it != addedFeatures.constEnd(); ++it )
1182 {
1183 if ( it->hasGeometry() )
1184 {
1185 const QgsBox3D bbox = it->geometry().boundingBox3D();
1186 extent.combineWith( bbox );
1187 }
1188 }
1189 }
1190 }
1191 else
1192 {
1193 QgsFeatureIterator fit = getFeatures( QgsFeatureRequest().setNoAttributes() );
1194
1195 QgsFeature fet;
1196 while ( fit.nextFeature( fet ) )
1197 {
1198 if ( fet.hasGeometry() && fet.geometry().type() != Qgis::GeometryType::Unknown )
1199 {
1200 const QgsBox3D bb = fet.geometry().boundingBox3D();
1201 extent.combineWith( bb );
1202 }
1203 }
1204 }
1205
1206 if ( extent.xMinimum() > extent.xMaximum() && extent.yMinimum() > extent.yMaximum() && extent.zMinimum() > extent.zMaximum() )
1207 {
1208 // special case when there are no features in provider nor any added
1209 extent = QgsBox3D(); // use rectangle with zero coordinates
1210 }
1211
1212 updateExtent( extent );
1213 mValidExtent3D = true;
1214
1215 // Send this (hopefully) up the chain to the map canvas
1216 emit recalculateExtents();
1217
1218 return extent;
1219}
1220
1227
1234
1236{
1238
1239 if ( !isValid() || !mDataProvider )
1240 {
1241 QgsDebugMsgLevel( u"invoked with invalid layer or null mDataProvider"_s, 3 );
1242 return customProperty( u"storedSubsetString"_s ).toString();
1243 }
1244 return mDataProvider->subsetString();
1245}
1246
1247bool QgsVectorLayer::setSubsetString( const QString &subset )
1248{
1250
1251 if ( !isValid() || !mDataProvider )
1252 {
1253 QgsDebugMsgLevel( u"invoked with invalid layer or null mDataProvider or while editing"_s, 3 );
1254 setCustomProperty( u"storedSubsetString"_s, subset );
1255 return false;
1256 }
1257 else if ( mEditBuffer )
1258 {
1259 QgsDebugMsgLevel( u"invoked while editing"_s, 3 );
1260 return false;
1261 }
1262
1263 if ( subset == mDataProvider->subsetString() )
1264 return true;
1265
1266 bool res = mDataProvider->setSubsetString( subset );
1267
1268 // get the updated data source string from the provider
1269 mDataSource = mDataProvider->dataSourceUri();
1270 updateExtents();
1271 updateFields();
1272
1273 if ( res )
1274 {
1275 emit subsetStringChanged();
1277 }
1278
1279 return res;
1280}
1281
1283{
1284 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
1286
1287 if ( isValid()
1288 && mDataProvider
1289 && !mEditBuffer
1291 && ( mSimplifyMethod.simplifyHints() & simplifyHint )
1292 && renderContext.useRenderingOptimization() )
1293 {
1294 double maximumSimplificationScale = mSimplifyMethod.maximumScale();
1295
1296 // check maximum scale at which generalisation should be carried out
1297 return !( maximumSimplificationScale > 1 && renderContext.rendererScale() <= maximumSimplificationScale );
1298 }
1299 return false;
1300}
1301
1303{
1305
1306 return mConditionalStyles;
1307}
1308
1310{
1311 // non fatal for now -- the aggregate expression functions are not thread safe and call this
1313
1314 if ( !isValid() || !mDataProvider )
1315 return QgsFeatureIterator();
1316
1317 return QgsFeatureIterator( new QgsVectorLayerFeatureIterator( new QgsVectorLayerFeatureSource( this ), true, request ) );
1318}
1319
1321{
1323
1324 QgsFeature feature;
1326 if ( feature.isValid() )
1327 return feature.geometry();
1328 else
1329 return QgsGeometry();
1330}
1331
1333{
1335
1336 if ( !isValid() || !mEditBuffer || !mDataProvider )
1337 return false;
1338
1339
1340 if ( mGeometryOptions->isActive() )
1341 {
1342 QgsGeometry geom = feature.geometry();
1343 mGeometryOptions->apply( geom );
1344 feature.setGeometry( geom );
1345 }
1346
1347 bool success = mEditBuffer->addFeature( feature );
1348
1349 if ( success && mJoinBuffer->containsJoins() )
1350 {
1351 success = mJoinBuffer->addFeature( feature );
1352 }
1353
1354 return success;
1355}
1356
1357bool QgsVectorLayer::updateFeature( QgsFeature &updatedFeature, bool skipDefaultValues )
1358{
1360
1361 if ( !mEditBuffer || !mDataProvider )
1362 {
1363 return false;
1364 }
1365
1366 QgsFeature currentFeature = getFeature( updatedFeature.id() );
1367 if ( currentFeature.isValid() )
1368 {
1369 bool hasChanged = false;
1370 bool hasError = false;
1371
1372 if ( ( updatedFeature.hasGeometry() || currentFeature.hasGeometry() ) && !updatedFeature.geometry().isExactlyEqual( currentFeature.geometry() ) )
1373 {
1374 QgsGeometry geometry = updatedFeature.geometry();
1375 if ( changeGeometry( updatedFeature.id(), geometry, true ) )
1376 {
1377 hasChanged = true;
1378 updatedFeature.setGeometry( geometry );
1379 }
1380 else
1381 {
1382 QgsDebugMsgLevel( u"geometry of feature %1 could not be changed."_s.arg( updatedFeature.id() ), 3 );
1383 }
1384 }
1385
1386 QgsAttributes fa = updatedFeature.attributes();
1387 QgsAttributes ca = currentFeature.attributes();
1388
1389 for ( int attr = 0; attr < fa.count(); ++attr )
1390 {
1391 if ( !qgsVariantEqual( fa.at( attr ), ca.at( attr ) ) )
1392 {
1393 if ( changeAttributeValue( updatedFeature.id(), attr, fa.at( attr ), ca.at( attr ), true ) )
1394 {
1395 hasChanged = true;
1396 }
1397 else
1398 {
1399 QgsDebugMsgLevel( u"attribute %1 of feature %2 could not be changed."_s.arg( attr ).arg( updatedFeature.id() ), 3 );
1400 hasError = true;
1401 }
1402 }
1403 }
1404 if ( hasChanged && !mDefaultValueOnUpdateFields.isEmpty() && !skipDefaultValues )
1405 updateDefaultValues( updatedFeature.id(), updatedFeature );
1406
1407 return !hasError;
1408 }
1409 else
1410 {
1411 QgsDebugMsgLevel( u"feature %1 could not be retrieved"_s.arg( updatedFeature.id() ), 3 );
1412 return false;
1413 }
1414}
1415
1416
1417bool QgsVectorLayer::insertVertex( double x, double y, QgsFeatureId atFeatureId, int beforeVertex )
1418{
1420
1421 if ( !isValid() || !mEditBuffer || !mDataProvider )
1422 return false;
1423
1424 QgsVectorLayerEditUtils utils( this );
1425 bool result = utils.insertVertex( x, y, atFeatureId, beforeVertex );
1426 if ( result )
1427 updateExtents();
1428 return result;
1429}
1430
1431
1432bool QgsVectorLayer::insertVertex( const QgsPoint &point, QgsFeatureId atFeatureId, int beforeVertex )
1433{
1435
1436 if ( !isValid() || !mEditBuffer || !mDataProvider )
1437 return false;
1438
1439 QgsVectorLayerEditUtils utils( this );
1440 bool result = utils.insertVertex( point, atFeatureId, beforeVertex );
1441 if ( result )
1442 updateExtents();
1443 return result;
1444}
1445
1446
1447bool QgsVectorLayer::moveVertex( double x, double y, QgsFeatureId atFeatureId, int atVertex )
1448{
1450
1451 if ( !isValid() || !mEditBuffer || !mDataProvider )
1452 return false;
1453
1454 QgsVectorLayerEditUtils utils( this );
1455 bool result = utils.moveVertex( x, y, atFeatureId, atVertex );
1456
1457 if ( result )
1458 updateExtents();
1459 return result;
1460}
1461
1462bool QgsVectorLayer::moveVertex( const QgsPoint &p, QgsFeatureId atFeatureId, int atVertex )
1463{
1465
1466 if ( !isValid() || !mEditBuffer || !mDataProvider )
1467 return false;
1468
1469 QgsVectorLayerEditUtils utils( this );
1470 bool result = utils.moveVertex( p, atFeatureId, atVertex );
1471
1472 if ( result )
1473 updateExtents();
1474 return result;
1475}
1476
1478{
1479 return deleteVertices( featureId, { vertex } );
1480}
1481
1483{
1485
1486 if ( !isValid() || !mEditBuffer || !mDataProvider )
1488
1489 QgsVectorLayerEditUtils utils( this );
1490 Qgis::VectorEditResult result = utils.deleteVertices( featureId, vertices );
1491
1493 updateExtents();
1494 return result;
1495}
1496
1498{
1500
1501 if ( !isValid() || !mDataProvider || !( mDataProvider->capabilities() & Qgis::VectorProviderCapability::DeleteFeatures ) )
1502 {
1503 return false;
1504 }
1505
1506 if ( !isEditable() )
1507 {
1508 return false;
1509 }
1510
1511 int deleted = 0;
1512 int count = mSelectedFeatureIds.size();
1513 // Make a copy since deleteFeature modifies mSelectedFeatureIds
1514 QgsFeatureIds selectedFeatures( mSelectedFeatureIds );
1515 for ( QgsFeatureId fid : std::as_const( selectedFeatures ) )
1516 {
1517 deleted += deleteFeature( fid, context ); // removes from selection
1518 }
1519
1521 updateExtents();
1522
1523 if ( deletedCount )
1524 {
1525 *deletedCount = deleted;
1526 }
1527
1528 return deleted == count;
1529}
1530
1531static const QgsPointSequence vectorPointXY2pointSequence( const QVector<QgsPointXY> &points )
1532{
1533 QgsPointSequence pts;
1534 pts.reserve( points.size() );
1535 QVector<QgsPointXY>::const_iterator it = points.constBegin();
1536 while ( it != points.constEnd() )
1537 {
1538 pts.append( QgsPoint( *it ) );
1539 ++it;
1540 }
1541 return pts;
1542}
1543Qgis::GeometryOperationResult QgsVectorLayer::addRing( const QVector<QgsPointXY> &ring, QgsFeatureId *featureId )
1544{
1546
1547 return addRing( vectorPointXY2pointSequence( ring ), featureId );
1548}
1549
1551{
1553
1554 if ( !isValid() || !mEditBuffer || !mDataProvider )
1556
1557 QgsVectorLayerEditUtils utils( this );
1559
1560 //first try with selected features
1561 if ( !mSelectedFeatureIds.isEmpty() )
1562 {
1563 result = utils.addRing( ring, mSelectedFeatureIds, featureId );
1564 }
1565
1567 {
1568 //try with all intersecting features
1569 result = utils.addRing( ring, QgsFeatureIds(), featureId );
1570 }
1571
1572 return result;
1573}
1574
1576{
1578
1579 std::unique_ptr<QgsCurve> uniquePtrRing( ring );
1580
1581 if ( !isValid() || !mEditBuffer || !mDataProvider )
1583
1584 if ( !uniquePtrRing )
1586
1587 if ( !uniquePtrRing->isClosed() )
1589
1590 QgsVectorLayerEditUtils utils( this );
1592
1593 //first try with selected features
1594 if ( !mSelectedFeatureIds.isEmpty() )
1595 {
1596 result = utils.addRing( static_cast< QgsCurve * >( uniquePtrRing->clone() ), mSelectedFeatureIds, featureId );
1597 }
1598
1600 {
1601 //try with all intersecting features
1602 result = utils.addRing( static_cast< QgsCurve * >( uniquePtrRing.release() ), QgsFeatureIds(), featureId );
1603 }
1604
1605 return result;
1606}
1607
1609{
1611
1612 QgsPointSequence pts;
1613 pts.reserve( points.size() );
1614 for ( QList<QgsPointXY>::const_iterator it = points.constBegin(); it != points.constEnd(); ++it )
1615 {
1616 pts.append( QgsPoint( *it ) );
1617 }
1618 return addPart( pts );
1619}
1620
1622{
1624
1625 if ( !isValid() || !mEditBuffer || !mDataProvider )
1627
1628 //number of selected features must be 1
1629
1630 if ( mSelectedFeatureIds.empty() )
1631 {
1632 QgsDebugMsgLevel( u"Number of selected features <1"_s, 3 );
1634 }
1635 else if ( mSelectedFeatureIds.size() > 1 )
1636 {
1637 QgsDebugMsgLevel( u"Number of selected features >1"_s, 3 );
1639 }
1640
1641 QgsVectorLayerEditUtils utils( this );
1642 Qgis::GeometryOperationResult result = utils.addPart( points, *mSelectedFeatureIds.constBegin() );
1643
1645 updateExtents();
1646 return result;
1647}
1648
1650{
1652
1653 std::unique_ptr<QgsCurve> uniquePtrRing( ring );
1654
1655 if ( !isValid() || !mEditBuffer || !mDataProvider )
1657
1658 //number of selected features must be 1
1659
1660 if ( mSelectedFeatureIds.empty() )
1661 {
1662 QgsDebugMsgLevel( u"Number of selected features <1"_s, 3 );
1664 }
1665 else if ( mSelectedFeatureIds.size() > 1 )
1666 {
1667 QgsDebugMsgLevel( u"Number of selected features >1"_s, 3 );
1669 }
1670
1671 QgsVectorLayerEditUtils utils( this );
1672 Qgis::GeometryOperationResult result = utils.addPart( uniquePtrRing.release(), *mSelectedFeatureIds.constBegin() );
1673
1675 updateExtents();
1676 return result;
1677}
1678
1680{
1682
1683 std::unique_ptr<QgsCurvePolygon> uniquePtrPolygon( polygon );
1684
1685 if ( !isValid() || !mEditBuffer || !mDataProvider )
1687
1688 //number of selected features must be 1
1689
1690 if ( mSelectedFeatureIds.empty() )
1691 {
1692 QgsDebugMsgLevel( u"Number of selected features <1"_s, 3 );
1694 }
1695 else if ( mSelectedFeatureIds.size() > 1 )
1696 {
1697 QgsDebugMsgLevel( u"Number of selected features >1"_s, 3 );
1699 }
1700
1701 QgsVectorLayerEditUtils utils( this );
1702 Qgis::GeometryOperationResult result = utils.addPart( uniquePtrPolygon.release(), *mSelectedFeatureIds.constBegin() );
1703
1705 updateExtents();
1706 return result;
1707}
1708
1709// TODO QGIS 5.0 -- this should return Qgis::GeometryOperationResult, not int
1710int QgsVectorLayer::translateFeature( QgsFeatureId featureId, double dx, double dy )
1711{
1713
1714 if ( !isValid() || !mEditBuffer || !mDataProvider )
1715 return static_cast< int >( Qgis::GeometryOperationResult::LayerNotEditable );
1716
1717 QgsVectorLayerEditUtils utils( this );
1718 int result = utils.translateFeature( featureId, dx, dy );
1719
1720 if ( result == static_cast< int >( Qgis::GeometryOperationResult::Success ) )
1721 updateExtents();
1722 return result;
1723}
1724
1725Qgis::GeometryOperationResult QgsVectorLayer::splitParts( const QVector<QgsPointXY> &splitLine, bool topologicalEditing )
1726{
1728
1729 return splitParts( vectorPointXY2pointSequence( splitLine ), topologicalEditing );
1730}
1731
1733{
1735
1736 if ( !isValid() || !mEditBuffer || !mDataProvider )
1738
1739 QgsVectorLayerEditUtils utils( this );
1740 return utils.splitParts( splitLine, topologicalEditing );
1741}
1742
1743Qgis::GeometryOperationResult QgsVectorLayer::splitFeatures( const QVector<QgsPointXY> &splitLine, bool topologicalEditing )
1744{
1746
1747 return splitFeatures( vectorPointXY2pointSequence( splitLine ), topologicalEditing );
1748}
1749
1751{
1753
1754 QgsLineString splitLineString( splitLine );
1755 QgsPointSequence topologyTestPoints;
1756 bool preserveCircular = false;
1757 return splitFeatures( &splitLineString, topologyTestPoints, preserveCircular, topologicalEditing );
1758}
1759
1760Qgis::GeometryOperationResult QgsVectorLayer::splitFeatures( const QgsCurve *curve, QgsPointSequence &topologyTestPoints, bool preserveCircular, bool topologicalEditing )
1761{
1763
1764 if ( !isValid() || !mEditBuffer || !mDataProvider )
1766
1767 QgsVectorLayerEditUtils utils( this );
1768 return utils.splitFeatures( curve, topologyTestPoints, preserveCircular, topologicalEditing );
1769}
1770
1772{
1774
1775 if ( !isValid() || !mEditBuffer || !mDataProvider )
1776 return -1;
1777
1778 QgsVectorLayerEditUtils utils( this );
1779 return utils.addTopologicalPoints( geom );
1780}
1781
1788
1790{
1792
1793 if ( !isValid() || !mEditBuffer || !mDataProvider )
1794 return -1;
1795
1796 QgsVectorLayerEditUtils utils( this );
1797 return utils.addTopologicalPoints( p );
1798}
1799
1801{
1803
1804 if ( !mValid || !mEditBuffer || !mDataProvider )
1805 return -1;
1806
1807 QgsVectorLayerEditUtils utils( this );
1808 return utils.addTopologicalPoints( ps );
1809}
1810
1812{
1814
1815 if ( mLabeling.get() == labeling )
1816 return;
1817
1818 mLabeling.reset( labeling );
1819}
1820
1822{
1824
1825 if ( project() && project()->transactionMode() == Qgis::TransactionMode::BufferedGroups )
1826 return project()->startEditing( this );
1827
1828 if ( !isValid() || !mDataProvider )
1829 {
1830 return false;
1831 }
1832
1833 // allow editing if provider supports any of the capabilities
1834 if ( !supportsEditing() )
1835 {
1836 return false;
1837 }
1838
1839 if ( mEditBuffer )
1840 {
1841 // editing already underway
1842 return false;
1843 }
1844
1845 mDataProvider->enterUpdateMode();
1846
1847 emit beforeEditingStarted();
1848
1849 createEditBuffer();
1850
1851 updateFields();
1852
1853 emit editingStarted();
1854
1855 return true;
1856}
1857
1859{
1861
1862 if ( mDataProvider )
1863 mDataProvider->setTransformContext( transformContext );
1864}
1865
1867{
1869
1870 return mDataProvider ? mDataProvider->hasSpatialIndex() : Qgis::SpatialIndexPresence::Unknown;
1871}
1872
1874{
1876
1877 if ( mRenderer )
1878 if ( !mRenderer->accept( visitor ) )
1879 return false;
1880
1881 if ( mLabeling )
1882 if ( !mLabeling->accept( visitor ) )
1883 return false;
1884
1885 return true;
1886}
1887
1889{
1891
1892 if ( mActions )
1893 {
1894 const QList<QgsAction> actions = mActions->actions();
1895 for ( const QgsAction &action : actions )
1896 {
1897 if ( action.command().isEmpty() )
1898 {
1899 continue;
1900 }
1901
1902 switch ( action.type() )
1903 {
1908 {
1909 QgsEmbeddedScriptEntity entity( Qgis::EmbeddedScriptType::Action, tr( "%1: Action ’%2’" ).arg( name(), action.name() ), action.command() );
1910 if ( !visitor->visitEmbeddedScript( entity, context ) )
1911 {
1912 return false;
1913 }
1914 break;
1915 }
1916
1921 {
1922 break;
1923 }
1924 }
1925 }
1926 }
1927
1928 QString initCode;
1929 switch ( mEditFormConfig.initCodeSource() )
1930 {
1932 {
1933 initCode = u"# Calling function ’%1’\n\n%2"_s.arg( mEditFormConfig.initFunction(), mEditFormConfig.initCode() );
1934 break;
1935 }
1936
1938 {
1939 QFile *inputFile = QgsApplication::networkContentFetcherRegistry()->localFile( mEditFormConfig.initFilePath() );
1940 if ( inputFile && inputFile->open( QFile::ReadOnly ) )
1941 {
1942 // Read it into a string
1943 QTextStream inf( inputFile );
1944 initCode = inf.readAll();
1945 inputFile->close();
1946 initCode = u"# Calling function ’%1’\n# From file %2\n\n"_s.arg( mEditFormConfig.initFunction(), mEditFormConfig.initFilePath() ) + initCode;
1947 }
1948 break;
1949 }
1950
1952 {
1953 initCode = u"# Calling function ’%1’\n# From environment\n\n"_s.arg( mEditFormConfig.initFunction() );
1954 break;
1955 }
1956
1958 {
1959 break;
1960 }
1961 }
1962
1963 if ( !initCode.isEmpty() )
1964 {
1965 QgsEmbeddedScriptEntity entity( Qgis::EmbeddedScriptType::FormInitCode, tr( "%1: Attribute form init code" ).arg( name() ), initCode );
1966 if ( !visitor->visitEmbeddedScript( entity, context ) )
1967 {
1968 return false;
1969 }
1970 }
1971
1972 return true;
1973}
1974
1975bool QgsVectorLayer::readXml( const QDomNode &layer_node, QgsReadWriteContext &context )
1976{
1978
1979 QgsDebugMsgLevel( u"Datasource in QgsVectorLayer::readXml: %1"_s.arg( mDataSource.toLocal8Bit().data() ), 3 );
1980
1981 //process provider key
1982 QDomNode pkeyNode = layer_node.namedItem( u"provider"_s );
1983
1984 if ( pkeyNode.isNull() )
1985 {
1986 mProviderKey.clear();
1987 }
1988 else
1989 {
1990 QDomElement pkeyElt = pkeyNode.toElement();
1991 mProviderKey = pkeyElt.text();
1992 }
1993
1994 // determine type of vector layer
1995 if ( !mProviderKey.isNull() )
1996 {
1997 // if the provider string isn't empty, then we successfully
1998 // got the stored provider
1999 }
2000 else if ( mDataSource.contains( "dbname="_L1 ) )
2001 {
2002 mProviderKey = u"postgres"_s;
2003 }
2004 else
2005 {
2006 mProviderKey = u"ogr"_s;
2007 }
2008
2009 const QDomElement elem = layer_node.toElement();
2011
2012 mDataSourceReadOnly = mReadFlags & QgsMapLayer::FlagForceReadOnly;
2014
2015 if ( ( mReadFlags & QgsMapLayer::FlagDontResolveLayers ) || !setDataProvider( mProviderKey, options, flags ) )
2016 {
2018 {
2019 QgsDebugError( u"Could not set data provider for layer %1"_s.arg( publicSource() ) );
2020 }
2021
2022 // for invalid layer sources, we fallback to stored wkbType if available
2023 if ( elem.hasAttribute( u"wkbType"_s ) )
2024 mWkbType = qgsEnumKeyToValue( elem.attribute( u"wkbType"_s ), mWkbType );
2025 }
2026
2027 QDomElement pkeyElem = pkeyNode.toElement();
2028 if ( !pkeyElem.isNull() )
2029 {
2030 QString encodingString = pkeyElem.attribute( u"encoding"_s );
2031 if ( mDataProvider && !encodingString.isEmpty() )
2032 {
2033 mDataProvider->setEncoding( encodingString );
2034 }
2035 }
2036
2037 // load vector joins - does not resolve references to layers yet
2038 mJoinBuffer->readXml( layer_node );
2039
2040 updateFields();
2041
2042 // If style doesn't include a legend, we'll need to make a default one later...
2043 mSetLegendFromStyle = false;
2044
2045 QString errorMsg;
2046 if ( !readSymbology( layer_node, errorMsg, context ) )
2047 {
2048 return false;
2049 }
2050
2051 readStyleManager( layer_node );
2052
2053 QDomNode depsNode = layer_node.namedItem( u"dataDependencies"_s );
2054 QDomNodeList depsNodes = depsNode.childNodes();
2055 QSet<QgsMapLayerDependency> sources;
2056 for ( int i = 0; i < depsNodes.count(); i++ )
2057 {
2058 QString source = depsNodes.at( i ).toElement().attribute( u"id"_s );
2059 sources << QgsMapLayerDependency( source );
2060 }
2061 setDependencies( sources );
2062
2063 if ( !mSetLegendFromStyle )
2065
2066 // read extent
2068 {
2069 mReadExtentFromXml = true;
2070 }
2071 if ( mReadExtentFromXml )
2072 {
2073 const QDomNode extentNode = layer_node.namedItem( u"extent"_s );
2074 if ( !extentNode.isNull() )
2075 {
2076 mXmlExtent2D = QgsXmlUtils::readRectangle( extentNode.toElement() );
2077 }
2078 const QDomNode extent3DNode = layer_node.namedItem( u"extent3D"_s );
2079 if ( !extent3DNode.isNull() )
2080 {
2081 mXmlExtent3D = QgsXmlUtils::readBox3D( extent3DNode.toElement() );
2082 }
2083 }
2084
2085 // auxiliary layer
2086 const QDomNode asNode = layer_node.namedItem( u"auxiliaryLayer"_s );
2087 const QDomElement asElem = asNode.toElement();
2088 if ( !asElem.isNull() )
2089 {
2090 mAuxiliaryLayerKey = asElem.attribute( u"key"_s );
2091 }
2092
2093 // QGIS Server WMS Dimensions
2094 mServerProperties->readXml( layer_node );
2095
2096 return isValid(); // should be true if read successfully
2097
2098} // void QgsVectorLayer::readXml
2099
2100
2101void QgsVectorLayer::setDataSourcePrivate( const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, Qgis::DataProviderReadFlags flags )
2102{
2104
2105 Qgis::GeometryType geomType = geometryType();
2106
2107 mDataSource = dataSource;
2108 setName( baseName );
2109 setDataProvider( provider, options, flags );
2110
2111 if ( !isValid() )
2112 {
2113 return;
2114 }
2115
2116 // Always set crs
2118
2119 bool loadDefaultStyleFlag = false;
2121 {
2122 loadDefaultStyleFlag = true;
2123 }
2124
2125 // reset style if loading default style, style is missing, or geometry type is has changed (and layer is valid)
2126 if ( !renderer() || !legend() || ( isValid() && geomType != geometryType() ) || loadDefaultStyleFlag )
2127 {
2128 std::unique_ptr< QgsScopedRuntimeProfile > profile;
2129 if ( QgsApplication::profiler()->groupIsActive( u"projectload"_s ) )
2130 profile = std::make_unique< QgsScopedRuntimeProfile >( tr( "Load layer style" ), u"projectload"_s );
2131
2132 bool defaultLoadedFlag = false;
2133
2134 // defer style changed signal until we've set the renderer, labeling, everything.
2135 // we don't want multiple signals!
2136 ScopedIntIncrementor styleChangedSignalBlocker( &mBlockStyleChangedSignal );
2137
2138 // need to check whether the default style included a legend, and if not, we need to make a default legend
2139 // later...
2140 mSetLegendFromStyle = false;
2141
2142 // first check if there is a default style / propertysheet defined
2143 // for this layer and if so apply it
2144 // this should take precedence over all
2145 if ( !defaultLoadedFlag && loadDefaultStyleFlag )
2146 {
2147 loadDefaultStyle( defaultLoadedFlag );
2148 }
2149
2150 if ( loadDefaultStyleFlag && !defaultLoadedFlag && isSpatial() && mDataProvider->capabilities() & Qgis::VectorProviderCapability::CreateRenderer )
2151 {
2152 // if we didn't load a default style for this layer, try to create a renderer directly from the data provider
2153 std::unique_ptr< QgsFeatureRenderer > defaultRenderer( mDataProvider->createRenderer() );
2154 if ( defaultRenderer )
2155 {
2156 defaultLoadedFlag = true;
2157 setRenderer( defaultRenderer.release() );
2158
2159 applyRendererSettings();
2160 }
2161 }
2162
2163 // if the default style failed to load or was disabled use some very basic defaults
2164 if ( !defaultLoadedFlag )
2165 {
2166 // add single symbol renderer for spatial layers
2168 }
2169
2170 if ( !mSetLegendFromStyle )
2172
2173 if ( mDataProvider->capabilities() & Qgis::VectorProviderCapability::CreateLabeling )
2174 {
2175 std::unique_ptr< QgsAbstractVectorLayerLabeling > defaultLabeling( mDataProvider->createLabeling() );
2176 if ( defaultLabeling )
2177 {
2178 setLabeling( defaultLabeling.release() );
2179 setLabelsEnabled( true );
2180 }
2181 }
2182
2183 styleChangedSignalBlocker.release();
2185 }
2186}
2187
2188QString QgsVectorLayer::loadDefaultStyle( bool &resultFlag )
2189{
2191
2192 // first try to load a user-defined default style - this should always take precedence
2193 QString styleXml = QgsMapLayer::loadDefaultStyle( resultFlag );
2194
2195 if ( resultFlag )
2196 {
2197 // Try to load all stored styles from DB
2198 if ( mLoadAllStoredStyle && mDataProvider && mDataProvider->styleStorageCapabilities().testFlag( Qgis::ProviderStyleStorageCapability::LoadFromDatabase ) )
2199 {
2200 QStringList ids, names, descriptions;
2201 QString errorMessage;
2202 // Get the number of styles related to current layer.
2203 const int relatedStylesCount { listStylesInDatabase( ids, names, descriptions, errorMessage ) };
2204 Q_ASSERT( ids.count() == names.count() );
2205 const QString currentStyleName { mStyleManager->currentStyle() };
2206 for ( int i = 0; i < relatedStylesCount; ++i )
2207 {
2208 if ( names.at( i ) == currentStyleName )
2209 {
2210 continue;
2211 }
2212 errorMessage.clear();
2213 const QString styleXml { getStyleFromDatabase( ids.at( i ), errorMessage ) };
2214 if ( !styleXml.isEmpty() && errorMessage.isEmpty() )
2215 {
2216 mStyleManager->addStyle( names.at( i ), QgsMapLayerStyle( styleXml ) );
2217 }
2218 else
2219 {
2220 QgsDebugMsgLevel( u"Error retrieving style %1 from DB: %2"_s.arg( ids.at( i ), errorMessage ), 2 );
2221 }
2222 }
2223 }
2224 return styleXml;
2225 }
2226
2227 if ( isSpatial() && mDataProvider->capabilities() & Qgis::VectorProviderCapability::CreateRenderer )
2228 {
2229 // otherwise try to create a renderer directly from the data provider
2230 std::unique_ptr< QgsFeatureRenderer > defaultRenderer( mDataProvider->createRenderer() );
2231 if ( defaultRenderer )
2232 {
2233 resultFlag = true;
2234 setRenderer( defaultRenderer.release() );
2235
2236 applyRendererSettings();
2237
2238 return QString();
2239 }
2240 }
2241
2242 return QString();
2243}
2244
2245bool QgsVectorLayer::setDataProvider( QString const &provider, const QgsDataProvider::ProviderOptions &options, Qgis::DataProviderReadFlags flags )
2246{
2248
2249 mProviderKey = provider;
2250 delete mDataProvider;
2251
2252 // For Postgres provider primary key unicity is tested at construction time,
2253 // so it has to be set before initializing the provider,
2254 // this manipulation is necessary to preserve default behavior when
2255 // "trust layer metadata" project level option is set and checkPrimaryKeyUnicity
2256 // was not explicitly passed in the uri
2257 if ( provider.compare( "postgres"_L1 ) == 0 )
2258 {
2259 const QString checkUnicityKey { u"checkPrimaryKeyUnicity"_s };
2260 QgsDataSourceUri uri( mDataSource );
2261 if ( !uri.hasParam( checkUnicityKey ) )
2262 {
2263 uri.setParam( checkUnicityKey, mReadExtentFromXml ? "0" : "1" );
2264 mDataSource = uri.uri( false );
2265 }
2266 }
2267
2268 std::unique_ptr< QgsScopedRuntimeProfile > profile;
2269 if ( QgsApplication::profiler()->groupIsActive( u"projectload"_s ) )
2270 profile = std::make_unique< QgsScopedRuntimeProfile >( tr( "Create %1 provider" ).arg( provider ), u"projectload"_s );
2271
2272 if ( mPreloadedProvider )
2273 {
2274 QgsDebugMsgLevel( u"Attaching map layer %1 to preloaded data provider. Provider belongs to thread %2"_s.arg( id(), QgsThreadingUtils::threadDescription( mPreloadedProvider->thread() ) ), 2 );
2275 mDataProvider = qobject_cast< QgsVectorDataProvider * >( mPreloadedProvider.release() );
2276 }
2277 else
2278 {
2279 mDataProvider = qobject_cast<QgsVectorDataProvider *>( QgsProviderRegistry::instance()->createProvider( provider, mDataSource, options, flags ) );
2280 }
2281
2282 if ( !mDataProvider )
2283 {
2284 setValid( false );
2285 QgsDebugMsgLevel( u"Unable to get data provider"_s, 2 );
2286 return false;
2287 }
2288
2289 mDataProvider->setParent( this );
2290 connect( mDataProvider, &QgsVectorDataProvider::raiseError, this, &QgsVectorLayer::raiseError );
2291
2292 QgsDebugMsgLevel( u"Instantiated the data provider plugin"_s, 2 );
2293
2294 setValid( mDataProvider->isValid() );
2295 if ( !isValid() )
2296 {
2297 QgsDebugMsgLevel( u"Invalid provider plugin %1"_s.arg( QString( mDataSource.toUtf8() ) ), 2 );
2298 return false;
2299 }
2300
2301 if ( profile )
2302 profile->switchTask( tr( "Read layer metadata" ) );
2303 if ( mDataProvider->capabilities() & Qgis::VectorProviderCapability::ReadLayerMetadata )
2304 {
2305 // we combine the provider metadata with the layer's existing metadata, so as not to reset any user customizations to the metadata
2306 // back to the default if a layer's data source is changed
2307 QgsLayerMetadata newMetadata = mDataProvider->layerMetadata();
2308 // this overwrites the provider metadata with any properties which are non-empty from the existing layer metadata
2309 newMetadata.combine( &mMetadata );
2310
2311 setMetadata( newMetadata );
2312 QgsDebugMsgLevel( u"Set Data provider QgsLayerMetadata identifier[%1]"_s.arg( metadata().identifier() ), 4 );
2313 }
2314
2315 // TODO: Check if the provider has the capability to send fullExtentCalculated
2316 connect( mDataProvider, &QgsVectorDataProvider::fullExtentCalculated, this, [this] { updateExtents(); } );
2317
2318 // get and store the feature type
2319 mWkbType = mDataProvider->wkbType();
2320
2321 // before we update the layer fields from the provider, we first copy any default set alias and
2322 // editor widget config from the data provider fields, if present
2323 const QgsFields providerFields = mDataProvider->fields();
2324 for ( const QgsField &field : providerFields )
2325 {
2326 // we only copy defaults from the provider if we aren't overriding any configuration made in the layer
2327 if ( !field.editorWidgetSetup().isNull() && mFieldWidgetSetups.value( field.name() ).isNull() )
2328 {
2329 mFieldWidgetSetups[field.name()] = field.editorWidgetSetup();
2330 }
2331 if ( !field.alias().isEmpty() && mAttributeAliasMap.value( field.name() ).isEmpty() )
2332 {
2333 mAttributeAliasMap[field.name()] = field.alias();
2334 }
2335 if ( !mAttributeSplitPolicy.contains( field.name() ) )
2336 {
2337 mAttributeSplitPolicy[field.name()] = field.splitPolicy();
2338 }
2339 if ( !mAttributeDuplicatePolicy.contains( field.name() ) )
2340 {
2341 mAttributeDuplicatePolicy[field.name()] = field.duplicatePolicy();
2342 }
2343 if ( !mAttributeMergePolicy.contains( field.name() ) )
2344 {
2345 mAttributeMergePolicy[field.name()] = field.mergePolicy();
2346 }
2347 }
2348
2349 if ( profile )
2350 profile->switchTask( tr( "Read layer fields" ) );
2351 updateFields();
2352
2353 if ( mProviderKey == "postgres"_L1 )
2354 {
2355 // update datasource from data provider computed one
2356 mDataSource = mDataProvider->dataSourceUri( false );
2357
2358 QgsDebugMsgLevel( u"Beautifying layer name %1"_s.arg( name() ), 3 );
2359
2360 // adjust the display name for postgres layers
2361 const thread_local QRegularExpression reg( R"lit("[^"]+"\."([^"] + )"( \‍([^)]+\))?)lit" );
2362 const QRegularExpressionMatch match = reg.match( name() );
2363 if ( match.hasMatch() )
2364 {
2365 QStringList stuff = match.capturedTexts();
2366 QString lName = stuff[1];
2367
2368 const QMap<QString, QgsMapLayer *> &layers = QgsProject::instance()->mapLayers(); // skip-keyword-check
2369
2370 QMap<QString, QgsMapLayer *>::const_iterator it;
2371 for ( it = layers.constBegin(); it != layers.constEnd() && ( *it )->name() != lName; ++it )
2372 ;
2373
2374 if ( it != layers.constEnd() && stuff.size() > 2 )
2375 {
2376 lName += '.' + stuff[2].mid( 2, stuff[2].length() - 3 );
2377 }
2378
2379 if ( !lName.isEmpty() )
2380 setName( lName );
2381 }
2382 QgsDebugMsgLevel( u"Beautified layer name %1"_s.arg( name() ), 3 );
2383 }
2384 else if ( mProviderKey == "osm"_L1 )
2385 {
2386 // make sure that the "observer" has been removed from URI to avoid crashes
2387 mDataSource = mDataProvider->dataSourceUri();
2388 }
2389 else if ( provider == "ogr"_L1 )
2390 {
2391 // make sure that the /vsigzip or /vsizip is added to uri, if applicable
2392 mDataSource = mDataProvider->dataSourceUri();
2393 if ( mDataSource.right( 10 ) == "|layerid=0"_L1 )
2394 mDataSource.chop( 10 );
2395 }
2396 else if ( provider == "memory"_L1 )
2397 {
2398 // required so that source differs between memory layers
2399 mDataSource = mDataSource + u"&uid=%1"_s.arg( QUuid::createUuid().toString() );
2400 }
2401 else if ( provider == "hana"_L1 )
2402 {
2403 // update datasource from data provider computed one
2404 mDataSource = mDataProvider->dataSourceUri( false );
2405 }
2406
2407 connect( mDataProvider, &QgsVectorDataProvider::dataChanged, this, &QgsVectorLayer::emitDataChanged );
2409
2410 return true;
2411} // QgsVectorLayer:: setDataProvider
2412
2413
2414/* virtual */
2415bool QgsVectorLayer::writeXml( QDomNode &layer_node, QDomDocument &document, const QgsReadWriteContext &context ) const
2416{
2418
2419 // first get the layer element so that we can append the type attribute
2420
2421 QDomElement mapLayerNode = layer_node.toElement();
2422
2423 if ( mapLayerNode.isNull() || ( "maplayer" != mapLayerNode.nodeName() ) )
2424 {
2425 QgsDebugMsgLevel( u"can't find <maplayer>"_s, 2 );
2426 return false;
2427 }
2428
2429 mapLayerNode.setAttribute( u"type"_s, QgsMapLayerFactory::typeToString( Qgis::LayerType::Vector ) );
2430
2431 // set the geometry type
2432 mapLayerNode.setAttribute( u"geometry"_s, QgsWkbTypes::geometryDisplayString( geometryType() ) );
2433 mapLayerNode.setAttribute( u"wkbType"_s, qgsEnumValueToKey( wkbType() ) );
2434
2435 // add provider node
2436 if ( mDataProvider )
2437 {
2438 QDomElement provider = document.createElement( u"provider"_s );
2439 provider.setAttribute( u"encoding"_s, mDataProvider->encoding() );
2440 QDomText providerText = document.createTextNode( providerType() );
2441 provider.appendChild( providerText );
2442 layer_node.appendChild( provider );
2443 }
2444
2445 //save joins
2446 mJoinBuffer->writeXml( layer_node, document );
2447
2448 // dependencies
2449 QDomElement dependenciesElement = document.createElement( u"layerDependencies"_s );
2450 const auto constDependencies = dependencies();
2451 for ( const QgsMapLayerDependency &dep : constDependencies )
2452 {
2454 continue;
2455 QDomElement depElem = document.createElement( u"layer"_s );
2456 depElem.setAttribute( u"id"_s, dep.layerId() );
2457 dependenciesElement.appendChild( depElem );
2458 }
2459 layer_node.appendChild( dependenciesElement );
2460
2461 // change dependencies
2462 QDomElement dataDependenciesElement = document.createElement( u"dataDependencies"_s );
2463 for ( const QgsMapLayerDependency &dep : constDependencies )
2464 {
2465 if ( dep.type() != QgsMapLayerDependency::DataDependency )
2466 continue;
2467 QDomElement depElem = document.createElement( u"layer"_s );
2468 depElem.setAttribute( u"id"_s, dep.layerId() );
2469 dataDependenciesElement.appendChild( depElem );
2470 }
2471 layer_node.appendChild( dataDependenciesElement );
2472
2473 // save expression fields
2474 mExpressionFieldBuffer->writeXml( layer_node, document );
2475
2476 writeStyleManager( layer_node, document );
2477
2478 // auxiliary layer
2479 QDomElement asElem = document.createElement( u"auxiliaryLayer"_s );
2480 if ( mAuxiliaryLayer )
2481 {
2482 const QString pkField = mAuxiliaryLayer->joinInfo().targetFieldName();
2483 asElem.setAttribute( u"key"_s, pkField );
2484 }
2485 layer_node.appendChild( asElem );
2486
2487 // renderer specific settings
2488 QString errorMsg;
2489 return writeSymbology( layer_node, document, errorMsg, context );
2490}
2491
2492QString QgsVectorLayer::encodedSource( const QString &source, const QgsReadWriteContext &context ) const
2493{
2495
2496 if ( providerType() == "memory"_L1 )
2497 {
2498 // Refetch the source from the provider, because adding fields actually changes the source for this provider.
2499 return dataProvider()->dataSourceUri();
2500 }
2501
2503}
2504
2505QString QgsVectorLayer::decodedSource( const QString &source, const QString &provider, const QgsReadWriteContext &context ) const
2506{
2508
2509 return QgsProviderRegistry::instance()->relativeToAbsoluteUri( provider, source, context );
2510}
2511
2512
2520
2521
2522bool QgsVectorLayer::readSymbology( const QDomNode &layerNode, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories )
2523{
2525
2526 if ( categories.testFlag( Fields ) )
2527 {
2528 if ( !mExpressionFieldBuffer )
2529 mExpressionFieldBuffer = std::make_unique<QgsExpressionFieldBuffer>();
2530 mExpressionFieldBuffer->readXml( layerNode );
2531
2532 updateFields();
2533 }
2534
2535 if ( categories.testFlag( Relations ) )
2536 {
2537 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Relations" ) );
2538
2539 // Restore referenced layers: relations where "this" is the child layer (the referencing part, that holds the FK)
2540 QDomNodeList referencedLayersNodeList = layerNode.toElement().elementsByTagName( u"referencedLayers"_s );
2541 if ( referencedLayersNodeList.size() > 0 )
2542 {
2543 const QDomNodeList relationNodes { referencedLayersNodeList.at( 0 ).childNodes() };
2544 for ( int i = 0; i < relationNodes.length(); ++i )
2545 {
2546 const QDomElement relationElement = relationNodes.at( i ).toElement();
2547
2548 mWeakRelations.push_back( QgsWeakRelation::readXml( this, QgsWeakRelation::Referencing, relationElement, context.pathResolver() ) );
2549 }
2550 }
2551
2552 // Restore referencing layers: relations where "this" is the parent layer (the referenced part where the FK points to)
2553 QDomNodeList referencingLayersNodeList = layerNode.toElement().elementsByTagName( u"referencingLayers"_s );
2554 if ( referencingLayersNodeList.size() > 0 )
2555 {
2556 const QDomNodeList relationNodes { referencingLayersNodeList.at( 0 ).childNodes() };
2557 for ( int i = 0; i < relationNodes.length(); ++i )
2558 {
2559 const QDomElement relationElement = relationNodes.at( i ).toElement();
2560 mWeakRelations.push_back( QgsWeakRelation::readXml( this, QgsWeakRelation::Referenced, relationElement, context.pathResolver() ) );
2561 }
2562 }
2563 }
2564
2565 QDomElement layerElement = layerNode.toElement();
2566
2567 readCommonStyle( layerElement, context, categories );
2568
2569 readStyle( layerNode, errorMessage, context, categories );
2570
2571 if ( categories.testFlag( MapTips ) )
2572 {
2573 QDomElement mapTipElem = layerNode.namedItem( u"mapTip"_s ).toElement();
2574 setMapTipTemplate( mapTipElem.text() );
2575 setMapTipsEnabled( mapTipElem.attribute( u"enabled"_s, u"1"_s ).toInt() == 1 );
2576 }
2577
2578 if ( categories.testFlag( LayerConfiguration ) )
2579 mDisplayExpression = layerNode.namedItem( u"previewExpression"_s ).toElement().text();
2580
2581 // Try to migrate pre QGIS 3.0 display field property
2582 QString displayField = layerNode.namedItem( u"displayfield"_s ).toElement().text();
2583 if ( mFields.lookupField( displayField ) < 0 )
2584 {
2585 // if it's not a field, it's a maptip
2586 if ( mMapTipTemplate.isEmpty() && categories.testFlag( MapTips ) )
2587 mMapTipTemplate = displayField;
2588 }
2589 else
2590 {
2591 if ( mDisplayExpression.isEmpty() && categories.testFlag( LayerConfiguration ) )
2592 mDisplayExpression = QgsExpression::quotedColumnRef( displayField );
2593 }
2594
2595 // process the attribute actions
2596 if ( categories.testFlag( Actions ) )
2597 mActions->readXml( layerNode, context );
2598
2599 if ( categories.testFlag( Fields ) )
2600 {
2601 // IMPORTANT - we don't clear mAttributeAliasMap here, as it may contain aliases which are coming direct
2602 // from the data provider. Instead we leave any existing aliases and only overwrite them if the style
2603 // has a specific value for that field's alias
2604 QDomNode aliasesNode = layerNode.namedItem( u"aliases"_s );
2605 if ( !aliasesNode.isNull() )
2606 {
2607 QDomElement aliasElem;
2608
2609 QDomNodeList aliasNodeList = aliasesNode.toElement().elementsByTagName( u"alias"_s );
2610 for ( int i = 0; i < aliasNodeList.size(); ++i )
2611 {
2612 aliasElem = aliasNodeList.at( i ).toElement();
2613
2614 QString field;
2615 if ( aliasElem.hasAttribute( u"field"_s ) )
2616 {
2617 field = aliasElem.attribute( u"field"_s );
2618 }
2619 else
2620 {
2621 int index = aliasElem.attribute( u"index"_s ).toInt();
2622
2623 if ( index >= 0 && index < fields().count() )
2624 field = fields().at( index ).name();
2625 }
2626
2627 QString alias;
2628
2629 if ( !aliasElem.attribute( u"name"_s ).isEmpty() )
2630 {
2631 //if it has alias
2632 alias = context.projectTranslator()->translate( u"project:layers:%1:fieldaliases"_s.arg( layerNode.namedItem( u"id"_s ).toElement().text() ), aliasElem.attribute( u"name"_s ) );
2633 QgsDebugMsgLevel( "context" + u"project:layers:%1:fieldaliases"_s.arg( layerNode.namedItem( u"id"_s ).toElement().text() ) + " source " + aliasElem.attribute( u"name"_s ), 3 );
2634 }
2635 else
2636 {
2637 //if it has no alias, it should be the fields translation
2638 alias = context.projectTranslator()->translate( u"project:layers:%1:fieldaliases"_s.arg( layerNode.namedItem( u"id"_s ).toElement().text() ), field );
2639 QgsDebugMsgLevel( "context" + u"project:layers:%1:fieldaliases"_s.arg( layerNode.namedItem( u"id"_s ).toElement().text() ) + " source " + field, 3 );
2640 //if it gets the exact field value, there has been no translation (or not even translation loaded) - so no alias should be generated;
2641 if ( alias == aliasElem.attribute( u"field"_s ) )
2642 alias.clear();
2643 }
2644
2645 QgsDebugMsgLevel( "field " + field + " origalias " + aliasElem.attribute( u"name"_s ) + " trans " + alias, 3 );
2646 mAttributeAliasMap.insert( field, alias );
2647 }
2648 }
2649
2650 // custom comments
2651 // mAttributeCustomCommentMap is cleared, because when a custom comment is null the provider comment should be considered
2652 mAttributeCustomCommentMap.clear();
2653 QDomNode customCommentsNode = layerNode.namedItem( u"customComments"_s );
2654 if ( !customCommentsNode.isNull() )
2655 {
2656 QDomElement customCommentEntryElem;
2657
2658 QDomNodeList customCommentNodeList = customCommentsNode.toElement().elementsByTagName( u"customComment"_s );
2659 for ( int i = 0; i < customCommentNodeList.size(); ++i )
2660 {
2661 customCommentEntryElem = customCommentNodeList.at( i ).toElement();
2662
2663 const QString field = customCommentEntryElem.attribute( u"field"_s );
2664
2665 //empty values are important as well (to override provider comments with nothing)
2666 const QString customCommentEntryValue = customCommentEntryElem.attribute( u"value"_s );
2667 QString customComment = customCommentEntryValue;
2668 if ( !customCommentEntryValue.isEmpty() )
2669 {
2670 //translate comment if it's not empty
2671 customComment = context.projectTranslator()->translate( u"project:layers:%1:fieldcustomcomments"_s.arg( layerNode.namedItem( u"id"_s ).toElement().text() ), customCommentEntryValue );
2672 QgsDebugMsgLevel( "context" + u"project:layers:%1:fieldcustomcomments"_s.arg( layerNode.namedItem( u"id"_s ).toElement().text() ) + " source " + customCommentEntryValue, 3 );
2673 }
2674 if ( fields().lookupField( field ) < 0 )
2675 {
2676 QgsDebugMsgLevel( u"Warning: Field %1 not found in layer %2 to load custom comment from setting "_s.arg( field, name() ), 2 );
2677 continue;
2678 }
2679 mAttributeCustomCommentMap.insert( field, customComment );
2680 }
2681 }
2682
2683 // IMPORTANT - we don't clear mAttributeSplitPolicy here, as it may contain policies which are coming direct
2684 // from the data provider. Instead we leave any existing policies and only overwrite them if the style
2685 // has a specific value for that field's policy
2686 const QDomNode splitPoliciesNode = layerNode.namedItem( u"splitPolicies"_s );
2687 if ( !splitPoliciesNode.isNull() )
2688 {
2689 const QDomNodeList splitPolicyNodeList = splitPoliciesNode.toElement().elementsByTagName( u"policy"_s );
2690 for ( int i = 0; i < splitPolicyNodeList.size(); ++i )
2691 {
2692 const QDomElement splitPolicyElem = splitPolicyNodeList.at( i ).toElement();
2693 const QString field = splitPolicyElem.attribute( u"field"_s );
2694 const Qgis::FieldDomainSplitPolicy policy = qgsEnumKeyToValue( splitPolicyElem.attribute( u"policy"_s ), Qgis::FieldDomainSplitPolicy::Duplicate );
2695 mAttributeSplitPolicy.insert( field, policy );
2696 }
2697 }
2698
2699 // The duplicate policy is - unlike alias and split policy - never defined by the data provider, so we clear the map
2700 mAttributeDuplicatePolicy.clear();
2701 const QDomNode duplicatePoliciesNode = layerNode.namedItem( u"duplicatePolicies"_s );
2702 if ( !duplicatePoliciesNode.isNull() )
2703 {
2704 const QDomNodeList duplicatePolicyNodeList = duplicatePoliciesNode.toElement().elementsByTagName( u"policy"_s );
2705 for ( int i = 0; i < duplicatePolicyNodeList.size(); ++i )
2706 {
2707 const QDomElement duplicatePolicyElem = duplicatePolicyNodeList.at( i ).toElement();
2708 const QString field = duplicatePolicyElem.attribute( u"field"_s );
2709 const Qgis::FieldDuplicatePolicy policy = qgsEnumKeyToValue( duplicatePolicyElem.attribute( u"policy"_s ), Qgis::FieldDuplicatePolicy::Duplicate );
2710 mAttributeDuplicatePolicy.insert( field, policy );
2711 }
2712 }
2713
2714 const QDomNode mergePoliciesNode = layerNode.namedItem( u"mergePolicies"_s );
2715 if ( !mergePoliciesNode.isNull() )
2716 {
2717 const QDomNodeList mergePolicyNodeList = mergePoliciesNode.toElement().elementsByTagName( u"policy"_s );
2718 for ( int i = 0; i < mergePolicyNodeList.size(); ++i )
2719 {
2720 const QDomElement mergePolicyElem = mergePolicyNodeList.at( i ).toElement();
2721 const QString field = mergePolicyElem.attribute( u"field"_s );
2722 const Qgis::FieldDomainMergePolicy policy = qgsEnumKeyToValue( mergePolicyElem.attribute( u"policy"_s ), Qgis::FieldDomainMergePolicy::UnsetField );
2723 mAttributeMergePolicy.insert( field, policy );
2724 }
2725 }
2726
2727 // default expressions
2728 mDefaultExpressionMap.clear();
2729 QDomNode defaultsNode = layerNode.namedItem( u"defaults"_s );
2730 if ( !defaultsNode.isNull() )
2731 {
2732 QDomNodeList defaultNodeList = defaultsNode.toElement().elementsByTagName( u"default"_s );
2733 for ( int i = 0; i < defaultNodeList.size(); ++i )
2734 {
2735 QDomElement defaultElem = defaultNodeList.at( i ).toElement();
2736
2737 QString field = defaultElem.attribute( u"field"_s, QString() );
2738 QString expression = defaultElem.attribute( u"expression"_s, QString() );
2739 bool applyOnUpdate = defaultElem.attribute( u"applyOnUpdate"_s, u"0"_s ) == "1"_L1;
2740 if ( field.isEmpty() || expression.isEmpty() )
2741 continue;
2742
2743 mDefaultExpressionMap.insert( field, QgsDefaultValue( expression, applyOnUpdate ) );
2744 }
2745 }
2746
2747 // constraints
2748 mFieldConstraints.clear();
2749 mFieldConstraintStrength.clear();
2750 QDomNode constraintsNode = layerNode.namedItem( u"constraints"_s );
2751 if ( !constraintsNode.isNull() )
2752 {
2753 QDomNodeList constraintNodeList = constraintsNode.toElement().elementsByTagName( u"constraint"_s );
2754 for ( int i = 0; i < constraintNodeList.size(); ++i )
2755 {
2756 QDomElement constraintElem = constraintNodeList.at( i ).toElement();
2757
2758 QString field = constraintElem.attribute( u"field"_s, QString() );
2759 int constraints = constraintElem.attribute( u"constraints"_s, u"0"_s ).toInt();
2760 if ( field.isEmpty() || constraints == 0 )
2761 continue;
2762
2763 mFieldConstraints.insert( field, static_cast< QgsFieldConstraints::Constraints >( constraints ) );
2764
2765 int uniqueStrength = constraintElem.attribute( u"unique_strength"_s, u"1"_s ).toInt();
2766 int notNullStrength = constraintElem.attribute( u"notnull_strength"_s, u"1"_s ).toInt();
2767 int expStrength = constraintElem.attribute( u"exp_strength"_s, u"1"_s ).toInt();
2768
2769 mFieldConstraintStrength.insert( qMakePair( field, QgsFieldConstraints::ConstraintUnique ), static_cast< QgsFieldConstraints::ConstraintStrength >( uniqueStrength ) );
2770 mFieldConstraintStrength.insert( qMakePair( field, QgsFieldConstraints::ConstraintNotNull ), static_cast< QgsFieldConstraints::ConstraintStrength >( notNullStrength ) );
2771 mFieldConstraintStrength.insert( qMakePair( field, QgsFieldConstraints::ConstraintExpression ), static_cast< QgsFieldConstraints::ConstraintStrength >( expStrength ) );
2772 }
2773 }
2774 mFieldConstraintExpressions.clear();
2775 QDomNode constraintExpressionsNode = layerNode.namedItem( u"constraintExpressions"_s );
2776 if ( !constraintExpressionsNode.isNull() )
2777 {
2778 QDomNodeList constraintNodeList = constraintExpressionsNode.toElement().elementsByTagName( u"constraint"_s );
2779 for ( int i = 0; i < constraintNodeList.size(); ++i )
2780 {
2781 QDomElement constraintElem = constraintNodeList.at( i ).toElement();
2782
2783 QString field = constraintElem.attribute( u"field"_s, QString() );
2784 QString exp = constraintElem.attribute( u"exp"_s, QString() );
2785 QString desc
2786 = context.projectTranslator()->translate( u"project:layers:%1:constraintdescriptions"_s.arg( layerNode.namedItem( u"id"_s ).toElement().text() ), constraintElem.attribute( u"desc"_s, QString() ) );
2787 QgsDebugMsgLevel( "context" + u"project:layers:%1:constraintdescriptions"_s.arg( layerNode.namedItem( u"id"_s ).toElement().text() ) + " source " + constraintElem.attribute( u"desc"_s, QString() ), 3 );
2788 if ( field.isEmpty() || exp.isEmpty() )
2789 continue;
2790
2791 mFieldConstraintExpressions.insert( field, qMakePair( exp, desc ) );
2792 }
2793 }
2794
2795 updateFields();
2796 }
2797
2798 // load field configuration
2799 if ( categories.testFlag( Fields ) || categories.testFlag( Forms ) )
2800 {
2801 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Forms" ) );
2802
2803 QDomElement widgetsElem = layerNode.namedItem( u"fieldConfiguration"_s ).toElement();
2804 QDomNodeList fieldConfigurationElementList = widgetsElem.elementsByTagName( u"field"_s );
2805 for ( int i = 0; i < fieldConfigurationElementList.size(); ++i )
2806 {
2807 const QDomElement fieldConfigElement = fieldConfigurationElementList.at( i ).toElement();
2808 const QDomElement fieldWidgetElement = fieldConfigElement.elementsByTagName( u"editWidget"_s ).at( 0 ).toElement();
2809
2810 QString fieldName = fieldConfigElement.attribute( u"name"_s );
2811
2812 if ( categories.testFlag( Fields ) )
2813 mFieldConfigurationFlags[fieldName] = qgsFlagKeysToValue( fieldConfigElement.attribute( u"configurationFlags"_s ), Qgis::FieldConfigurationFlag::NoFlag );
2814
2815 // load editor widget configuration
2816 if ( categories.testFlag( Forms ) )
2817 {
2818 const QString widgetType = fieldWidgetElement.attribute( u"type"_s );
2819 const QDomElement cfgElem = fieldConfigElement.elementsByTagName( u"config"_s ).at( 0 ).toElement();
2820 const QDomElement optionsElem = cfgElem.childNodes().at( 0 ).toElement();
2821 QVariantMap optionsMap = QgsXmlUtils::readVariant( optionsElem ).toMap();
2822 // translate widget configuration strings
2823 if ( widgetType == "ValueRelation"_L1 )
2824 {
2825 optionsMap[u"Value"_s]
2826 = context.projectTranslator()->translate( u"project:layers:%1:fields:%2:valuerelationvalue"_s.arg( layerNode.namedItem( u"id"_s ).toElement().text(), fieldName ), optionsMap[u"Value"_s].toString() );
2827 optionsMap[u"Description"_s]
2828 = context.projectTranslator()
2829 ->translate( u"project:layers:%1:fields:%2:valuerelationdescription"_s.arg( layerNode.namedItem( u"id"_s ).toElement().text(), fieldName ), optionsMap[u"Description"_s].toString() );
2830 }
2831 if ( widgetType == "ValueMap"_L1 )
2832 {
2833 if ( optionsMap[u"map"_s].canConvert<QList<QVariant>>() )
2834 {
2835 QList<QVariant> translatedValueList;
2836 const QList<QVariant> valueList = optionsMap[u"map"_s].toList();
2837 for ( int i = 0; i < valueList.count(); i++ )
2838 {
2839 QMap<QString, QVariant> translatedValueMap;
2840 QString translatedKey
2841 = context.projectTranslator()
2842 ->translate( u"project:layers:%1:fields:%2:valuemapdescriptions"_s.arg( layerNode.namedItem( u"id"_s ).toElement().text(), fieldName ), valueList[i].toMap().constBegin().key() );
2843 translatedValueMap.insert( translatedKey, valueList[i].toMap().constBegin().value() );
2844 translatedValueList.append( translatedValueMap );
2845 }
2846 optionsMap.insert( u"map"_s, translatedValueList );
2847 }
2848 }
2849 QgsEditorWidgetSetup setup = QgsEditorWidgetSetup( widgetType, optionsMap );
2850 mFieldWidgetSetups[fieldName] = setup;
2851 }
2852 }
2853 }
2854
2855 // Legacy reading for QGIS 3.14 and older projects
2856 // Attributes excluded from WMS and WFS
2857 if ( categories.testFlag( Fields ) )
2858 {
2859 const QList<QPair<QString, Qgis::FieldConfigurationFlag>>
2860 legacyConfig { qMakePair( u"excludeAttributesWMS"_s, Qgis::FieldConfigurationFlag::HideFromWms ), qMakePair( u"excludeAttributesWFS"_s, Qgis::FieldConfigurationFlag::HideFromWfs ) };
2861 for ( const auto &config : legacyConfig )
2862 {
2863 QDomNode excludeNode = layerNode.namedItem( config.first );
2864 if ( !excludeNode.isNull() )
2865 {
2866 QDomNodeList attributeNodeList = excludeNode.toElement().elementsByTagName( u"attribute"_s );
2867 for ( int i = 0; i < attributeNodeList.size(); ++i )
2868 {
2869 QString fieldName = attributeNodeList.at( i ).toElement().text();
2870 if ( !mFieldConfigurationFlags.contains( fieldName ) )
2871 mFieldConfigurationFlags[fieldName] = config.second;
2872 else
2873 mFieldConfigurationFlags[fieldName].setFlag( config.second, true );
2874 }
2875 }
2876 }
2877 }
2878
2879 if ( categories.testFlag( GeometryOptions ) )
2880 mGeometryOptions->readXml( layerNode.namedItem( u"geometryOptions"_s ) );
2881
2882 if ( categories.testFlag( Forms ) )
2883 mEditFormConfig.readXml( layerNode, context );
2884
2885 if ( categories.testFlag( AttributeTable ) )
2886 {
2887 mAttributeTableConfig.readXml( layerNode );
2888 mConditionalStyles->readXml( layerNode, context );
2889 mStoredExpressionManager->readXml( layerNode );
2890 }
2891
2892 if ( categories.testFlag( CustomProperties ) )
2893 readCustomProperties( layerNode, u"variable"_s );
2894
2895 QDomElement mapLayerNode = layerNode.toElement();
2896 if ( categories.testFlag( LayerConfiguration ) && mapLayerNode.attribute( u"readOnly"_s, u"0"_s ).toInt() == 1 )
2897 mReadOnly = true;
2898
2899 updateFields();
2900
2901 if ( categories.testFlag( Legend ) )
2902 {
2903 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Legend" ) );
2904
2905 const QDomElement legendElem = layerNode.firstChildElement( u"legend"_s );
2906 if ( !legendElem.isNull() )
2907 {
2908 std::unique_ptr< QgsMapLayerLegend > legend( QgsMapLayerLegend::defaultVectorLegend( this ) );
2909 legend->readXml( legendElem, context );
2910 setLegend( legend.release() );
2911 mSetLegendFromStyle = true;
2912 }
2913 }
2914
2915 return true;
2916}
2917
2918bool QgsVectorLayer::readStyle( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories )
2919{
2921
2922 bool result = true;
2923 emit readCustomSymbology( node.toElement(), errorMessage );
2924
2925 // we must try to restore a renderer if our geometry type is unknown
2926 // as this allows the renderer to be correctly restored even for layers
2927 // with broken sources
2928 if ( isSpatial() || mWkbType == Qgis::WkbType::Unknown )
2929 {
2930 // defer style changed signal until we've set the renderer, labeling, everything.
2931 // we don't want multiple signals!
2932 ScopedIntIncrementor styleChangedSignalBlocker( &mBlockStyleChangedSignal );
2933
2934 // try renderer v2 first
2935 if ( categories.testFlag( Symbology ) )
2936 {
2937 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Symbology" ) );
2938
2939 QDomElement rendererElement = node.firstChildElement( RENDERER_TAG_NAME );
2940 if ( !rendererElement.isNull() )
2941 {
2942 QgsFeatureRenderer *r = QgsFeatureRenderer::load( rendererElement, context );
2943 if ( r )
2944 {
2945 setRenderer( r );
2946 }
2947 else
2948 {
2949 result = false;
2950 }
2951 }
2952 // make sure layer has a renderer - if none exists, fallback to a default renderer
2953 if ( isSpatial() && !renderer() )
2954 {
2956 }
2957
2958 if ( mSelectionProperties )
2959 mSelectionProperties->readXml( node.toElement(), context );
2960 }
2961
2962 // read labeling definition
2963 if ( categories.testFlag( Labeling ) )
2964 {
2965 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Labeling" ) );
2966
2967 QDomElement labelingElement = node.firstChildElement( u"labeling"_s );
2969 if ( labelingElement.isNull() || ( labelingElement.attribute( u"type"_s ) == "simple"_L1 && labelingElement.firstChildElement( u"settings"_s ).isNull() ) )
2970 {
2971 // make sure we have custom properties for labeling for 2.x projects
2972 // (custom properties should be already loaded when reading the whole layer from XML,
2973 // but when reading style, custom properties are not read)
2974 readCustomProperties( node, u"labeling"_s );
2975
2976 // support for pre-QGIS 3 labeling configurations written in custom properties
2977 labeling = readLabelingFromCustomProperties();
2978 }
2979 else
2980 {
2981 labeling = QgsAbstractVectorLayerLabeling::create( labelingElement, context );
2982 }
2984
2985 if ( node.toElement().hasAttribute( u"labelsEnabled"_s ) )
2986 mLabelsEnabled = node.toElement().attribute( u"labelsEnabled"_s ).toInt();
2987 else
2988 mLabelsEnabled = true;
2989 }
2990
2991 if ( categories.testFlag( Symbology ) )
2992 {
2993 // get and set the blend mode if it exists
2994 QDomNode blendModeNode = node.namedItem( u"blendMode"_s );
2995 if ( !blendModeNode.isNull() )
2996 {
2997 QDomElement e = blendModeNode.toElement();
2998 setBlendMode( QgsPainting::getCompositionMode( static_cast< Qgis::BlendMode >( e.text().toInt() ) ) );
2999 }
3000
3001 // get and set the feature blend mode if it exists
3002 QDomNode featureBlendModeNode = node.namedItem( u"featureBlendMode"_s );
3003 if ( !featureBlendModeNode.isNull() )
3004 {
3005 QDomElement e = featureBlendModeNode.toElement();
3006 setFeatureBlendMode( QgsPainting::getCompositionMode( static_cast< Qgis::BlendMode >( e.text().toInt() ) ) );
3007 }
3008 }
3009
3010 // get and set the layer transparency and scale visibility if they exists
3011 if ( categories.testFlag( Rendering ) )
3012 {
3013 QDomNode layerTransparencyNode = node.namedItem( u"layerTransparency"_s );
3014 if ( !layerTransparencyNode.isNull() )
3015 {
3016 QDomElement e = layerTransparencyNode.toElement();
3017 setOpacity( 1.0 - e.text().toInt() / 100.0 );
3018 }
3019 QDomNode layerOpacityNode = node.namedItem( u"layerOpacity"_s );
3020 if ( !layerOpacityNode.isNull() )
3021 {
3022 QDomElement e = layerOpacityNode.toElement();
3023 setOpacity( e.text().toDouble() );
3024 }
3025
3026 const bool hasScaleBasedVisibiliy { node.attributes().namedItem( u"hasScaleBasedVisibilityFlag"_s ).nodeValue() == '1' };
3027 setScaleBasedVisibility( hasScaleBasedVisibiliy );
3028 bool ok;
3029 const double maxScale { node.attributes().namedItem( u"maxScale"_s ).nodeValue().toDouble( &ok ) };
3030 if ( ok )
3031 {
3032 setMaximumScale( maxScale );
3033 }
3034 const double minScale { node.attributes().namedItem( u"minScale"_s ).nodeValue().toDouble( &ok ) };
3035 if ( ok )
3036 {
3037 setMinimumScale( minScale );
3038 }
3039
3040 QDomElement e = node.toElement();
3041
3042 // get the simplification drawing settings
3043 mSimplifyMethod.setSimplifyHints( static_cast< Qgis::VectorRenderingSimplificationFlags >( e.attribute( u"simplifyDrawingHints"_s, u"1"_s ).toInt() ) );
3044 mSimplifyMethod.setSimplifyAlgorithm( static_cast< Qgis::VectorSimplificationAlgorithm >( e.attribute( u"simplifyAlgorithm"_s, u"0"_s ).toInt() ) );
3045 mSimplifyMethod.setThreshold( e.attribute( u"simplifyDrawingTol"_s, u"1"_s ).toFloat() );
3046 mSimplifyMethod.setForceLocalOptimization( e.attribute( u"simplifyLocal"_s, u"1"_s ).toInt() );
3047 mSimplifyMethod.setMaximumScale( e.attribute( u"simplifyMaxScale"_s, u"1"_s ).toFloat() );
3048
3049 if ( mRenderer )
3050 mRenderer->setReferenceScale( e.attribute( u"symbologyReferenceScale"_s, u"-1"_s ).toDouble() );
3051 }
3052
3053 //diagram renderer and diagram layer settings
3054 if ( categories.testFlag( Diagrams ) )
3055 {
3056 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Diagrams" ) );
3057
3058 mDiagramRenderer.reset();
3059 QDomElement singleCatDiagramElem = node.firstChildElement( u"SingleCategoryDiagramRenderer"_s );
3060 if ( !singleCatDiagramElem.isNull() )
3061 {
3062 mDiagramRenderer = std::make_unique<QgsSingleCategoryDiagramRenderer>();
3063 mDiagramRenderer->readXml( singleCatDiagramElem, context );
3064 }
3065 QDomElement linearDiagramElem = node.firstChildElement( u"LinearlyInterpolatedDiagramRenderer"_s );
3066 if ( !linearDiagramElem.isNull() )
3067 {
3068 if ( linearDiagramElem.hasAttribute( u"classificationAttribute"_s ) )
3069 {
3070 // fix project from before QGIS 3.0
3071 int idx = linearDiagramElem.attribute( u"classificationAttribute"_s ).toInt();
3072 if ( idx >= 0 && idx < mFields.count() )
3073 linearDiagramElem.setAttribute( u"classificationField"_s, mFields.at( idx ).name() );
3074 }
3075
3076 mDiagramRenderer = std::make_unique<QgsLinearlyInterpolatedDiagramRenderer>();
3077 mDiagramRenderer->readXml( linearDiagramElem, context );
3078 }
3079 QDomElement stackedDiagramElem = node.firstChildElement( u"StackedDiagramRenderer"_s );
3080 if ( !stackedDiagramElem.isNull() )
3081 {
3082 mDiagramRenderer = std::make_unique<QgsStackedDiagramRenderer>();
3083 mDiagramRenderer->readXml( stackedDiagramElem, context );
3084 }
3085
3086 if ( mDiagramRenderer )
3087 {
3088 QDomElement diagramSettingsElem = node.firstChildElement( u"DiagramLayerSettings"_s );
3089 if ( !diagramSettingsElem.isNull() )
3090 {
3091 bool oldXPos = diagramSettingsElem.hasAttribute( u"xPosColumn"_s );
3092 bool oldYPos = diagramSettingsElem.hasAttribute( u"yPosColumn"_s );
3093 bool oldShow = diagramSettingsElem.hasAttribute( u"showColumn"_s );
3094 if ( oldXPos || oldYPos || oldShow )
3095 {
3096 // fix project from before QGIS 3.0
3098 if ( oldXPos )
3099 {
3100 int xPosColumn = diagramSettingsElem.attribute( u"xPosColumn"_s ).toInt();
3101 if ( xPosColumn >= 0 && xPosColumn < mFields.count() )
3102 ddp.setProperty( QgsDiagramLayerSettings::Property::PositionX, QgsProperty::fromField( mFields.at( xPosColumn ).name(), true ) );
3103 }
3104 if ( oldYPos )
3105 {
3106 int yPosColumn = diagramSettingsElem.attribute( u"yPosColumn"_s ).toInt();
3107 if ( yPosColumn >= 0 && yPosColumn < mFields.count() )
3108 ddp.setProperty( QgsDiagramLayerSettings::Property::PositionY, QgsProperty::fromField( mFields.at( yPosColumn ).name(), true ) );
3109 }
3110 if ( oldShow )
3111 {
3112 int showColumn = diagramSettingsElem.attribute( u"showColumn"_s ).toInt();
3113 if ( showColumn >= 0 && showColumn < mFields.count() )
3114 ddp.setProperty( QgsDiagramLayerSettings::Property::Show, QgsProperty::fromField( mFields.at( showColumn ).name(), true ) );
3115 }
3116 QDomElement propertiesElem = diagramSettingsElem.ownerDocument().createElement( u"properties"_s );
3118 { static_cast< int >( QgsDiagramLayerSettings::Property::PositionX ), QgsPropertyDefinition( "positionX", QObject::tr( "Position (X)" ), QgsPropertyDefinition::Double ) },
3119 { static_cast< int >( QgsDiagramLayerSettings::Property::PositionY ), QgsPropertyDefinition( "positionY", QObject::tr( "Position (Y)" ), QgsPropertyDefinition::Double ) },
3120 { static_cast< int >( QgsDiagramLayerSettings::Property::Show ), QgsPropertyDefinition( "show", QObject::tr( "Show diagram" ), QgsPropertyDefinition::Boolean ) },
3121 };
3122 ddp.writeXml( propertiesElem, defs );
3123 diagramSettingsElem.appendChild( propertiesElem );
3124 }
3125
3126 mDiagramLayerSettings = std::make_unique<QgsDiagramLayerSettings>();
3127 mDiagramLayerSettings->readXml( diagramSettingsElem );
3128 }
3129 }
3130 }
3131 // end diagram
3132
3133 styleChangedSignalBlocker.release();
3135 }
3136 return result;
3137}
3138
3139
3140bool QgsVectorLayer::writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories ) const
3141{
3143
3144 QDomElement layerElement = node.toElement();
3145 writeCommonStyle( layerElement, doc, context, categories );
3146
3147 ( void ) writeStyle( node, doc, errorMessage, context, categories );
3148
3149 if ( categories.testFlag( GeometryOptions ) )
3150 mGeometryOptions->writeXml( node );
3151
3152 if ( categories.testFlag( Legend ) && legend() )
3153 {
3154 QDomElement legendElement = legend()->writeXml( doc, context );
3155 if ( !legendElement.isNull() )
3156 node.appendChild( legendElement );
3157 }
3158
3159 // Relation information for both referenced and referencing sides
3160 if ( categories.testFlag( Relations ) )
3161 {
3162 if ( QgsProject *p = project() )
3163 {
3164 // Store referenced layers: relations where "this" is the child layer (the referencing part, that holds the FK)
3165 QDomElement referencedLayersElement = doc.createElement( u"referencedLayers"_s );
3166 node.appendChild( referencedLayersElement );
3167
3168 const QList<QgsRelation> referencingRelations { p->relationManager()->referencingRelations( this ) };
3169 for ( const QgsRelation &rel : referencingRelations )
3170 {
3171 switch ( rel.type() )
3172 {
3174 QgsWeakRelation::writeXml( this, QgsWeakRelation::Referencing, rel, referencedLayersElement, doc );
3175 break;
3177 break;
3178 }
3179 }
3180
3181 // Store referencing layers: relations where "this" is the parent layer (the referenced part, that holds the FK)
3182 QDomElement referencingLayersElement = doc.createElement( u"referencingLayers"_s );
3183 node.appendChild( referencingLayersElement );
3184
3185 const QList<QgsRelation> referencedRelations { p->relationManager()->referencedRelations( this ) };
3186 for ( const QgsRelation &rel : referencedRelations )
3187 {
3188 switch ( rel.type() )
3189 {
3191 QgsWeakRelation::writeXml( this, QgsWeakRelation::Referenced, rel, referencingLayersElement, doc );
3192 break;
3194 break;
3195 }
3196 }
3197 }
3198 }
3199
3200 // write field configurations
3201 if ( categories.testFlag( Fields ) || categories.testFlag( Forms ) )
3202 {
3203 QDomElement fieldConfigurationElement;
3204 // field configuration flag
3205 fieldConfigurationElement = doc.createElement( u"fieldConfiguration"_s );
3206 node.appendChild( fieldConfigurationElement );
3207
3208 for ( const QgsField &field : std::as_const( mFields ) )
3209 {
3210 QDomElement fieldElement = doc.createElement( u"field"_s );
3211 fieldElement.setAttribute( u"name"_s, field.name() );
3212 fieldConfigurationElement.appendChild( fieldElement );
3213
3214 if ( categories.testFlag( Fields ) )
3215 {
3216 fieldElement.setAttribute( u"configurationFlags"_s, qgsFlagValueToKeys( field.configurationFlags() ) );
3217 }
3218
3219 if ( categories.testFlag( Forms ) )
3220 {
3221 QgsEditorWidgetSetup widgetSetup = field.editorWidgetSetup();
3222
3223 // TODO : wrap this part in an if to only save if it was user-modified
3224 QDomElement editWidgetElement = doc.createElement( u"editWidget"_s );
3225 fieldElement.appendChild( editWidgetElement );
3226 editWidgetElement.setAttribute( u"type"_s, field.editorWidgetSetup().type() );
3227 QDomElement editWidgetConfigElement = doc.createElement( u"config"_s );
3228
3229 editWidgetConfigElement.appendChild( QgsXmlUtils::writeVariant( widgetSetup.config(), doc ) );
3230 editWidgetElement.appendChild( editWidgetConfigElement );
3231 // END TODO : wrap this part in an if to only save if it was user-modified
3232 }
3233 }
3234 }
3235
3236 if ( categories.testFlag( Fields ) )
3237 {
3238 //attribute aliases
3239 QDomElement aliasElem = doc.createElement( u"aliases"_s );
3240 for ( const QgsField &field : std::as_const( mFields ) )
3241 {
3242 QDomElement aliasEntryElem = doc.createElement( u"alias"_s );
3243 aliasEntryElem.setAttribute( u"field"_s, field.name() );
3244 aliasEntryElem.setAttribute( u"index"_s, mFields.indexFromName( field.name() ) );
3245 aliasEntryElem.setAttribute( u"name"_s, field.alias() );
3246 aliasElem.appendChild( aliasEntryElem );
3247 }
3248 node.appendChild( aliasElem );
3249
3250 //custom comments
3251 QDomElement customCommentElem = doc.createElement( u"customComments"_s );
3252 bool hasCustomComments = false;
3253 for ( const QgsField &field : std::as_const( mFields ) )
3254 {
3255 //if empty ("") we store it, if null we don't store it
3256 const QString customComment = field.customComment();
3257 if ( customComment.isNull() )
3258 continue;
3259
3260 hasCustomComments = true;
3261 QDomElement customCommentEntryElem = doc.createElement( u"customComment"_s );
3262 customCommentEntryElem.setAttribute( u"field"_s, field.name() );
3263 customCommentEntryElem.setAttribute( u"value"_s, customComment );
3264 customCommentElem.appendChild( customCommentEntryElem );
3265 }
3266 if ( hasCustomComments )
3267 {
3268 node.appendChild( customCommentElem );
3269 }
3270
3271 //split policies
3272 {
3273 QDomElement splitPoliciesElement = doc.createElement( u"splitPolicies"_s );
3274 bool hasNonDefaultSplitPolicies = false;
3275 for ( const QgsField &field : std::as_const( mFields ) )
3276 {
3277 if ( field.splitPolicy() != Qgis::FieldDomainSplitPolicy::Duplicate )
3278 {
3279 QDomElement splitPolicyElem = doc.createElement( u"policy"_s );
3280 splitPolicyElem.setAttribute( u"field"_s, field.name() );
3281 splitPolicyElem.setAttribute( u"policy"_s, qgsEnumValueToKey( field.splitPolicy() ) );
3282 splitPoliciesElement.appendChild( splitPolicyElem );
3283 hasNonDefaultSplitPolicies = true;
3284 }
3285 }
3286 if ( hasNonDefaultSplitPolicies )
3287 node.appendChild( splitPoliciesElement );
3288 }
3289
3290 //duplicate policies
3291 {
3292 QDomElement duplicatePoliciesElement = doc.createElement( u"duplicatePolicies"_s );
3293 bool hasNonDefaultDuplicatePolicies = false;
3294 for ( const QgsField &field : std::as_const( mFields ) )
3295 {
3296 if ( field.duplicatePolicy() != Qgis::FieldDuplicatePolicy::Duplicate )
3297 {
3298 QDomElement duplicatePolicyElem = doc.createElement( u"policy"_s );
3299 duplicatePolicyElem.setAttribute( u"field"_s, field.name() );
3300 duplicatePolicyElem.setAttribute( u"policy"_s, qgsEnumValueToKey( field.duplicatePolicy() ) );
3301 duplicatePoliciesElement.appendChild( duplicatePolicyElem );
3302 hasNonDefaultDuplicatePolicies = true;
3303 }
3304 }
3305 if ( hasNonDefaultDuplicatePolicies )
3306 node.appendChild( duplicatePoliciesElement );
3307 }
3308
3309 //merge policies
3310 {
3311 QDomElement mergePoliciesElement = doc.createElement( u"mergePolicies"_s );
3312 bool hasNonDefaultMergePolicies = false;
3313 for ( const QgsField &field : std::as_const( mFields ) )
3314 {
3315 if ( field.mergePolicy() != Qgis::FieldDomainMergePolicy::UnsetField )
3316 {
3317 QDomElement mergePolicyElem = doc.createElement( u"policy"_s );
3318 mergePolicyElem.setAttribute( u"field"_s, field.name() );
3319 mergePolicyElem.setAttribute( u"policy"_s, qgsEnumValueToKey( field.mergePolicy() ) );
3320 mergePoliciesElement.appendChild( mergePolicyElem );
3321 hasNonDefaultMergePolicies = true;
3322 }
3323 }
3324 if ( hasNonDefaultMergePolicies )
3325 node.appendChild( mergePoliciesElement );
3326 }
3327
3328 //default expressions
3329 QDomElement defaultsElem = doc.createElement( u"defaults"_s );
3330 for ( const QgsField &field : std::as_const( mFields ) )
3331 {
3332 QDomElement defaultElem = doc.createElement( u"default"_s );
3333 defaultElem.setAttribute( u"field"_s, field.name() );
3334 defaultElem.setAttribute( u"expression"_s, field.defaultValueDefinition().expression() );
3335 defaultElem.setAttribute( u"applyOnUpdate"_s, field.defaultValueDefinition().applyOnUpdate() ? u"1"_s : u"0"_s );
3336 defaultsElem.appendChild( defaultElem );
3337 }
3338 node.appendChild( defaultsElem );
3339
3340 // constraints
3341 QDomElement constraintsElem = doc.createElement( u"constraints"_s );
3342 for ( const QgsField &field : std::as_const( mFields ) )
3343 {
3344 QDomElement constraintElem = doc.createElement( u"constraint"_s );
3345 constraintElem.setAttribute( u"field"_s, field.name() );
3346 constraintElem.setAttribute( u"constraints"_s, field.constraints().constraints() );
3347 constraintElem.setAttribute( u"unique_strength"_s, field.constraints().constraintStrength( QgsFieldConstraints::ConstraintUnique ) );
3348 constraintElem.setAttribute( u"notnull_strength"_s, field.constraints().constraintStrength( QgsFieldConstraints::ConstraintNotNull ) );
3349 constraintElem.setAttribute( u"exp_strength"_s, field.constraints().constraintStrength( QgsFieldConstraints::ConstraintExpression ) );
3350
3351 constraintsElem.appendChild( constraintElem );
3352 }
3353 node.appendChild( constraintsElem );
3354
3355 // constraint expressions
3356 QDomElement constraintExpressionsElem = doc.createElement( u"constraintExpressions"_s );
3357 for ( const QgsField &field : std::as_const( mFields ) )
3358 {
3359 QDomElement constraintExpressionElem = doc.createElement( u"constraint"_s );
3360 constraintExpressionElem.setAttribute( u"field"_s, field.name() );
3361 constraintExpressionElem.setAttribute( u"exp"_s, field.constraints().constraintExpression() );
3362 constraintExpressionElem.setAttribute( u"desc"_s, field.constraints().constraintDescription() );
3363 constraintExpressionsElem.appendChild( constraintExpressionElem );
3364 }
3365 node.appendChild( constraintExpressionsElem );
3366
3367 // save expression fields
3368 if ( !mExpressionFieldBuffer )
3369 {
3370 // can happen when saving style on a invalid layer
3372 dummy.writeXml( node, doc );
3373 }
3374 else
3375 {
3376 mExpressionFieldBuffer->writeXml( node, doc );
3377 }
3378 }
3379
3380 // add attribute actions
3381 if ( categories.testFlag( Actions ) )
3382 mActions->writeXml( node );
3383
3384 if ( categories.testFlag( AttributeTable ) )
3385 {
3386 mAttributeTableConfig.writeXml( node );
3387 mConditionalStyles->writeXml( node, doc, context );
3388 mStoredExpressionManager->writeXml( node );
3389 }
3390
3391 if ( categories.testFlag( Forms ) )
3392 mEditFormConfig.writeXml( node, context );
3393
3394 // save readonly state
3395 if ( categories.testFlag( LayerConfiguration ) )
3396 node.toElement().setAttribute( u"readOnly"_s, mReadOnly );
3397
3398 // save preview expression
3399 if ( categories.testFlag( LayerConfiguration ) )
3400 {
3401 QDomElement prevExpElem = doc.createElement( u"previewExpression"_s );
3402 QDomText prevExpText = doc.createTextNode( mDisplayExpression );
3403 prevExpElem.appendChild( prevExpText );
3404 node.appendChild( prevExpElem );
3405 }
3406
3407 // save map tip
3408 if ( categories.testFlag( MapTips ) )
3409 {
3410 QDomElement mapTipElem = doc.createElement( u"mapTip"_s );
3411 mapTipElem.setAttribute( u"enabled"_s, mapTipsEnabled() );
3412 QDomText mapTipText = doc.createTextNode( mMapTipTemplate );
3413 mapTipElem.appendChild( mapTipText );
3414 node.toElement().appendChild( mapTipElem );
3415 }
3416
3417 return true;
3418}
3419
3420bool QgsVectorLayer::writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories ) const
3421{
3423
3424 QDomElement mapLayerNode = node.toElement();
3425
3426 emit writeCustomSymbology( mapLayerNode, doc, errorMessage );
3427
3428 // we must try to write the renderer if our geometry type is unknown
3429 // as this allows the renderer to be correctly restored even for layers
3430 // with broken sources
3431 if ( isSpatial() || mWkbType == Qgis::WkbType::Unknown )
3432 {
3433 if ( categories.testFlag( Symbology ) )
3434 {
3435 if ( mRenderer )
3436 {
3437 QDomElement rendererElement = mRenderer->save( doc, context );
3438 node.appendChild( rendererElement );
3439 }
3440 if ( mSelectionProperties )
3441 {
3442 mSelectionProperties->writeXml( mapLayerNode, doc, context );
3443 }
3444 }
3445
3446 if ( categories.testFlag( Labeling ) )
3447 {
3448 if ( mLabeling )
3449 {
3450 QDomElement labelingElement = mLabeling->save( doc, context );
3451 node.appendChild( labelingElement );
3452 }
3453 mapLayerNode.setAttribute( u"labelsEnabled"_s, mLabelsEnabled ? u"1"_s : u"0"_s );
3454 }
3455
3456 // save the simplification drawing settings
3457 if ( categories.testFlag( Rendering ) )
3458 {
3459 mapLayerNode.setAttribute( u"simplifyDrawingHints"_s, QString::number( static_cast< int >( mSimplifyMethod.simplifyHints() ) ) );
3460 mapLayerNode.setAttribute( u"simplifyAlgorithm"_s, QString::number( static_cast< int >( mSimplifyMethod.simplifyAlgorithm() ) ) );
3461 mapLayerNode.setAttribute( u"simplifyDrawingTol"_s, QString::number( mSimplifyMethod.threshold() ) );
3462 mapLayerNode.setAttribute( u"simplifyLocal"_s, mSimplifyMethod.forceLocalOptimization() ? 1 : 0 );
3463 mapLayerNode.setAttribute( u"simplifyMaxScale"_s, QString::number( mSimplifyMethod.maximumScale() ) );
3464 }
3465
3466 //save customproperties
3467 if ( categories.testFlag( CustomProperties ) )
3468 {
3469 writeCustomProperties( node, doc );
3470 }
3471
3472 if ( categories.testFlag( Symbology ) )
3473 {
3474 // add the blend mode field
3475 QDomElement blendModeElem = doc.createElement( u"blendMode"_s );
3476 QDomText blendModeText = doc.createTextNode( QString::number( static_cast< int >( QgsPainting::getBlendModeEnum( blendMode() ) ) ) );
3477 blendModeElem.appendChild( blendModeText );
3478 node.appendChild( blendModeElem );
3479
3480 // add the feature blend mode field
3481 QDomElement featureBlendModeElem = doc.createElement( u"featureBlendMode"_s );
3482 QDomText featureBlendModeText = doc.createTextNode( QString::number( static_cast< int >( QgsPainting::getBlendModeEnum( featureBlendMode() ) ) ) );
3483 featureBlendModeElem.appendChild( featureBlendModeText );
3484 node.appendChild( featureBlendModeElem );
3485 }
3486
3487 // add the layer opacity and scale visibility
3488 if ( categories.testFlag( Rendering ) )
3489 {
3490 QDomElement layerOpacityElem = doc.createElement( u"layerOpacity"_s );
3491 QDomText layerOpacityText = doc.createTextNode( QString::number( opacity() ) );
3492 layerOpacityElem.appendChild( layerOpacityText );
3493 node.appendChild( layerOpacityElem );
3494 mapLayerNode.setAttribute( u"hasScaleBasedVisibilityFlag"_s, hasScaleBasedVisibility() ? 1 : 0 );
3495 mapLayerNode.setAttribute( u"maxScale"_s, maximumScale() );
3496 mapLayerNode.setAttribute( u"minScale"_s, minimumScale() );
3497
3498 mapLayerNode.setAttribute( u"symbologyReferenceScale"_s, mRenderer ? mRenderer->referenceScale() : -1 );
3499 }
3500
3501 if ( categories.testFlag( Diagrams ) && mDiagramRenderer )
3502 {
3503 mDiagramRenderer->writeXml( mapLayerNode, doc, context );
3504 if ( mDiagramLayerSettings )
3505 mDiagramLayerSettings->writeXml( mapLayerNode, doc );
3506 }
3507 }
3508 return true;
3509}
3510
3511bool QgsVectorLayer::readSld( const QDomNode &node, QString &errorMessage )
3512{
3514
3515 // get the Name element
3516 QDomElement nameElem = node.firstChildElement( u"Name"_s );
3517 if ( nameElem.isNull() )
3518 {
3519 errorMessage = u"Warning: Name element not found within NamedLayer while it's required."_s;
3520 }
3521
3522 if ( isSpatial() )
3523 {
3524 QgsFeatureRenderer *r = QgsFeatureRenderer::loadSld( node, geometryType(), errorMessage );
3525 if ( !r )
3526 return false;
3527
3528 // defer style changed signal until we've set the renderer, labeling, everything.
3529 // we don't want multiple signals!
3530 ScopedIntIncrementor styleChangedSignalBlocker( &mBlockStyleChangedSignal );
3531
3532 setRenderer( r );
3533
3534 // labeling
3535 readSldLabeling( node );
3536
3537 styleChangedSignalBlocker.release();
3539 }
3540 return true;
3541}
3542
3543bool QgsVectorLayer::writeSld( QDomNode &node, QDomDocument &doc, QString &, const QVariantMap &props ) const
3544{
3546 QgsSldExportContext context;
3547 context.setExtraProperties( props );
3548 writeSld( node, doc, context );
3549 return true;
3550}
3551
3552bool QgsVectorLayer::writeSld( QDomNode &node, QDomDocument &doc, QgsSldExportContext &context ) const
3553{
3555
3556 QVariantMap localProps = context.extraProperties();
3558 {
3560 }
3561 context.setExtraProperties( localProps );
3562
3563 if ( isSpatial() )
3564 {
3565 // store the Name element
3566 QDomElement nameNode = doc.createElement( u"se:Name"_s );
3567 nameNode.appendChild( doc.createTextNode( name() ) );
3568 node.appendChild( nameNode );
3569
3570 QDomElement userStyleElem = doc.createElement( u"UserStyle"_s );
3571 node.appendChild( userStyleElem );
3572
3573 QDomElement nameElem = doc.createElement( u"se:Name"_s );
3574 nameElem.appendChild( doc.createTextNode( name() ) );
3575
3576 userStyleElem.appendChild( nameElem );
3577
3578 QDomElement featureTypeStyleElem = doc.createElement( u"se:FeatureTypeStyle"_s );
3579 userStyleElem.appendChild( featureTypeStyleElem );
3580
3581 mRenderer->toSld( doc, featureTypeStyleElem, context );
3582 if ( labelsEnabled() )
3583 {
3584 mLabeling->toSld( featureTypeStyleElem, context );
3585 }
3586 }
3587 return true;
3588}
3589
3590bool QgsVectorLayer::changeGeometry( QgsFeatureId fid, QgsGeometry &geom, bool skipDefaultValue )
3591{
3593
3594 if ( !mEditBuffer || !mDataProvider )
3595 {
3596 return false;
3597 }
3598
3599 if ( mGeometryOptions->isActive() )
3600 mGeometryOptions->apply( geom );
3601
3602 updateExtents();
3603
3604 bool result = mEditBuffer->changeGeometry( fid, geom );
3605
3606 if ( result )
3607 {
3608 updateExtents();
3609 if ( !skipDefaultValue && !mDefaultValueOnUpdateFields.isEmpty() )
3610 updateDefaultValues( fid );
3611 }
3612 return result;
3613}
3614
3615
3616bool QgsVectorLayer::changeAttributeValue( QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue, bool skipDefaultValues, QgsVectorLayerToolsContext *context )
3617{
3619
3620 bool result = false;
3621
3622 switch ( fields().fieldOrigin( field ) )
3623 {
3625 result = mJoinBuffer->changeAttributeValue( fid, field, newValue, oldValue );
3626 if ( result )
3627 emit attributeValueChanged( fid, field, newValue );
3628 break;
3629
3633 {
3634 if ( mEditBuffer && mDataProvider )
3635 result = mEditBuffer->changeAttributeValue( fid, field, newValue, oldValue );
3636 break;
3637 }
3638
3640 break;
3641 }
3642
3643 if ( result && !skipDefaultValues && !mDefaultValueOnUpdateFields.isEmpty() )
3644 updateDefaultValues( fid, QgsFeature(), context ? context->expressionContext() : nullptr );
3645
3646 return result;
3647}
3648
3649bool QgsVectorLayer::changeAttributeValues( QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues, bool skipDefaultValues, QgsVectorLayerToolsContext *context )
3650{
3652
3653 bool result = true;
3654
3655 QgsAttributeMap newValuesJoin;
3656 QgsAttributeMap oldValuesJoin;
3657
3658 QgsAttributeMap newValuesNotJoin;
3659 QgsAttributeMap oldValuesNotJoin;
3660
3661 for ( auto it = newValues.constBegin(); it != newValues.constEnd(); ++it )
3662 {
3663 const int field = it.key();
3664 const QVariant newValue = it.value();
3665 QVariant oldValue;
3666
3667 if ( oldValues.contains( field ) )
3668 oldValue = oldValues[field];
3669
3670 switch ( fields().fieldOrigin( field ) )
3671 {
3673 newValuesJoin[field] = newValue;
3674 oldValuesJoin[field] = oldValue;
3675 break;
3676
3680 {
3681 newValuesNotJoin[field] = newValue;
3682 oldValuesNotJoin[field] = oldValue;
3683 break;
3684 }
3685
3687 break;
3688 }
3689 }
3690
3691 if ( !newValuesJoin.isEmpty() && mJoinBuffer )
3692 {
3693 result = mJoinBuffer->changeAttributeValues( fid, newValuesJoin, oldValuesJoin );
3694 }
3695
3696 if ( !newValuesNotJoin.isEmpty() )
3697 {
3698 if ( mEditBuffer && mDataProvider )
3699 result &= mEditBuffer->changeAttributeValues( fid, newValuesNotJoin, oldValues );
3700 else
3701 result = false;
3702 }
3703
3704 if ( result && !skipDefaultValues && !mDefaultValueOnUpdateFields.isEmpty() )
3705 {
3706 updateDefaultValues( fid, QgsFeature(), context ? context->expressionContext() : nullptr );
3707 }
3708
3709 return result;
3710}
3711
3713{
3715
3716 if ( !mEditBuffer || !mDataProvider )
3717 return false;
3718
3719 return mEditBuffer->addAttribute( field );
3720}
3721
3723{
3725
3726 if ( attIndex < 0 || attIndex >= fields().count() )
3727 return;
3728
3729 QString name = fields().at( attIndex ).name();
3730 mFields[attIndex].setAlias( QString() );
3731 if ( mAttributeAliasMap.contains( name ) )
3732 {
3733 mAttributeAliasMap.remove( name );
3734 updateFields();
3735 mEditFormConfig.setFields( mFields );
3736 emit layerModified();
3737 }
3738}
3739
3740bool QgsVectorLayer::renameAttribute( int index, const QString &newName )
3741{
3743
3744 if ( index < 0 || index >= fields().count() )
3745 return false;
3746
3747 switch ( mFields.fieldOrigin( index ) )
3748 {
3750 {
3751 if ( mExpressionFieldBuffer )
3752 {
3753 int oi = mFields.fieldOriginIndex( index );
3754 mExpressionFieldBuffer->renameExpression( oi, newName );
3755 updateFields();
3756 return true;
3757 }
3758 else
3759 {
3760 return false;
3761 }
3762 }
3763
3766
3767 if ( !mEditBuffer || !mDataProvider )
3768 return false;
3769
3770 return mEditBuffer->renameAttribute( index, newName );
3771
3774 return false;
3775 }
3776
3777 return false; // avoid warning
3778}
3779
3780void QgsVectorLayer::setFieldAlias( int attIndex, const QString &aliasString )
3781{
3783
3784 if ( attIndex < 0 || attIndex >= fields().count() )
3785 return;
3786
3787 QString name = fields().at( attIndex ).name();
3788
3789 mAttributeAliasMap.insert( name, aliasString );
3790 mFields[attIndex].setAlias( aliasString );
3791 mEditFormConfig.setFields( mFields );
3792 emit layerModified(); // TODO[MD]: should have a different signal?
3793}
3794
3795QString QgsVectorLayer::attributeAlias( int index ) const
3796{
3798
3799 if ( index < 0 || index >= fields().count() )
3800 return QString();
3801
3802 return fields().at( index ).alias();
3803}
3804
3805void QgsVectorLayer::setFieldCustomComment( int attIndex, const QString &customCommentString )
3806{
3808
3809 if ( attIndex < 0 || attIndex >= fields().count() )
3810 return;
3811
3812 QString name = fields().at( attIndex ).name();
3813
3814 mAttributeCustomCommentMap.insert( name, customCommentString );
3815 mFields[attIndex].setCustomComment( customCommentString );
3816 mEditFormConfig.setFields( mFields );
3817 emit layerModified();
3818}
3819
3821{
3823
3824 if ( attIndex < 0 || attIndex >= fields().count() )
3825 return;
3826
3827 QString name = fields().at( attIndex ).name();
3828 mFields[attIndex].setCustomComment( QString() );
3829 if ( mAttributeCustomCommentMap.contains( name ) )
3830 {
3831 mAttributeCustomCommentMap.remove( name );
3832 updateFields();
3833 mEditFormConfig.setFields( mFields );
3834 emit layerModified();
3835 }
3836}
3837
3839{
3841
3842 if ( index < 0 || index >= fields().count() )
3843 return QString();
3844
3845 return fields().at( index ).customComment();
3846}
3847
3849{
3851
3852 return mAttributeCustomCommentMap;
3853}
3854
3856{
3858
3859 if ( index >= 0 && index < mFields.count() )
3860 return mFields.at( index ).displayName();
3861 else
3862 return QString();
3863}
3864
3866{
3868
3869 return mAttributeAliasMap;
3870}
3871
3873{
3875
3876 if ( index < 0 || index >= fields().count() )
3877 return;
3878
3879 const QString name = fields().at( index ).name();
3880
3881 mAttributeSplitPolicy.insert( name, policy );
3882 mFields[index].setSplitPolicy( policy );
3883 mEditFormConfig.setFields( mFields );
3884 emit layerModified(); // TODO[MD]: should have a different signal?
3885}
3886
3888{
3890
3891 if ( index < 0 || index >= fields().count() )
3892 return;
3893
3894 const QString name = fields().at( index ).name();
3895
3896 mAttributeDuplicatePolicy.insert( name, policy );
3897 mFields[index].setDuplicatePolicy( policy );
3898 mEditFormConfig.setFields( mFields );
3899 emit layerModified(); // TODO[MD]: should have a different signal?
3900}
3901
3903{
3905
3906 if ( index < 0 || index >= fields().count() )
3907 return;
3908
3909 const QString name = fields().at( index ).name();
3910
3911 mAttributeMergePolicy.insert( name, policy );
3912 mFields[index].setMergePolicy( policy );
3913 mEditFormConfig.setFields( mFields );
3914 emit layerModified(); // TODO[MD]: should have a different signal?
3915}
3916
3918{
3920
3921 QSet<QString> excludeList;
3922 QMap< QString, Qgis::FieldConfigurationFlags >::const_iterator flagsIt = mFieldConfigurationFlags.constBegin();
3923 for ( ; flagsIt != mFieldConfigurationFlags.constEnd(); ++flagsIt )
3924 {
3925 if ( flagsIt->testFlag( Qgis::FieldConfigurationFlag::HideFromWms ) )
3926 {
3927 excludeList << flagsIt.key();
3928 }
3929 }
3930 return excludeList;
3931}
3932
3933void QgsVectorLayer::setExcludeAttributesWms( const QSet<QString> &att )
3934{
3936
3937 QMap< QString, Qgis::FieldConfigurationFlags >::iterator flagsIt = mFieldConfigurationFlags.begin();
3938 for ( ; flagsIt != mFieldConfigurationFlags.end(); ++flagsIt )
3939 {
3940 flagsIt->setFlag( Qgis::FieldConfigurationFlag::HideFromWms, att.contains( flagsIt.key() ) );
3941 }
3942 updateFields();
3943}
3944
3946{
3948
3949 QSet<QString> excludeList;
3950 QMap< QString, Qgis::FieldConfigurationFlags >::const_iterator flagsIt = mFieldConfigurationFlags.constBegin();
3951 for ( ; flagsIt != mFieldConfigurationFlags.constEnd(); ++flagsIt )
3952 {
3953 if ( flagsIt->testFlag( Qgis::FieldConfigurationFlag::HideFromWfs ) )
3954 {
3955 excludeList << flagsIt.key();
3956 }
3957 }
3958 return excludeList;
3959}
3960
3961void QgsVectorLayer::setExcludeAttributesWfs( const QSet<QString> &att )
3962{
3964
3965 QMap< QString, Qgis::FieldConfigurationFlags >::iterator flagsIt = mFieldConfigurationFlags.begin();
3966 for ( ; flagsIt != mFieldConfigurationFlags.end(); ++flagsIt )
3967 {
3968 flagsIt->setFlag( Qgis::FieldConfigurationFlag::HideFromWfs, att.contains( flagsIt.key() ) );
3969 }
3970 updateFields();
3971}
3972
3974{
3976
3977 if ( index < 0 || index >= fields().count() )
3978 return false;
3979
3980 if ( mFields.fieldOrigin( index ) == Qgis::FieldOrigin::Expression )
3981 {
3982 removeExpressionField( index );
3983 return true;
3984 }
3985
3986 if ( !mEditBuffer || !mDataProvider )
3987 return false;
3988
3989 return mEditBuffer->deleteAttribute( index );
3990}
3991
3992bool QgsVectorLayer::deleteAttributes( const QList<int> &attrs )
3993{
3995
3996 bool deleted = false;
3997
3998 // Remove multiple occurrences of same attribute
3999 QList<int> attrList = qgis::setToList( qgis::listToSet( attrs ) );
4000
4001 std::sort( attrList.begin(), attrList.end(), std::greater<int>() );
4002
4003 for ( int attr : std::as_const( attrList ) )
4004 {
4005 if ( deleteAttribute( attr ) )
4006 {
4007 deleted = true;
4008 }
4009 }
4010
4011 return deleted;
4012}
4013
4014bool QgsVectorLayer::deleteFeatureCascade( QgsFeatureId fid, QgsVectorLayer::DeleteContext *context )
4015{
4017
4018 if ( !mEditBuffer )
4019 return false;
4020
4021 if ( context && context->cascade )
4022 {
4023 const QList<QgsRelation> relations = context->project->relationManager()->referencedRelations( this );
4024 const bool hasRelationsOrJoins = !relations.empty() || mJoinBuffer->containsJoins();
4025 if ( hasRelationsOrJoins )
4026 {
4027 if ( context->mHandledFeatures.contains( this ) )
4028 {
4029 QgsFeatureIds &handledFeatureIds = context->mHandledFeatures[this];
4030 if ( handledFeatureIds.contains( fid ) )
4031 {
4032 // avoid endless recursion
4033 return false;
4034 }
4035 else
4036 {
4037 // add feature id
4038 handledFeatureIds << fid;
4039 }
4040 }
4041 else
4042 {
4043 // add layer and feature id
4044 context->mHandledFeatures.insert( this, QgsFeatureIds() << fid );
4045 }
4046
4047 for ( const QgsRelation &relation : relations )
4048 {
4049 //check if composition (and not association)
4050 switch ( relation.strength() )
4051 {
4053 {
4054 //get features connected over this relation
4055 QgsFeatureIterator relatedFeaturesIt = relation.getRelatedFeatures( getFeature( fid ) );
4056 QgsFeatureIds childFeatureIds;
4057 QgsFeature childFeature;
4058 while ( relatedFeaturesIt.nextFeature( childFeature ) )
4059 {
4060 childFeatureIds.insert( childFeature.id() );
4061 }
4062 if ( childFeatureIds.count() > 0 )
4063 {
4064 relation.referencingLayer()->startEditing();
4065 relation.referencingLayer()->deleteFeatures( childFeatureIds, context );
4066 }
4067 break;
4068 }
4069
4071 break;
4072 }
4073 }
4074 }
4075 }
4076
4077 if ( mJoinBuffer->containsJoins() )
4078 mJoinBuffer->deleteFeature( fid, context );
4079
4080 bool res = mEditBuffer->deleteFeature( fid );
4081
4082 return res;
4083}
4084
4086{
4088
4089 if ( !mEditBuffer )
4090 return false;
4091
4092 return deleteFeatureCascade( fid, context );
4093}
4094
4096{
4098
4099 bool res = true;
4100
4101 if ( ( context && context->cascade ) || mJoinBuffer->containsJoins() )
4102 {
4103 // should ideally be "deleteFeaturesCascade" for performance!
4104 for ( QgsFeatureId fid : fids )
4105 res = deleteFeatureCascade( fid, context ) && res;
4106 }
4107 else
4108 {
4109 res = mEditBuffer && mEditBuffer->deleteFeatures( fids );
4110 }
4111
4112 if ( res )
4113 {
4114 mSelectedFeatureIds.subtract( fids ); // remove it from selection
4115 updateExtents();
4116 }
4117
4118 return res;
4119}
4120
4122{
4123 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
4125
4126 return mFields;
4127}
4128
4130{
4132
4133 QgsAttributeList pkAttributesList;
4134 if ( !mDataProvider )
4135 return pkAttributesList;
4136
4137 QgsAttributeList providerIndexes = mDataProvider->pkAttributeIndexes();
4138 for ( int i = 0; i < mFields.count(); ++i )
4139 {
4140 if ( mFields.fieldOrigin( i ) == Qgis::FieldOrigin::Provider && providerIndexes.contains( mFields.fieldOriginIndex( i ) ) )
4141 pkAttributesList << i;
4142 }
4143
4144 return pkAttributesList;
4145}
4146
4148{
4150
4151 if ( !mDataProvider )
4152 return static_cast< long long >( Qgis::FeatureCountState::UnknownCount );
4153 return mDataProvider->featureCount() + ( mEditBuffer && !mDataProvider->transaction() ? mEditBuffer->addedFeatures().size() - mEditBuffer->deletedFeatureIds().size() : 0 );
4154}
4155
4157{
4159
4160 const QgsFeatureIds deletedFeatures( mEditBuffer && !mDataProvider->transaction() ? mEditBuffer->deletedFeatureIds() : QgsFeatureIds() );
4161 const QgsFeatureMap addedFeatures( mEditBuffer && !mDataProvider->transaction() ? mEditBuffer->addedFeatures() : QgsFeatureMap() );
4162
4163 if ( mEditBuffer && !deletedFeatures.empty() )
4164 {
4165 if ( addedFeatures.size() > deletedFeatures.size() )
4167 else
4169 }
4170
4171 if ( ( !mEditBuffer || addedFeatures.empty() ) && mDataProvider && mDataProvider->empty() )
4173 else
4175}
4176
4177bool QgsVectorLayer::commitChanges( bool stopEditing )
4178{
4180
4181 if ( project() && project()->transactionMode() == Qgis::TransactionMode::BufferedGroups )
4182 return project()->commitChanges( mCommitErrors, stopEditing, this );
4183
4184 mCommitErrors.clear();
4185
4186 if ( !mDataProvider )
4187 {
4188 mCommitErrors << tr( "ERROR: no provider" );
4189 return false;
4190 }
4191
4192 if ( !mEditBuffer )
4193 {
4194 mCommitErrors << tr( "ERROR: layer not editable" );
4195 return false;
4196 }
4197
4198 emit beforeCommitChanges( stopEditing );
4199
4200 if ( !mAllowCommit )
4201 return false;
4202
4203 mCommitChangesActive = true;
4204
4205 bool success = false;
4206 if ( mEditBuffer->editBufferGroup() )
4207 success = mEditBuffer->editBufferGroup()->commitChanges( mCommitErrors, stopEditing );
4208 else
4209 success = mEditBuffer->commitChanges( mCommitErrors );
4210
4211 mCommitChangesActive = false;
4212
4213 if ( !mDeletedFids.empty() )
4214 {
4215 emit featuresDeleted( mDeletedFids );
4216 mDeletedFids.clear();
4217 }
4218
4219 if ( success )
4220 {
4221 if ( stopEditing )
4222 {
4223 clearEditBuffer();
4224 }
4225 undoStack()->clear();
4226 emit afterCommitChanges();
4227 if ( stopEditing )
4228 emit editingStopped();
4229 }
4230 else
4231 {
4232 QgsMessageLog::logMessage( tr( "Commit errors:\n %1" ).arg( mCommitErrors.join( "\n "_L1 ) ) );
4233 }
4234
4235 updateFields();
4236
4237 mDataProvider->updateExtents();
4238
4239 if ( stopEditing )
4240 {
4241 mDataProvider->leaveUpdateMode();
4242 }
4243
4244 // This second call is required because OGR provider with JSON
4245 // driver might have changed fields order after the call to
4246 // leaveUpdateMode
4247 if ( mFields.names() != mDataProvider->fields().names() )
4248 {
4249 updateFields();
4250 }
4251
4253
4254 return success;
4255}
4256
4258{
4260
4261 return mCommitErrors;
4262}
4263
4264bool QgsVectorLayer::rollBack( bool deleteBuffer )
4265{
4267
4268 if ( project() && project()->transactionMode() == Qgis::TransactionMode::BufferedGroups )
4269 return project()->rollBack( mCommitErrors, deleteBuffer, this );
4270
4271 if ( !mEditBuffer )
4272 {
4273 return false;
4274 }
4275
4276 if ( !mDataProvider )
4277 {
4278 mCommitErrors << tr( "ERROR: no provider" );
4279 return false;
4280 }
4281
4282 bool rollbackExtent = !mDataProvider->transaction() && ( !mEditBuffer->deletedFeatureIds().isEmpty() || !mEditBuffer->addedFeatures().isEmpty() || !mEditBuffer->changedGeometries().isEmpty() );
4283
4284 emit beforeRollBack();
4285
4286 mEditBuffer->rollBack();
4287
4288 emit afterRollBack();
4289
4290 if ( isModified() )
4291 {
4292 // new undo stack roll back method
4293 // old method of calling every undo could cause many canvas refreshes
4294 undoStack()->setIndex( 0 );
4295 }
4296
4297 updateFields();
4298
4299 if ( deleteBuffer )
4300 {
4301 delete mEditBuffer;
4302 mEditBuffer = nullptr;
4303 undoStack()->clear();
4304 }
4305 emit editingStopped();
4306
4307 if ( rollbackExtent )
4308 updateExtents();
4309
4310 mDataProvider->leaveUpdateMode();
4311
4313 return true;
4314}
4315
4317{
4319
4320 return mSelectedFeatureIds.size();
4321}
4322
4324{
4325 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
4327
4328 return mSelectedFeatureIds;
4329}
4330
4332{
4334
4335 QgsFeatureList features;
4336 features.reserve( mSelectedFeatureIds.count() );
4337 QgsFeature f;
4338
4340
4341 while ( it.nextFeature( f ) )
4342 {
4343 features.push_back( f );
4344 }
4345
4346 return features;
4347}
4348
4350{
4352
4353 if ( mSelectedFeatureIds.isEmpty() )
4354 return QgsFeatureIterator();
4355
4358
4359 if ( mSelectedFeatureIds.count() == 1 )
4360 request.setFilterFid( *mSelectedFeatureIds.constBegin() );
4361 else
4362 request.setFilterFids( mSelectedFeatureIds );
4363
4364 return getFeatures( request );
4365}
4366
4368{
4370
4371 if ( !mEditBuffer || !mDataProvider )
4372 return false;
4373
4374 if ( mGeometryOptions->isActive() )
4375 {
4376 for ( auto feature = features.begin(); feature != features.end(); ++feature )
4377 {
4378 QgsGeometry geom = feature->geometry();
4379 mGeometryOptions->apply( geom );
4380 feature->setGeometry( geom );
4381 }
4382 }
4383
4384 bool res = mEditBuffer->addFeatures( features );
4385 updateExtents();
4386
4387 if ( res && mJoinBuffer->containsJoins() )
4388 res = mJoinBuffer->addFeatures( features );
4389
4390 return res;
4391}
4392
4394{
4396
4397 // if layer is not spatial, it has not CRS!
4398 setCrs( ( isSpatial() && mDataProvider ) ? mDataProvider->crs() : QgsCoordinateReferenceSystem() );
4399}
4400
4402{
4404
4406 if ( exp.isField() )
4407 {
4408 return static_cast<const QgsExpressionNodeColumnRef *>( exp.rootNode() )->name();
4409 }
4410
4411 return QString();
4412}
4413
4415{
4417
4418 if ( mDisplayExpression == displayExpression )
4419 return;
4420
4421 mDisplayExpression = displayExpression;
4423}
4424
4426{
4428
4429 if ( !mDisplayExpression.isEmpty() || mFields.isEmpty() )
4430 {
4431 return mDisplayExpression;
4432 }
4433 else
4434 {
4435 const QString candidateName = QgsVectorLayerUtils::guessFriendlyIdentifierField( mFields );
4436 if ( !candidateName.isEmpty() )
4437 {
4438 return QgsExpression::quotedColumnRef( candidateName );
4439 }
4440 else
4441 {
4442 return QString();
4443 }
4444 }
4445}
4446
4448{
4450
4451 // display expressions are used as a fallback when no explicit map tip template is set
4452 return mapTipsEnabled() && ( !mapTipTemplate().isEmpty() || !displayExpression().isEmpty() );
4453}
4454
4456{
4458
4459 return ( mEditBuffer && mDataProvider );
4460}
4461
4463{
4464 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
4466
4469}
4470
4471bool QgsVectorLayer::isReadOnly() const
4472{
4474
4475 return mDataSourceReadOnly || mReadOnly;
4476}
4477
4478bool QgsVectorLayer::setReadOnly( bool readonly )
4479{
4481
4482 // exit if the layer is in editing mode
4483 if ( readonly && mEditBuffer )
4484 return false;
4485
4486 // exit if the data source is in read-only mode
4487 if ( !readonly && mDataSourceReadOnly )
4488 return false;
4489
4490 mReadOnly = readonly;
4491 emit readOnlyChanged();
4492 return true;
4493}
4494
4496{
4498
4499 if ( !mDataProvider )
4500 return false;
4501
4502 if ( mDataSourceReadOnly )
4503 return false;
4504
4505 return mDataProvider->capabilities() & QgsVectorDataProvider::EditingCapabilities && !mReadOnly;
4506}
4507
4509{
4511
4512 emit beforeModifiedCheck();
4513 return mEditBuffer && mEditBuffer->isModified();
4514}
4515
4516bool QgsVectorLayer::isAuxiliaryField( int index, int &srcIndex ) const
4517{
4519
4520 bool auxiliaryField = false;
4521 srcIndex = -1;
4522
4523 if ( !auxiliaryLayer() )
4524 return auxiliaryField;
4525
4526 if ( index >= 0 && fields().fieldOrigin( index ) == Qgis::FieldOrigin::Join )
4527 {
4528 const QgsVectorLayerJoinInfo *info = mJoinBuffer->joinForFieldIndex( index, fields(), srcIndex );
4529
4530 if ( info && info->joinLayerId() == auxiliaryLayer()->id() )
4531 auxiliaryField = true;
4532 }
4533
4534 return auxiliaryField;
4535}
4536
4538{
4540
4541 // we must allow setting a renderer if our geometry type is unknown
4542 // as this allows the renderer to be correctly set even for layers
4543 // with broken sources
4544 // (note that we allow REMOVING the renderer for non-spatial layers,
4545 // e.g. to permit removing the renderer when the layer changes from
4546 // a spatial layer to a non-spatial one)
4547 if ( r && !isSpatial() && mWkbType != Qgis::WkbType::Unknown )
4548 return;
4549
4550 if ( r != mRenderer.get() )
4551 {
4552 mRenderer.reset( r );
4553 mSymbolFeatureCounted = false;
4554 mSymbolFeatureCountMap.clear();
4555 mSymbolFeatureIdMap.clear();
4556
4557 if ( mRenderer )
4558 {
4559 const double refreshRate = QgsSymbolLayerUtils::rendererFrameRate( mRenderer.get() );
4560 if ( refreshRate <= 0 )
4561 {
4562 mRefreshRendererTimer->stop();
4563 mRefreshRendererTimer->setInterval( 0 );
4564 }
4565 else
4566 {
4567 mRefreshRendererTimer->setInterval( 1000 / refreshRate );
4568 mRefreshRendererTimer->start();
4569 }
4570 }
4571
4572 emit rendererChanged();
4574 }
4575}
4576
4578{
4580
4581 if ( generator )
4582 {
4583 mRendererGenerators << generator;
4584 }
4585}
4586
4588{
4590
4591 for ( int i = mRendererGenerators.count() - 1; i >= 0; --i )
4592 {
4593 if ( mRendererGenerators.at( i )->id() == id )
4594 {
4595 delete mRendererGenerators.at( i );
4596 mRendererGenerators.removeAt( i );
4597 }
4598 }
4599}
4600
4601QList<const QgsFeatureRendererGenerator *> QgsVectorLayer::featureRendererGenerators() const
4602{
4603 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
4605
4606 QList< const QgsFeatureRendererGenerator * > res;
4607 for ( const QgsFeatureRendererGenerator *generator : mRendererGenerators )
4608 res << generator;
4609 return res;
4610}
4611
4612void QgsVectorLayer::beginEditCommand( const QString &text )
4613{
4615
4616 if ( !mDataProvider )
4617 {
4618 return;
4619 }
4620 if ( mDataProvider->transaction() )
4621 {
4622 QString ignoredError;
4623 mDataProvider->transaction()->createSavepoint( ignoredError );
4624 }
4625 undoStack()->beginMacro( text );
4626 mEditCommandActive = true;
4627 emit editCommandStarted( text );
4628}
4629
4631{
4633
4634 if ( !mDataProvider )
4635 {
4636 return;
4637 }
4638 undoStack()->endMacro();
4639 mEditCommandActive = false;
4640 if ( !mDeletedFids.isEmpty() )
4641 {
4642 if ( selectedFeatureCount() > 0 )
4643 {
4644 mSelectedFeatureIds.subtract( mDeletedFids );
4645 }
4646 emit featuresDeleted( mDeletedFids );
4647 mDeletedFids.clear();
4648 }
4649 emit editCommandEnded();
4650}
4651
4653{
4655
4656 if ( !mDataProvider )
4657 {
4658 return;
4659 }
4660 undoStack()->endMacro();
4661 undoStack()->undo();
4662
4663 // it's not directly possible to pop the last command off the stack (the destroyed one)
4664 // and delete, so we add a dummy obsolete command to force this to occur.
4665 // Pushing the new command deletes the destroyed one, and since the new
4666 // command is obsolete it's automatically deleted by the undo stack.
4667 auto command = std::make_unique< QUndoCommand >();
4668 command->setObsolete( true );
4669 undoStack()->push( command.release() );
4670
4671 mEditCommandActive = false;
4672 mDeletedFids.clear();
4673 emit editCommandDestroyed();
4674}
4675
4677{
4679
4680 return mJoinBuffer->addJoin( joinInfo );
4681}
4682
4683bool QgsVectorLayer::removeJoin( const QString &joinLayerId )
4684{
4686
4687 return mJoinBuffer->removeJoin( joinLayerId );
4688}
4689
4690const QList< QgsVectorLayerJoinInfo > QgsVectorLayer::vectorJoins() const
4691{
4693
4694 return mJoinBuffer->vectorJoins();
4695}
4696
4697int QgsVectorLayer::addExpressionField( const QString &exp, const QgsField &fld )
4698{
4700
4701 emit beforeAddingExpressionField( fld.name() );
4702 mExpressionFieldBuffer->addExpression( exp, fld );
4703 updateFields();
4704 int idx = mFields.indexFromName( fld.name() );
4705 emit attributeAdded( idx );
4706 return idx;
4707}
4708
4710{
4712
4713 emit beforeRemovingExpressionField( index );
4714 int oi = mFields.fieldOriginIndex( index );
4715 mExpressionFieldBuffer->removeExpression( oi );
4716 updateFields();
4717 emit attributeDeleted( index );
4718}
4719
4720QString QgsVectorLayer::expressionField( int index ) const
4721{
4723
4724 if ( mFields.fieldOrigin( index ) != Qgis::FieldOrigin::Expression )
4725 return QString();
4726
4727 int oi = mFields.fieldOriginIndex( index );
4728 if ( oi < 0 || oi >= mExpressionFieldBuffer->expressions().size() )
4729 return QString();
4730
4731 return mExpressionFieldBuffer->expressions().at( oi ).cachedExpression.expression();
4732}
4733
4734void QgsVectorLayer::updateExpressionField( int index, const QString &exp )
4735{
4737
4738 int oi = mFields.fieldOriginIndex( index );
4739 mExpressionFieldBuffer->updateExpression( oi, exp );
4740}
4741
4743{
4744 // non fatal for now -- the QgsVirtualLayerTask class is not thread safe and calls this
4746
4747 if ( !mDataProvider )
4748 return;
4749
4750 QgsFields oldFields = mFields;
4751
4752 mFields = mDataProvider->fields();
4753
4754 // added / removed fields
4755 if ( mEditBuffer )
4756 mEditBuffer->updateFields( mFields );
4757
4758 // joined fields
4759 if ( mJoinBuffer->containsJoins() )
4760 mJoinBuffer->updateFields( mFields );
4761
4762 if ( mExpressionFieldBuffer )
4763 mExpressionFieldBuffer->updateFields( mFields );
4764
4765 // set aliases and default values
4766 for ( auto aliasIt = mAttributeAliasMap.constBegin(); aliasIt != mAttributeAliasMap.constEnd(); ++aliasIt )
4767 {
4768 int index = mFields.lookupField( aliasIt.key() );
4769 if ( index < 0 )
4770 continue;
4771
4772 mFields[index].setAlias( aliasIt.value() );
4773 }
4774
4775 // set custom comments
4776 for ( auto customCommentIt = mAttributeCustomCommentMap.constBegin(); customCommentIt != mAttributeCustomCommentMap.constEnd(); ++customCommentIt )
4777 {
4778 int index = mFields.lookupField( customCommentIt.key() );
4779 if ( index < 0 )
4780 continue;
4781
4782 mFields[index].setCustomComment( customCommentIt.value() );
4783 }
4784
4785 for ( auto splitPolicyIt = mAttributeSplitPolicy.constBegin(); splitPolicyIt != mAttributeSplitPolicy.constEnd(); ++splitPolicyIt )
4786 {
4787 int index = mFields.lookupField( splitPolicyIt.key() );
4788 if ( index < 0 )
4789 continue;
4790
4791 mFields[index].setSplitPolicy( splitPolicyIt.value() );
4792 }
4793
4794 for ( auto duplicatePolicyIt = mAttributeDuplicatePolicy.constBegin(); duplicatePolicyIt != mAttributeDuplicatePolicy.constEnd(); ++duplicatePolicyIt )
4795 {
4796 int index = mFields.lookupField( duplicatePolicyIt.key() );
4797 if ( index < 0 )
4798 continue;
4799
4800 mFields[index].setDuplicatePolicy( duplicatePolicyIt.value() );
4801 }
4802
4803 for ( auto mergePolicyIt = mAttributeMergePolicy.constBegin(); mergePolicyIt != mAttributeMergePolicy.constEnd(); ++mergePolicyIt )
4804 {
4805 int index = mFields.lookupField( mergePolicyIt.key() );
4806 if ( index < 0 )
4807 continue;
4808
4809 mFields[index].setMergePolicy( mergePolicyIt.value() );
4810 }
4811
4812 // Update configuration flags
4813 QMap< QString, Qgis::FieldConfigurationFlags >::const_iterator flagsIt = mFieldConfigurationFlags.constBegin();
4814 for ( ; flagsIt != mFieldConfigurationFlags.constEnd(); ++flagsIt )
4815 {
4816 int index = mFields.lookupField( flagsIt.key() );
4817 if ( index < 0 )
4818 continue;
4819
4820 mFields[index].setConfigurationFlags( flagsIt.value() );
4821 }
4822
4823 // Update default values
4824 mDefaultValueOnUpdateFields.clear();
4825 QMap< QString, QgsDefaultValue >::const_iterator defaultIt = mDefaultExpressionMap.constBegin();
4826 for ( ; defaultIt != mDefaultExpressionMap.constEnd(); ++defaultIt )
4827 {
4828 int index = mFields.lookupField( defaultIt.key() );
4829 if ( index < 0 )
4830 continue;
4831
4832 mFields[index].setDefaultValueDefinition( defaultIt.value() );
4833 if ( defaultIt.value().applyOnUpdate() )
4834 mDefaultValueOnUpdateFields.insert( index );
4835 }
4836
4837 QMap< QString, QgsFieldConstraints::Constraints >::const_iterator constraintIt = mFieldConstraints.constBegin();
4838 for ( ; constraintIt != mFieldConstraints.constEnd(); ++constraintIt )
4839 {
4840 int index = mFields.lookupField( constraintIt.key() );
4841 if ( index < 0 )
4842 continue;
4843
4844 QgsFieldConstraints constraints = mFields.at( index ).constraints();
4845
4846 // always keep provider constraints intact
4847 if ( !( constraints.constraints() & QgsFieldConstraints::ConstraintNotNull ) && ( constraintIt.value() & QgsFieldConstraints::ConstraintNotNull ) )
4849 if ( !( constraints.constraints() & QgsFieldConstraints::ConstraintUnique ) && ( constraintIt.value() & QgsFieldConstraints::ConstraintUnique ) )
4851 if ( !( constraints.constraints() & QgsFieldConstraints::ConstraintExpression ) && ( constraintIt.value() & QgsFieldConstraints::ConstraintExpression ) )
4853 mFields[index].setConstraints( constraints );
4854 }
4855
4856 QMap< QString, QPair< QString, QString > >::const_iterator constraintExpIt = mFieldConstraintExpressions.constBegin();
4857 for ( ; constraintExpIt != mFieldConstraintExpressions.constEnd(); ++constraintExpIt )
4858 {
4859 int index = mFields.lookupField( constraintExpIt.key() );
4860 if ( index < 0 )
4861 continue;
4862
4863 QgsFieldConstraints constraints = mFields.at( index ).constraints();
4864
4865 // always keep provider constraints intact
4867 continue;
4868
4869 constraints.setConstraintExpression( constraintExpIt.value().first, constraintExpIt.value().second );
4870 mFields[index].setConstraints( constraints );
4871 }
4872
4873 QMap< QPair< QString, QgsFieldConstraints::Constraint >, QgsFieldConstraints::ConstraintStrength >::const_iterator constraintStrengthIt = mFieldConstraintStrength.constBegin();
4874 for ( ; constraintStrengthIt != mFieldConstraintStrength.constEnd(); ++constraintStrengthIt )
4875 {
4876 int index = mFields.lookupField( constraintStrengthIt.key().first );
4877 if ( index < 0 )
4878 continue;
4879
4880 QgsFieldConstraints constraints = mFields.at( index ).constraints();
4881
4882 // always keep provider constraints intact
4884 continue;
4885
4886 constraints.setConstraintStrength( constraintStrengthIt.key().second, constraintStrengthIt.value() );
4887 mFields[index].setConstraints( constraints );
4888 }
4889
4890 auto fieldWidgetIterator = mFieldWidgetSetups.constBegin();
4891 for ( ; fieldWidgetIterator != mFieldWidgetSetups.constEnd(); ++fieldWidgetIterator )
4892 {
4893 int index = mFields.indexOf( fieldWidgetIterator.key() );
4894 if ( index < 0 )
4895 continue;
4896
4897 mFields[index].setEditorWidgetSetup( fieldWidgetIterator.value() );
4898 }
4899
4900 if ( oldFields != mFields )
4901 {
4902 emit updatedFields();
4903 mEditFormConfig.setFields( mFields );
4904 }
4905}
4906
4907QVariant QgsVectorLayer::defaultValue( int index, const QgsFeature &feature, QgsExpressionContext *context ) const
4908{
4910
4911 if ( index < 0 || index >= mFields.count() || !mDataProvider )
4912 return QVariant();
4913
4914 QString expression = mFields.at( index ).defaultValueDefinition().expression();
4915 if ( expression.isEmpty() )
4916 return mDataProvider->defaultValue( index );
4917
4918 QgsExpressionContext *evalContext = context;
4919 std::unique_ptr< QgsExpressionContext > tempContext;
4920 if ( !evalContext )
4921 {
4922 // no context passed, so we create a default one
4923 tempContext = std::make_unique<QgsExpressionContext>( QgsExpressionContextUtils::globalProjectLayerScopes( this ) );
4924 evalContext = tempContext.get();
4925 }
4926
4927 if ( feature.isValid() )
4928 {
4930 featScope->setFeature( feature );
4931 featScope->setFields( feature.fields() );
4932 evalContext->appendScope( featScope );
4933 }
4934
4935 QVariant val;
4936 QgsExpression exp( expression );
4937 exp.prepare( evalContext );
4938 if ( exp.hasEvalError() )
4939 {
4940 QgsLogger::warning( "Error evaluating default value: " + exp.evalErrorString() );
4941 }
4942 else
4943 {
4944 val = exp.evaluate( evalContext );
4945 }
4946
4947 if ( feature.isValid() )
4948 {
4949 delete evalContext->popScope();
4950 }
4951
4952 return val;
4953}
4954
4956{
4958
4959 if ( index < 0 || index >= mFields.count() )
4960 return;
4961
4962 if ( definition.isValid() )
4963 {
4964 mDefaultExpressionMap.insert( mFields.at( index ).name(), definition );
4965 }
4966 else
4967 {
4968 mDefaultExpressionMap.remove( mFields.at( index ).name() );
4969 }
4970 updateFields();
4971}
4972
4974{
4976
4977 if ( index < 0 || index >= mFields.count() )
4978 return QgsDefaultValue();
4979 else
4980 return mFields.at( index ).defaultValueDefinition();
4981}
4982
4983QSet<QVariant> QgsVectorLayer::uniqueValues( int index, int limit ) const
4984{
4986
4987 QSet<QVariant> uniqueValues;
4988 if ( !mDataProvider )
4989 {
4990 return uniqueValues;
4991 }
4992
4993 Qgis::FieldOrigin origin = mFields.fieldOrigin( index );
4994 switch ( origin )
4995 {
4997 return uniqueValues;
4998
4999 case Qgis::FieldOrigin::Provider: //a provider field
5000 {
5001 uniqueValues = mDataProvider->uniqueValues( index, limit );
5002
5003 if ( mEditBuffer && !mDataProvider->transaction() )
5004 {
5005 QSet<QString> vals;
5006 const auto constUniqueValues = uniqueValues;
5007 for ( const QVariant &v : constUniqueValues )
5008 {
5009 vals << v.toString();
5010 }
5011
5012 QgsFeatureMap added = mEditBuffer->addedFeatures();
5013 QMapIterator< QgsFeatureId, QgsFeature > addedIt( added );
5014 while ( addedIt.hasNext() && ( limit < 0 || uniqueValues.count() < limit ) )
5015 {
5016 addedIt.next();
5017 QVariant v = addedIt.value().attribute( index );
5018 if ( v.isValid() )
5019 {
5020 QString vs = v.toString();
5021 if ( !vals.contains( vs ) )
5022 {
5023 vals << vs;
5024 uniqueValues << v;
5025 }
5026 }
5027 }
5028
5029 QMapIterator< QgsFeatureId, QgsAttributeMap > it( mEditBuffer->changedAttributeValues() );
5030 while ( it.hasNext() && ( limit < 0 || uniqueValues.count() < limit ) )
5031 {
5032 it.next();
5033 QVariant v = it.value().value( index );
5034 if ( v.isValid() )
5035 {
5036 QString vs = v.toString();
5037 if ( !vals.contains( vs ) )
5038 {
5039 vals << vs;
5040 uniqueValues << v;
5041 }
5042 }
5043 }
5044 }
5045
5046 return uniqueValues;
5047 }
5048
5050 // the layer is editable, but in certain cases it can still be avoided going through all features
5051 if ( mDataProvider->transaction()
5052 || ( mEditBuffer->deletedFeatureIds().isEmpty() && mEditBuffer->addedFeatures().isEmpty() && !mEditBuffer->deletedAttributeIds().contains( index ) && mEditBuffer->changedAttributeValues().isEmpty() ) )
5053 {
5054 uniqueValues = mDataProvider->uniqueValues( index, limit );
5055 return uniqueValues;
5056 }
5057 [[fallthrough]];
5058 //we need to go through each feature
5061 {
5062 QgsAttributeList attList;
5063 attList << index;
5064
5066
5067 QgsFeature f;
5068 QVariant currentValue;
5069 QHash<QString, QVariant> val;
5070 while ( fit.nextFeature( f ) )
5071 {
5072 currentValue = f.attribute( index );
5073 val.insert( currentValue.toString(), currentValue );
5074 if ( limit >= 0 && val.size() >= limit )
5075 {
5076 break;
5077 }
5078 }
5079
5080 return qgis::listToSet( val.values() );
5081 }
5082 }
5083
5084 Q_ASSERT_X( false, "QgsVectorLayer::uniqueValues()", "Unknown source of the field!" );
5085 return uniqueValues;
5086}
5087
5088QStringList QgsVectorLayer::uniqueStringsMatching( int index, const QString &substring, int limit, QgsFeedback *feedback ) const
5089{
5091
5092 QStringList results;
5093 if ( !mDataProvider )
5094 {
5095 return results;
5096 }
5097
5098 Qgis::FieldOrigin origin = mFields.fieldOrigin( index );
5099 switch ( origin )
5100 {
5102 return results;
5103
5104 case Qgis::FieldOrigin::Provider: //a provider field
5105 {
5106 results = mDataProvider->uniqueStringsMatching( index, substring, limit, feedback );
5107
5108 if ( mEditBuffer && !mDataProvider->transaction() )
5109 {
5110 QgsFeatureMap added = mEditBuffer->addedFeatures();
5111 QMapIterator< QgsFeatureId, QgsFeature > addedIt( added );
5112 while ( addedIt.hasNext() && ( limit < 0 || results.count() < limit ) && ( !feedback || !feedback->isCanceled() ) )
5113 {
5114 addedIt.next();
5115 QVariant v = addedIt.value().attribute( index );
5116 if ( v.isValid() )
5117 {
5118 QString vs = v.toString();
5119 if ( vs.contains( substring, Qt::CaseInsensitive ) && !results.contains( vs ) )
5120 {
5121 results << vs;
5122 }
5123 }
5124 }
5125
5126 QMapIterator< QgsFeatureId, QgsAttributeMap > it( mEditBuffer->changedAttributeValues() );
5127 while ( it.hasNext() && ( limit < 0 || results.count() < limit ) && ( !feedback || !feedback->isCanceled() ) )
5128 {
5129 it.next();
5130 QVariant v = it.value().value( index );
5131 if ( v.isValid() )
5132 {
5133 QString vs = v.toString();
5134 if ( vs.contains( substring, Qt::CaseInsensitive ) && !results.contains( vs ) )
5135 {
5136 results << vs;
5137 }
5138 }
5139 }
5140 }
5141
5142 return results;
5143 }
5144
5146 // the layer is editable, but in certain cases it can still be avoided going through all features
5147 if ( mDataProvider->transaction()
5148 || ( mEditBuffer->deletedFeatureIds().isEmpty() && mEditBuffer->addedFeatures().isEmpty() && !mEditBuffer->deletedAttributeIds().contains( index ) && mEditBuffer->changedAttributeValues().isEmpty() ) )
5149 {
5150 return mDataProvider->uniqueStringsMatching( index, substring, limit, feedback );
5151 }
5152 [[fallthrough]];
5153 //we need to go through each feature
5156 {
5157 QgsAttributeList attList;
5158 attList << index;
5159
5160 QgsFeatureRequest request;
5161 request.setSubsetOfAttributes( attList );
5163 QString fieldName = mFields.at( index ).name();
5164 request.setFilterExpression( u"\"%1\" ILIKE '%%2%'"_s.arg( fieldName, substring ) );
5165 QgsFeatureIterator fit = getFeatures( request );
5166
5167 QgsFeature f;
5168 QString currentValue;
5169 while ( fit.nextFeature( f ) )
5170 {
5171 currentValue = f.attribute( index ).toString();
5172 if ( !results.contains( currentValue ) )
5173 results << currentValue;
5174
5175 if ( ( limit >= 0 && results.size() >= limit ) || ( feedback && feedback->isCanceled() ) )
5176 {
5177 break;
5178 }
5179 }
5180
5181 return results;
5182 }
5183 }
5184
5185 Q_ASSERT_X( false, "QgsVectorLayer::uniqueStringsMatching()", "Unknown source of the field!" );
5186 return results;
5187}
5188
5189QVariant QgsVectorLayer::minimumValue( int index ) const
5190{
5192
5193 QVariant minimum;
5194 minimumOrMaximumValue( index, &minimum, nullptr );
5195 return minimum;
5196}
5197
5198QVariant QgsVectorLayer::maximumValue( int index ) const
5199{
5201
5202 QVariant maximum;
5203 minimumOrMaximumValue( index, nullptr, &maximum );
5204 return maximum;
5205}
5206
5207void QgsVectorLayer::minimumAndMaximumValue( int index, QVariant &minimum, QVariant &maximum ) const
5208{
5210
5211 minimumOrMaximumValue( index, &minimum, &maximum );
5212}
5213
5214void QgsVectorLayer::minimumOrMaximumValue( int index, QVariant *minimum, QVariant *maximum ) const
5215{
5217
5218 if ( minimum )
5219 *minimum = QVariant();
5220 if ( maximum )
5221 *maximum = QVariant();
5222
5223 if ( !mDataProvider )
5224 {
5225 return;
5226 }
5227
5228 Qgis::FieldOrigin origin = mFields.fieldOrigin( index );
5229
5230 switch ( origin )
5231 {
5233 {
5234 return;
5235 }
5236
5237 case Qgis::FieldOrigin::Provider: //a provider field
5238 {
5239 if ( minimum )
5240 *minimum = mDataProvider->minimumValue( index );
5241 if ( maximum )
5242 *maximum = mDataProvider->maximumValue( index );
5243 if ( mEditBuffer && !mDataProvider->transaction() )
5244 {
5245 const QgsFeatureMap added = mEditBuffer->addedFeatures();
5246 QMapIterator< QgsFeatureId, QgsFeature > addedIt( added );
5247 while ( addedIt.hasNext() )
5248 {
5249 addedIt.next();
5250 const QVariant v = addedIt.value().attribute( index );
5251 if ( minimum && v.isValid() && qgsVariantLessThan( v, *minimum ) )
5252 *minimum = v;
5253 if ( maximum && v.isValid() && qgsVariantGreaterThan( v, *maximum ) )
5254 *maximum = v;
5255 }
5256
5257 QMapIterator< QgsFeatureId, QgsAttributeMap > it( mEditBuffer->changedAttributeValues() );
5258 while ( it.hasNext() )
5259 {
5260 it.next();
5261 const QVariant v = it.value().value( index );
5262 if ( minimum && v.isValid() && qgsVariantLessThan( v, *minimum ) )
5263 *minimum = v;
5264 if ( maximum && v.isValid() && qgsVariantGreaterThan( v, *maximum ) )
5265 *maximum = v;
5266 }
5267 }
5268 return;
5269 }
5270
5272 {
5273 // the layer is editable, but in certain cases it can still be avoided going through all features
5274 if ( mDataProvider->transaction()
5275 || ( mEditBuffer->deletedFeatureIds().isEmpty() && mEditBuffer->addedFeatures().isEmpty() && !mEditBuffer->deletedAttributeIds().contains( index ) && mEditBuffer->changedAttributeValues().isEmpty() ) )
5276 {
5277 if ( minimum )
5278 *minimum = mDataProvider->minimumValue( index );
5279 if ( maximum )
5280 *maximum = mDataProvider->maximumValue( index );
5281 return;
5282 }
5283 }
5284 [[fallthrough]];
5285 // no choice but to go through all features
5288 {
5289 // we need to go through each feature
5290 QgsAttributeList attList;
5291 attList << index;
5292
5293 QgsFeatureIterator fit = getFeatures( QgsFeatureRequest().setFlags( Qgis::FeatureRequestFlag::NoGeometry ).setSubsetOfAttributes( attList ) );
5294
5295 QgsFeature f;
5296 bool firstValue = true;
5297 while ( fit.nextFeature( f ) )
5298 {
5299 const QVariant currentValue = f.attribute( index );
5300 if ( QgsVariantUtils::isNull( currentValue ) )
5301 continue;
5302
5303 if ( firstValue )
5304 {
5305 if ( minimum )
5306 *minimum = currentValue;
5307 if ( maximum )
5308 *maximum = currentValue;
5309 firstValue = false;
5310 }
5311 else
5312 {
5313 if ( minimum && currentValue.isValid() && qgsVariantLessThan( currentValue, *minimum ) )
5314 *minimum = currentValue;
5315 if ( maximum && currentValue.isValid() && qgsVariantGreaterThan( currentValue, *maximum ) )
5316 *maximum = currentValue;
5317 }
5318 }
5319 return;
5320 }
5321 }
5322
5323 Q_ASSERT_X( false, "QgsVectorLayer::minimumOrMaximumValue()", "Unknown source of the field!" );
5324}
5325
5326void QgsVectorLayer::createEditBuffer()
5327{
5329
5330 if ( mEditBuffer )
5331 clearEditBuffer();
5332
5333 if ( mDataProvider->transaction() )
5334 {
5335 mEditBuffer = new QgsVectorLayerEditPassthrough( this );
5336 connect( mDataProvider->transaction(), &QgsTransaction::dirtied, this, &QgsVectorLayer::onDirtyTransaction, Qt::UniqueConnection );
5337 }
5338 else
5339 {
5340 mEditBuffer = new QgsVectorLayerEditBuffer( this );
5341 }
5342
5343 mEditBuffer->setParent( this );
5344
5345 // forward signals
5346 connect( mEditBuffer, &QgsVectorLayerEditBuffer::layerModified, this, &QgsVectorLayer::invalidateSymbolCountedFlag );
5347 connect( mEditBuffer, &QgsVectorLayerEditBuffer::layerModified, this, &QgsVectorLayer::layerModified ); // TODO[MD]: necessary?
5348 //connect( mEditBuffer, &QgsVectorLayerEditBuffer::layerModified, this, &QgsVectorLayer::triggerRepaint ); // TODO[MD]: works well?
5349 connect( mEditBuffer, &QgsVectorLayerEditBuffer::featureAdded, this, &QgsVectorLayer::onFeatureAdded );
5350 connect( mEditBuffer, &QgsVectorLayerEditBuffer::featureDeleted, this, &QgsVectorLayer::onFeatureDeleted );
5361}
5362
5363void QgsVectorLayer::clearEditBuffer()
5364{
5366
5367 delete mEditBuffer;
5368 mEditBuffer = nullptr;
5369}
5370
5371void QgsVectorLayer::applyRendererSettings()
5372{
5373 const QgsLayerRenderingSettings *providerRenderingSettings = mDataProvider->renderingSettings();
5374
5375 if ( !providerRenderingSettings )
5376 return;
5377
5378 if ( providerRenderingSettings->hasLayerOpacity() )
5379 setOpacity( providerRenderingSettings->layerOpacity() );
5380 if ( providerRenderingSettings->hasMaximumScale() )
5381 setMaximumScale( providerRenderingSettings->maximumScale() );
5382 if ( providerRenderingSettings->hasMinimumScale() )
5383 setMinimumScale( providerRenderingSettings->minimumScale() );
5384 if ( providerRenderingSettings->hasMaximumScale() || providerRenderingSettings->hasMinimumScale() )
5386 ( providerRenderingSettings->hasMaximumScale() && providerRenderingSettings->maximumScale() != 0 )
5387 || ( providerRenderingSettings->hasMinimumScale() && providerRenderingSettings->minimumScale() != 0 )
5388 );
5389}
5390
5393 const QString &fieldOrExpression,
5395 QgsExpressionContext *context,
5396 bool *ok,
5397 QgsFeatureIds *fids,
5398 QgsFeedback *feedback,
5399 QString *error
5400) const
5401{
5402 // non fatal for now -- the aggregate expression functions are not thread safe and call this
5404
5405 if ( ok )
5406 *ok = false;
5407 if ( error )
5408 error->clear();
5409
5410 if ( !mDataProvider )
5411 {
5412 if ( error )
5413 *error = tr( "Layer is invalid" );
5414 return QVariant();
5415 }
5416
5417 // test if we are calculating based on a field
5418 const int attrIndex = QgsExpression::expressionToLayerFieldIndex( fieldOrExpression, this );
5419 if ( attrIndex >= 0 )
5420 {
5421 // aggregate is based on a field - if it's a provider field, we could possibly hand over the calculation
5422 // to the provider itself
5423 Qgis::FieldOrigin origin = mFields.fieldOrigin( attrIndex );
5424 if ( origin == Qgis::FieldOrigin::Provider )
5425 {
5426 bool providerOk = false;
5427 QVariant val = mDataProvider->aggregate( aggregate, attrIndex, parameters, context, providerOk, fids );
5428 if ( providerOk )
5429 {
5430 // provider handled calculation
5431 if ( ok )
5432 *ok = true;
5433 return val;
5434 }
5435 }
5436 }
5437
5438 // fallback to using aggregate calculator to determine aggregate
5439 QgsAggregateCalculator c( this );
5440 if ( fids )
5441 c.setFidsFilter( *fids );
5442 c.setParameters( parameters );
5443 bool aggregateOk = false;
5444 const QVariant result = c.calculate( aggregate, fieldOrExpression, context, &aggregateOk, feedback );
5445 if ( ok )
5446 *ok = aggregateOk;
5447 if ( !aggregateOk && error )
5448 *error = c.lastError();
5449
5450 return result;
5451}
5452
5454{
5456
5457 if ( mFeatureBlendMode == featureBlendMode )
5458 return;
5459
5460 mFeatureBlendMode = featureBlendMode;
5463}
5464
5465QPainter::CompositionMode QgsVectorLayer::featureBlendMode() const
5466{
5467 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
5469
5470 return mFeatureBlendMode;
5471}
5472
5473void QgsVectorLayer::readSldLabeling( const QDomNode &node )
5474{
5476
5477 setLabeling( nullptr ); // start with no labeling
5478 setLabelsEnabled( false );
5479
5480 QDomElement element = node.toElement();
5481 if ( element.isNull() )
5482 return;
5483
5484 QDomElement userStyleElem = element.firstChildElement( u"UserStyle"_s );
5485 if ( userStyleElem.isNull() )
5486 {
5487 QgsDebugMsgLevel( u"Info: UserStyle element not found."_s, 4 );
5488 return;
5489 }
5490
5491 QDomElement featTypeStyleElem = userStyleElem.firstChildElement( u"FeatureTypeStyle"_s );
5492 if ( featTypeStyleElem.isNull() )
5493 {
5494 QgsDebugMsgLevel( u"Info: FeatureTypeStyle element not found."_s, 4 );
5495 return;
5496 }
5497
5498 // create empty FeatureTypeStyle element to merge TextSymbolizer's Rule's from all FeatureTypeStyle's
5499 QDomElement mergedFeatTypeStyle = featTypeStyleElem.cloneNode( false ).toElement();
5500
5501 // use the RuleRenderer when more rules are present or the rule
5502 // has filters or min/max scale denominators set,
5503 // otherwise use the Simple labeling
5504 bool needRuleBasedLabeling = false;
5505 int ruleCount = 0;
5506
5507 while ( !featTypeStyleElem.isNull() )
5508 {
5509 QDomElement ruleElem = featTypeStyleElem.firstChildElement( u"Rule"_s );
5510 while ( !ruleElem.isNull() )
5511 {
5512 // test rule children element to check if we need to create RuleRenderer
5513 // and if the rule has a symbolizer
5514 bool hasTextSymbolizer = false;
5515 bool hasRuleBased = false;
5516 QDomElement ruleChildElem = ruleElem.firstChildElement();
5517 while ( !ruleChildElem.isNull() )
5518 {
5519 // rule has filter or min/max scale denominator, use the RuleRenderer
5520 if ( ruleChildElem.localName() == "Filter"_L1 || ruleChildElem.localName() == "MinScaleDenominator"_L1 || ruleChildElem.localName() == "MaxScaleDenominator"_L1 )
5521 {
5522 hasRuleBased = true;
5523 }
5524 // rule has a renderer symbolizer, not a text symbolizer
5525 else if ( ruleChildElem.localName() == "TextSymbolizer"_L1 )
5526 {
5527 QgsDebugMsgLevel( u"Info: TextSymbolizer element found"_s, 4 );
5528 hasTextSymbolizer = true;
5529 }
5530
5531 ruleChildElem = ruleChildElem.nextSiblingElement();
5532 }
5533
5534 if ( hasTextSymbolizer )
5535 {
5536 ruleCount++;
5537
5538 // append a clone of all Rules to the merged FeatureTypeStyle element
5539 mergedFeatTypeStyle.appendChild( ruleElem.cloneNode().toElement() );
5540
5541 if ( hasRuleBased )
5542 {
5543 QgsDebugMsgLevel( u"Info: Filter or Min/MaxScaleDenominator element found: need a RuleBasedLabeling"_s, 4 );
5544 needRuleBasedLabeling = true;
5545 }
5546 }
5547
5548 // more rules present, use the RuleRenderer
5549 if ( ruleCount > 1 )
5550 {
5551 QgsDebugMsgLevel( u"Info: More Rule elements found: need a RuleBasedLabeling"_s, 4 );
5552 needRuleBasedLabeling = true;
5553 }
5554
5555 // not use the rule based labeling if no rules with textSymbolizer
5556 if ( ruleCount == 0 )
5557 {
5558 needRuleBasedLabeling = false;
5559 }
5560
5561 ruleElem = ruleElem.nextSiblingElement( u"Rule"_s );
5562 }
5563 featTypeStyleElem = featTypeStyleElem.nextSiblingElement( u"FeatureTypeStyle"_s );
5564 }
5565
5566 if ( ruleCount == 0 )
5567 {
5568 QgsDebugMsgLevel( u"Info: No TextSymbolizer element."_s, 4 );
5569 return;
5570 }
5571
5572 QDomElement ruleElem = mergedFeatTypeStyle.firstChildElement( u"Rule"_s );
5573
5574 if ( needRuleBasedLabeling )
5575 {
5576 QgsDebugMsgLevel( u"Info: rule based labeling"_s, 4 );
5577 QgsRuleBasedLabeling::Rule *rootRule = new QgsRuleBasedLabeling::Rule( nullptr );
5578 while ( !ruleElem.isNull() )
5579 {
5580 QString label, description, filterExp;
5581 int scaleMinDenom = 0, scaleMaxDenom = 0;
5582 QgsPalLayerSettings settings;
5583
5584 // retrieve the Rule element child nodes
5585 QDomElement childElem = ruleElem.firstChildElement();
5586 while ( !childElem.isNull() )
5587 {
5588 if ( childElem.localName() == "Name"_L1 )
5589 {
5590 // <se:Name> tag contains the rule identifier,
5591 // so prefer title tag for the label property value
5592 if ( label.isEmpty() )
5593 label = childElem.firstChild().nodeValue();
5594 }
5595 else if ( childElem.localName() == "Description"_L1 )
5596 {
5597 // <se:Description> can contains a title and an abstract
5598 QDomElement titleElem = childElem.firstChildElement( u"Title"_s );
5599 if ( !titleElem.isNull() )
5600 {
5601 label = titleElem.firstChild().nodeValue();
5602 }
5603
5604 QDomElement abstractElem = childElem.firstChildElement( u"Abstract"_s );
5605 if ( !abstractElem.isNull() )
5606 {
5607 description = abstractElem.firstChild().nodeValue();
5608 }
5609 }
5610 else if ( childElem.localName() == "Abstract"_L1 )
5611 {
5612 // <sld:Abstract> (v1.0)
5613 description = childElem.firstChild().nodeValue();
5614 }
5615 else if ( childElem.localName() == "Title"_L1 )
5616 {
5617 // <sld:Title> (v1.0)
5618 label = childElem.firstChild().nodeValue();
5619 }
5620 else if ( childElem.localName() == "Filter"_L1 )
5621 {
5622 QgsExpression *filter = QgsOgcUtils::expressionFromOgcFilter( childElem );
5623 if ( filter )
5624 {
5625 if ( filter->hasParserError() )
5626 {
5627 QgsDebugMsgLevel( u"SLD Filter parsing error: %1"_s.arg( filter->parserErrorString() ), 3 );
5628 }
5629 else
5630 {
5631 filterExp = filter->expression();
5632 }
5633 delete filter;
5634 }
5635 }
5636 else if ( childElem.localName() == "MinScaleDenominator"_L1 )
5637 {
5638 bool ok;
5639 int v = childElem.firstChild().nodeValue().toInt( &ok );
5640 if ( ok )
5641 scaleMinDenom = v;
5642 }
5643 else if ( childElem.localName() == "MaxScaleDenominator"_L1 )
5644 {
5645 bool ok;
5646 int v = childElem.firstChild().nodeValue().toInt( &ok );
5647 if ( ok )
5648 scaleMaxDenom = v;
5649 }
5650 else if ( childElem.localName() == "TextSymbolizer"_L1 )
5651 {
5652 readSldTextSymbolizer( childElem, settings );
5653 }
5654
5655 childElem = childElem.nextSiblingElement();
5656 }
5657
5658 QgsRuleBasedLabeling::Rule *ruleLabeling = new QgsRuleBasedLabeling::Rule( new QgsPalLayerSettings( settings ), scaleMinDenom, scaleMaxDenom, filterExp, label );
5659 rootRule->appendChild( ruleLabeling );
5660
5661 ruleElem = ruleElem.nextSiblingElement();
5662 }
5663
5664 setLabeling( new QgsRuleBasedLabeling( rootRule ) );
5665 setLabelsEnabled( true );
5666 }
5667 else
5668 {
5669 QgsDebugMsgLevel( u"Info: simple labeling"_s, 4 );
5670 // retrieve the TextSymbolizer element child node
5671 QDomElement textSymbolizerElem = ruleElem.firstChildElement( u"TextSymbolizer"_s );
5672 QgsPalLayerSettings s;
5673 if ( readSldTextSymbolizer( textSymbolizerElem, s ) )
5674 {
5675 setLabeling( new QgsVectorLayerSimpleLabeling( s ) );
5676 setLabelsEnabled( true );
5677 }
5678 }
5679}
5680
5681bool QgsVectorLayer::readSldTextSymbolizer( const QDomNode &node, QgsPalLayerSettings &settings ) const
5682{
5684
5685 if ( node.localName() != "TextSymbolizer"_L1 )
5686 {
5687 QgsDebugMsgLevel( u"Not a TextSymbolizer element: %1"_s.arg( node.localName() ), 3 );
5688 return false;
5689 }
5690 QDomElement textSymbolizerElem = node.toElement();
5691 // Label
5692 QDomElement labelElem = textSymbolizerElem.firstChildElement( u"Label"_s );
5693 if ( !labelElem.isNull() )
5694 {
5695 QDomElement propertyNameElem = labelElem.firstChildElement( u"PropertyName"_s );
5696 if ( !propertyNameElem.isNull() )
5697 {
5698 // set labeling defaults
5699
5700 // label attribute
5701 QString labelAttribute = propertyNameElem.text();
5702 settings.fieldName = labelAttribute;
5703 settings.isExpression = false;
5704
5705 int fieldIndex = mFields.lookupField( labelAttribute );
5706 if ( fieldIndex == -1 )
5707 {
5708 // label attribute is not in columns, check if it is an expression
5709 QgsExpression exp( labelAttribute );
5710 if ( !exp.hasEvalError() )
5711 {
5712 settings.isExpression = true;
5713 }
5714 else
5715 {
5716 QgsDebugMsgLevel( u"SLD label attribute error: %1"_s.arg( exp.evalErrorString() ), 3 );
5717 }
5718 }
5719 }
5720 else
5721 {
5722 QgsDebugMsgLevel( u"Info: PropertyName element not found."_s, 4 );
5723 return false;
5724 }
5725 }
5726 else
5727 {
5728 QgsDebugMsgLevel( u"Info: Label element not found."_s, 4 );
5729 return false;
5730 }
5731
5733 if ( textSymbolizerElem.hasAttribute( u"uom"_s ) )
5734 {
5735 sldUnitSize = QgsSymbolLayerUtils::decodeSldUom( textSymbolizerElem.attribute( u"uom"_s ) );
5736 }
5737
5738 QString fontFamily = u"Sans-Serif"_s;
5739 double fontPointSize = 10;
5741 int fontWeight = -1;
5742 bool fontItalic = false;
5743 bool fontUnderline = false;
5744
5745 // Font
5746 QDomElement fontElem = textSymbolizerElem.firstChildElement( u"Font"_s );
5747 if ( !fontElem.isNull() )
5748 {
5749 QgsStringMap fontSvgParams = QgsSymbolLayerUtils::getSvgParameterList( fontElem );
5750 for ( QgsStringMap::iterator it = fontSvgParams.begin(); it != fontSvgParams.end(); ++it )
5751 {
5752 QgsDebugMsgLevel( u"found fontSvgParams %1: %2"_s.arg( it.key(), it.value() ), 4 );
5753
5754 if ( it.key() == "font-family"_L1 )
5755 {
5756 fontFamily = it.value();
5757 }
5758 else if ( it.key() == "font-style"_L1 )
5759 {
5760 fontItalic = ( it.value() == "italic"_L1 ) || ( it.value() == "Italic"_L1 );
5761 }
5762 else if ( it.key() == "font-size"_L1 )
5763 {
5764 bool ok;
5765 double fontSize = it.value().toDouble( &ok );
5766 if ( ok )
5767 {
5768 fontPointSize = fontSize;
5769 fontUnitSize = sldUnitSize;
5770 }
5771 }
5772 else if ( it.key() == "font-weight"_L1 )
5773 {
5774 if ( ( it.value() == "bold"_L1 ) || ( it.value() == "Bold"_L1 ) )
5775 fontWeight = QFont::Bold;
5776 }
5777 else if ( it.key() == "font-underline"_L1 )
5778 {
5779 fontUnderline = ( it.value() == "underline"_L1 ) || ( it.value() == "Underline"_L1 );
5780 }
5781 }
5782 }
5783
5784 QgsTextFormat format;
5785 QFont font( fontFamily, 1, fontWeight, fontItalic );
5786 font.setUnderline( fontUnderline );
5787 format.setFont( font );
5788 format.setSize( fontPointSize );
5789 format.setSizeUnit( fontUnitSize );
5790
5791 // Fill
5792 QDomElement fillElem = textSymbolizerElem.firstChildElement( u"Fill"_s );
5793 QColor textColor;
5794 Qt::BrushStyle textBrush = Qt::SolidPattern;
5795 QgsSymbolLayerUtils::fillFromSld( fillElem, textBrush, textColor );
5796 if ( textColor.isValid() )
5797 {
5798 QgsDebugMsgLevel( u"Info: textColor %1."_s.arg( QVariant( textColor ).toString() ), 4 );
5799 format.setColor( textColor );
5800 }
5801
5802 QgsTextBufferSettings bufferSettings;
5803
5804 // Halo
5805 QDomElement haloElem = textSymbolizerElem.firstChildElement( u"Halo"_s );
5806 if ( !haloElem.isNull() )
5807 {
5808 bufferSettings.setEnabled( true );
5809 bufferSettings.setSize( 1 );
5810
5811 QDomElement radiusElem = haloElem.firstChildElement( u"Radius"_s );
5812 if ( !radiusElem.isNull() )
5813 {
5814 bool ok;
5815 double bufferSize = radiusElem.text().toDouble( &ok );
5816 if ( ok )
5817 {
5818 bufferSettings.setSize( bufferSize );
5819 bufferSettings.setSizeUnit( sldUnitSize );
5820 }
5821 }
5822
5823 QDomElement haloFillElem = haloElem.firstChildElement( u"Fill"_s );
5824 QColor bufferColor;
5825 Qt::BrushStyle bufferBrush = Qt::SolidPattern;
5826 QgsSymbolLayerUtils::fillFromSld( haloFillElem, bufferBrush, bufferColor );
5827 if ( bufferColor.isValid() )
5828 {
5829 QgsDebugMsgLevel( u"Info: bufferColor %1."_s.arg( QVariant( bufferColor ).toString() ), 4 );
5830 bufferSettings.setColor( bufferColor );
5831 }
5832 }
5833
5834 // LabelPlacement
5835 QDomElement labelPlacementElem = textSymbolizerElem.firstChildElement( u"LabelPlacement"_s );
5836 if ( !labelPlacementElem.isNull() )
5837 {
5838 // PointPlacement
5839 QDomElement pointPlacementElem = labelPlacementElem.firstChildElement( u"PointPlacement"_s );
5840 if ( !pointPlacementElem.isNull() )
5841 {
5844 {
5846 }
5847
5848 QDomElement displacementElem = pointPlacementElem.firstChildElement( u"Displacement"_s );
5849 if ( !displacementElem.isNull() )
5850 {
5851 QDomElement displacementXElem = displacementElem.firstChildElement( u"DisplacementX"_s );
5852 if ( !displacementXElem.isNull() )
5853 {
5854 bool ok;
5855 double xOffset = displacementXElem.text().toDouble( &ok );
5856 if ( ok )
5857 {
5858 settings.xOffset = xOffset;
5859 settings.offsetUnits = sldUnitSize;
5860 }
5861 }
5862 QDomElement displacementYElem = displacementElem.firstChildElement( u"DisplacementY"_s );
5863 if ( !displacementYElem.isNull() )
5864 {
5865 bool ok;
5866 double yOffset = displacementYElem.text().toDouble( &ok );
5867 if ( ok )
5868 {
5869 settings.yOffset = yOffset;
5870 settings.offsetUnits = sldUnitSize;
5871 }
5872 }
5873 }
5874 QDomElement anchorPointElem = pointPlacementElem.firstChildElement( u"AnchorPoint"_s );
5875 if ( !anchorPointElem.isNull() )
5876 {
5877 bool xOffsetOk = false;
5878 double xOffset = 0.0;
5879 bool yOffsetOk = false;
5880 double yOffset = 0.0;
5881
5882 QDomElement anchorPointXElem = anchorPointElem.firstChildElement( u"AnchorPointX"_s );
5883 if ( !anchorPointXElem.isNull() )
5884 {
5885 xOffset = anchorPointXElem.text().toDouble( &xOffsetOk );
5886 }
5887 QDomElement anchorPointYElem = anchorPointElem.firstChildElement( u"AnchorPointY"_s );
5888 if ( !anchorPointYElem.isNull() )
5889 {
5890 yOffset = anchorPointYElem.text().toDouble( &yOffsetOk );
5891 }
5892
5893 if ( xOffsetOk & yOffsetOk )
5894 {
5895 // Round values in increments of 0.5
5896 xOffset = std::round( xOffset * 2.0 ) / 2.0;
5897 yOffset = std::round( yOffset * 2.0 ) / 2.0;
5898
5899 if ( xOffset == 1.0 && yOffset == 0.0 )
5900 {
5902 }
5903 else if ( xOffset == 0.5 && yOffset == 0.0 )
5904 {
5906 }
5907 else if ( xOffset == 0.0 && yOffset == 0.0 )
5908 {
5910 }
5911 else if ( xOffset == 1.0 && yOffset == 0.5 )
5912 {
5914 }
5915 else if ( xOffset == 0.5 && yOffset == 0.5 )
5916 {
5918 }
5919 else if ( xOffset == 0.0 && yOffset == 0.5 )
5920 {
5922 }
5923 else if ( xOffset == 1.0 && yOffset == 1.0 )
5924 {
5926 }
5927 else if ( xOffset == 0.5 && yOffset == 1.0 )
5928 {
5930 }
5931 else
5932 {
5934 }
5935 }
5936 }
5937
5938 QDomElement rotationElem = pointPlacementElem.firstChildElement( u"Rotation"_s );
5939 if ( !rotationElem.isNull() )
5940 {
5941 bool ok;
5942 double rotation = rotationElem.text().toDouble( &ok );
5943 if ( ok )
5944 {
5945 settings.angleOffset = 360 - rotation;
5946 }
5947 }
5948 }
5949 else
5950 {
5951 // PointPlacement
5952 QDomElement linePlacementElem = labelPlacementElem.firstChildElement( u"LinePlacement"_s );
5953 if ( !linePlacementElem.isNull() )
5954 {
5956 }
5957 }
5958 }
5959
5960 // read vendor options
5961 QgsStringMap vendorOptions;
5962 QDomElement vendorOptionElem = textSymbolizerElem.firstChildElement( u"VendorOption"_s );
5963 while ( !vendorOptionElem.isNull() && vendorOptionElem.localName() == "VendorOption"_L1 )
5964 {
5965 QString optionName = vendorOptionElem.attribute( u"name"_s );
5966 QString optionValue;
5967 if ( vendorOptionElem.firstChild().nodeType() == QDomNode::TextNode )
5968 {
5969 optionValue = vendorOptionElem.firstChild().nodeValue();
5970 }
5971 else
5972 {
5973 if ( vendorOptionElem.firstChild().nodeType() == QDomNode::ElementNode && vendorOptionElem.firstChild().localName() == "Literal"_L1 )
5974 {
5975 QgsDebugMsgLevel( vendorOptionElem.firstChild().localName(), 2 );
5976 optionValue = vendorOptionElem.firstChild().firstChild().nodeValue();
5977 }
5978 else
5979 {
5980 QgsDebugError( u"unexpected child of %1 named %2"_s.arg( vendorOptionElem.localName(), optionName ) );
5981 }
5982 }
5983
5984 if ( !optionName.isEmpty() && !optionValue.isEmpty() )
5985 {
5986 vendorOptions[optionName] = optionValue;
5987 }
5988
5989 vendorOptionElem = vendorOptionElem.nextSiblingElement();
5990 }
5991 if ( !vendorOptions.isEmpty() )
5992 {
5993 for ( QgsStringMap::iterator it = vendorOptions.begin(); it != vendorOptions.end(); ++it )
5994 {
5995 if ( it.key() == "underlineText"_L1 && it.value() == "true"_L1 )
5996 {
5997 font.setUnderline( true );
5998 format.setFont( font );
5999 }
6000 else if ( it.key() == "strikethroughText"_L1 && it.value() == "true"_L1 )
6001 {
6002 font.setStrikeOut( true );
6003 format.setFont( font );
6004 }
6005 else if ( it.key() == "maxDisplacement"_L1 )
6006 {
6008 }
6009 else if ( it.key() == "followLine"_L1 && it.value() == "true"_L1 )
6010 {
6012 {
6014 }
6015 else
6016 {
6018 }
6019 }
6020 else if ( it.key() == "maxAngleDelta"_L1 )
6021 {
6022 bool ok;
6023 double angle = it.value().toDouble( &ok );
6024 if ( ok )
6025 {
6026 settings.maxCurvedCharAngleIn = angle;
6027 settings.maxCurvedCharAngleOut = angle;
6028 }
6029 }
6030 // miscellaneous options
6031 else if ( it.key() == "conflictResolution"_L1 && it.value() == "false"_L1 )
6032 {
6034 }
6035 else if ( it.key() == "forceLeftToRight"_L1 && it.value() == "false"_L1 )
6036 {
6038 }
6039 else if ( it.key() == "group"_L1 && it.value() == "yes"_L1 )
6040 {
6041 settings.lineSettings().setMergeLines( true );
6042 }
6043 else if ( it.key() == "labelAllGroup"_L1 && it.value() == "true"_L1 )
6044 {
6045 settings.lineSettings().setMergeLines( true );
6046 }
6047 }
6048 }
6049
6050 format.setBuffer( bufferSettings );
6051 settings.setFormat( format );
6052 return true;
6053}
6054
6056{
6058
6059 return mEditFormConfig;
6060}
6061
6063{
6065
6066 if ( mEditFormConfig == editFormConfig )
6067 return;
6068
6069 mEditFormConfig = editFormConfig;
6070 mEditFormConfig.onRelationsLoaded();
6071 emit editFormConfigChanged();
6072}
6073
6075{
6077
6078 QgsAttributeTableConfig config = mAttributeTableConfig;
6079
6080 if ( config.isEmpty() )
6081 config.update( fields() );
6082
6083 return config;
6084}
6085
6087{
6089
6090 if ( mAttributeTableConfig != attributeTableConfig )
6091 {
6092 mAttributeTableConfig = attributeTableConfig;
6093 emit configChanged();
6094 }
6095}
6096
6098{
6099 // called in a non-thread-safe way in some cases when calculating aggregates in a different thread
6101
6103}
6104
6111
6113{
6115
6116 if ( !mDiagramLayerSettings )
6117 mDiagramLayerSettings = std::make_unique<QgsDiagramLayerSettings>();
6118 *mDiagramLayerSettings = s;
6119}
6120
6122{
6124
6125 QgsLayerMetadataFormatter htmlFormatter( metadata() );
6126 QString myMetadata = u"<html><head></head>\n<body>\n"_s;
6127
6128 myMetadata += generalHtmlMetadata();
6129
6130 // Begin Provider section
6131 myMetadata += u"<h1>"_s + tr( "Information from provider" ) + u"</h1>\n<hr>\n"_s;
6132 myMetadata += "<table class=\"list-view\">\n"_L1;
6133
6134 // storage type
6135 if ( !storageType().isEmpty() )
6136 {
6137 myMetadata += u"<tr><td class=\"highlight\">"_s + tr( "Storage" ) + u"</td><td>"_s + storageType() + u"</td></tr>\n"_s;
6138 }
6139
6140 // comment
6141 if ( !dataComment().isEmpty() )
6142 {
6143 myMetadata += u"<tr><td class=\"highlight\">"_s + tr( "Comment" ) + u"</td><td>"_s + dataComment() + u"</td></tr>\n"_s;
6144 }
6145
6146 // encoding
6147 if ( const QgsVectorDataProvider *provider = dataProvider() )
6148 {
6149 myMetadata += u"<tr><td class=\"highlight\">"_s + tr( "Encoding" ) + u"</td><td>"_s + provider->encoding() + u"</td></tr>\n"_s;
6150 myMetadata += provider->htmlMetadata();
6151 }
6152
6153 if ( isSpatial() )
6154 {
6155 // geom type
6157 if ( static_cast<int>( type ) < 0 || static_cast< int >( type ) > static_cast< int >( Qgis::GeometryType::Null ) )
6158 {
6159 QgsDebugMsgLevel( u"Invalid vector type"_s, 2 );
6160 }
6161 else
6162 {
6163 QString typeString( u"%1 (%2)"_s.arg( QgsWkbTypes::geometryDisplayString( geometryType() ), QgsWkbTypes::displayString( wkbType() ) ) );
6164 myMetadata += u"<tr><td class=\"highlight\">"_s + tr( "Geometry type" ) + u"</td><td>"_s + typeString + u"</td></tr>\n"_s;
6165 }
6166
6167 // geom column name
6168 if ( const QgsVectorDataProvider *provider = dataProvider(); provider && !provider->geometryColumnName().isEmpty() )
6169 {
6170 myMetadata += u"<tr><td class=\"highlight\">"_s + tr( "Geometry column" ) + u"</td><td>"_s + provider->geometryColumnName() + u"</td></tr>\n"_s;
6171 }
6172
6173 // Extent
6174 // Try to display extent 3D by default. If empty (probably because the data is 2D), fallback to the 2D version
6175 const QgsBox3D extentBox3D = extent3D();
6176 const QString extentAsStr = !extentBox3D.isEmpty() ? extentBox3D.toString() : extent().toString();
6177 myMetadata += u"<tr><td class=\"highlight\">"_s + tr( "Extent" ) + u"</td><td>"_s + extentAsStr + u"</td></tr>\n"_s;
6178 }
6179
6180 // feature count
6181 QLocale locale = QLocale();
6182 locale.setNumberOptions( locale.numberOptions() &= ~QLocale::NumberOption::OmitGroupSeparator );
6183 myMetadata += u"<tr><td class=\"highlight\">"_s
6184 + tr( "Feature count" )
6185 + u"</td><td>"_s
6186 + ( featureCount() == -1 ? tr( "unknown" ) : locale.toString( static_cast<qlonglong>( featureCount() ) ) )
6187 + u"</td></tr>\n"_s;
6188
6189 // End Provider section
6190 myMetadata += "</table>\n<br><br>"_L1;
6191
6192 if ( isSpatial() )
6193 {
6194 // CRS
6195 myMetadata += crsHtmlMetadata();
6196 }
6197
6198 // identification section
6199 myMetadata += u"<h1>"_s + tr( "Identification" ) + u"</h1>\n<hr>\n"_s;
6200 myMetadata += htmlFormatter.identificationSectionHtml();
6201 myMetadata += "<br><br>\n"_L1;
6202
6203 // extent section
6204 myMetadata += u"<h1>"_s + tr( "Extent" ) + u"</h1>\n<hr>\n"_s;
6205 myMetadata += htmlFormatter.extentSectionHtml( isSpatial() );
6206 myMetadata += "<br><br>\n"_L1;
6207
6208 // Start the Access section
6209 myMetadata += u"<h1>"_s + tr( "Access" ) + u"</h1>\n<hr>\n"_s;
6210 myMetadata += htmlFormatter.accessSectionHtml();
6211 myMetadata += "<br><br>\n"_L1;
6212
6213 // Fields section
6214 myMetadata += u"<h1>"_s + tr( "Fields" ) + u"</h1>\n<hr>\n<table class=\"list-view\">\n"_s;
6215
6216 // primary key
6218 if ( !pkAttrList.isEmpty() )
6219 {
6220 myMetadata += u"<tr><td class=\"highlight\">"_s + tr( "Primary key attributes" ) + u"</td><td>"_s;
6221 const auto constPkAttrList = pkAttrList;
6222 for ( int idx : constPkAttrList )
6223 {
6224 myMetadata += fields().at( idx ).name() + ' ';
6225 }
6226 myMetadata += "</td></tr>\n"_L1;
6227 }
6228
6229 const QgsFields myFields = fields();
6230
6231 // count fields
6232 myMetadata += u"<tr><td class=\"highlight\">"_s + tr( "Count" ) + u"</td><td>"_s + QString::number( myFields.size() ) + u"</td></tr>\n"_s;
6233
6234 myMetadata += "</table>\n<br><table width=\"100%\" class=\"tabular-view\">\n"_L1;
6235 myMetadata += "<tr><th>"_L1 + tr( "Field" ) + "</th><th>"_L1 + tr( "Type" ) + "</th><th>"_L1 + tr( "Length" ) + "</th><th>"_L1 + tr( "Precision" ) + "</th><th>"_L1 + tr( "Comment" ) + "</th></tr>\n"_L1;
6236
6237 for ( int i = 0; i < myFields.size(); ++i )
6238 {
6239 QgsField myField = myFields.at( i );
6240 QString rowClass;
6241 if ( i % 2 )
6242 rowClass = u"class=\"odd-row\""_s;
6243 myMetadata += "<tr "_L1
6244 + rowClass
6245 + "><td>"_L1
6246 + myField.displayNameWithAlias()
6247 + "</td><td>"_L1
6248 + myField.typeName()
6249 + "</td><td>"_L1
6250 + QString::number( myField.length() )
6251 + "</td><td>"_L1
6252 + QString::number( myField.precision() )
6253 + "</td><td>"_L1
6254 + myField.comment()
6255 + "</td></tr>\n"_L1;
6256 }
6257
6258 //close field list
6259 myMetadata += "</table>\n<br><br>"_L1;
6260
6261 // Start the contacts section
6262 myMetadata += u"<h1>"_s + tr( "Contacts" ) + u"</h1>\n<hr>\n"_s;
6263 myMetadata += htmlFormatter.contactsSectionHtml();
6264 myMetadata += "<br><br>\n"_L1;
6265
6266 // Start the links section
6267 myMetadata += u"<h1>"_s + tr( "Links" ) + u"</h1>\n<hr>\n"_s;
6268 myMetadata += htmlFormatter.linksSectionHtml();
6269 myMetadata += "<br><br>\n"_L1;
6270
6271 // Start the history section
6272 myMetadata += u"<h1>"_s + tr( "History" ) + u"</h1>\n<hr>\n"_s;
6273 myMetadata += htmlFormatter.historySectionHtml();
6274 myMetadata += "<br><br>\n"_L1;
6275
6276 myMetadata += customPropertyHtmlMetadata();
6277
6278 myMetadata += "\n</body>\n</html>\n"_L1;
6279 return myMetadata;
6280}
6281
6282void QgsVectorLayer::invalidateSymbolCountedFlag()
6283{
6285
6286 mSymbolFeatureCounted = false;
6287}
6288
6289void QgsVectorLayer::onFeatureCounterCompleted()
6290{
6292
6293 onSymbolsCounted();
6294 mFeatureCounter = nullptr;
6295}
6296
6297void QgsVectorLayer::onFeatureCounterTerminated()
6298{
6300
6301 mFeatureCounter = nullptr;
6302}
6303
6304void QgsVectorLayer::onJoinedFieldsChanged()
6305{
6307
6308 // some of the fields of joined layers have changed -> we need to update this layer's fields too
6309 updateFields();
6310}
6311
6312void QgsVectorLayer::onFeatureAdded( QgsFeatureId fid )
6313{
6315
6316 updateExtents();
6317
6318 emit featureAdded( fid );
6319}
6320
6321void QgsVectorLayer::onFeatureDeleted( QgsFeatureId fid )
6322{
6324
6325 updateExtents();
6326
6327 if ( mEditCommandActive || mCommitChangesActive )
6328 {
6329 mDeletedFids << fid;
6330 }
6331 else
6332 {
6333 mSelectedFeatureIds.remove( fid );
6334 emit featuresDeleted( QgsFeatureIds() << fid );
6335 }
6336
6337 emit featureDeleted( fid );
6338}
6339
6340void QgsVectorLayer::onRelationsLoaded()
6341{
6343
6344 mEditFormConfig.onRelationsLoaded();
6345}
6346
6347void QgsVectorLayer::onSymbolsCounted()
6348{
6350
6351 if ( mFeatureCounter )
6352 {
6353 mSymbolFeatureCounted = true;
6354 mSymbolFeatureCountMap = mFeatureCounter->symbolFeatureCountMap();
6355 mSymbolFeatureIdMap = mFeatureCounter->symbolFeatureIdMap();
6357 }
6358}
6359
6360QList<QgsRelation> QgsVectorLayer::referencingRelations( int idx ) const
6361{
6363
6364 if ( QgsProject *p = project() )
6365 return p->relationManager()->referencingRelations( this, idx );
6366 else
6367 return {};
6368}
6369
6370QList<QgsWeakRelation> QgsVectorLayer::weakRelations() const
6371{
6373
6374 return mWeakRelations;
6375}
6376
6377void QgsVectorLayer::setWeakRelations( const QList<QgsWeakRelation> &relations )
6378{
6380
6381 mWeakRelations = relations;
6382}
6383
6384bool QgsVectorLayer::loadAuxiliaryLayer( const QgsAuxiliaryStorage &storage, const QString &key )
6385{
6387
6388 bool rc = false;
6389
6390 QString joinKey = mAuxiliaryLayerKey;
6391 if ( !key.isEmpty() )
6392 joinKey = key;
6393
6394 if ( storage.isValid() && !joinKey.isEmpty() )
6395 {
6396 QgsAuxiliaryLayer *alayer = nullptr;
6397
6398 int idx = fields().lookupField( joinKey );
6399
6400 if ( idx >= 0 )
6401 {
6402 alayer = storage.createAuxiliaryLayer( fields().field( idx ), this );
6403
6404 if ( alayer )
6405 {
6406 setAuxiliaryLayer( alayer );
6407 rc = true;
6408 }
6409 }
6410 }
6411
6412 return rc;
6413}
6414
6416{
6418
6419 mAuxiliaryLayerKey.clear();
6420
6421 if ( mAuxiliaryLayer )
6422 removeJoin( mAuxiliaryLayer->id() );
6423
6424 if ( alayer )
6425 {
6426 addJoin( alayer->joinInfo() );
6427
6428 if ( !alayer->isEditable() )
6429 alayer->startEditing();
6430
6431 mAuxiliaryLayerKey = alayer->joinInfo().targetFieldName();
6432 }
6433
6434 mAuxiliaryLayer.reset( alayer );
6435 if ( mAuxiliaryLayer )
6436 mAuxiliaryLayer->setParent( this );
6437 updateFields();
6438}
6439
6441{
6443
6444 return mAuxiliaryLayer.get();
6445}
6446
6448{
6450
6451 return mAuxiliaryLayer.get();
6452}
6453
6454QSet<QgsMapLayerDependency> QgsVectorLayer::dependencies() const
6455{
6457
6458 if ( mDataProvider )
6459 return mDataProvider->dependencies() + mDependencies;
6460 return mDependencies;
6461}
6462
6463void QgsVectorLayer::emitDataChanged()
6464{
6466
6467 if ( mDataChangedFired )
6468 return;
6469
6470 // If we are asked to fire dataChanged from a layer we depend on,
6471 // be sure that this layer is not in the process of committing its changes, because
6472 // we will be asked to fire dataChanged at the end of his commit, and we don't
6473 // want to fire this signal more than necessary.
6474 if ( QgsVectorLayer *layerWeDependUpon = qobject_cast<QgsVectorLayer *>( sender() ); layerWeDependUpon && layerWeDependUpon->mCommitChangesActive )
6475 return;
6476
6477 updateExtents(); // reset cached extent to reflect data changes
6478
6479 mDataChangedFired = true;
6480 emit dataChanged();
6481 mDataChangedFired = false;
6482}
6483
6484void QgsVectorLayer::onDependencyAfterCommitChanges()
6485{
6487
6488 if ( mDataProvider && mDataProvider->capabilities().testFlag( Qgis::VectorProviderCapability::CacheData ) )
6489 mDataProvider->reloadData();
6490 else
6491 emitDataChanged();
6492}
6493
6494bool QgsVectorLayer::setDependencies( const QSet<QgsMapLayerDependency> &oDeps )
6495{
6497
6498 QSet<QgsMapLayerDependency> deps;
6499 const auto constODeps = oDeps;
6500 for ( const QgsMapLayerDependency &dep : constODeps )
6501 {
6502 if ( dep.origin() == QgsMapLayerDependency::FromUser )
6503 deps << dep;
6504 }
6505
6506 QSet<QgsMapLayerDependency> toAdd = deps - dependencies();
6507
6508 // disconnect layers that are not present in the list of dependencies anymore
6509 if ( QgsProject *p = project() )
6510 {
6511 for ( const QgsMapLayerDependency &dep : std::as_const( mDependencies ) )
6512 {
6513 QgsVectorLayer *lyr = static_cast<QgsVectorLayer *>( p->mapLayer( dep.layerId() ) );
6514 if ( !lyr )
6515 continue;
6516 disconnect( lyr, &QgsVectorLayer::featureAdded, this, &QgsVectorLayer::emitDataChanged );
6517 disconnect( lyr, &QgsVectorLayer::featureDeleted, this, &QgsVectorLayer::emitDataChanged );
6518 disconnect( lyr, &QgsVectorLayer::geometryChanged, this, &QgsVectorLayer::emitDataChanged );
6519 disconnect( lyr, &QgsVectorLayer::dataChanged, this, &QgsVectorLayer::emitDataChanged );
6521 disconnect( lyr, &QgsVectorLayer::afterCommitChanges, this, &QgsVectorLayer::onDependencyAfterCommitChanges );
6522 }
6523 }
6524
6525 // assign new dependencies
6526 if ( mDataProvider )
6527 mDependencies = mDataProvider->dependencies() + deps;
6528 else
6529 mDependencies = deps;
6530 emit dependenciesChanged();
6531
6532 // connect to new layers
6533 if ( QgsProject *p = project() )
6534 {
6535 for ( const QgsMapLayerDependency &dep : std::as_const( mDependencies ) )
6536 {
6537 QgsVectorLayer *lyr = static_cast<QgsVectorLayer *>( p->mapLayer( dep.layerId() ) );
6538 if ( !lyr )
6539 continue;
6540 connect( lyr, &QgsVectorLayer::featureAdded, this, &QgsVectorLayer::emitDataChanged );
6541 connect( lyr, &QgsVectorLayer::featureDeleted, this, &QgsVectorLayer::emitDataChanged );
6542 connect( lyr, &QgsVectorLayer::geometryChanged, this, &QgsVectorLayer::emitDataChanged );
6543 connect( lyr, &QgsVectorLayer::dataChanged, this, &QgsVectorLayer::emitDataChanged );
6545 connect( lyr, &QgsVectorLayer::afterCommitChanges, this, &QgsVectorLayer::onDependencyAfterCommitChanges );
6546 }
6547 }
6548
6549 // if new layers are present, emit a data change
6550 if ( !toAdd.isEmpty() )
6551 emitDataChanged();
6552
6553 return true;
6554}
6555
6557{
6559
6560 if ( fieldIndex < 0 || fieldIndex >= mFields.count() || !mDataProvider )
6562
6563 QgsFieldConstraints::Constraints constraints = mFields.at( fieldIndex ).constraints().constraints();
6564
6565 // make sure provider constraints are always present!
6566 if ( mFields.fieldOrigin( fieldIndex ) == Qgis::FieldOrigin::Provider )
6567 {
6568 constraints |= mDataProvider->fieldConstraints( mFields.fieldOriginIndex( fieldIndex ) );
6569 }
6570
6571 return constraints;
6572}
6573
6574QMap< QgsFieldConstraints::Constraint, QgsFieldConstraints::ConstraintStrength> QgsVectorLayer::fieldConstraintsAndStrength( int fieldIndex ) const
6575{
6577
6578 QMap< QgsFieldConstraints::Constraint, QgsFieldConstraints::ConstraintStrength > m;
6579
6580 if ( fieldIndex < 0 || fieldIndex >= mFields.count() )
6581 return m;
6582
6583 QString name = mFields.at( fieldIndex ).name();
6584
6585 QMap< QPair< QString, QgsFieldConstraints::Constraint >, QgsFieldConstraints::ConstraintStrength >::const_iterator conIt = mFieldConstraintStrength.constBegin();
6586 for ( ; conIt != mFieldConstraintStrength.constEnd(); ++conIt )
6587 {
6588 if ( conIt.key().first == name )
6589 {
6590 m[conIt.key().second] = mFieldConstraintStrength.value( conIt.key() );
6591 }
6592 }
6593
6594 return m;
6595}
6596
6598{
6600
6601 if ( index < 0 || index >= mFields.count() )
6602 return;
6603
6604 QString name = mFields.at( index ).name();
6605
6606 // add constraint to existing constraints
6607 QgsFieldConstraints::Constraints constraints = mFieldConstraints.value( name, QgsFieldConstraints::Constraints() );
6608 constraints |= constraint;
6609 mFieldConstraints.insert( name, constraints );
6610
6611 mFieldConstraintStrength.insert( qMakePair( name, constraint ), strength );
6612
6613 updateFields();
6614}
6615
6617{
6619
6620 if ( index < 0 || index >= mFields.count() )
6621 return;
6622
6623 QString name = mFields.at( index ).name();
6624
6625 // remove constraint from existing constraints
6626 QgsFieldConstraints::Constraints constraints = mFieldConstraints.value( name, QgsFieldConstraints::Constraints() );
6627 constraints &= ~constraint;
6628 mFieldConstraints.insert( name, constraints );
6629
6630 mFieldConstraintStrength.remove( qMakePair( name, constraint ) );
6631
6632 updateFields();
6633}
6634
6636{
6638
6639 if ( index < 0 || index >= mFields.count() )
6640 return QString();
6641
6642 return mFields.at( index ).constraints().constraintExpression();
6643}
6644
6646{
6648
6649 if ( index < 0 || index >= mFields.count() )
6650 return QString();
6651
6652 return mFields.at( index ).constraints().constraintDescription();
6653}
6654
6655void QgsVectorLayer::setConstraintExpression( int index, const QString &expression, const QString &description )
6656{
6658
6659 if ( index < 0 || index >= mFields.count() )
6660 return;
6661
6662 if ( expression.isEmpty() )
6663 {
6664 mFieldConstraintExpressions.remove( mFields.at( index ).name() );
6665 }
6666 else
6667 {
6668 mFieldConstraintExpressions.insert( mFields.at( index ).name(), qMakePair( expression, description ) );
6669 }
6670 updateFields();
6671}
6672
6674{
6676
6677 if ( index < 0 || index >= mFields.count() )
6678 return;
6679
6680 mFieldConfigurationFlags.insert( mFields.at( index ).name(), flags );
6681 updateFields();
6682}
6683
6685{
6687
6688 if ( index < 0 || index >= mFields.count() )
6689 return;
6690 Qgis::FieldConfigurationFlags flags = mFields.at( index ).configurationFlags();
6691 flags.setFlag( flag, active );
6693}
6694
6696{
6698
6699 if ( index < 0 || index >= mFields.count() )
6701
6702 return mFields.at( index ).configurationFlags();
6703}
6704
6706{
6708
6709 if ( index < 0 || index >= mFields.count() )
6710 return;
6711
6712 if ( setup.isNull() )
6713 mFieldWidgetSetups.remove( mFields.at( index ).name() );
6714 else
6715 mFieldWidgetSetups.insert( mFields.at( index ).name(), setup );
6716 updateFields();
6717}
6718
6720{
6722
6723 if ( index < 0 || index >= mFields.count() )
6724 return QgsEditorWidgetSetup();
6725
6726 return mFields.at( index ).editorWidgetSetup();
6727}
6728
6729QgsAbstractVectorLayerLabeling *QgsVectorLayer::readLabelingFromCustomProperties()
6730{
6732
6734 if ( customProperty( u"labeling"_s ).toString() == "pal"_L1 )
6735 {
6736 if ( customProperty( u"labeling/enabled"_s, QVariant( false ) ).toBool() )
6737 {
6738 // try to load from custom properties
6739 QgsPalLayerSettings settings;
6740 settings.readFromLayerCustomProperties( this );
6741 labeling = new QgsVectorLayerSimpleLabeling( settings );
6742 }
6743
6744 // also clear old-style labeling config
6745 removeCustomProperty( u"labeling"_s );
6746 const auto constCustomPropertyKeys = customPropertyKeys();
6747 for ( const QString &key : constCustomPropertyKeys )
6748 {
6749 if ( key.startsWith( "labeling/"_L1 ) )
6750 removeCustomProperty( key );
6751 }
6752 }
6753
6754 return labeling;
6755}
6756
6758{
6760
6761 return mAllowCommit;
6762}
6763
6765{
6767
6768 if ( mAllowCommit == allowCommit )
6769 return;
6770
6771 mAllowCommit = allowCommit;
6772 emit allowCommitChanged();
6773}
6774
6776{
6778
6779 return mGeometryOptions.get();
6780}
6781
6788
6790{
6792
6793 return mReadExtentFromXml;
6794}
6795
6796void QgsVectorLayer::onDirtyTransaction( const QString &sql, const QString &name )
6797{
6799
6801 if ( tr && mEditBuffer )
6802 {
6803 qobject_cast<QgsVectorLayerEditPassthrough *>( mEditBuffer )->update( tr, sql, name );
6804 }
6805}
6806
6807QList<QgsVectorLayer *> QgsVectorLayer::DeleteContext::handledLayers( bool includeAuxiliaryLayers ) const
6808{
6809 QList<QgsVectorLayer *> layers;
6810 QMap<QgsVectorLayer *, QgsFeatureIds>::const_iterator i;
6811 for ( i = mHandledFeatures.begin(); i != mHandledFeatures.end(); ++i )
6812 {
6813 if ( includeAuxiliaryLayers || !qobject_cast< QgsAuxiliaryLayer * >( i.key() ) )
6814 layers.append( i.key() );
6815 }
6816 return layers;
6817}
6818
Provides global constants and enumerations for use throughout the application.
Definition qgis.h:62
@ Action
Map layers' action.
Definition qgis.h:466
@ FormInitCode
Attribute forms' initiation code.
Definition qgis.h:467
@ SelectAtId
Fast access to features using their ID.
Definition qgis.h:533
@ CacheData
Provider caches source data and should force provider data reloads when dependent layers are committe...
Definition qgis.h:551
@ CreateRenderer
Provider can create feature renderers using backend-specific formatting information....
Definition qgis.h:547
@ CreateLabeling
Provider can set labeling settings using backend-specific formatting information. Since QGIS 3....
Definition qgis.h:548
@ ReadLayerMetadata
Provider can read layer metadata from data store. Since QGIS 3.0. See QgsDataProvider::layerMetadata(...
Definition qgis.h:544
@ DeleteFeatures
Allows deletion of features.
Definition qgis.h:528
QFlags< VectorRenderingSimplificationFlag > VectorRenderingSimplificationFlags
Simplification flags for vector feature rendering.
Definition qgis.h:3247
@ Composition
Fix relation, related elements are part of the parent and a parent copy will copy any children or del...
Definition qgis.h:4839
@ Association
Loose relation, related elements are not part of the parent and a parent copy will not copy any child...
Definition qgis.h:4838
GeometryOperationResult
Success or failure of a geometry operation.
Definition qgis.h:2192
@ InvalidInputGeometryType
The input geometry (ring, part, split line, etc.) has not the correct geometry type.
Definition qgis.h:2196
@ Success
Operation succeeded.
Definition qgis.h:2193
@ SelectionIsEmpty
No features were selected.
Definition qgis.h:2197
@ AddRingNotInExistingFeature
The input ring doesn't have any existing ring to fit into.
Definition qgis.h:2208
@ AddRingNotClosed
The input ring is not closed.
Definition qgis.h:2205
@ SelectionIsGreaterThanOne
More than one features were selected.
Definition qgis.h:2198
@ LayerNotEditable
Cannot edit layer.
Definition qgis.h:2200
SpatialIndexPresence
Enumeration of spatial index presence states.
Definition qgis.h:599
@ Unknown
Spatial index presence cannot be determined, index may or may not exist.
Definition qgis.h:600
VectorRenderingSimplificationFlag
Simplification flags for vector feature rendering.
Definition qgis.h:3232
@ NoSimplification
No simplification can be applied.
Definition qgis.h:3233
@ OverPoint
Arranges candidates over a point (or centroid of a polygon), or at a preset offset from the point....
Definition qgis.h:1289
@ Curved
Arranges candidates following the curvature of a line feature. Applies to line layers only.
Definition qgis.h:1291
@ AroundPoint
Arranges candidates in a circle around a point (or centroid of a polygon). Applies to point or polygo...
Definition qgis.h:1288
@ Line
Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon'...
Definition qgis.h:1290
@ Horizontal
Arranges horizontal candidates scattered throughout a polygon feature or along a line feature....
Definition qgis.h:1292
@ PerimeterCurved
Arranges candidates following the curvature of a polygon's boundary. Applies to polygon layers only.
Definition qgis.h:1295
QFlags< VectorLayerTypeFlag > VectorLayerTypeFlags
Vector layer type flags.
Definition qgis.h:440
VectorSimplificationAlgorithm
Simplification algorithms for vector features.
Definition qgis.h:3216
@ Distance
The simplification uses the distance between points to remove duplicate points.
Definition qgis.h:3217
@ File
Load the Python code from an external file.
Definition qgis.h:6188
@ Environment
Use the Python code available in the Python environment.
Definition qgis.h:6190
@ NoSource
Do not use Python code at all.
Definition qgis.h:6187
@ Dialog
Use the Python code provided in the dialog.
Definition qgis.h:6189
@ ExactIntersect
Use exact geometry intersection (slower) instead of bounding boxes.
Definition qgis.h:2362
@ SubsetOfAttributes
Fetch only a subset of attributes (setSubsetOfAttributes sets this flag).
Definition qgis.h:2361
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
Definition qgis.h:2360
@ FastExtent3D
Provider's 3D extent retrieval via QgsDataProvider::extent3D() is always guaranteed to be trivial/fas...
Definition qgis.h:2477
@ FastExtent2D
Provider's 2D extent retrieval via QgsDataProvider::extent() is always guaranteed to be trivial/fast ...
Definition qgis.h:2476
@ BufferedGroups
Buffered transactional editing means that all editable layers in the buffered transaction group are t...
Definition qgis.h:4191
@ Mac
MacOS specific.
Definition qgis.h:5150
@ OpenUrl
Open URL action.
Definition qgis.h:5153
@ Unix
Unix specific.
Definition qgis.h:5152
@ SubmitUrlMultipart
POST data to an URL using "multipart/form-data".
Definition qgis.h:5155
@ Windows
Windows specific.
Definition qgis.h:5151
@ SubmitUrlEncoded
POST data to an URL, using "application/x-www-form-urlencoded" or "application/json" if the body is v...
Definition qgis.h:5154
FieldDomainMergePolicy
Merge policy for field domains.
Definition qgis.h:4142
@ UnsetField
Clears the field value so that the data provider backend will populate using any backend triggers or ...
Definition qgis.h:4146
FieldDomainSplitPolicy
Split policy for field domains.
Definition qgis.h:4125
@ Duplicate
Duplicate original value.
Definition qgis.h:4127
BlendMode
Blending modes defining the available composition modes that can be used when painting.
Definition qgis.h:5402
@ AboveRight
Above right.
Definition qgis.h:1378
@ BelowLeft
Below left.
Definition qgis.h:1382
@ Above
Above center.
Definition qgis.h:1377
@ BelowRight
Below right.
Definition qgis.h:1384
@ Right
Right middle.
Definition qgis.h:1381
@ AboveLeft
Above left.
Definition qgis.h:1376
@ Below
Below center.
Definition qgis.h:1383
@ Over
Center middle.
Definition qgis.h:1380
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:379
@ Point
Points.
Definition qgis.h:380
@ Line
Lines.
Definition qgis.h:381
@ Polygon
Polygons.
Definition qgis.h:382
@ Unknown
Unknown types.
Definition qgis.h:383
@ Null
No geometry.
Definition qgis.h:384
@ Generated
A generated relation is a child of a polymorphic relation.
Definition qgis.h:4825
@ Normal
A normal relation.
Definition qgis.h:4824
FieldDuplicatePolicy
Duplicate policy for fields.
Definition qgis.h:4162
@ Duplicate
Duplicate original value.
Definition qgis.h:4164
static const float DEFAULT_MAPTOPIXEL_THRESHOLD
Default threshold between map coordinates and device coordinates for map2pixel simplification.
Definition qgis.h:7013
QFlags< DataProviderReadFlag > DataProviderReadFlags
Flags which control data provider construction.
Definition qgis.h:512
FeatureAvailability
Possible return value for QgsFeatureSource::hasFeatures() to determine if a source is empty.
Definition qgis.h:618
@ FeaturesMaybeAvailable
There may be features available in this source.
Definition qgis.h:621
@ FeaturesAvailable
There is at least one feature available in this source.
Definition qgis.h:620
@ NoFeaturesAvailable
There are certainly no features available in this source.
Definition qgis.h:619
@ Vector
Vector layer.
Definition qgis.h:207
FieldOrigin
Field origin.
Definition qgis.h:1854
@ Provider
Field originates from the underlying data provider of the vector layer.
Definition qgis.h:1856
@ Edit
Field has been temporarily added in editing mode.
Definition qgis.h:1858
@ Unknown
The field origin has not been specified.
Definition qgis.h:1855
@ Expression
Field is calculated from an expression.
Definition qgis.h:1859
@ Join
Field originates from a joined layer.
Definition qgis.h:1857
RenderUnit
Rendering size units.
Definition qgis.h:5655
@ Points
Points (e.g., for font sizes).
Definition qgis.h:5660
@ Pixels
Pixels.
Definition qgis.h:5658
@ LoadDefaultStyle
Reset the layer's style to the default for the datasource.
Definition qgis.h:495
@ ForceReadOnly
Open layer in a read-only mode.
Definition qgis.h:498
Aggregate
Available aggregates to calculate.
Definition qgis.h:6489
VertexMarkerType
Editing vertex markers, used for showing vertices during a edit operation.
Definition qgis.h:1983
@ NoMarker
No marker.
Definition qgis.h:1986
@ SemiTransparentCircle
Semi-transparent circle marker.
Definition qgis.h:1984
@ Cross
Cross marker.
Definition qgis.h:1985
VectorEditResult
Specifies the result of a vector layer edit operation.
Definition qgis.h:1968
@ EmptyGeometry
Edit operation resulted in an empty geometry.
Definition qgis.h:1970
@ Success
Edit operation was successful.
Definition qgis.h:1969
@ InvalidLayer
Edit failed due to invalid layer.
Definition qgis.h:1973
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:294
@ Unknown
Unknown.
Definition qgis.h:295
FieldConfigurationFlag
Configuration flags for fields These flags are meant to be user-configurable and are not describing a...
Definition qgis.h:1871
@ HideFromWfs
Field is not available if layer is served as WFS from QGIS server.
Definition qgis.h:1875
@ NoFlag
No flag is defined.
Definition qgis.h:1872
@ HideFromWms
Field is not available if layer is served as WMS from QGIS server.
Definition qgis.h:1874
@ AllowOverlapIfRequired
Avoids overlapping labels when possible, but permit overlaps if labels for features cannot otherwise ...
Definition qgis.h:1250
QFlags< FieldConfigurationFlag > FieldConfigurationFlags
Configuration flags for fields These flags are meant to be user-configurable and are not describing a...
Definition qgis.h:1886
@ AlwaysAllowUpsideDown
Show upside down for all labels, including dynamic ones.
Definition qgis.h:1446
SelectBehavior
Specifies how a selection should be applied.
Definition qgis.h:1921
@ SetSelection
Set selection, removing any existing selection.
Definition qgis.h:1922
@ AddToSelection
Add selection to current selection.
Definition qgis.h:1923
@ IntersectSelection
Modify current selection to include only select features which match.
Definition qgis.h:1924
@ RemoveFromSelection
Remove from current selection.
Definition qgis.h:1925
Abstract base class for objects which generate elevation profiles.
virtual bool writeXml(QDomElement &collectionElem, const QgsPropertiesDefinition &definitions) const
Writes the current state of the property collection into an XML element.
Abstract base class - its implementations define different approaches to the labeling of a vector lay...
static QgsAbstractVectorLayerLabeling * create(const QDomElement &element, const QgsReadWriteContext &context)
Try to create instance of an implementation based on the XML data.
Storage and management of actions associated with a layer.
QList< QgsAction > actions(const QString &actionScope=QString()) const
Returns a list of actions that are available in the given action scope.
QUuid addAction(Qgis::AttributeActionType type, const QString &name, const QString &command, bool capture=false)
Add an action with the given name and action details.
Utility class that encapsulates an action based on vector attributes.
Definition qgsaction.h:38
Utility class for calculating aggregates for a field (or expression) over the features from a vector ...
static QgsNetworkContentFetcherRegistry * networkContentFetcherRegistry()
Returns the application's network content registry used for fetching temporary files during QGIS sess...
static QgsRuntimeProfiler * profiler()
Returns the application runtime profiler.
static QgsTaskManager * taskManager()
Returns the application's task manager, used for managing application wide background task handling.
A container for configuration of the attribute table.
void update(const QgsFields &fields)
Update the configuration with the given fields.
A vector of attributes.
Allows managing the auxiliary storage for a vector layer.
QgsVectorLayerJoinInfo joinInfo() const
Returns information to use for joining with primary key and so on.
Providing some utility methods to manage auxiliary storage.
QgsAuxiliaryLayer * createAuxiliaryLayer(const QgsField &field, QgsVectorLayer *layer) const
Creates an auxiliary layer for a vector layer.
bool isValid() const
Returns the status of the auxiliary storage currently defined.
A 3-dimensional box composed of x, y, z coordinates.
Definition qgsbox3d.h:45
QString toString(int precision=16) const
Returns a string representation of form xmin,ymin,zmin : xmax,ymax,zmax Coordinates will be truncated...
Definition qgsbox3d.cpp:326
bool isEmpty() const
Returns true if the box is empty.
Definition qgsbox3d.cpp:321
Holds conditional style information for a layer.
Represents a coordinate reference system (CRS).
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
Contains information about the context in which a coordinate transform is executed.
Curve polygon geometry type.
Abstract base class for curved geometry type.
Definition qgscurve.h:36
void dataChanged()
Emitted whenever a change is made to the data provider which may have caused changes in the provider'...
void fullExtentCalculated()
Emitted whenever a deferred extent calculation is completed by the provider.
virtual QString dataSourceUri(bool expandAuthConfig=false) const
Gets the data source specification.
Stores the component parts of a data source URI (e.g.
bool useEstimatedMetadata() const
Returns true if estimated metadata should be used for the connection.
Provides a container for managing client side default values for fields.
bool isValid() const
Returns if this default value should be applied.
Stores the settings for rendering of all diagrams for a layer.
@ PositionX
X-coordinate data defined diagram position.
@ PositionY
Y-coordinate data defined diagram position.
@ Show
Whether to show the diagram.
Evaluates and returns the diagram settings relating to a diagram for a specific feature.
Contains configuration settings for an editor form.
Holder for the widget type and its configuration for a field.
QVariantMap config() const
Returns the widget configuration.
bool isNull() const
Returns true if there is no widget configured.
A embedded script entity for QgsObjectEntityVisitorInterface.
Single scope for storing variables and functions for use within a QgsExpressionContext.
void setFields(const QgsFields &fields)
Convenience function for setting a fields for the scope.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the scope.
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
QgsExpressionContextScope * popScope()
Removes the last scope from the expression context and return it.
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
Buffers information about expression fields for a vector layer.
void writeXml(QDomNode &layer_node, QDomDocument &document) const
Saves expressions to xml under the layer node.
An expression node which takes its value from a feature's field.
QString name() const
The name of the column.
Handles parsing and evaluation of expressions (formerly called "search strings").
bool prepare(const QgsExpressionContext *context)
Gets the expression ready for evaluation - find out column indexes.
QString expression() const
Returns the original, unmodified expression string.
bool hasParserError() const
Returns true if an error occurred when parsing the input expression.
QString evalErrorString() const
Returns evaluation error.
QString parserErrorString() const
Returns parser error.
QSet< QString > referencedColumns() const
Gets list of columns referenced by the expression.
static QString quotedColumnRef(QString name)
Returns a quoted column reference (in double quotes).
bool hasEvalError() const
Returns true if an error occurred when evaluating last input.
static int expressionToLayerFieldIndex(const QString &expression, const QgsVectorLayer *layer)
Attempts to resolve an expression to a field index from the given layer.
bool needsGeometry() const
Returns true if the expression uses feature geometry for some computation.
QVariant evaluate()
Evaluate the feature and return the result.
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.
bool close()
Call to end the iteration.
An interface for objects which generate feature renderers for vector layers.
Abstract base class for all 2D vector feature renderers.
static QgsFeatureRenderer * defaultRenderer(Qgis::GeometryType geomType)
Returns a new renderer - used by default in vector layers.
static QgsFeatureRenderer * load(QDomElement &symbologyElem, const QgsReadWriteContext &context)
create a renderer from XML element
static QgsFeatureRenderer * loadSld(const QDomNode &node, Qgis::GeometryType geomType, QString &errorMessage)
Create a new renderer according to the information contained in the UserStyle element of a SLD style ...
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.
QgsFeatureRequest & setFilterExpression(const QString &expression)
Set the filter expression.
QgsFeatureRequest & setExpressionContext(const QgsExpressionContext &context)
Sets the expression context used to evaluate filter expressions.
QgsFeatureRequest & setFilterFid(QgsFeatureId fid)
Sets the feature ID that should be fetched.
QFlags< Flag > Flags
virtual QgsFeatureIds allFeatureIds() const
Returns a list of all feature IDs for features present in the source.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:60
Q_INVOKABLE bool setAttribute(int field, const QVariant &attr)
Sets an attribute's value by field index.
QgsAttributes attributes
Definition qgsfeature.h:64
QgsFields fields
Definition qgsfeature.h:65
QgsFeatureId id
Definition qgsfeature.h:63
QgsGeometry geometry
Definition qgsfeature.h:66
bool hasGeometry() const
Returns true if the feature has an associated geometry.
bool isValid() const
Returns the validity of this feature.
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
bool isCanceled() const
Tells whether the operation has been canceled already.
Definition qgsfeedback.h:56
Stores information about constraints which may be present on a field.
ConstraintStrength
Strength of constraints.
void setConstraintStrength(Constraint constraint, ConstraintStrength strength)
Sets the strength of a constraint.
void setConstraintExpression(const QString &expression, const QString &description=QString())
Set the constraint expression for the field.
@ ConstraintOriginProvider
Constraint was set at data provider.
@ ConstraintOriginLayer
Constraint was set by layer.
ConstraintOrigin constraintOrigin(Constraint constraint) const
Returns the origin of a field constraint, or ConstraintOriginNotSet if the constraint is not present ...
Constraint
Constraints which may be present on a field.
@ ConstraintNotNull
Field may not be null.
@ ConstraintUnique
Field must have a unique value.
@ ConstraintExpression
Field has an expression constraint set. See constraintExpression().
void setConstraint(Constraint constraint, ConstraintOrigin origin=ConstraintOriginLayer)
Sets a constraint on the field.
QFlags< Constraint > Constraints
Encapsulate a field in an attribute table or data source.
Definition qgsfield.h:56
QString typeName() const
Gets the field type.
Definition qgsfield.cpp:158
QString name
Definition qgsfield.h:65
int precision
Definition qgsfield.h:62
int length
Definition qgsfield.h:61
QString displayNameWithAlias() const
Returns the name to use when displaying this field and adds the alias in parenthesis if it is defined...
Definition qgsfield.cpp:104
QString alias
Definition qgsfield.h:66
QString customComment
Definition qgsfield.h:71
QString comment
Definition qgsfield.h:64
Container of fields for a vector layer.
Definition qgsfields.h:45
int count
Definition qgsfields.h:49
int size() const
Returns number of items.
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
const_iterator constBegin() const noexcept
Returns a const STL-style iterator pointing to the first item in the list.
Contains options to automatically adjust geometries to constraints on a layer.
A geometry is the spatial representation of a feature.
bool isExactlyEqual(const QgsGeometry &geometry, Qgis::GeometryBackend backend=Qgis::GeometryBackend::QGIS) const
Compares the geometry with another geometry using the specified backend.
QgsBox3D boundingBox3D() const
Returns the 3D bounding box of the geometry.
Qgis::GeometryType type
QgsRectangle boundingBox() const
Returns the bounding box of the geometry.
void setMergeLines(bool merge)
Sets whether connected line features with identical label text should be merged prior to generating l...
void setOverlapHandling(Qgis::LabelOverlapHandling handling)
Sets the technique used to handle overlapping labels.
void setQuadrant(Qgis::LabelQuadrantPosition quadrant)
Sets the quadrant in which to offset labels from the point.
Formats layer metadata into HTML.
void combine(const QgsAbstractMetadataBase *other) override
Combines the metadata from this object with the metadata from an other object.
bool hasMaximumScale() const
Returns true if maximum scale is set.
double maximumScale() const
Returns maximum scale denominator.
bool hasMinimumScale() const
Returns true if minimum scale is set.
bool hasLayerOpacity() const
Returns true if layer opacity is set.
double layerOpacity() const
Returns layer opacity in the range [0, 1].
double minimumScale() const
Returns minimum scale denominator.
Line string geometry type, with support for z-dimension and m-values.
static void warning(const QString &msg)
Goes to qWarning.
Models dependencies with or between map layers.
@ DataDependency
The layer may be invalidated by data changes on another layer.
@ PresenceDependency
The layer must be already present (in the registry) for this dependency to be resolved.
@ FromUser
Dependency given by the user.
Base class for storage of map layer elevation properties.
static QString typeToString(Qgis::LayerType type)
Converts a map layer type to a string value.
virtual QDomElement writeXml(QDomDocument &doc, const QgsReadWriteContext &context) const
Writes configuration to a DOM element, to be used later with readXml().
static QgsMapLayerLegend * defaultVectorLegend(QgsVectorLayer *vl)
Create new legend implementation for vector layer.
Base class for utility classes that encapsulate information necessary for rendering of map layers.
Base class for storage of map layer selection properties.
Stores style information (renderer, opacity, labeling, diagrams etc.) applicable to a map layer.
Base class for storage of map layer temporal properties.
QString name
Definition qgsmaplayer.h:87
void readStyleManager(const QDomNode &layerNode)
Read style manager's configuration (if any). To be called by subclasses.
void dependenciesChanged()
Emitted when dependencies are changed.
void writeStyleManager(QDomNode &layerNode, QDomDocument &doc) const
Write style manager's configuration (if exists). To be called by subclasses.
QgsMapLayerLegend * legend() const
Can be nullptr.
void editingStopped()
Emitted when edited changes have been successfully written to the data provider.
void recalculateExtents() const
This is used to send a request that any mapcanvas using this layer update its extents.
virtual Q_INVOKABLE QgsRectangle extent() const
Returns the extent of the layer.
QString source() const
Returns the source for the layer.
Q_INVOKABLE QVariant customProperty(const QString &value, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer.
int mBlockStyleChangedSignal
If non-zero, the styleChanged signal should not be emitted.
QString providerType() const
Returns the provider type (provider key) for this layer.
virtual void setExtent3D(const QgsBox3D &box)
Sets the extent.
void removeCustomProperty(const QString &key)
Remove a custom property from layer.
void setBlendMode(QPainter::CompositionMode blendMode)
Set the blending mode used for rendering a layer.
void configChanged()
Emitted whenever the configuration is changed.
void setMinimumScale(double scale)
Sets the minimum map scale (i.e.
static Qgis::DataProviderReadFlags providerReadFlags(const QDomNode &layerNode, QgsMapLayer::ReadFlags layerReadFlags)
Returns provider read flag deduced from layer read flags layerReadFlags and a dom node layerNode that...
void editingStarted()
Emitted when editing on this layer has started.
QgsCoordinateReferenceSystem crs
Definition qgsmaplayer.h:90
friend class QgsVectorLayer
void writeCustomProperties(QDomNode &layerNode, QDomDocument &doc) const
Write custom properties to project file.
virtual int listStylesInDatabase(QStringList &ids, QStringList &names, QStringList &descriptions, QString &msgError)
Lists all the style in db split into related to the layer and not related to.
virtual QString loadDefaultStyle(bool &resultFlag)
Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record...
void setDataSource(const QString &dataSource, const QString &baseName=QString(), const QString &provider=QString(), bool loadDefaultStyleFlag=false)
Updates the data source of the layer.
void triggerRepaint(bool deferredUpdate=false)
Will advise the map canvas (and any other interested party) that this layer requires to be repainted.
QString crsHtmlMetadata() const
Returns a HTML fragment containing the layer's CRS metadata, for use in the htmlMetadata() method.
void setMaximumScale(double scale)
Sets the maximum map scale (i.e.
QgsLayerMetadata metadata
Definition qgsmaplayer.h:89
QgsMapLayer(Qgis::LayerType type=Qgis::LayerType::Vector, const QString &name=QString(), const QString &source=QString())
Constructor for QgsMapLayer.
Qgis::LayerType type
Definition qgsmaplayer.h:93
QPainter::CompositionMode blendMode() const
Returns the current blending mode for a layer.
virtual void setOpacity(double opacity)
Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1....
void setFlags(QgsMapLayer::LayerFlags flags)
Returns the flags for this layer.
QString publicSource(bool hidePassword=false) const
Gets a version of the internal layer definition that has sensitive bits removed (for example,...
QSet< QgsMapLayerDependency > mDependencies
List of layers that may modify this layer on modification.
void readCustomProperties(const QDomNode &layerNode, const QString &keyStartsWith=QString())
Read custom properties from project file.
virtual void setMetadata(const QgsLayerMetadata &metadata)
Sets the layer's metadata store.
QFlags< StyleCategory > StyleCategories
Q_INVOKABLE void setCustomProperty(const QString &key, const QVariant &value)
Set a custom property for layer.
QString mProviderKey
Data provider key (name of the data provider).
QgsCoordinateTransformContext transformContext() const
Returns the layer data provider coordinate transform context or a default transform context if the la...
void styleChanged()
Signal emitted whenever a change affects the layer's style.
QUndoStack * undoStack()
Returns pointer to layer's undo stack.
std::unique_ptr< QgsDataProvider > mPreloadedProvider
Optionally used when loading a project, it is released when the layer is effectively created.
void rendererChanged()
Signal emitted when renderer is changed.
virtual QgsError error() const
Gets current status error.
void setScaleBasedVisibility(bool enabled)
Sets whether scale based visibility is enabled for the layer.
void dataSourceChanged()
Emitted whenever the layer's data source has been changed.
QgsMapLayer::LayerFlags flags
Definition qgsmaplayer.h:99
bool hasScaleBasedVisibility() const
Returns whether scale based visibility is enabled for the layer.
virtual QString getStyleFromDatabase(const QString &styleId, QString &msgError)
Returns the named style corresponding to style id provided.
void emitStyleChanged()
Triggers an emission of the styleChanged() signal.
void dataChanged()
Data of layer changed.
void willBeDeleted()
Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid...
virtual QgsBox3D extent3D() const
Returns the 3D extent of the layer.
virtual QgsMapLayer * clone() const =0
Returns a new instance equivalent to this one except for the id which is still unique.
void setName(const QString &name)
Set the display name of the layer.
virtual void setExtent(const QgsRectangle &rect)
Sets the extent.
virtual void resolveReferences(QgsProject *project)
Resolve references to other layers (kept as layer IDs after reading XML) into layer objects.
QString mDataSource
Data source description string, varies by layer type.
void setMapTipsEnabled(bool enabled)
Enable or disable map tips for this layer.
@ FlagReadExtentFromXml
Read extent from xml and skip get extent from provider.
@ FlagForceReadOnly
Force open as read only.
@ FlagDontResolveLayers
Don't resolve layer paths or create data providers for layers.
void setValid(bool valid)
Sets whether layer is valid or not.
void readCommonStyle(const QDomElement &layerElement, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories)
Read style data common to all layer types.
QgsMapLayer::ReadFlags mReadFlags
Read flags. It's up to the subclass to respect these when restoring state from XML.
double minimumScale() const
Returns the minimum map scale (i.e.
void repaintRequested(bool deferredUpdate=false)
By emitting this signal the layer tells that either appearance or content have been changed and any v...
void setMapTipTemplate(const QString &mapTipTemplate)
The mapTip is a pretty, html representation for feature information.
Q_INVOKABLE QStringList customPropertyKeys() const
Returns list of all keys within custom properties.
QgsProject * project() const
Returns the parent project if this map layer is added to a project.
bool mapTipsEnabled
Definition qgsmaplayer.h:97
void setLegend(QgsMapLayerLegend *legend)
Assign a legend controller to the map layer.
double opacity
Definition qgsmaplayer.h:95
bool mValid
Indicates if the layer is valid and can be drawn.
@ GeometryOptions
Geometry validation configuration.
@ AttributeTable
Attribute table settings: choice and order of columns, conditional styling.
@ LayerConfiguration
General configuration: identifiable, removable, searchable, display expression, read-only.
@ Symbology
Symbology.
@ MapTips
Map tips.
@ Rendering
Rendering: scale visibility, simplify method, opacity.
@ Relations
Relations.
@ CustomProperties
Custom properties (by plugins for instance).
@ Actions
Actions.
@ Forms
Feature form.
@ Fields
Aliases, widgets, WMS/WFS, expressions, constraints, virtual fields.
@ Legend
Legend settings.
@ Diagrams
Diagrams.
@ Labeling
Labeling.
void layerModified()
Emitted when modifications has been done on layer.
void setProviderType(const QString &providerType)
Sets the providerType (provider key).
QString customPropertyHtmlMetadata() const
Returns an HTML fragment containing custom property information, for use in the htmlMetadata() method...
QString generalHtmlMetadata() const
Returns an HTML fragment containing general metadata information, for use in the htmlMetadata() metho...
void writeCommonStyle(QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const
Write style data common to all layer types.
double maximumScale() const
Returns the maximum map scale (i.e.
QString mapTipTemplate
Definition qgsmaplayer.h:96
bool mShouldValidateCrs
true if the layer's CRS should be validated and invalid CRSes are not permitted.
void setCrs(const QgsCoordinateReferenceSystem &srs, bool emitSignal=true)
Sets layer's spatial reference system.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true, const char *file=__builtin_FILE(), const char *function=__builtin_FUNCTION(), int line=__builtin_LINE(), Qgis::StringFormat format=Qgis::StringFormat::PlainText)
Adds a message to the log instance (and creates it if necessary).
QFile * localFile(const QString &filePathOrUrl)
Returns a QFile from a local file or to a temporary file previously fetched by the registry.
An interface for classes which can visit various object entity (e.g.
virtual bool visitEmbeddedScript(const QgsEmbeddedScriptEntity &entity, const QgsObjectVisitorContext &context)
Called when the visitor will visit an embedded script entity.
A QgsObjectEntityVisitorInterface context object.
static QgsExpression * expressionFromOgcFilter(const QDomElement &element, QgsVectorLayer *layer=nullptr)
Parse XML with OGC filter into QGIS expression.
static Qgis::BlendMode getBlendModeEnum(QPainter::CompositionMode blendMode)
Returns a Qgis::BlendMode corresponding to a QPainter::CompositionMode.
static QPainter::CompositionMode getCompositionMode(Qgis::BlendMode blendMode)
Returns a QPainter::CompositionMode corresponding to a Qgis::BlendMode.
Contains settings for how a map layer will be labeled.
double yOffset
Vertical offset of label.
const QgsLabelPlacementSettings & placementSettings() const
Returns the label placement settings.
double maxCurvedCharAngleIn
Maximum angle between inside curved label characters (valid range 20.0 to 60.0).
void setFormat(const QgsTextFormat &format)
Sets the label text formatting settings, e.g., font settings, buffer settings, etc.
double xOffset
Horizontal offset of label.
Qgis::LabelPlacement placement
Label placement mode.
double angleOffset
Label rotation, in degrees clockwise.
double maxCurvedCharAngleOut
Maximum angle between outside curved label characters (valid range -20.0 to -95.0).
Qgis::RenderUnit offsetUnits
Units for offsets of label.
bool isExpression
true if this label is made from a expression string, e.g., FieldName || 'mm'
const QgsLabelLineSettings & lineSettings() const
Returns the label line settings, which contain settings related to how the label engine places and fo...
Qgis::UpsideDownLabelHandling upsidedownLabels
Controls whether upside down labels are displayed and how they are handled.
QString fieldName
Name of field (or an expression) to use for label text.
const QgsLabelPointSettings & pointSettings() const
Returns the label point settings, which contain settings related to how the label engine places and f...
Represents a 2D point.
Definition qgspointxy.h:62
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:53
Encapsulates properties and constraints relating to fetching elevation profiles from different source...
virtual QString translate(const QString &context, const QString &sourceText, const char *disambiguation=nullptr, int n=-1) const =0
Translates a string using the Qt QTranslator mechanism.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:114
QgsRelationManager * relationManager
Definition qgsproject.h:125
bool commitChanges(QStringList &commitErrors, bool stopEditing=true, QgsVectorLayer *vectorLayer=nullptr)
Attempts to commit to the underlying data provider any buffered changes made since the last to call t...
static QgsProject * instance()
Returns the QgsProject singleton instance.
bool rollBack(QStringList &rollbackErrors, bool stopEditing=true, QgsVectorLayer *vectorLayer=nullptr)
Stops a current editing operation on vectorLayer and discards any uncommitted edits.
bool startEditing(QgsVectorLayer *vectorLayer=nullptr)
Makes the layer editable.
QMap< QString, QgsMapLayer * > mapLayers(const bool validOnly=false) const
Returns a map of all registered layers by layer ID.
A grouped map of multiple QgsProperty objects, each referenced by an integer key value.
void setProperty(int key, const QgsProperty &property)
Adds a property to the collection and takes ownership of it.
Definition for a property.
Definition qgsproperty.h:47
@ Double
Double value (including negative values).
Definition qgsproperty.h:56
@ Boolean
Boolean value.
Definition qgsproperty.h:52
static QgsProperty fromField(const QString &fieldName, bool isActive=true)
Returns a new FieldBasedProperty created from the specified field name.
QString absoluteToRelativeUri(const QString &providerKey, const QString &uri, const QgsReadWriteContext &context) const
Converts absolute path(s) to relative path(s) in the given provider-specific URI.
static QgsProviderRegistry * instance(const QString &pluginPath=QString())
Means of accessing canonical single instance.
QString relativeToAbsoluteUri(const QString &providerKey, const QString &uri, const QgsReadWriteContext &context) const
Converts relative path(s) to absolute path(s) in the given provider-specific URI.
Allows entering a context category and takes care of leaving this category on deletion of the class.
A container for the context for various read/write operations on objects.
QgsReadWriteContextCategoryPopper enterCategory(const QString &category, const QString &details=QString()) const
Push a category to the stack.
const QgsProjectTranslator * projectTranslator() const
Returns the project translator.
QgsCoordinateTransformContext transformContext() const
Returns data provider coordinate transform context.
const QgsPathResolver & pathResolver() const
Returns path resolver for conversion between relative and absolute paths.
A rectangle specified with double values.
Q_INVOKABLE QString toString(int precision=16) const
Returns a string representation of form xmin,ymin : xmax,ymax Coordinates will be rounded to the spec...
double xMinimum
double yMinimum
double xMaximum
void set(const QgsPointXY &p1, const QgsPointXY &p2, bool normalize=true)
Sets the rectangle from two QgsPoints.
double yMaximum
void combineExtentWith(const QgsRectangle &rect)
Expands the rectangle so that it covers both the original rectangle and the given rectangle.
void normalize()
Normalize the rectangle so it has non-negative width/height.
void setNull()
Mark a rectangle as being null (holding no spatial information).
QList< QgsRelation > referencedRelations(const QgsVectorLayer *layer=nullptr) const
Gets all relations where this layer is the referenced part (i.e.
void relationsLoaded()
Emitted when the relations were loaded after reading a project.
Represents a relationship between two vector layers.
Definition qgsrelation.h:42
Contains information about the context of a rendering operation.
double rendererScale() const
Returns the renderer map scale.
bool useRenderingOptimization() const
Returns true if the rendering optimization (geometry simplification) can be executed.
void appendChild(QgsRuleBasedLabeling::Rule *rule)
add child rule, take ownership, sets this as parent
A boolean settings entry.
A double settings entry.
A template class for enum and flag settings entry.
static QgsSettingsTreeNode * sTreeQgis
Holds SLD export options and other information related to SLD export of a QGIS layer style.
void setExtraProperties(const QVariantMap &properties)
Sets the open ended set of properties that can drive/inform the SLD encoding.
QVariantMap extraProperties() const
Returns the open ended set of properties that can drive/inform the SLD encoding.
Manages stored expressions regarding creation, modification and storing in the project.
An interface for classes which can visit style entity (e.g.
static double rendererFrameRate(const QgsFeatureRenderer *renderer)
Calculates the frame rate (in frames per second) at which the given renderer must be redrawn.
static QgsStringMap getSvgParameterList(QDomElement &element)
static void mergeScaleDependencies(double mScaleMinDenom, double mScaleMaxDenom, QVariantMap &props)
Merges the local scale limits, if any, with the ones already in the map, if any.
static bool fillFromSld(QDomElement &element, Qt::BrushStyle &brushStyle, QColor &color)
static Qgis::RenderUnit decodeSldUom(const QString &str, double *scaleFactor=nullptr)
Decodes a SLD unit of measure string to a render unit.
long addTask(QgsTask *task, int priority=0)
Adds a task to the manager.
void taskCompleted()
Will be emitted by task to indicate its successful completion.
void taskTerminated()
Will be emitted by task if it has terminated for any reason other then completion (e....
void setColor(const QColor &color)
Sets the color for the buffer.
void setSizeUnit(Qgis::RenderUnit unit)
Sets the units used for the buffer size.
void setEnabled(bool enabled)
Sets whether the text buffer will be drawn.
void setSize(double size)
Sets the size of the buffer.
void setColor(const QColor &color)
Sets the color that text will be rendered in.
void setSize(double size)
Sets the size for rendered text.
void setFont(const QFont &font)
Sets the font used for rendering text.
void setSizeUnit(Qgis::RenderUnit unit)
Sets the units for the size of rendered text.
void setBuffer(const QgsTextBufferSettings &bufferSettings)
Sets the text's buffer settings.
static QString threadDescription(QThread *thread)
Returns a descriptive identifier for a thread.
Allows creation of a multi-layer database-side transaction.
void dirtied(const QString &sql, const QString &name)
Emitted if a sql query is executed and the underlying data is modified.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
Base class for vector data providers.
static const int EditingCapabilities
Bitmask of all provider's editing capabilities.
virtual QString geometryColumnName() const
Returns the name of the column storing geometry, if applicable.
void raiseError(const QString &msg) const
Signals an error in this provider.
virtual void handlePostCloneOperations(QgsVectorDataProvider *source)
Handles any post-clone operations required after this vector data provider was cloned from the source...
virtual QgsTransaction * transaction() const
Returns the transaction this data provider is included in, if any.
void committedAttributesDeleted(const QString &layerId, const QgsAttributeList &deletedAttributes)
Emitted after attribute deletion has been committed to the layer.
void committedAttributeValuesChanges(const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues)
Emitted after feature attribute value changes have been committed to the layer.
void geometryChanged(QgsFeatureId fid, const QgsGeometry &geom)
Emitted when a feature's geometry is changed.
void committedAttributesAdded(const QString &layerId, const QList< QgsField > &addedAttributes)
Emitted after attribute addition has been committed to the layer.
void committedFeaturesAdded(const QString &layerId, const QgsFeatureList &addedFeatures)
Emitted after feature addition has been committed to the layer.
void featureDeleted(QgsFeatureId fid)
Emitted when a feature was deleted from the buffer.
void attributeAdded(int idx)
Emitted when an attribute was added to the buffer.
void committedGeometriesChanges(const QString &layerId, const QgsGeometryMap &changedGeometries)
Emitted after feature geometry changes have been committed to the layer.
void attributeValueChanged(QgsFeatureId fid, int idx, const QVariant &value)
Emitted when a feature's attribute value has been changed.
void attributeDeleted(int idx)
Emitted when an attribute was deleted from the buffer.
void featureAdded(QgsFeatureId fid)
Emitted when a feature has been added to the buffer.
void layerModified()
Emitted when modifications has been done on layer.
void committedFeaturesRemoved(const QString &layerId, const QgsFeatureIds &deletedFeatureIds)
Emitted after feature removal has been committed to the layer.
Contains utility functions for editing vector layers.
int translateFeature(QgsFeatureId featureId, double dx, double dy)
Translates feature by dx, dy.
Qgis::VectorEditResult deleteVertices(QgsFeatureId featureId, const QSet< int > &vertices)
Deletes a set of vertices from a feature.
bool insertVertex(double x, double y, QgsFeatureId atFeatureId, int beforeVertex)
Insert a new vertex before the given vertex number, in the given ring, item (first number is index 0)...
Q_DECL_DEPRECATED Qgis::GeometryOperationResult addPart(const QVector< QgsPointXY > &ring, QgsFeatureId featureId)
Adds a new part polygon to a multipart feature.
int addTopologicalPoints(const QgsGeometry &geom)
Adds topological points for every vertex of the geometry.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult splitParts(const QVector< QgsPointXY > &splitLine, bool topologicalEditing=false)
Splits parts cut by the given line.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult splitFeatures(const QVector< QgsPointXY > &splitLine, bool topologicalEditing=false)
Splits features cut by the given line.
bool moveVertex(double x, double y, QgsFeatureId atFeatureId, int atVertex)
Moves the vertex at the given position number, ring and item (first number is index 0),...
Q_DECL_DEPRECATED Qgis::GeometryOperationResult addRing(const QVector< QgsPointXY > &ring, const QgsFeatureIds &targetFeatureIds=QgsFeatureIds(), QgsFeatureId *modifiedFeatureId=nullptr)
Adds a ring to polygon/multipolygon features.
Vector layer specific subclass of QgsMapLayerElevationProperties.
QgsVectorLayerElevationProperties * clone() const override
Creates a clone of the properties.
Counts the features in a QgsVectorLayer in task.
A feature iterator which iterates over features from a QgsVectorLayer.
Manages joined fields for a vector layer.
bool containsJoins() const
Quick way to test if there is any join at all.
void joinedFieldsChanged()
Emitted whenever the list of joined fields changes (e.g.
Defines left outer join from our vector layer to some other vector layer.
QString targetFieldName() const
Returns name of the field of our layer that will be used for join.
QString joinLayerId() const
ID of the joined layer - may be used to resolve reference to the joined layer.
Implementation of QgsAbstractProfileGenerator for vector layers.
Implementation of threaded rendering for vector layers.
Implementation of layer selection properties for vector layers.
QgsVectorLayerSelectionProperties * clone() const override
Creates a clone of the properties.
Basic implementation of the labeling interface.
Implementation of map layer temporal properties for vector layers.
Contains settings which reflect the context in which vector layer tool operations should be considere...
QgsExpressionContext * expressionContext() const
Returns the optional expression context used by the vector layer tools.
static QString guessFriendlyIdentifierField(const QgsFields &fields, bool *foundFriendly=nullptr)
Given a set of fields, attempts to pick the "most useful" field for user-friendly identification of f...
static QgsFeatureIds filterValidFeatureIds(const QgsVectorLayer *layer, const QgsFeatureIds &featureIds)
Filters a set of feature IDs to only include those that exist in the layer.
Represents a vector layer which manages a vector based dataset.
void setLabeling(QgsAbstractVectorLayerLabeling *labeling)
Sets labeling configuration.
Q_INVOKABLE QString attributeDisplayName(int index) const
Convenience function that returns the attribute alias if defined or the field name else.
bool writeSymbology(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const final
Write the style for the layer into the document provided.
QSet< QgsMapLayerDependency > dependencies() const final
Gets the list of dependencies.
int addExpressionField(const QString &exp, const QgsField &fld)
Add a new field which is calculated by the expression specified.
Q_INVOKABLE void selectByRect(const QgsRectangle &rect, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection)
Selects features found within the search rectangle (in layer's coordinates).
void committedFeaturesAdded(const QString &layerId, const QgsFeatureList &addedFeatures)
Emitted when features are added to the provider if not in transaction mode.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult addPart(const QList< QgsPointXY > &ring)
Adds a new part polygon to a multipart feature.
static const QgsSettingsEntryEnumFlag< Qgis::VectorRenderingSimplificationFlags > * settingsSimplifyDrawingHints
void featureBlendModeChanged(QPainter::CompositionMode blendMode)
Signal emitted when setFeatureBlendMode() is called.
bool labelsEnabled() const
Returns whether the layer contains labels which are enabled and should be drawn.
bool isModified() const override
Returns true if the provider has been modified since the last commit.
bool isEditable() const final
Returns true if the provider is in editing mode.
void addFeatureRendererGenerator(QgsFeatureRendererGenerator *generator)
Adds a new feature renderer generator to the layer.
Q_DECL_DEPRECATED void setExcludeAttributesWfs(const QSet< QString > &att)
A set of attributes that are not advertised in WFS requests with QGIS server.
Q_INVOKABLE bool deleteSelectedFeatures(int *deletedCount=nullptr, QgsVectorLayer::DeleteContext *context=nullptr)
Deletes the selected features.
Q_INVOKABLE void removeFieldAlias(int index)
Removes an alias (a display name) for attributes to display in dialogs.
void setAuxiliaryLayer(QgsAuxiliaryLayer *layer=nullptr)
Sets the current auxiliary layer.
Q_INVOKABLE QVariant minimumValue(int index) const final
Returns the minimum value for an attribute column or an invalid variant in case of error.
void beforeRemovingExpressionField(int idx)
Will be emitted, when an expression field is going to be deleted from this vector layer.
Q_INVOKABLE bool deleteFeatures(const QgsFeatureIds &fids, QgsVectorLayer::DeleteContext *context=nullptr)
Deletes a set of features from the layer (but does not commit it).
void committedGeometriesChanges(const QString &layerId, const QgsGeometryMap &changedGeometries)
Emitted when geometry changes are saved to the provider if not in transaction mode.
void beforeCommitChanges(bool stopEditing)
Emitted before changes are committed to the data provider.
Q_INVOKABLE bool startEditing()
Makes the layer editable.
void setFieldConfigurationFlags(int index, Qgis::FieldConfigurationFlags flags)
Sets the configuration flags of the field at given index.
Q_INVOKABLE QVariant maximumValue(int index) const final
Returns the maximum value for an attribute column or an invalid variant in case of error.
QMap< QgsFieldConstraints::Constraint, QgsFieldConstraints::ConstraintStrength > fieldConstraintsAndStrength(int fieldIndex) const
Returns a map of constraint with their strength for a specific field of the layer.
bool addJoin(const QgsVectorLayerJoinInfo &joinInfo)
Joins another vector layer to this layer.
QgsVectorLayer(const QString &path=QString(), const QString &baseName=QString(), const QString &providerLib="ogr", const QgsVectorLayer::LayerOptions &options=QgsVectorLayer::LayerOptions())
Constructor - creates a vector layer.
QgsMapLayerTemporalProperties * temporalProperties() override
Returns the layer's temporal properties.
QgsExpressionContext createExpressionContext() const final
This method needs to be reimplemented in all classes which implement this interface and return an exp...
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).
Q_DECL_DEPRECATED Qgis::GeometryOperationResult splitFeatures(const QVector< QgsPointXY > &splitLine, bool topologicalEditing=false)
Splits features cut by the given line.
QgsDefaultValue defaultValueDefinition(int index) const
Returns the definition of the expression used when calculating the default value for a field.
QgsVectorLayerFeatureCounter * countSymbolFeatures(bool storeSymbolFids=false)
Count features for symbols.
Q_INVOKABLE QString attributeCustomComment(int index) const
Returns the custom comment for the field.
QPainter::CompositionMode featureBlendMode() const
Returns the current blending mode for features.
QString constraintExpression(int index) const
Returns the constraint expression for for a specified field index, if set.
Q_INVOKABLE bool addAttribute(const QgsField &field)
Add an attribute field (but does not commit it) returns true if the field was added.
void attributeAdded(int idx)
Will be emitted, when a new attribute has been added to this vector layer.
QString capabilitiesString() const
Capabilities for this layer, comma separated and translated.
void deselect(QgsFeatureId featureId)
Deselects feature by its ID.
void allowCommitChanged()
Emitted whenever the allowCommit() property of this layer changes.
friend class QgsVectorLayerEditBuffer
void editCommandStarted(const QString &text)
Signal emitted when a new edit command has been started.
void updateFields()
Will regenerate the fields property of this layer by obtaining all fields from the dataProvider,...
QgsBox3D extent3D() const final
Returns the 3D extent of the layer.
const QgsDiagramLayerSettings * diagramLayerSettings() const
void setFieldConstraint(int index, QgsFieldConstraints::Constraint constraint, QgsFieldConstraints::ConstraintStrength strength=QgsFieldConstraints::ConstraintStrengthHard)
Sets a constraint for a specified field index.
Q_INVOKABLE void invertSelectionInRectangle(const QgsRectangle &rect)
Inverts selection of features found within the search rectangle (in layer's coordinates).
bool loadAuxiliaryLayer(const QgsAuxiliaryStorage &storage, const QString &key=QString())
Loads the auxiliary layer for this vector layer.
bool insertVertex(double x, double y, QgsFeatureId atFeatureId, int beforeVertex)
Inserts a new vertex before the given vertex number, in the given ring, item (first number is index 0...
QgsAbstractProfileGenerator * createProfileGenerator(const QgsProfileRequest &request) override
Given a profile request, returns a new profile generator ready for generating elevation profiles.
bool readSymbology(const QDomNode &layerNode, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) final
Read the symbology for the current layer from the DOM node supplied.
Q_INVOKABLE QgsRectangle boundingBoxOfSelected() const
Returns the bounding box of the selected features. If there is no selection, QgsRectangle(0,...
bool isSpatial() const final
Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeome...
Q_INVOKABLE QgsFeatureList selectedFeatures() const
Returns a copy of the user-selected features.
QString expressionField(int index) const
Returns the expression used for a given expression field.
void removeFeatureRendererGenerator(const QString &id)
Removes the feature renderer with matching id from the layer.
Q_INVOKABLE bool deleteFeature(QgsFeatureId fid, QgsVectorLayer::DeleteContext *context=nullptr)
Deletes a feature from the layer (but does not commit it).
friend class QgsVectorLayerEditPassthrough
void setSimplifyMethod(const QgsVectorSimplifyMethod &simplifyMethod)
Sets the simplification settings for fast rendering of features.
void editCommandDestroyed()
Signal emitted, when an edit command is destroyed.
QVariant aggregate(Qgis::Aggregate aggregate, const QString &fieldOrExpression, const QgsAggregateCalculator::AggregateParameters &parameters=QgsAggregateCalculator::AggregateParameters(), QgsExpressionContext *context=nullptr, bool *ok=nullptr, QgsFeatureIds *fids=nullptr, QgsFeedback *feedback=nullptr, QString *error=nullptr) const
Calculates an aggregated value from the layer's features.
QgsRectangle sourceExtent() const final
Returns the extent of all geometries from the source.
QgsFieldConstraints::Constraints fieldConstraints(int fieldIndex) const
Returns any constraints which are present for a specified field index.
static const QgsSettingsEntryEnumFlag< Qgis::VectorSimplificationAlgorithm > * settingsSimplifyAlgorithm
Q_DECL_DEPRECATED QSet< QString > excludeAttributesWms() const
A set of attributes that are not advertised in WMS requests with QGIS server.
QgsFeatureIds symbolFeatureIds(const QString &legendKey) const
Ids of features rendered with specified legend key.
void removeFieldConstraint(int index, QgsFieldConstraints::Constraint constraint)
Removes a constraint for a specified field index.
int selectedFeatureCount() const
Returns the number of features that are selected in this layer.
void featuresDeleted(const QgsFeatureIds &fids)
Emitted when features have been deleted.
Qgis::VectorLayerTypeFlags vectorLayerTypeFlags() const
Returns the vector layer type flags.
void setLabelsEnabled(bool enabled)
Sets whether labels should be enabled for the layer.
void subsetStringChanged()
Emitted when the layer's subset string has changed.
bool setDependencies(const QSet< QgsMapLayerDependency > &layers) final
Sets the list of dependencies.
QgsAuxiliaryLayer * auxiliaryLayer()
Returns the current auxiliary layer.
void setCoordinateSystem()
Setup the coordinate system transformation for the layer.
void committedFeaturesRemoved(const QString &layerId, const QgsFeatureIds &deletedFeatureIds)
Emitted when features are deleted from the provider if not in transaction mode.
void setFieldMergePolicy(int index, Qgis::FieldDomainMergePolicy policy)
Sets a merge policy for the field with the specified index.
void updateExpressionField(int index, const QString &exp)
Changes the expression used to define an expression based (virtual) field.
Q_INVOKABLE void selectByExpression(const QString &expression, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection, QgsExpressionContext *context=nullptr)
Selects matching features using an expression.
static const QgsSettingsEntryDouble * settingsSimplifyMaxScale
void reload() final
Synchronises with changes in the datasource.
long long featureCount() const final
Returns feature count including changes which have not yet been committed If you need only the count ...
~QgsVectorLayer() override
QgsRectangle extent() const final
Returns the extent of the layer.
void endEditCommand()
Finish edit command and add it to undo/redo stack.
void destroyEditCommand()
Destroy active command and reverts all changes in it.
bool isAuxiliaryField(int index, int &srcIndex) const
Returns true if the field comes from the auxiliary layer, false otherwise.
bool hasMapTips() const final
Returns true if the layer contains map tips.
Q_INVOKABLE Qgis::WkbType wkbType() const final
Returns the WKBType or WKBUnknown in case of error.
void setExtent(const QgsRectangle &rect) final
Sets the extent.
QList< QgsRelation > referencingRelations(int idx) const
Returns the layer's relations, where the foreign key is on this layer.
Q_DECL_DEPRECATED QSet< QString > excludeAttributesWfs() const
A set of attributes that are not advertised in WFS requests with QGIS server.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult splitParts(const QVector< QgsPointXY > &splitLine, bool topologicalEditing=false)
Splits parts cut by the given line.
void setDefaultValueDefinition(int index, const QgsDefaultValue &definition)
Sets the definition of the expression to use when calculating the default value for a field.
bool diagramsEnabled() const
Returns whether the layer contains diagrams which are enabled and should be drawn.
void setAllowCommit(bool allowCommit)
Controls, if the layer is allowed to commit changes.
QgsBox3D sourceExtent3D() const final
Returns the 3D extent of all geometries from the source.
void symbolFeatureCountMapChanged()
Emitted when the feature count for symbols on this layer has been recalculated.
Q_INVOKABLE const QgsFeatureIds & selectedFeatureIds() const
Returns a list of the selected features IDs in this layer.
Qgis::VectorEditResult deleteVertex(QgsFeatureId featureId, int vertex)
Deletes a vertex from a feature.
Qgis::FeatureAvailability hasFeatures() const final
Determines if this vector layer has features.
void setFeatureBlendMode(QPainter::CompositionMode blendMode)
Sets the blending mode used for rendering each feature.
QString constraintDescription(int index) const
Returns the descriptive name for the constraint expression for a specified field index.
void writeCustomSymbology(QDomElement &element, QDomDocument &doc, QString &errorMessage) const
Signal emitted whenever the symbology (QML-file) for this layer is being written.
const QgsAbstractVectorLayerLabeling * labeling() const
Access to const labeling configuration.
bool writeStyle(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const final
Write just the symbology information for the layer into the document.
void setProviderEncoding(const QString &encoding)
Sets the text encoding of the data provider.
Q_DECL_DEPRECATED bool writeSld(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QVariantMap &props=QVariantMap()) const
Writes the symbology of the layer into the document provided in SLD 1.1 format.
void setDisplayExpression(const QString &displayExpression)
Set the preview expression, used to create a human readable preview string.
virtual Q_INVOKABLE bool deleteAttribute(int attr)
Deletes an attribute field (but does not commit it).
static const QgsSettingsEntryBool * settingsSimplifyLocal
QString loadDefaultStyle(bool &resultFlag) final
Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record...
bool simplifyDrawingCanbeApplied(const QgsRenderContext &renderContext, Qgis::VectorRenderingSimplificationFlag simplifyHint) const
Returns whether the VectorLayer can apply the specified simplification hint.
QString htmlMetadata() const final
Obtain a formatted HTML string containing assorted metadata for this layer.
QgsMapLayerElevationProperties * elevationProperties() override
Returns the layer's elevation properties.
bool removeJoin(const QString &joinLayerId)
Removes a vector layer join.
void setRenderer(QgsFeatureRenderer *r)
Sets the feature renderer which will be invoked to represent this layer in 2D map views.
Q_INVOKABLE void selectAll()
Select all the features.
QStringList commitErrors() const
Returns a list containing any error messages generated when attempting to commit changes to the layer...
QString decodedSource(const QString &source, const QString &provider, const QgsReadWriteContext &context) const final
Called by readLayerXML(), used by derived classes to decode provider's specific data source from proj...
QString storageType() const
Returns the permanent storage type for this layer as a friendly name.
QString encodedSource(const QString &source, const QgsReadWriteContext &context) const final
Called by writeLayerXML(), used by derived classes to encode provider's specific data source to proje...
bool readExtentFromXml() const
Returns true if the extent is read from the XML document when data source has no metadata,...
QString dataComment() const
Returns a description for this layer as defined in the data provider.
bool accept(QgsStyleEntityVisitorInterface *visitor) const override
QgsExpressionContextScope * createExpressionContextScope() const final
This method needs to be reimplemented in all classes which implement this interface and return an exp...
QgsGeometryOptions * geometryOptions() const
Configuration and logic to apply automatically on any edit happening on this layer.
QgsStringMap attributeAliases() const
Returns a map of field name to attribute alias.
Q_INVOKABLE int translateFeature(QgsFeatureId featureId, double dx, double dy)
Translates feature by dx, dy.
virtual void updateExtents(bool force=false)
Update the extents for the layer.
void attributeDeleted(int idx)
Will be emitted, when an attribute has been deleted from this vector layer.
QgsFeatureRenderer * renderer()
Returns the feature renderer used for rendering the features in the layer in 2D map views.
void beforeEditingStarted()
Emitted before editing on this layer is started.
void committedAttributeValuesChanges(const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues)
Emitted when attribute value changes are saved to the provider if not in transaction mode.
QgsStringMap attributeCustomComments() const
Returns a map of all the custom comments.
void committedAttributesAdded(const QString &layerId, const QList< QgsField > &addedAttributes)
Emitted when attributes are added to the provider if not in transaction mode.
void setEditFormConfig(const QgsEditFormConfig &editFormConfig)
Sets the editFormConfig (configuration) of the form used to represent this vector layer.
Qgis::FieldConfigurationFlags fieldConfigurationFlags(int index) const
Returns the configuration flags of the field at given index.
void committedAttributesDeleted(const QString &layerId, const QgsAttributeList &deletedAttributes)
Emitted when attributes are deleted from the provider if not in transaction mode.
QString displayExpression
void displayExpressionChanged()
Emitted when the display expression changes.
QgsFeatureIterator getSelectedFeatures(QgsFeatureRequest request=QgsFeatureRequest()) const
Returns an iterator of the selected features.
void setEditorWidgetSetup(int index, const QgsEditorWidgetSetup &setup)
Sets the editor widget setup for the field at the specified index.
void setConstraintExpression(int index, const QString &expression, const QString &description=QString())
Sets the constraint expression for the specified field index.
Q_INVOKABLE bool rollBack(bool deleteBuffer=true)
Stops a current editing operation and discards any uncommitted edits.
QString sourceName() const final
Returns a friendly display name for the source.
Qgis::VectorEditResult deleteVertices(QgsFeatureId featureId, const QSet< int > &vertices)
Deletes a set of vertices from a feature.
bool readStyle(const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) final
Read the style for the current layer from the DOM node supplied.
bool updateFeature(QgsFeature &feature, bool skipDefaultValues=false)
Updates an existing feature in the layer, replacing the attributes and geometry for the feature with ...
Q_INVOKABLE bool commitChanges(bool stopEditing=true)
Attempts to commit to the underlying data provider any buffered changes made since the last to call t...
void setFieldConfigurationFlag(int index, Qgis::FieldConfigurationFlag flag, bool active)
Sets the given configuration flag for the field at given index to be active or not.
void setFieldDuplicatePolicy(int index, Qgis::FieldDuplicatePolicy policy)
Sets a duplicate policy for the field with the specified index.
bool setReadOnly(bool readonly=true)
Makes layer read-only (editing disabled) or not.
void editFormConfigChanged()
Will be emitted whenever the edit form configuration of this layer changes.
Q_INVOKABLE void modifySelection(const QgsFeatureIds &selectIds, const QgsFeatureIds &deselectIds)
Modifies the current selection on this layer.
void setWeakRelations(const QList< QgsWeakRelation > &relations)
Sets the layer's weak relations.
void resolveReferences(QgsProject *project) final
Resolves references to other layers (kept as layer IDs after reading XML) into layer objects.
void reselect()
Reselects the previous set of selected features.
void select(QgsFeatureId featureId)
Selects feature by its ID.
QgsEditorWidgetSetup editorWidgetSetup(int index) const
Returns the editor widget setup for the field at the specified index.
bool readSld(const QDomNode &node, QString &errorMessage) final
QgsMapLayerRenderer * createMapRenderer(QgsRenderContext &rendererContext) final
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.
Q_INVOKABLE void setFieldCustomComment(int index, const QString &customCommentString)
Sets the custom comment for the field.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const final
Queries the layer for features specified in request.
void setReadExtentFromXml(bool readExtentFromXml)
Flag allowing to indicate if the extent has to be read from the XML document when data source has no ...
void afterCommitChanges()
Emitted after changes are committed to the data provider.
QgsVectorLayer * clone() const override
Returns a new instance equivalent to this one.
QgsAttributeTableConfig attributeTableConfig() const
Returns the attribute table configuration object.
QgsActionManager * actions()
Returns all layer actions defined on this layer.
QStringList uniqueStringsMatching(int index, const QString &substring, int limit=-1, QgsFeedback *feedback=nullptr) const
Returns unique string values of an attribute which contain a specified subset string.
void raiseError(const QString &msg)
Signals an error related to this vector layer.
void editCommandEnded()
Signal emitted, when an edit command successfully ended.
void supportsEditingChanged()
Emitted when the read only state or the data provider of this layer is changed.
QgsCoordinateReferenceSystem sourceCrs() const final
Returns the coordinate reference system for features in the source.
void readOnlyChanged()
Emitted when the read only state of this layer is changed.
void removeExpressionField(int index)
Removes an expression field.
void setTransformContext(const QgsCoordinateTransformContext &transformContext) override
Sets the coordinate transform context to transformContext.
void attributeValueChanged(QgsFeatureId fid, int idx, const QVariant &value)
Emitted whenever an attribute value change is done in the edit buffer.
static Q_DECL_DEPRECATED void drawVertexMarker(double x, double y, QPainter &p, Qgis::VertexMarkerType type, int vertexSize)
Draws a vertex symbol at (screen) coordinates x, y.
Q_INVOKABLE void selectByIds(const QgsFeatureIds &ids, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection, bool validateIds=false)
Selects matching features using a list of feature IDs.
Q_INVOKABLE void setFieldAlias(int index, const QString &aliasString)
Sets an alias (a display name) for attributes to display in dialogs.
friend class QgsVectorLayerFeatureSource
void minimumAndMaximumValue(int index, QVariant &minimum, QVariant &maximum) const
Calculates both the minimum and maximum value for an attribute column.
Q_INVOKABLE Qgis::GeometryType geometryType() const
Returns point, line or polygon.
Q_DECL_DEPRECATED void setExcludeAttributesWms(const QSet< QString > &att)
A set of attributes that are not advertised in WMS requests with QGIS server.
void setAttributeTableConfig(const QgsAttributeTableConfig &attributeTableConfig)
Sets the attribute table configuration object.
virtual bool setSubsetString(const QString &subset)
Sets the string (typically sql) used to define a subset of the layer.
void afterRollBack()
Emitted after changes are rolled back.
bool writeXml(QDomNode &layer_node, QDomDocument &doc, const QgsReadWriteContext &context) const final
Writes vector layer specific state to project file Dom node.
void setDiagramLayerSettings(const QgsDiagramLayerSettings &s)
bool readXml(const QDomNode &layer_node, QgsReadWriteContext &context) final
Reads vector layer specific state from project file Dom node.
QList< QgsWeakRelation > weakRelations() const
Returns the layer's weak relations as specified in the layer's style.
const QgsVectorSimplifyMethod & simplifyMethod() const
Returns the simplification settings for fast rendering of features.
void selectionChanged(const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect)
Emitted when selection was changed.
void beforeAddingExpressionField(const QString &fieldName)
Will be emitted, when an expression field is going to be added to this vector layer.
Q_INVOKABLE bool deleteAttributes(const QList< int > &attrs)
Deletes a list of attribute fields (but does not commit it).
void updatedFields()
Emitted whenever the fields available from this layer have been changed.
QVariant defaultValue(int index, const QgsFeature &feature=QgsFeature(), QgsExpressionContext *context=nullptr) const
Returns the calculated default value for the specified field index.
void featureAdded(QgsFeatureId fid)
Emitted when a new feature has been added to the layer.
Q_INVOKABLE QString attributeAlias(int index) const
Returns the alias of an attribute name or a null string if there is no alias.
void featureDeleted(QgsFeatureId fid)
Emitted when a feature has been deleted.
Q_INVOKABLE void removeSelection()
Clear selection.
bool allowCommit() const
Controls, if the layer is allowed to commit changes.
QgsConditionalLayerStyles * conditionalStyles() const
Returns the conditional styles that are set for this layer.
void readCustomSymbology(const QDomElement &element, QString &errorMessage)
Signal emitted whenever the symbology (QML-file) for this layer is being read.
void setExtent3D(const QgsBox3D &rect) final
Sets the extent.
const QList< QgsVectorLayerJoinInfo > vectorJoins() const
Q_INVOKABLE bool renameAttribute(int index, const QString &newName)
Renames an attribute field (but does not commit it).
bool isSqlQuery() const
Returns true if the layer is a query (SQL) layer.
void beforeRollBack()
Emitted before changes are rolled back.
QgsAttributeList primaryKeyAttributes() const
Returns the list of attributes which make up the layer's primary keys.
void beginEditCommand(const QString &text)
Create edit command for undo/redo operations.
QString displayField() const
This is a shorthand for accessing the displayExpression if it is a simple field.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult addRing(const QVector< QgsPointXY > &ring, QgsFeatureId *featureId=nullptr)
Adds a ring to polygon/multipolygon features.
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) final
Adds a list of features to the sink.
void setDiagramRenderer(QgsDiagramRenderer *r)
Sets diagram rendering object (takes ownership).
void geometryChanged(QgsFeatureId fid, const QgsGeometry &geometry)
Emitted whenever a geometry change is done in the edit buffer.
QgsEditFormConfig editFormConfig
QList< const QgsFeatureRendererGenerator * > featureRendererGenerators() const
Returns a list of the feature renderer generators owned by the layer.
Q_INVOKABLE QSet< QVariant > uniqueValues(int fieldIndex, int limit=-1) const final
Calculates a list of unique values contained within an attribute in the layer.
Q_INVOKABLE void removeFieldCustomComment(int index)
Removes the custom comment for the field.
bool moveVertex(double x, double y, QgsFeatureId atFeatureId, int atVertex)
Moves the vertex at the given position number, ring and item (first number is index 0),...
QgsGeometry getGeometry(QgsFeatureId fid) const
Queries the layer for the geometry at the given id.
int addTopologicalPoints(const QgsGeometry &geom)
Adds topological points for every vertex of the geometry.
bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) final
Adds a single feature to the sink.
void beforeModifiedCheck() const
Emitted when the layer is checked for modifications. Use for last-minute additions.
Q_INVOKABLE QgsFeature getFeature(QgsFeatureId fid) const
Queries the layer for the feature with the given id.
Q_INVOKABLE void invertSelection()
Selects not selected features and deselects selected ones.
const QgsDiagramRenderer * diagramRenderer() const
Q_INVOKABLE bool changeAttributeValues(QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues=QgsAttributeMap(), bool skipDefaultValues=false, QgsVectorLayerToolsContext *context=nullptr)
Changes attributes' values for a feature (but does not immediately commit the changes).
QgsMapLayerSelectionProperties * selectionProperties() override
Returns the layer's selection properties.
QgsVectorDataProvider * dataProvider() final
Returns the layer's data provider, it may be nullptr.
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...
static const QgsSettingsEntryDouble * settingsSimplifyDrawingTol
Qgis::SpatialIndexPresence hasSpatialIndex() const override
void setFieldSplitPolicy(int index, Qgis::FieldDomainSplitPolicy policy)
Sets a split policy for the field with the specified index.
@ Referencing
The layer is referencing (or the "child" / "right" layer in the relationship).
@ Referenced
The layer is referenced (or the "parent" / "left" left in the relationship).
static void writeXml(const QgsVectorLayer *layer, WeakRelationType type, const QgsRelation &relation, QDomNode &node, QDomDocument &doc)
Writes a weak relation infoto an XML structure.
static QgsWeakRelation readXml(const QgsVectorLayer *layer, WeakRelationType type, const QDomNode &node, const QgsPathResolver resolver)
Returns a weak relation for the given layer.
static Qgis::GeometryType geometryType(Qgis::WkbType type)
Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a Polyg...
static Q_INVOKABLE QString displayString(Qgis::WkbType type)
Returns a non-translated display string type for a WKB type, e.g., the geometry name used in WKT geom...
static Q_INVOKABLE QString geometryDisplayString(Qgis::GeometryType type)
Returns a display string for a geometry type.
static QDomElement writeVariant(const QVariant &value, QDomDocument &doc)
Write a QVariant to a QDomElement.
static QgsBox3D readBox3D(const QDomElement &element)
Decodes a DOM element to a 3D box.
static QVariant readVariant(const QDomElement &element)
Read a QVariant from a QDomElement.
static QgsRectangle readRectangle(const QDomElement &element)
@ UnknownCount
Provider returned an unknown feature count.
Definition qgis.h:588
double ANALYSIS_EXPORT angle(QgsPoint *p1, QgsPoint *p2, QgsPoint *p3, QgsPoint *p4)
Calculates the angle between two segments (in 2 dimension, z-values are ignored).
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
bool qgsVariantEqual(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether they are equal, two NULL values are always treated a...
Definition qgis.cpp:657
bool qgsVariantLessThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is less than the second.
Definition qgis.cpp:596
bool qgsVariantGreaterThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is greater than the second.
Definition qgis.cpp:601
T qgsEnumKeyToValue(const QString &key, const T &defaultValue, bool tryValueAsKey=true, bool *returnOk=nullptr)
Returns the value corresponding to the given key of an enum.
Definition qgis.h:7717
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
Definition qgis.h:7698
QString qgsFlagValueToKeys(const T &value, bool *returnOk=nullptr)
Returns the value for the given keys of a flag.
Definition qgis.h:7756
T qgsFlagKeysToValue(const QString &keys, const T &defaultValue, bool tryValueAsKey=true, bool *returnOk=nullptr)
Returns the value corresponding to the given keys of a flag.
Definition qgis.h:7785
QMap< QString, QString > QgsStringMap
Definition qgis.h:8031
QVector< QgsPoint > QgsPointSequence
QMap< int, QVariant > QgsAttributeMap
QList< QgsFeature > QgsFeatureList
QSet< QgsFeatureId > QgsFeatureIds
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:80
#define QgsDebugError(str)
Definition qgslogger.h:71
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
#define RENDERER_TAG_NAME
Definition qgsrenderer.h:57
#define QGIS_PROTECT_QOBJECT_THREAD_ACCESS_NON_FATAL
#define QGIS_PROTECT_QOBJECT_THREAD_ACCESS
bool saveStyle_t(const QString &uri, const QString &qmlStyle, const QString &sldStyle, const QString &styleName, const QString &styleDescription, const QString &uiFileContent, bool useAsDefault, QString &errCause)
int listStyles_t(const QString &uri, QStringList &ids, QStringList &names, QStringList &descriptions, QString &errCause)
QString getStyleById_t(const QString &uri, QString styleID, QString &errCause)
bool deleteStyleById_t(const QString &uri, QString styleID, QString &errCause)
QString loadStyle_t(const QString &uri, QString &errCause)
QList< int > QgsAttributeList
QMap< QgsFeatureId, QgsFeature > QgsFeatureMap
A bundle of parameters controlling aggregate calculation.
Setting options for creating vector data providers.
Context for cascade delete features.
QList< QgsVectorLayer * > handledLayers(bool includeAuxiliaryLayers=true) const
Returns a list of all layers affected by the delete operation.
QMap< QgsVectorLayer *, QgsFeatureIds > mHandledFeatures
QgsFeatureIds handledFeatures(QgsVectorLayer *layer) const
Returns a list of feature IDs from the specified layer affected by the delete operation.
Setting options for loading vector layers.
bool skipCrsValidation
Controls whether the layer is allowed to have an invalid/unknown CRS.
bool forceReadOnly
Controls whether the layer is forced to be load as Read Only.
bool loadDefaultStyle
Set to true if the default layer style should be loaded.
QgsCoordinateTransformContext transformContext
Coordinate transform context.
QgsCoordinateReferenceSystem fallbackCrs
Fallback layer coordinate reference system.
Qgis::WkbType fallbackWkbType
Fallback geometry type.
bool loadAllStoredStyles
Controls whether the stored styles will be all loaded.