QGIS API Documentation 3.43.0-Master (3ee7834ace6)
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 "qgis.h" //for globals
25#include "qgssettings.h"
26#include "qgsvectorlayer.h"
27#include "moc_qgsvectorlayer.cpp"
28#include "qgsactionmanager.h"
29#include "qgsapplication.h"
30#include "qgsconditionalstyle.h"
32#include "qgscurve.h"
33#include "qgsdatasourceuri.h"
36#include "qgsfeature.h"
37#include "qgsfeaturerequest.h"
38#include "qgsfields.h"
39#include "qgsmaplayerfactory.h"
41#include "qgsgeometry.h"
43#include "qgslogger.h"
44#include "qgsmaplayerlegend.h"
45#include "qgsmessagelog.h"
46#include "qgsogcutils.h"
47#include "qgspainting.h"
48#include "qgspointxy.h"
49#include "qgsproject.h"
50#include "qgsproviderregistry.h"
51#include "qgsrectangle.h"
52#include "qgsrelationmanager.h"
53#include "qgsweakrelation.h"
54#include "qgsrendercontext.h"
67#include "qgspoint.h"
68#include "qgsrenderer.h"
69#include "qgssymbollayer.h"
70#include "qgsdiagramrenderer.h"
71#include "qgspallabeling.h"
75#include "qgsfeedback.h"
76#include "qgsxmlutils.h"
77#include "qgstaskmanager.h"
78#include "qgstransaction.h"
79#include "qgsauxiliarystorage.h"
80#include "qgsgeometryoptions.h"
82#include "qgsruntimeprofiler.h"
84#include "qgsvectorlayerutils.h"
86#include "qgsprofilerequest.h"
87#include "qgssymbollayerutils.h"
88#include "qgsthreadingutils.h"
89
90#include <QDir>
91#include <QFile>
92#include <QImage>
93#include <QPainter>
94#include <QPainterPath>
95#include <QPolygonF>
96#include <QProgressDialog>
97#include <QString>
98#include <QDomNode>
99#include <QVector>
100#include <QStringBuilder>
101#include <QUrl>
102#include <QUndoCommand>
103#include <QUrlQuery>
104#include <QUuid>
105#include <QRegularExpression>
106#include <QTimer>
107
108#include <limits>
109#include <optional>
110
112#include "qgssettingsentryimpl.h"
113#include "qgssettingstree.h"
114
120
121
122#ifdef TESTPROVIDERLIB
123#include <dlfcn.h>
124#endif
125
126typedef bool saveStyle_t(
127 const QString &uri,
128 const QString &qmlStyle,
129 const QString &sldStyle,
130 const QString &styleName,
131 const QString &styleDescription,
132 const QString &uiFileContent,
133 bool useAsDefault,
134 QString &errCause
135);
136
137typedef QString loadStyle_t(
138 const QString &uri,
139 QString &errCause
140);
141
142typedef int listStyles_t(
143 const QString &uri,
144 QStringList &ids,
145 QStringList &names,
146 QStringList &descriptions,
147 QString &errCause
148);
149
150typedef QString getStyleById_t(
151 const QString &uri,
152 QString styleID,
153 QString &errCause
154);
155
156typedef bool deleteStyleById_t(
157 const QString &uri,
158 QString styleID,
159 QString &errCause
160);
161
162
163QgsVectorLayer::QgsVectorLayer( const QString &vectorLayerPath,
164 const QString &baseName,
165 const QString &providerKey,
166 const QgsVectorLayer::LayerOptions &options )
167 : QgsMapLayer( Qgis::LayerType::Vector, baseName, vectorLayerPath )
168 , mSelectionProperties( new QgsVectorLayerSelectionProperties( this ) )
169 , mTemporalProperties( new QgsVectorLayerTemporalProperties( this ) )
170 , mElevationProperties( new QgsVectorLayerElevationProperties( this ) )
171 , mAuxiliaryLayer( nullptr )
172 , mAuxiliaryLayerKey( QString() )
173 , mReadExtentFromXml( options.readExtentFromXml )
174 , mRefreshRendererTimer( new QTimer( this ) )
175{
177 mLoadAllStoredStyle = options.loadAllStoredStyles;
178
179 if ( options.fallbackCrs.isValid() )
180 setCrs( options.fallbackCrs, false );
181 mWkbType = options.fallbackWkbType;
182
183 setProviderType( providerKey );
184
185 mGeometryOptions = std::make_unique<QgsGeometryOptions>();
186 mActions = new QgsActionManager( this );
187 mConditionalStyles = new QgsConditionalLayerStyles( this );
188 mStoredExpressionManager = new QgsStoredExpressionManager();
189 mStoredExpressionManager->setParent( this );
190
191 mJoinBuffer = new QgsVectorLayerJoinBuffer( this );
192 mJoinBuffer->setParent( this );
193 connect( mJoinBuffer, &QgsVectorLayerJoinBuffer::joinedFieldsChanged, this, &QgsVectorLayer::onJoinedFieldsChanged );
194
195 mExpressionFieldBuffer = new QgsExpressionFieldBuffer();
196 // if we're given a provider type, try to create and bind one to this layer
197 if ( !vectorLayerPath.isEmpty() && !mProviderKey.isEmpty() )
198 {
199 QgsDataProvider::ProviderOptions providerOptions { options.transformContext };
200 Qgis::DataProviderReadFlags providerFlags;
201 if ( options.loadDefaultStyle )
202 {
204 }
205 if ( options.forceReadOnly )
206 {
208 mDataSourceReadOnly = true;
209 }
210 setDataSource( vectorLayerPath, baseName, providerKey, providerOptions, providerFlags );
211 }
212
213 for ( const QgsField &field : std::as_const( mFields ) )
214 {
215 if ( !mAttributeAliasMap.contains( field.name() ) )
216 mAttributeAliasMap.insert( field.name(), QString() );
217 }
218
219 if ( isValid() )
220 {
221 mTemporalProperties->setDefaultsFromDataProviderTemporalCapabilities( mDataProvider->temporalCapabilities() );
222 if ( !mTemporalProperties->isActive() )
223 {
224 // didn't populate temporal properties from provider metadata, so at least try to setup some initially nice
225 // selections
226 mTemporalProperties->guessDefaultsFromFields( mFields );
227 }
228
229 mElevationProperties->setDefaultsFromLayer( this );
230 }
231
232 connect( this, &QgsVectorLayer::selectionChanged, this, [this] { triggerRepaint(); } );
233 connect( QgsProject::instance()->relationManager(), &QgsRelationManager::relationsLoaded, this, &QgsVectorLayer::onRelationsLoaded ); // skip-keyword-check
234
238
239 // Default simplify drawing settings
240 QgsSettings settings;
241 mSimplifyMethod.setSimplifyHints( QgsVectorLayer::settingsSimplifyDrawingHints->valueWithDefaultOverride( mSimplifyMethod.simplifyHints() ) );
242 mSimplifyMethod.setSimplifyAlgorithm( QgsVectorLayer::settingsSimplifyAlgorithm->valueWithDefaultOverride( mSimplifyMethod.simplifyAlgorithm() ) );
243 mSimplifyMethod.setThreshold( QgsVectorLayer::settingsSimplifyDrawingTol->valueWithDefaultOverride( mSimplifyMethod.threshold() ) );
244 mSimplifyMethod.setForceLocalOptimization( QgsVectorLayer::settingsSimplifyLocal->valueWithDefaultOverride( mSimplifyMethod.forceLocalOptimization() ) );
245 mSimplifyMethod.setMaximumScale( QgsVectorLayer::settingsSimplifyMaxScale->valueWithDefaultOverride( mSimplifyMethod.maximumScale() ) );
246
247 connect( mRefreshRendererTimer, &QTimer::timeout, this, [this] { triggerRepaint( true ); } );
248}
249
251{
252 emit willBeDeleted();
253
254 setValid( false );
255
256 delete mDataProvider;
257 delete mEditBuffer;
258 delete mJoinBuffer;
259 delete mExpressionFieldBuffer;
260 delete mLabeling;
261 delete mDiagramLayerSettings;
262 delete mDiagramRenderer;
263
264 delete mActions;
265
266 delete mRenderer;
267 delete mConditionalStyles;
268 delete mStoredExpressionManager;
269
270 if ( mFeatureCounter )
271 mFeatureCounter->cancel();
272
273 qDeleteAll( mRendererGenerators );
274}
275
277{
279
281 // We get the data source string from the provider when
282 // possible because some providers may have changed it
283 // directly (memory provider does that).
284 QString dataSource;
285 if ( mDataProvider )
286 {
287 dataSource = mDataProvider->dataSourceUri();
288 options.transformContext = mDataProvider->transformContext();
289 }
290 else
291 {
292 dataSource = source();
293 }
294 options.forceReadOnly = mDataSourceReadOnly;
295 QgsVectorLayer *layer = new QgsVectorLayer( dataSource, name(), mProviderKey, options );
296 if ( mDataProvider && layer->dataProvider() )
297 {
298 layer->dataProvider()->handlePostCloneOperations( mDataProvider );
299 }
300 QgsMapLayer::clone( layer );
301 layer->mXmlExtent2D = mXmlExtent2D;
302 layer->mLazyExtent2D = mLazyExtent2D;
303 layer->mValidExtent2D = mValidExtent2D;
304 layer->mXmlExtent3D = mXmlExtent3D;
305 layer->mLazyExtent3D = mLazyExtent3D;
306 layer->mValidExtent3D = mValidExtent3D;
307
308 QList<QgsVectorLayerJoinInfo> joins = vectorJoins();
309 const auto constJoins = joins;
310 for ( const QgsVectorLayerJoinInfo &join : constJoins )
311 {
312 // do not copy join information for auxiliary layer
313 if ( !auxiliaryLayer()
314 || ( auxiliaryLayer() && auxiliaryLayer()->id() != join.joinLayerId() ) )
315 layer->addJoin( join );
316 }
317
318 if ( mDataProvider )
319 layer->setProviderEncoding( mDataProvider->encoding() );
320 layer->setSubsetString( subsetString() );
324 layer->setReadOnly( isReadOnly() );
329
330 const auto constActions = actions()->actions();
331 for ( const QgsAction &action : constActions )
332 {
333 layer->actions()->addAction( action );
334 }
335
336 if ( auto *lRenderer = renderer() )
337 {
338 layer->setRenderer( lRenderer->clone() );
339 }
340
341 if ( auto *lLabeling = labeling() )
342 {
343 layer->setLabeling( lLabeling->clone() );
344 }
346
348
349 if ( auto *lDiagramRenderer = diagramRenderer() )
350 {
351 layer->setDiagramRenderer( lDiagramRenderer->clone() );
352 }
353
354 if ( auto *lDiagramLayerSettings = diagramLayerSettings() )
355 {
356 layer->setDiagramLayerSettings( *lDiagramLayerSettings );
357 }
358
359 for ( int i = 0; i < fields().count(); i++ )
360 {
361 layer->setFieldAlias( i, attributeAlias( i ) );
363 layer->setEditorWidgetSetup( i, editorWidgetSetup( i ) );
366
367 QMap< QgsFieldConstraints::Constraint, QgsFieldConstraints::ConstraintStrength> constraints = fieldConstraintsAndStrength( i );
368 auto constraintIt = constraints.constBegin();
369 for ( ; constraintIt != constraints.constEnd(); ++ constraintIt )
370 {
371 layer->setFieldConstraint( i, constraintIt.key(), constraintIt.value() );
372 }
373
374 if ( fields().fieldOrigin( i ) == Qgis::FieldOrigin::Expression )
375 {
376 layer->addExpressionField( expressionField( i ), fields().at( i ) );
377 }
378 }
379
381
382 if ( auto *lAuxiliaryLayer = auxiliaryLayer() )
383 layer->setAuxiliaryLayer( lAuxiliaryLayer->clone( layer ) );
384
385 layer->mElevationProperties = mElevationProperties->clone();
386 layer->mElevationProperties->setParent( layer );
387
388 layer->mSelectionProperties = mSelectionProperties->clone();
389 layer->mSelectionProperties->setParent( layer );
390
391 return layer;
392}
393
395{
397
398 if ( mDataProvider )
399 {
400 return mDataProvider->storageType();
401 }
402 return QString();
403}
404
405
407{
409
410 if ( mDataProvider )
411 {
412 return mDataProvider->capabilitiesString();
413 }
414 return QString();
415}
416
418{
420
421 return mDataProvider && mDataProvider->isSqlQuery();
422}
423
430
432{
434
435 if ( mDataProvider )
436 {
437 return mDataProvider->dataComment();
438 }
439 return QString();
440}
441
448
450{
452
453 return name();
454}
455
457{
458 // non fatal for now -- the QgsVirtualLayerTask class is not thread safe and calls this
460
461 if ( mDataProvider )
462 {
463 mDataProvider->reloadData();
464 updateFields();
465 }
466}
467
469{
470 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
472
473 return new QgsVectorLayerRenderer( this, rendererContext );
474}
475
476
477void QgsVectorLayer::drawVertexMarker( double x, double y, QPainter &p, Qgis::VertexMarkerType type, int m )
478{
479 switch ( type )
480 {
482 p.setPen( QColor( 50, 100, 120, 200 ) );
483 p.setBrush( QColor( 200, 200, 210, 120 ) );
484 p.drawEllipse( x - m, y - m, m * 2 + 1, m * 2 + 1 );
485 break;
486
488 p.setPen( QColor( 255, 0, 0 ) );
489 p.drawLine( x - m, y + m, x + m, y - m );
490 p.drawLine( x - m, y - m, x + m, y + m );
491 break;
492
494 break;
495 }
496}
497
499{
501
502 mSelectedFeatureIds.insert( fid );
503 mPreviousSelectedFeatureIds.clear();
504
505 emit selectionChanged( QgsFeatureIds() << fid, QgsFeatureIds(), false );
506}
507
508void QgsVectorLayer::select( const QgsFeatureIds &featureIds )
509{
511
512 mSelectedFeatureIds.unite( featureIds );
513 mPreviousSelectedFeatureIds.clear();
514
515 emit selectionChanged( featureIds, QgsFeatureIds(), false );
516}
517
519{
521
522 mSelectedFeatureIds.remove( fid );
523 mPreviousSelectedFeatureIds.clear();
524
525 emit selectionChanged( QgsFeatureIds(), QgsFeatureIds() << fid, false );
526}
527
529{
531
532 mSelectedFeatureIds.subtract( featureIds );
533 mPreviousSelectedFeatureIds.clear();
534
535 emit selectionChanged( QgsFeatureIds(), featureIds, false );
536}
537
539{
541
542 // normalize the rectangle
543 rect.normalize();
544
545 QgsFeatureIds newSelection;
546
548 .setFilterRect( rect )
550 .setNoAttributes() );
551
552 QgsFeature feat;
553 while ( features.nextFeature( feat ) )
554 {
555 newSelection << feat.id();
556 }
557 features.close();
558
559 selectByIds( newSelection, behavior );
560}
561
562void QgsVectorLayer::selectByExpression( const QString &expression, Qgis::SelectBehavior behavior, QgsExpressionContext *context )
563{
565
566 QgsFeatureIds newSelection;
567
568 std::optional< QgsExpressionContext > defaultContext;
569 if ( !context )
570 {
571 defaultContext.emplace( QgsExpressionContextUtils::globalProjectLayerScopes( this ) );
572 context = &defaultContext.value();
573 }
574
576 {
578 .setExpressionContext( *context )
581
582 QgsFeatureIterator features = getFeatures( request );
583
584 if ( behavior == Qgis::SelectBehavior::AddToSelection )
585 {
586 newSelection = selectedFeatureIds();
587 }
588 QgsFeature feat;
589 while ( features.nextFeature( feat ) )
590 {
591 newSelection << feat.id();
592 }
593 features.close();
594 }
596 {
597 QgsExpression exp( expression );
598 exp.prepare( context );
599
600 QgsFeatureIds oldSelection = selectedFeatureIds();
601 QgsFeatureRequest request = QgsFeatureRequest().setFilterFids( oldSelection );
602
603 //refine request
604 if ( !exp.needsGeometry() )
607
608 QgsFeatureIterator features = getFeatures( request );
609 QgsFeature feat;
610 while ( features.nextFeature( feat ) )
611 {
612 context->setFeature( feat );
613 bool matches = exp.evaluate( context ).toBool();
614
615 if ( matches && behavior == Qgis::SelectBehavior::IntersectSelection )
616 {
617 newSelection << feat.id();
618 }
619 else if ( !matches && behavior == Qgis::SelectBehavior::RemoveFromSelection )
620 {
621 newSelection << feat.id();
622 }
623 }
624 }
625
626 selectByIds( newSelection );
627}
628
630{
632
633 QgsFeatureIds newSelection;
634
635 switch ( behavior )
636 {
638 newSelection = ids;
639 break;
640
642 newSelection = mSelectedFeatureIds + ids;
643 break;
644
646 newSelection = mSelectedFeatureIds - ids;
647 break;
648
650 newSelection = mSelectedFeatureIds.intersect( ids );
651 break;
652 }
653
654 QgsFeatureIds deselectedFeatures = mSelectedFeatureIds - newSelection;
655 mSelectedFeatureIds = newSelection;
656 mPreviousSelectedFeatureIds.clear();
657
658 emit selectionChanged( newSelection, deselectedFeatures, true );
659}
660
661void QgsVectorLayer::modifySelection( const QgsFeatureIds &selectIds, const QgsFeatureIds &deselectIds )
662{
664
665 QgsFeatureIds intersectingIds = selectIds & deselectIds;
666 if ( !intersectingIds.isEmpty() )
667 {
668 QgsDebugMsgLevel( QStringLiteral( "Trying to select and deselect the same item at the same time. Unsure what to do. Selecting dubious items." ), 3 );
669 }
670
671 mSelectedFeatureIds -= deselectIds;
672 mSelectedFeatureIds += selectIds;
673 mPreviousSelectedFeatureIds.clear();
674
675 emit selectionChanged( selectIds, deselectIds - intersectingIds, false );
676}
677
679{
681
683 ids.subtract( mSelectedFeatureIds );
684 selectByIds( ids );
685}
686
693
695{
697
698 // normalize the rectangle
699 rect.normalize();
700
702 .setFilterRect( rect )
704 .setNoAttributes() );
705
706 QgsFeatureIds selectIds;
707 QgsFeatureIds deselectIds;
708
709 QgsFeature fet;
710 while ( fit.nextFeature( fet ) )
711 {
712 if ( mSelectedFeatureIds.contains( fet.id() ) )
713 {
714 deselectIds << fet.id();
715 }
716 else
717 {
718 selectIds << fet.id();
719 }
720 }
721
722 modifySelection( selectIds, deselectIds );
723}
724
726{
728
729 if ( mSelectedFeatureIds.isEmpty() )
730 return;
731
732 const QgsFeatureIds previous = mSelectedFeatureIds;
734 mPreviousSelectedFeatureIds = previous;
735}
736
738{
740
741 if ( mPreviousSelectedFeatureIds.isEmpty() || !mSelectedFeatureIds.empty() )
742 return;
743
744 selectByIds( mPreviousSelectedFeatureIds );
745}
746
748{
749 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
751
752 return mDataProvider;
753}
754
756{
757 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
759
760 return mDataProvider;
761}
762
764{
765 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
767
768 return mSelectionProperties;
769}
770
777
784
786{
788
789 QgsProfileRequest modifiedRequest( request );
790 modifiedRequest.expressionContext().appendScope( createExpressionContextScope() );
791 return new QgsVectorLayerProfileGenerator( this, modifiedRequest );
792}
793
794void QgsVectorLayer::setProviderEncoding( const QString &encoding )
795{
797
798 if ( isValid() && mDataProvider && mDataProvider->encoding() != encoding )
799 {
800 mDataProvider->setEncoding( encoding );
801 updateFields();
802 }
803}
804
806{
808
809 delete mDiagramRenderer;
810 mDiagramRenderer = r;
811 emit rendererChanged();
812 emit styleChanged();
813}
814
816{
817 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
819
820 return QgsWkbTypes::geometryType( mWkbType );
821}
822
824{
826
827 return mWkbType;
828}
829
831{
833
834 if ( !isValid() || !isSpatial() || mSelectedFeatureIds.isEmpty() || !mDataProvider ) //no selected features
835 {
836 return QgsRectangle( 0, 0, 0, 0 );
837 }
838
839 QgsRectangle r, retval;
840 retval.setNull();
841
842 QgsFeature fet;
844 {
846 .setFilterFids( mSelectedFeatureIds )
847 .setNoAttributes() );
848
849 while ( fit.nextFeature( fet ) )
850 {
851 if ( !fet.hasGeometry() )
852 continue;
853 r = fet.geometry().boundingBox();
854 retval.combineExtentWith( r );
855 }
856 }
857 else
858 {
860 .setNoAttributes() );
861
862 while ( fit.nextFeature( fet ) )
863 {
864 if ( mSelectedFeatureIds.contains( fet.id() ) )
865 {
866 if ( fet.hasGeometry() )
867 {
868 r = fet.geometry().boundingBox();
869 retval.combineExtentWith( r );
870 }
871 }
872 }
873 }
874
875 if ( retval.width() == 0.0 || retval.height() == 0.0 )
876 {
877 // If all of the features are at the one point, buffer the
878 // rectangle a bit. If they are all at zero, do something a bit
879 // more crude.
880
881 if ( retval.xMinimum() == 0.0 && retval.xMaximum() == 0.0 &&
882 retval.yMinimum() == 0.0 && retval.yMaximum() == 0.0 )
883 {
884 retval.set( -1.0, -1.0, 1.0, 1.0 );
885 }
886 }
887
888 return retval;
889}
890
892{
893 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
895
896 return mLabelsEnabled && static_cast< bool >( mLabeling );
897}
898
900{
902
903 mLabelsEnabled = enabled;
904}
905
907{
908 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
910
911 if ( !mDiagramRenderer || !mDiagramLayerSettings )
912 return false;
913
914 QList<QgsDiagramSettings> settingList = mDiagramRenderer->diagramSettings();
915 if ( !settingList.isEmpty() )
916 {
917 return settingList.at( 0 ).enabled;
918 }
919 return false;
920}
921
922long long QgsVectorLayer::featureCount( const QString &legendKey ) const
923{
925
926 if ( !mSymbolFeatureCounted )
927 return -1;
928
929 return mSymbolFeatureCountMap.value( legendKey, -1 );
930}
931
932QgsFeatureIds QgsVectorLayer::symbolFeatureIds( const QString &legendKey ) const
933{
935
936 if ( !mSymbolFeatureCounted )
937 return QgsFeatureIds();
938
939 return mSymbolFeatureIdMap.value( legendKey, QgsFeatureIds() );
940}
942{
944
945 if ( ( mSymbolFeatureCounted || mFeatureCounter ) && !( storeSymbolFids && mSymbolFeatureIdMap.isEmpty() ) )
946 return mFeatureCounter;
947
948 mSymbolFeatureCountMap.clear();
949 mSymbolFeatureIdMap.clear();
950
951 if ( !isValid() )
952 {
953 QgsDebugMsgLevel( QStringLiteral( "invoked with invalid layer" ), 3 );
954 return mFeatureCounter;
955 }
956 if ( !mDataProvider )
957 {
958 QgsDebugMsgLevel( QStringLiteral( "invoked with null mDataProvider" ), 3 );
959 return mFeatureCounter;
960 }
961 if ( !mRenderer )
962 {
963 QgsDebugMsgLevel( QStringLiteral( "invoked with null mRenderer" ), 3 );
964 return mFeatureCounter;
965 }
966
967 if ( !mFeatureCounter || ( storeSymbolFids && mSymbolFeatureIdMap.isEmpty() ) )
968 {
969 mFeatureCounter = new QgsVectorLayerFeatureCounter( this, QgsExpressionContext(), storeSymbolFids );
970 connect( mFeatureCounter, &QgsTask::taskCompleted, this, &QgsVectorLayer::onFeatureCounterCompleted, Qt::UniqueConnection );
971 connect( mFeatureCounter, &QgsTask::taskTerminated, this, &QgsVectorLayer::onFeatureCounterTerminated, Qt::UniqueConnection );
972 QgsApplication::taskManager()->addTask( mFeatureCounter );
973 }
974
975 return mFeatureCounter;
976}
977
979{
981
982 // do not update extent by default when trust project option is activated
983 if ( force || !mReadExtentFromXml || ( mReadExtentFromXml && mXmlExtent2D.isNull() && mXmlExtent3D.isNull() ) )
984 {
985 mValidExtent2D = false;
986 mValidExtent3D = false;
987 }
988}
989
991{
993
995 mValidExtent2D = true;
996}
997
999{
1001
1003 mValidExtent3D = true;
1004}
1005
1006void QgsVectorLayer::updateDefaultValues( QgsFeatureId fid, QgsFeature feature, QgsExpressionContext *context )
1007{
1009
1010 if ( !mDefaultValueOnUpdateFields.isEmpty() )
1011 {
1012 if ( !feature.isValid() )
1013 feature = getFeature( fid );
1014
1015 int size = mFields.size();
1016 for ( int idx : std::as_const( mDefaultValueOnUpdateFields ) )
1017 {
1018 if ( idx < 0 || idx >= size )
1019 continue;
1020 feature.setAttribute( idx, defaultValue( idx, feature, context ) );
1021 updateFeature( feature, true );
1022 }
1023 }
1024}
1025
1027{
1029
1030 QgsRectangle rect;
1031 rect.setNull();
1032
1033 if ( !isSpatial() )
1034 return rect;
1035
1036 if ( mDataProvider && mDataProvider->isValid() && ( mDataProvider->flags() & Qgis::DataProviderFlag::FastExtent2D ) )
1037 {
1038 // Provider has a trivial 2D extent calculation => always get extent from provider.
1039 // Things are nice and simple this way, e.g. we can always trust that this extent is
1040 // accurate and up to date.
1041 updateExtent( mDataProvider->extent() );
1042 mValidExtent2D = true;
1043 mLazyExtent2D = false;
1044 }
1045 else
1046 {
1047 if ( !mValidExtent2D && mLazyExtent2D && mReadExtentFromXml && !mXmlExtent2D.isNull() )
1048 {
1049 updateExtent( mXmlExtent2D );
1050 mValidExtent2D = true;
1051 mLazyExtent2D = false;
1052 }
1053
1054 if ( !mValidExtent2D && mLazyExtent2D && mDataProvider && mDataProvider->isValid() )
1055 {
1056 // store the extent
1057 updateExtent( mDataProvider->extent() );
1058 mValidExtent2D = true;
1059 mLazyExtent2D = false;
1060
1061 // show the extent
1062 QgsDebugMsgLevel( QStringLiteral( "2D Extent of layer: %1" ).arg( mExtent2D.toString() ), 3 );
1063 }
1064 }
1065
1066 if ( mValidExtent2D )
1067 return QgsMapLayer::extent();
1068
1069 if ( !isValid() || !mDataProvider )
1070 {
1071 QgsDebugMsgLevel( QStringLiteral( "invoked with invalid layer or null mDataProvider" ), 3 );
1072 return rect;
1073 }
1074
1075 if ( !mEditBuffer ||
1076 ( !mDataProvider->transaction() && ( mEditBuffer->deletedFeatureIds().isEmpty() && mEditBuffer->changedGeometries().isEmpty() ) ) ||
1078 {
1079 mDataProvider->updateExtents();
1080
1081 // get the extent of the layer from the provider
1082 // but only when there are some features already
1083 if ( mDataProvider->featureCount() != 0 )
1084 {
1085 const QgsRectangle r = mDataProvider->extent();
1086 rect.combineExtentWith( r );
1087 }
1088
1089 if ( mEditBuffer && !mDataProvider->transaction() )
1090 {
1091 const auto addedFeatures = mEditBuffer->addedFeatures();
1092 for ( QgsFeatureMap::const_iterator it = addedFeatures.constBegin(); it != addedFeatures.constEnd(); ++it )
1093 {
1094 if ( it->hasGeometry() )
1095 {
1096 const QgsRectangle r = it->geometry().boundingBox();
1097 rect.combineExtentWith( r );
1098 }
1099 }
1100 }
1101 }
1102 else
1103 {
1105 .setNoAttributes() );
1106
1107 QgsFeature fet;
1108 while ( fit.nextFeature( fet ) )
1109 {
1110 if ( fet.hasGeometry() && fet.geometry().type() != Qgis::GeometryType::Unknown )
1111 {
1112 const QgsRectangle bb = fet.geometry().boundingBox();
1113 rect.combineExtentWith( bb );
1114 }
1115 }
1116 }
1117
1118 if ( rect.xMinimum() > rect.xMaximum() && rect.yMinimum() > rect.yMaximum() )
1119 {
1120 // special case when there are no features in provider nor any added
1121 rect = QgsRectangle(); // use rectangle with zero coordinates
1122 }
1123
1124 updateExtent( rect );
1125 mValidExtent2D = true;
1126
1127 // Send this (hopefully) up the chain to the map canvas
1128 emit recalculateExtents();
1129
1130 return rect;
1131}
1132
1134{
1136
1137 // if data is 2D, redirect to 2D extend computation, and save it as 2D extent (in 3D bbox)
1138 if ( mDataProvider && mDataProvider->elevationProperties() && !mDataProvider->elevationProperties()->containsElevationData() )
1139 {
1140 return QgsBox3D( extent() );
1141 }
1142
1144 extent.setNull();
1145
1146 if ( !isSpatial() )
1147 return extent;
1148
1149 if ( mDataProvider && mDataProvider->isValid() && ( mDataProvider->flags() & Qgis::DataProviderFlag::FastExtent3D ) )
1150 {
1151 // Provider has a trivial 3D extent calculation => always get extent from provider.
1152 // Things are nice and simple this way, e.g. we can always trust that this extent is
1153 // accurate and up to date.
1154 updateExtent( mDataProvider->extent3D() );
1155 mValidExtent3D = true;
1156 mLazyExtent3D = false;
1157 }
1158 else
1159 {
1160 if ( !mValidExtent3D && mLazyExtent3D && mReadExtentFromXml && !mXmlExtent3D.isNull() )
1161 {
1162 updateExtent( mXmlExtent3D );
1163 mValidExtent3D = true;
1164 mLazyExtent3D = false;
1165 }
1166
1167 if ( !mValidExtent3D && mLazyExtent3D && mDataProvider && mDataProvider->isValid() )
1168 {
1169 // store the extent
1170 updateExtent( mDataProvider->extent3D() );
1171 mValidExtent3D = true;
1172 mLazyExtent3D = false;
1173
1174 // show the extent
1175 QgsDebugMsgLevel( QStringLiteral( "3D Extent of layer: %1" ).arg( mExtent3D.toString() ), 3 );
1176 }
1177 }
1178
1179 if ( mValidExtent3D )
1180 return QgsMapLayer::extent3D();
1181
1182 if ( !isValid() || !mDataProvider )
1183 {
1184 QgsDebugMsgLevel( QStringLiteral( "invoked with invalid layer or null mDataProvider" ), 3 );
1185 return extent;
1186 }
1187
1188 if ( !mEditBuffer ||
1189 ( !mDataProvider->transaction() && ( mEditBuffer->deletedFeatureIds().isEmpty() && mEditBuffer->changedGeometries().isEmpty() ) ) ||
1191 {
1192 mDataProvider->updateExtents();
1193
1194 // get the extent of the layer from the provider
1195 // but only when there are some features already
1196 if ( mDataProvider->featureCount() != 0 )
1197 {
1198 const QgsBox3D ext = mDataProvider->extent3D();
1199 extent.combineWith( ext );
1200 }
1201
1202 if ( mEditBuffer && !mDataProvider->transaction() )
1203 {
1204 const auto addedFeatures = mEditBuffer->addedFeatures();
1205 for ( QgsFeatureMap::const_iterator it = addedFeatures.constBegin(); it != addedFeatures.constEnd(); ++it )
1206 {
1207 if ( it->hasGeometry() )
1208 {
1209 const QgsBox3D bbox = it->geometry().boundingBox3D();
1210 extent.combineWith( bbox );
1211 }
1212 }
1213 }
1214 }
1215 else
1216 {
1218 .setNoAttributes() );
1219
1220 QgsFeature fet;
1221 while ( fit.nextFeature( fet ) )
1222 {
1223 if ( fet.hasGeometry() && fet.geometry().type() != Qgis::GeometryType::Unknown )
1224 {
1225 const QgsBox3D bb = fet.geometry().boundingBox3D();
1226 extent.combineWith( bb );
1227 }
1228 }
1229 }
1230
1231 if ( extent.xMinimum() > extent.xMaximum() && extent.yMinimum() > extent.yMaximum() && extent.zMinimum() > extent.zMaximum() )
1232 {
1233 // special case when there are no features in provider nor any added
1234 extent = QgsBox3D(); // use rectangle with zero coordinates
1235 }
1236
1237 updateExtent( extent );
1238 mValidExtent3D = true;
1239
1240 // Send this (hopefully) up the chain to the map canvas
1241 emit recalculateExtents();
1242
1243 return extent;
1244}
1245
1252
1259
1261{
1263
1264 if ( !isValid() || !mDataProvider )
1265 {
1266 QgsDebugMsgLevel( QStringLiteral( "invoked with invalid layer or null mDataProvider" ), 3 );
1267 return customProperty( QStringLiteral( "storedSubsetString" ) ).toString();
1268 }
1269 return mDataProvider->subsetString();
1270}
1271
1272bool QgsVectorLayer::setSubsetString( const QString &subset )
1273{
1275
1276 if ( !isValid() || !mDataProvider )
1277 {
1278 QgsDebugMsgLevel( QStringLiteral( "invoked with invalid layer or null mDataProvider or while editing" ), 3 );
1279 setCustomProperty( QStringLiteral( "storedSubsetString" ), subset );
1280 return false;
1281 }
1282 else if ( mEditBuffer )
1283 {
1284 QgsDebugMsgLevel( QStringLiteral( "invoked while editing" ), 3 );
1285 return false;
1286 }
1287
1288 if ( subset == mDataProvider->subsetString() )
1289 return true;
1290
1291 bool res = mDataProvider->setSubsetString( subset );
1292
1293 // get the updated data source string from the provider
1294 mDataSource = mDataProvider->dataSourceUri();
1295 updateExtents();
1296 updateFields();
1297
1298 if ( res )
1299 {
1300 emit subsetStringChanged();
1302 }
1303
1304 return res;
1305}
1306
1308{
1309 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
1311
1312 if ( isValid() && mDataProvider && !mEditBuffer && ( isSpatial() && geometryType() != Qgis::GeometryType::Point ) && ( mSimplifyMethod.simplifyHints() & simplifyHint ) && renderContext.useRenderingOptimization() )
1313 {
1314 double maximumSimplificationScale = mSimplifyMethod.maximumScale();
1315
1316 // check maximum scale at which generalisation should be carried out
1317 return !( maximumSimplificationScale > 1 && renderContext.rendererScale() <= maximumSimplificationScale );
1318 }
1319 return false;
1320}
1321
1323{
1325
1326 return mConditionalStyles;
1327}
1328
1330{
1331 // non fatal for now -- the aggregate expression functions are not thread safe and call this
1333
1334 if ( !isValid() || !mDataProvider )
1335 return QgsFeatureIterator();
1336
1337 return QgsFeatureIterator( new QgsVectorLayerFeatureIterator( new QgsVectorLayerFeatureSource( this ), true, request ) );
1338}
1339
1341{
1343
1344 QgsFeature feature;
1346 if ( feature.isValid() )
1347 return feature.geometry();
1348 else
1349 return QgsGeometry();
1350}
1351
1353{
1355
1356 if ( !isValid() || !mEditBuffer || !mDataProvider )
1357 return false;
1358
1359
1360 if ( mGeometryOptions->isActive() )
1361 {
1362 QgsGeometry geom = feature.geometry();
1363 mGeometryOptions->apply( geom );
1364 feature.setGeometry( geom );
1365 }
1366
1367 bool success = mEditBuffer->addFeature( feature );
1368
1369 if ( success && mJoinBuffer->containsJoins() )
1370 {
1371 success = mJoinBuffer->addFeature( feature );
1372 }
1373
1374 return success;
1375}
1376
1377bool QgsVectorLayer::updateFeature( QgsFeature &updatedFeature, bool skipDefaultValues )
1378{
1380
1381 if ( !mEditBuffer || !mDataProvider )
1382 {
1383 return false;
1384 }
1385
1386 QgsFeature currentFeature = getFeature( updatedFeature.id() );
1387 if ( currentFeature.isValid() )
1388 {
1389 bool hasChanged = false;
1390 bool hasError = false;
1391
1392 if ( ( updatedFeature.hasGeometry() || currentFeature.hasGeometry() ) && !updatedFeature.geometry().equals( currentFeature.geometry() ) )
1393 {
1394 QgsGeometry geometry = updatedFeature.geometry();
1395 if ( changeGeometry( updatedFeature.id(), geometry, true ) )
1396 {
1397 hasChanged = true;
1398 updatedFeature.setGeometry( geometry );
1399 }
1400 else
1401 {
1402 QgsDebugMsgLevel( QStringLiteral( "geometry of feature %1 could not be changed." ).arg( updatedFeature.id() ), 3 );
1403 }
1404 }
1405
1406 QgsAttributes fa = updatedFeature.attributes();
1407 QgsAttributes ca = currentFeature.attributes();
1408
1409 for ( int attr = 0; attr < fa.count(); ++attr )
1410 {
1411 if ( !qgsVariantEqual( fa.at( attr ), ca.at( attr ) ) )
1412 {
1413 if ( changeAttributeValue( updatedFeature.id(), attr, fa.at( attr ), ca.at( attr ), true ) )
1414 {
1415 hasChanged = true;
1416 }
1417 else
1418 {
1419 QgsDebugMsgLevel( QStringLiteral( "attribute %1 of feature %2 could not be changed." ).arg( attr ).arg( updatedFeature.id() ), 3 );
1420 hasError = true;
1421 }
1422 }
1423 }
1424 if ( hasChanged && !mDefaultValueOnUpdateFields.isEmpty() && !skipDefaultValues )
1425 updateDefaultValues( updatedFeature.id(), updatedFeature );
1426
1427 return !hasError;
1428 }
1429 else
1430 {
1431 QgsDebugMsgLevel( QStringLiteral( "feature %1 could not be retrieved" ).arg( updatedFeature.id() ), 3 );
1432 return false;
1433 }
1434}
1435
1436
1437bool QgsVectorLayer::insertVertex( double x, double y, QgsFeatureId atFeatureId, int beforeVertex )
1438{
1440
1441 if ( !isValid() || !mEditBuffer || !mDataProvider )
1442 return false;
1443
1444 QgsVectorLayerEditUtils utils( this );
1445 bool result = utils.insertVertex( x, y, atFeatureId, beforeVertex );
1446 if ( result )
1447 updateExtents();
1448 return result;
1449}
1450
1451
1452bool QgsVectorLayer::insertVertex( const QgsPoint &point, QgsFeatureId atFeatureId, int beforeVertex )
1453{
1455
1456 if ( !isValid() || !mEditBuffer || !mDataProvider )
1457 return false;
1458
1459 QgsVectorLayerEditUtils utils( this );
1460 bool result = utils.insertVertex( point, atFeatureId, beforeVertex );
1461 if ( result )
1462 updateExtents();
1463 return result;
1464}
1465
1466
1467bool QgsVectorLayer::moveVertex( double x, double y, QgsFeatureId atFeatureId, int atVertex )
1468{
1470
1471 if ( !isValid() || !mEditBuffer || !mDataProvider )
1472 return false;
1473
1474 QgsVectorLayerEditUtils utils( this );
1475 bool result = utils.moveVertex( x, y, atFeatureId, atVertex );
1476
1477 if ( result )
1478 updateExtents();
1479 return result;
1480}
1481
1482bool QgsVectorLayer::moveVertex( const QgsPoint &p, QgsFeatureId atFeatureId, int atVertex )
1483{
1485
1486 if ( !isValid() || !mEditBuffer || !mDataProvider )
1487 return false;
1488
1489 QgsVectorLayerEditUtils utils( this );
1490 bool result = utils.moveVertex( p, atFeatureId, atVertex );
1491
1492 if ( result )
1493 updateExtents();
1494 return result;
1495}
1496
1498{
1500
1501 if ( !isValid() || !mEditBuffer || !mDataProvider )
1503
1504 QgsVectorLayerEditUtils utils( this );
1505 Qgis::VectorEditResult result = utils.deleteVertex( featureId, vertex );
1506
1507 if ( result == Qgis::VectorEditResult::Success )
1508 updateExtents();
1509 return result;
1510}
1511
1512
1514{
1516
1517 if ( !isValid() || !mDataProvider || !( mDataProvider->capabilities() & Qgis::VectorProviderCapability::DeleteFeatures ) )
1518 {
1519 return false;
1520 }
1521
1522 if ( !isEditable() )
1523 {
1524 return false;
1525 }
1526
1527 int deleted = 0;
1528 int count = mSelectedFeatureIds.size();
1529 // Make a copy since deleteFeature modifies mSelectedFeatureIds
1530 QgsFeatureIds selectedFeatures( mSelectedFeatureIds );
1531 for ( QgsFeatureId fid : std::as_const( selectedFeatures ) )
1532 {
1533 deleted += deleteFeature( fid, context ); // removes from selection
1534 }
1535
1537 updateExtents();
1538
1539 if ( deletedCount )
1540 {
1541 *deletedCount = deleted;
1542 }
1543
1544 return deleted == count;
1545}
1546
1547static const QgsPointSequence vectorPointXY2pointSequence( const QVector<QgsPointXY> &points )
1548{
1549 QgsPointSequence pts;
1550 pts.reserve( points.size() );
1551 QVector<QgsPointXY>::const_iterator it = points.constBegin();
1552 while ( it != points.constEnd() )
1553 {
1554 pts.append( QgsPoint( *it ) );
1555 ++it;
1556 }
1557 return pts;
1558}
1559Qgis::GeometryOperationResult QgsVectorLayer::addRing( const QVector<QgsPointXY> &ring, QgsFeatureId *featureId )
1560{
1562
1563 return addRing( vectorPointXY2pointSequence( ring ), featureId );
1564}
1565
1567{
1569
1570 if ( !isValid() || !mEditBuffer || !mDataProvider )
1572
1573 QgsVectorLayerEditUtils utils( this );
1575
1576 //first try with selected features
1577 if ( !mSelectedFeatureIds.isEmpty() )
1578 {
1579 result = utils.addRing( ring, mSelectedFeatureIds, featureId );
1580 }
1581
1583 {
1584 //try with all intersecting features
1585 result = utils.addRing( ring, QgsFeatureIds(), featureId );
1586 }
1587
1588 return result;
1589}
1590
1592{
1594
1595 if ( !isValid() || !mEditBuffer || !mDataProvider )
1596 {
1597 delete ring;
1599 }
1600
1601 if ( !ring )
1602 {
1604 }
1605
1606 if ( !ring->isClosed() )
1607 {
1608 delete ring;
1610 }
1611
1612 QgsVectorLayerEditUtils utils( this );
1614
1615 //first try with selected features
1616 if ( !mSelectedFeatureIds.isEmpty() )
1617 {
1618 result = utils.addRing( static_cast< QgsCurve * >( ring->clone() ), mSelectedFeatureIds, featureId );
1619 }
1620
1622 {
1623 //try with all intersecting features
1624 result = utils.addRing( static_cast< QgsCurve * >( ring->clone() ), QgsFeatureIds(), featureId );
1625 }
1626
1627 delete ring;
1628 return result;
1629}
1630
1632{
1634
1635 QgsPointSequence pts;
1636 pts.reserve( points.size() );
1637 for ( QList<QgsPointXY>::const_iterator it = points.constBegin(); it != points.constEnd() ; ++it )
1638 {
1639 pts.append( QgsPoint( *it ) );
1640 }
1641 return addPart( pts );
1642}
1643
1644#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
1645Qgis::GeometryOperationResult QgsVectorLayer::addPart( const QVector<QgsPointXY> &points )
1646{
1648
1649 return addPart( vectorPointXY2pointSequence( points ) );
1650}
1651#endif
1652
1654{
1656
1657 if ( !isValid() || !mEditBuffer || !mDataProvider )
1659
1660 //number of selected features must be 1
1661
1662 if ( mSelectedFeatureIds.empty() )
1663 {
1664 QgsDebugMsgLevel( QStringLiteral( "Number of selected features <1" ), 3 );
1666 }
1667 else if ( mSelectedFeatureIds.size() > 1 )
1668 {
1669 QgsDebugMsgLevel( QStringLiteral( "Number of selected features >1" ), 3 );
1671 }
1672
1673 QgsVectorLayerEditUtils utils( this );
1674 Qgis::GeometryOperationResult result = utils.addPart( points, *mSelectedFeatureIds.constBegin() );
1675
1677 updateExtents();
1678 return result;
1679}
1680
1682{
1684
1685 if ( !isValid() || !mEditBuffer || !mDataProvider )
1687
1688 //number of selected features must be 1
1689
1690 if ( mSelectedFeatureIds.empty() )
1691 {
1692 QgsDebugMsgLevel( QStringLiteral( "Number of selected features <1" ), 3 );
1694 }
1695 else if ( mSelectedFeatureIds.size() > 1 )
1696 {
1697 QgsDebugMsgLevel( QStringLiteral( "Number of selected features >1" ), 3 );
1699 }
1700
1701 QgsVectorLayerEditUtils utils( this );
1702 Qgis::GeometryOperationResult result = utils.addPart( ring, *mSelectedFeatureIds.constBegin() );
1703
1705 updateExtents();
1706 return result;
1707}
1708
1709// TODO QGIS 4.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 == labeling )
1816 return;
1817
1818 delete mLabeling;
1819 mLabeling = labeling;
1820}
1821
1823{
1825
1826 if ( project() && project()->transactionMode() == Qgis::TransactionMode::BufferedGroups )
1827 return project()->startEditing( this );
1828
1829 if ( !isValid() || !mDataProvider )
1830 {
1831 return false;
1832 }
1833
1834 // allow editing if provider supports any of the capabilities
1835 if ( !supportsEditing() )
1836 {
1837 return false;
1838 }
1839
1840 if ( mEditBuffer )
1841 {
1842 // editing already underway
1843 return false;
1844 }
1845
1846 mDataProvider->enterUpdateMode();
1847
1848 emit beforeEditingStarted();
1849
1850 createEditBuffer();
1851
1852 updateFields();
1853
1854 emit editingStarted();
1855
1856 return true;
1857}
1858
1860{
1862
1863 if ( mDataProvider )
1864 mDataProvider->setTransformContext( transformContext );
1865}
1866
1873
1875{
1877
1878 if ( mRenderer )
1879 if ( !mRenderer->accept( visitor ) )
1880 return false;
1881
1882 if ( mLabeling )
1883 if ( !mLabeling->accept( visitor ) )
1884 return false;
1885
1886 return true;
1887}
1888
1889bool QgsVectorLayer::readXml( const QDomNode &layer_node, QgsReadWriteContext &context )
1890{
1892
1893 QgsDebugMsgLevel( QStringLiteral( "Datasource in QgsVectorLayer::readXml: %1" ).arg( mDataSource.toLocal8Bit().data() ), 3 );
1894
1895 //process provider key
1896 QDomNode pkeyNode = layer_node.namedItem( QStringLiteral( "provider" ) );
1897
1898 if ( pkeyNode.isNull() )
1899 {
1900 mProviderKey.clear();
1901 }
1902 else
1903 {
1904 QDomElement pkeyElt = pkeyNode.toElement();
1905 mProviderKey = pkeyElt.text();
1906 }
1907
1908 // determine type of vector layer
1909 if ( !mProviderKey.isNull() )
1910 {
1911 // if the provider string isn't empty, then we successfully
1912 // got the stored provider
1913 }
1914 else if ( mDataSource.contains( QLatin1String( "dbname=" ) ) )
1915 {
1916 mProviderKey = QStringLiteral( "postgres" );
1917 }
1918 else
1919 {
1920 mProviderKey = QStringLiteral( "ogr" );
1921 }
1922
1923 const QDomElement elem = layer_node.toElement();
1925
1926 mDataSourceReadOnly = mReadFlags & QgsMapLayer::FlagForceReadOnly;
1928
1929 if ( ( mReadFlags & QgsMapLayer::FlagDontResolveLayers ) || !setDataProvider( mProviderKey, options, flags ) )
1930 {
1932 {
1933 QgsDebugError( QStringLiteral( "Could not set data provider for layer %1" ).arg( publicSource() ) );
1934 }
1935
1936 // for invalid layer sources, we fallback to stored wkbType if available
1937 if ( elem.hasAttribute( QStringLiteral( "wkbType" ) ) )
1938 mWkbType = qgsEnumKeyToValue( elem.attribute( QStringLiteral( "wkbType" ) ), mWkbType );
1939 }
1940
1941 QDomElement pkeyElem = pkeyNode.toElement();
1942 if ( !pkeyElem.isNull() )
1943 {
1944 QString encodingString = pkeyElem.attribute( QStringLiteral( "encoding" ) );
1945 if ( mDataProvider && !encodingString.isEmpty() )
1946 {
1947 mDataProvider->setEncoding( encodingString );
1948 }
1949 }
1950
1951 // load vector joins - does not resolve references to layers yet
1952 mJoinBuffer->readXml( layer_node );
1953
1954 updateFields();
1955
1956 // If style doesn't include a legend, we'll need to make a default one later...
1957 mSetLegendFromStyle = false;
1958
1959 QString errorMsg;
1960 if ( !readSymbology( layer_node, errorMsg, context ) )
1961 {
1962 return false;
1963 }
1964
1965 readStyleManager( layer_node );
1966
1967 QDomNode depsNode = layer_node.namedItem( QStringLiteral( "dataDependencies" ) );
1968 QDomNodeList depsNodes = depsNode.childNodes();
1969 QSet<QgsMapLayerDependency> sources;
1970 for ( int i = 0; i < depsNodes.count(); i++ )
1971 {
1972 QString source = depsNodes.at( i ).toElement().attribute( QStringLiteral( "id" ) );
1973 sources << QgsMapLayerDependency( source );
1974 }
1975 setDependencies( sources );
1976
1977 if ( !mSetLegendFromStyle )
1979
1980 // read extent
1982 {
1983 mReadExtentFromXml = true;
1984 }
1985 if ( mReadExtentFromXml )
1986 {
1987 const QDomNode extentNode = layer_node.namedItem( QStringLiteral( "extent" ) );
1988 if ( !extentNode.isNull() )
1989 {
1990 mXmlExtent2D = QgsXmlUtils::readRectangle( extentNode.toElement() );
1991 }
1992 const QDomNode extent3DNode = layer_node.namedItem( QStringLiteral( "extent3D" ) );
1993 if ( !extent3DNode.isNull() )
1994 {
1995 mXmlExtent3D = QgsXmlUtils::readBox3D( extent3DNode.toElement() );
1996 }
1997 }
1998
1999 // auxiliary layer
2000 const QDomNode asNode = layer_node.namedItem( QStringLiteral( "auxiliaryLayer" ) );
2001 const QDomElement asElem = asNode.toElement();
2002 if ( !asElem.isNull() )
2003 {
2004 mAuxiliaryLayerKey = asElem.attribute( QStringLiteral( "key" ) );
2005 }
2006
2007 // QGIS Server WMS Dimensions
2008 mServerProperties->readXml( layer_node );
2009
2010 return isValid(); // should be true if read successfully
2011
2012} // void QgsVectorLayer::readXml
2013
2014
2015void QgsVectorLayer::setDataSourcePrivate( const QString &dataSource, const QString &baseName, const QString &provider,
2017{
2019
2020 Qgis::GeometryType geomType = geometryType();
2021
2022 mDataSource = dataSource;
2023 setName( baseName );
2024 setDataProvider( provider, options, flags );
2025
2026 if ( !isValid() )
2027 {
2028 return;
2029 }
2030
2031 // Always set crs
2033
2034 bool loadDefaultStyleFlag = false;
2036 {
2037 loadDefaultStyleFlag = true;
2038 }
2039
2040 // reset style if loading default style, style is missing, or geometry type is has changed (and layer is valid)
2041 if ( !renderer() || !legend() || ( isValid() && geomType != geometryType() ) || loadDefaultStyleFlag )
2042 {
2043 std::unique_ptr< QgsScopedRuntimeProfile > profile;
2044 if ( QgsApplication::profiler()->groupIsActive( QStringLiteral( "projectload" ) ) )
2045 profile = std::make_unique< QgsScopedRuntimeProfile >( tr( "Load layer style" ), QStringLiteral( "projectload" ) );
2046
2047 bool defaultLoadedFlag = false;
2048
2049 // defer style changed signal until we've set the renderer, labeling, everything.
2050 // we don't want multiple signals!
2051 ScopedIntIncrementor styleChangedSignalBlocker( &mBlockStyleChangedSignal );
2052
2053 // need to check whether the default style included a legend, and if not, we need to make a default legend
2054 // later...
2055 mSetLegendFromStyle = false;
2056
2057 // first check if there is a default style / propertysheet defined
2058 // for this layer and if so apply it
2059 // this should take precedence over all
2060 if ( !defaultLoadedFlag && loadDefaultStyleFlag )
2061 {
2062 loadDefaultStyle( defaultLoadedFlag );
2063 }
2064
2065 if ( loadDefaultStyleFlag && !defaultLoadedFlag && isSpatial() && mDataProvider->capabilities() & Qgis::VectorProviderCapability::CreateRenderer )
2066 {
2067 // if we didn't load a default style for this layer, try to create a renderer directly from the data provider
2068 std::unique_ptr< QgsFeatureRenderer > defaultRenderer( mDataProvider->createRenderer() );
2069 if ( defaultRenderer )
2070 {
2071 defaultLoadedFlag = true;
2072 setRenderer( defaultRenderer.release() );
2073 }
2074 }
2075
2076 // if the default style failed to load or was disabled use some very basic defaults
2077 if ( !defaultLoadedFlag )
2078 {
2079 // add single symbol renderer for spatial layers
2081 }
2082
2083 if ( !mSetLegendFromStyle )
2085
2087 {
2088 std::unique_ptr< QgsAbstractVectorLayerLabeling > defaultLabeling( mDataProvider->createLabeling() );
2089 if ( defaultLabeling )
2090 {
2091 setLabeling( defaultLabeling.release() );
2092 setLabelsEnabled( true );
2093 }
2094 }
2095
2096 styleChangedSignalBlocker.release();
2098 }
2099}
2100
2101QString QgsVectorLayer::loadDefaultStyle( bool &resultFlag )
2102{
2104
2105 // first try to load a user-defined default style - this should always take precedence
2106 QString styleXml = QgsMapLayer::loadDefaultStyle( resultFlag );
2107
2108 if ( resultFlag )
2109 {
2110 // Try to load all stored styles from DB
2111 if ( mLoadAllStoredStyle && mDataProvider && mDataProvider->styleStorageCapabilities().testFlag( Qgis::ProviderStyleStorageCapability::LoadFromDatabase ) )
2112 {
2113 QStringList ids, names, descriptions;
2114 QString errorMessage;
2115 // Get the number of styles related to current layer.
2116 const int relatedStylesCount { listStylesInDatabase( ids, names, descriptions, errorMessage ) };
2117 Q_ASSERT( ids.count() == names.count() );
2118 const QString currentStyleName { mStyleManager->currentStyle() };
2119 for ( int i = 0; i < relatedStylesCount; ++i )
2120 {
2121 if ( names.at( i ) == currentStyleName )
2122 {
2123 continue;
2124 }
2125 errorMessage.clear();
2126 const QString styleXml { getStyleFromDatabase( ids.at( i ), errorMessage ) };
2127 if ( ! styleXml.isEmpty() && errorMessage.isEmpty() )
2128 {
2129 mStyleManager->addStyle( names.at( i ), QgsMapLayerStyle( styleXml ) );
2130 }
2131 else
2132 {
2133 QgsDebugMsgLevel( QStringLiteral( "Error retrieving style %1 from DB: %2" ).arg( ids.at( i ), errorMessage ), 2 );
2134 }
2135 }
2136 }
2137 return styleXml ;
2138 }
2139
2141 {
2142 // otherwise try to create a renderer directly from the data provider
2143 std::unique_ptr< QgsFeatureRenderer > defaultRenderer( mDataProvider->createRenderer() );
2144 if ( defaultRenderer )
2145 {
2146 resultFlag = true;
2147 setRenderer( defaultRenderer.release() );
2148 return QString();
2149 }
2150 }
2151
2152 return QString();
2153}
2154
2155bool QgsVectorLayer::setDataProvider( QString const &provider, const QgsDataProvider::ProviderOptions &options, Qgis::DataProviderReadFlags flags )
2156{
2158
2159 mProviderKey = provider;
2160 delete mDataProvider;
2161
2162 // For Postgres provider primary key unicity is tested at construction time,
2163 // so it has to be set before initializing the provider,
2164 // this manipulation is necessary to preserve default behavior when
2165 // "trust layer metadata" project level option is set and checkPrimaryKeyUnicity
2166 // was not explicitly passed in the uri
2167 if ( provider.compare( QLatin1String( "postgres" ) ) == 0 )
2168 {
2169 const QString checkUnicityKey { QStringLiteral( "checkPrimaryKeyUnicity" ) };
2171 if ( ! uri.hasParam( checkUnicityKey ) )
2172 {
2173 uri.setParam( checkUnicityKey, mReadExtentFromXml ? "0" : "1" );
2174 mDataSource = uri.uri( false );
2175 }
2176 }
2177
2178 std::unique_ptr< QgsScopedRuntimeProfile > profile;
2179 if ( QgsApplication::profiler()->groupIsActive( QStringLiteral( "projectload" ) ) )
2180 profile = std::make_unique< QgsScopedRuntimeProfile >( tr( "Create %1 provider" ).arg( provider ), QStringLiteral( "projectload" ) );
2181
2182 if ( mPreloadedProvider )
2183 mDataProvider = qobject_cast< QgsVectorDataProvider * >( mPreloadedProvider.release() );
2184 else
2185 mDataProvider = qobject_cast<QgsVectorDataProvider *>( QgsProviderRegistry::instance()->createProvider( provider, mDataSource, options, flags ) );
2186
2187 if ( !mDataProvider )
2188 {
2189 setValid( false );
2190 QgsDebugMsgLevel( QStringLiteral( "Unable to get data provider" ), 2 );
2191 return false;
2192 }
2193
2194 mDataProvider->setParent( this );
2195 connect( mDataProvider, &QgsVectorDataProvider::raiseError, this, &QgsVectorLayer::raiseError );
2196
2197 QgsDebugMsgLevel( QStringLiteral( "Instantiated the data provider plugin" ), 2 );
2198
2199 setValid( mDataProvider->isValid() );
2200 if ( !isValid() )
2201 {
2202 QgsDebugMsgLevel( QStringLiteral( "Invalid provider plugin %1" ).arg( QString( mDataSource.toUtf8() ) ), 2 );
2203 return false;
2204 }
2205
2206 if ( profile )
2207 profile->switchTask( tr( "Read layer metadata" ) );
2209 {
2210 // we combine the provider metadata with the layer's existing metadata, so as not to reset any user customizations to the metadata
2211 // back to the default if a layer's data source is changed
2212 QgsLayerMetadata newMetadata = mDataProvider->layerMetadata();
2213 // this overwrites the provider metadata with any properties which are non-empty from the existing layer metadata
2214 newMetadata.combine( &mMetadata );
2215
2216 setMetadata( newMetadata );
2217 QgsDebugMsgLevel( QStringLiteral( "Set Data provider QgsLayerMetadata identifier[%1]" ).arg( metadata().identifier() ), 4 );
2218 }
2219
2220 // TODO: Check if the provider has the capability to send fullExtentCalculated
2221 connect( mDataProvider, &QgsVectorDataProvider::fullExtentCalculated, this, [this] { updateExtents(); } );
2222
2223 // get and store the feature type
2224 mWkbType = mDataProvider->wkbType();
2225
2226 // before we update the layer fields from the provider, we first copy any default set alias and
2227 // editor widget config from the data provider fields, if present
2228 const QgsFields providerFields = mDataProvider->fields();
2229 for ( const QgsField &field : providerFields )
2230 {
2231 // we only copy defaults from the provider if we aren't overriding any configuration made in the layer
2232 if ( !field.editorWidgetSetup().isNull() && mFieldWidgetSetups.value( field.name() ).isNull() )
2233 {
2234 mFieldWidgetSetups[ field.name() ] = field.editorWidgetSetup();
2235 }
2236 if ( !field.alias().isEmpty() && mAttributeAliasMap.value( field.name() ).isEmpty() )
2237 {
2238 mAttributeAliasMap[ field.name() ] = field.alias();
2239 }
2240 if ( !mAttributeSplitPolicy.contains( field.name() ) )
2241 {
2242 mAttributeSplitPolicy[ field.name() ] = field.splitPolicy();
2243 }
2244 if ( !mAttributeDuplicatePolicy.contains( field.name() ) )
2245 {
2246 mAttributeDuplicatePolicy[ field.name() ] = field.duplicatePolicy();
2247 }
2248 }
2249
2250 if ( profile )
2251 profile->switchTask( tr( "Read layer fields" ) );
2252 updateFields();
2253
2254 if ( mProviderKey == QLatin1String( "postgres" ) )
2255 {
2256 // update datasource from data provider computed one
2257 mDataSource = mDataProvider->dataSourceUri( false );
2258
2259 QgsDebugMsgLevel( QStringLiteral( "Beautifying layer name %1" ).arg( name() ), 3 );
2260
2261 // adjust the display name for postgres layers
2262 const thread_local QRegularExpression reg( R"lit("[^"]+"\."([^"] + )"( \‍([^)]+\))?)lit" );
2263 const QRegularExpressionMatch match = reg.match( name() );
2264 if ( match.hasMatch() )
2265 {
2266 QStringList stuff = match.capturedTexts();
2267 QString lName = stuff[1];
2268
2269 const QMap<QString, QgsMapLayer *> &layers = QgsProject::instance()->mapLayers(); // skip-keyword-check
2270
2271 QMap<QString, QgsMapLayer *>::const_iterator it;
2272 for ( it = layers.constBegin(); it != layers.constEnd() && ( *it )->name() != lName; ++it )
2273 ;
2274
2275 if ( it != layers.constEnd() && stuff.size() > 2 )
2276 {
2277 lName += '.' + stuff[2].mid( 2, stuff[2].length() - 3 );
2278 }
2279
2280 if ( !lName.isEmpty() )
2281 setName( lName );
2282 }
2283 QgsDebugMsgLevel( QStringLiteral( "Beautified layer name %1" ).arg( name() ), 3 );
2284 }
2285 else if ( mProviderKey == QLatin1String( "osm" ) )
2286 {
2287 // make sure that the "observer" has been removed from URI to avoid crashes
2288 mDataSource = mDataProvider->dataSourceUri();
2289 }
2290 else if ( provider == QLatin1String( "ogr" ) )
2291 {
2292 // make sure that the /vsigzip or /vsizip is added to uri, if applicable
2293 mDataSource = mDataProvider->dataSourceUri();
2294 if ( mDataSource.right( 10 ) == QLatin1String( "|layerid=0" ) )
2295 mDataSource.chop( 10 );
2296 }
2297 else if ( provider == QLatin1String( "memory" ) )
2298 {
2299 // required so that source differs between memory layers
2300 mDataSource = mDataSource + QStringLiteral( "&uid=%1" ).arg( QUuid::createUuid().toString() );
2301 }
2302 else if ( provider == QLatin1String( "hana" ) )
2303 {
2304 // update datasource from data provider computed one
2305 mDataSource = mDataProvider->dataSourceUri( false );
2306 }
2307
2308 connect( mDataProvider, &QgsVectorDataProvider::dataChanged, this, &QgsVectorLayer::emitDataChanged );
2310
2311 return true;
2312} // QgsVectorLayer:: setDataProvider
2313
2314
2315
2316
2317/* virtual */
2318bool QgsVectorLayer::writeXml( QDomNode &layer_node,
2319 QDomDocument &document,
2320 const QgsReadWriteContext &context ) const
2321{
2323
2324 // first get the layer element so that we can append the type attribute
2325
2326 QDomElement mapLayerNode = layer_node.toElement();
2327
2328 if ( mapLayerNode.isNull() || ( "maplayer" != mapLayerNode.nodeName() ) )
2329 {
2330 QgsDebugMsgLevel( QStringLiteral( "can't find <maplayer>" ), 2 );
2331 return false;
2332 }
2333
2334 mapLayerNode.setAttribute( QStringLiteral( "type" ), QgsMapLayerFactory::typeToString( Qgis::LayerType::Vector ) );
2335
2336 // set the geometry type
2337 mapLayerNode.setAttribute( QStringLiteral( "geometry" ), QgsWkbTypes::geometryDisplayString( geometryType() ) );
2338 mapLayerNode.setAttribute( QStringLiteral( "wkbType" ), qgsEnumValueToKey( wkbType() ) );
2339
2340 // add provider node
2341 if ( mDataProvider )
2342 {
2343 QDomElement provider = document.createElement( QStringLiteral( "provider" ) );
2344 provider.setAttribute( QStringLiteral( "encoding" ), mDataProvider->encoding() );
2345 QDomText providerText = document.createTextNode( providerType() );
2346 provider.appendChild( providerText );
2347 layer_node.appendChild( provider );
2348 }
2349
2350 //save joins
2351 mJoinBuffer->writeXml( layer_node, document );
2352
2353 // dependencies
2354 QDomElement dependenciesElement = document.createElement( QStringLiteral( "layerDependencies" ) );
2355 const auto constDependencies = dependencies();
2356 for ( const QgsMapLayerDependency &dep : constDependencies )
2357 {
2359 continue;
2360 QDomElement depElem = document.createElement( QStringLiteral( "layer" ) );
2361 depElem.setAttribute( QStringLiteral( "id" ), dep.layerId() );
2362 dependenciesElement.appendChild( depElem );
2363 }
2364 layer_node.appendChild( dependenciesElement );
2365
2366 // change dependencies
2367 QDomElement dataDependenciesElement = document.createElement( QStringLiteral( "dataDependencies" ) );
2368 for ( const QgsMapLayerDependency &dep : constDependencies )
2369 {
2370 if ( dep.type() != QgsMapLayerDependency::DataDependency )
2371 continue;
2372 QDomElement depElem = document.createElement( QStringLiteral( "layer" ) );
2373 depElem.setAttribute( QStringLiteral( "id" ), dep.layerId() );
2374 dataDependenciesElement.appendChild( depElem );
2375 }
2376 layer_node.appendChild( dataDependenciesElement );
2377
2378 // save expression fields
2379 mExpressionFieldBuffer->writeXml( layer_node, document );
2380
2381 writeStyleManager( layer_node, document );
2382
2383 // auxiliary layer
2384 QDomElement asElem = document.createElement( QStringLiteral( "auxiliaryLayer" ) );
2385 if ( mAuxiliaryLayer )
2386 {
2387 const QString pkField = mAuxiliaryLayer->joinInfo().targetFieldName();
2388 asElem.setAttribute( QStringLiteral( "key" ), pkField );
2389 }
2390 layer_node.appendChild( asElem );
2391
2392 // renderer specific settings
2393 QString errorMsg;
2394 return writeSymbology( layer_node, document, errorMsg, context );
2395}
2396
2397QString QgsVectorLayer::encodedSource( const QString &source, const QgsReadWriteContext &context ) const
2398{
2400
2401 if ( providerType() == QLatin1String( "memory" ) )
2402 {
2403 // Refetch the source from the provider, because adding fields actually changes the source for this provider.
2404 return dataProvider()->dataSourceUri();
2405 }
2406
2408}
2409
2410QString QgsVectorLayer::decodedSource( const QString &source, const QString &provider, const QgsReadWriteContext &context ) const
2411{
2413
2414 return QgsProviderRegistry::instance()->relativeToAbsoluteUri( provider, source, context );
2415}
2416
2417
2418
2426
2427
2428bool QgsVectorLayer::readSymbology( const QDomNode &layerNode, QString &errorMessage,
2430{
2432
2433 if ( categories.testFlag( Fields ) )
2434 {
2435 if ( !mExpressionFieldBuffer )
2436 mExpressionFieldBuffer = new QgsExpressionFieldBuffer();
2437 mExpressionFieldBuffer->readXml( layerNode );
2438
2439 updateFields();
2440 }
2441
2442 if ( categories.testFlag( Relations ) )
2443 {
2444 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Relations" ) );
2445
2446 // Restore referenced layers: relations where "this" is the child layer (the referencing part, that holds the FK)
2447 QDomNodeList referencedLayersNodeList = layerNode.toElement().elementsByTagName( QStringLiteral( "referencedLayers" ) );
2448 if ( referencedLayersNodeList.size() > 0 )
2449 {
2450 const QDomNodeList relationNodes { referencedLayersNodeList.at( 0 ).childNodes() };
2451 for ( int i = 0; i < relationNodes.length(); ++i )
2452 {
2453 const QDomElement relationElement = relationNodes.at( i ).toElement();
2454
2455 mWeakRelations.push_back( QgsWeakRelation::readXml( this, QgsWeakRelation::Referencing, relationElement, context.pathResolver() ) );
2456 }
2457 }
2458
2459 // Restore referencing layers: relations where "this" is the parent layer (the referenced part where the FK points to)
2460 QDomNodeList referencingLayersNodeList = layerNode.toElement().elementsByTagName( QStringLiteral( "referencingLayers" ) );
2461 if ( referencingLayersNodeList.size() > 0 )
2462 {
2463 const QDomNodeList relationNodes { referencingLayersNodeList.at( 0 ).childNodes() };
2464 for ( int i = 0; i < relationNodes.length(); ++i )
2465 {
2466 const QDomElement relationElement = relationNodes.at( i ).toElement();
2467 mWeakRelations.push_back( QgsWeakRelation::readXml( this, QgsWeakRelation::Referenced, relationElement, context.pathResolver() ) );
2468 }
2469 }
2470 }
2471
2472 QDomElement layerElement = layerNode.toElement();
2473
2474 readCommonStyle( layerElement, context, categories );
2475
2476 readStyle( layerNode, errorMessage, context, categories );
2477
2478 if ( categories.testFlag( MapTips ) )
2479 {
2480 QDomElement mapTipElem = layerNode.namedItem( QStringLiteral( "mapTip" ) ).toElement();
2481 setMapTipTemplate( mapTipElem.text() );
2482 setMapTipsEnabled( mapTipElem.attribute( QStringLiteral( "enabled" ), QStringLiteral( "1" ) ).toInt() == 1 );
2483 }
2484
2485 if ( categories.testFlag( LayerConfiguration ) )
2486 mDisplayExpression = layerNode.namedItem( QStringLiteral( "previewExpression" ) ).toElement().text();
2487
2488 // Try to migrate pre QGIS 3.0 display field property
2489 QString displayField = layerNode.namedItem( QStringLiteral( "displayfield" ) ).toElement().text();
2490 if ( mFields.lookupField( displayField ) < 0 )
2491 {
2492 // if it's not a field, it's a maptip
2493 if ( mMapTipTemplate.isEmpty() && categories.testFlag( MapTips ) )
2494 mMapTipTemplate = displayField;
2495 }
2496 else
2497 {
2498 if ( mDisplayExpression.isEmpty() && categories.testFlag( LayerConfiguration ) )
2499 mDisplayExpression = QgsExpression::quotedColumnRef( displayField );
2500 }
2501
2502 // process the attribute actions
2503 if ( categories.testFlag( Actions ) )
2504 mActions->readXml( layerNode );
2505
2506 if ( categories.testFlag( Fields ) )
2507 {
2508 // IMPORTANT - we don't clear mAttributeAliasMap here, as it may contain aliases which are coming direct
2509 // from the data provider. Instead we leave any existing aliases and only overwrite them if the style
2510 // has a specific value for that field's alias
2511 QDomNode aliasesNode = layerNode.namedItem( QStringLiteral( "aliases" ) );
2512 if ( !aliasesNode.isNull() )
2513 {
2514 QDomElement aliasElem;
2515
2516 QDomNodeList aliasNodeList = aliasesNode.toElement().elementsByTagName( QStringLiteral( "alias" ) );
2517 for ( int i = 0; i < aliasNodeList.size(); ++i )
2518 {
2519 aliasElem = aliasNodeList.at( i ).toElement();
2520
2521 QString field;
2522 if ( aliasElem.hasAttribute( QStringLiteral( "field" ) ) )
2523 {
2524 field = aliasElem.attribute( QStringLiteral( "field" ) );
2525 }
2526 else
2527 {
2528 int index = aliasElem.attribute( QStringLiteral( "index" ) ).toInt();
2529
2530 if ( index >= 0 && index < fields().count() )
2531 field = fields().at( index ).name();
2532 }
2533
2534 QString alias;
2535
2536 if ( !aliasElem.attribute( QStringLiteral( "name" ) ).isEmpty() )
2537 {
2538 //if it has alias
2539 alias = context.projectTranslator()->translate( QStringLiteral( "project:layers:%1:fieldaliases" ).arg( layerNode.namedItem( QStringLiteral( "id" ) ).toElement().text() ), aliasElem.attribute( QStringLiteral( "name" ) ) );
2540 QgsDebugMsgLevel( "context" + QStringLiteral( "project:layers:%1:fieldaliases" ).arg( layerNode.namedItem( QStringLiteral( "id" ) ).toElement().text() ) + " source " + aliasElem.attribute( QStringLiteral( "name" ) ), 3 );
2541 }
2542 else
2543 {
2544 //if it has no alias, it should be the fields translation
2545 alias = context.projectTranslator()->translate( QStringLiteral( "project:layers:%1:fieldaliases" ).arg( layerNode.namedItem( QStringLiteral( "id" ) ).toElement().text() ), field );
2546 QgsDebugMsgLevel( "context" + QStringLiteral( "project:layers:%1:fieldaliases" ).arg( layerNode.namedItem( QStringLiteral( "id" ) ).toElement().text() ) + " source " + field, 3 );
2547 //if it gets the exact field value, there has been no translation (or not even translation loaded) - so no alias should be generated;
2548 if ( alias == aliasElem.attribute( QStringLiteral( "field" ) ) )
2549 alias.clear();
2550 }
2551
2552 QgsDebugMsgLevel( "field " + field + " origalias " + aliasElem.attribute( QStringLiteral( "name" ) ) + " trans " + alias, 3 );
2553 mAttributeAliasMap.insert( field, alias );
2554 }
2555 }
2556
2557 // IMPORTANT - we don't clear mAttributeSplitPolicy here, as it may contain policies which are coming direct
2558 // from the data provider. Instead we leave any existing policies and only overwrite them if the style
2559 // has a specific value for that field's policy
2560 const QDomNode splitPoliciesNode = layerNode.namedItem( QStringLiteral( "splitPolicies" ) );
2561 if ( !splitPoliciesNode.isNull() )
2562 {
2563 const QDomNodeList splitPolicyNodeList = splitPoliciesNode.toElement().elementsByTagName( QStringLiteral( "policy" ) );
2564 for ( int i = 0; i < splitPolicyNodeList.size(); ++i )
2565 {
2566 const QDomElement splitPolicyElem = splitPolicyNodeList.at( i ).toElement();
2567 const QString field = splitPolicyElem.attribute( QStringLiteral( "field" ) );
2568 const Qgis::FieldDomainSplitPolicy policy = qgsEnumKeyToValue( splitPolicyElem.attribute( QStringLiteral( "policy" ) ), Qgis::FieldDomainSplitPolicy::Duplicate );
2569 mAttributeSplitPolicy.insert( field, policy );
2570 }
2571 }
2572
2573 // The duplicate policy is - unlike alias and split policy - never defined by the data provider, so we clear the map
2574 mAttributeDuplicatePolicy.clear();
2575 const QDomNode duplicatePoliciesNode = layerNode.namedItem( QStringLiteral( "duplicatePolicies" ) );
2576 if ( !duplicatePoliciesNode.isNull() )
2577 {
2578 const QDomNodeList duplicatePolicyNodeList = duplicatePoliciesNode.toElement().elementsByTagName( QStringLiteral( "policy" ) );
2579 for ( int i = 0; i < duplicatePolicyNodeList.size(); ++i )
2580 {
2581 const QDomElement duplicatePolicyElem = duplicatePolicyNodeList.at( i ).toElement();
2582 const QString field = duplicatePolicyElem.attribute( QStringLiteral( "field" ) );
2583 const Qgis::FieldDuplicatePolicy policy = qgsEnumKeyToValue( duplicatePolicyElem.attribute( QStringLiteral( "policy" ) ), Qgis::FieldDuplicatePolicy::Duplicate );
2584 mAttributeDuplicatePolicy.insert( field, policy );
2585 }
2586 }
2587
2588 // default expressions
2589 mDefaultExpressionMap.clear();
2590 QDomNode defaultsNode = layerNode.namedItem( QStringLiteral( "defaults" ) );
2591 if ( !defaultsNode.isNull() )
2592 {
2593 QDomNodeList defaultNodeList = defaultsNode.toElement().elementsByTagName( QStringLiteral( "default" ) );
2594 for ( int i = 0; i < defaultNodeList.size(); ++i )
2595 {
2596 QDomElement defaultElem = defaultNodeList.at( i ).toElement();
2597
2598 QString field = defaultElem.attribute( QStringLiteral( "field" ), QString() );
2599 QString expression = defaultElem.attribute( QStringLiteral( "expression" ), QString() );
2600 bool applyOnUpdate = defaultElem.attribute( QStringLiteral( "applyOnUpdate" ), QStringLiteral( "0" ) ) == QLatin1String( "1" );
2601 if ( field.isEmpty() || expression.isEmpty() )
2602 continue;
2603
2604 mDefaultExpressionMap.insert( field, QgsDefaultValue( expression, applyOnUpdate ) );
2605 }
2606 }
2607
2608 // constraints
2609 mFieldConstraints.clear();
2610 mFieldConstraintStrength.clear();
2611 QDomNode constraintsNode = layerNode.namedItem( QStringLiteral( "constraints" ) );
2612 if ( !constraintsNode.isNull() )
2613 {
2614 QDomNodeList constraintNodeList = constraintsNode.toElement().elementsByTagName( QStringLiteral( "constraint" ) );
2615 for ( int i = 0; i < constraintNodeList.size(); ++i )
2616 {
2617 QDomElement constraintElem = constraintNodeList.at( i ).toElement();
2618
2619 QString field = constraintElem.attribute( QStringLiteral( "field" ), QString() );
2620 int constraints = constraintElem.attribute( QStringLiteral( "constraints" ), QStringLiteral( "0" ) ).toInt();
2621 if ( field.isEmpty() || constraints == 0 )
2622 continue;
2623
2624 mFieldConstraints.insert( field, static_cast< QgsFieldConstraints::Constraints >( constraints ) );
2625
2626 int uniqueStrength = constraintElem.attribute( QStringLiteral( "unique_strength" ), QStringLiteral( "1" ) ).toInt();
2627 int notNullStrength = constraintElem.attribute( QStringLiteral( "notnull_strength" ), QStringLiteral( "1" ) ).toInt();
2628 int expStrength = constraintElem.attribute( QStringLiteral( "exp_strength" ), QStringLiteral( "1" ) ).toInt();
2629
2630 mFieldConstraintStrength.insert( qMakePair( field, QgsFieldConstraints::ConstraintUnique ), static_cast< QgsFieldConstraints::ConstraintStrength >( uniqueStrength ) );
2631 mFieldConstraintStrength.insert( qMakePair( field, QgsFieldConstraints::ConstraintNotNull ), static_cast< QgsFieldConstraints::ConstraintStrength >( notNullStrength ) );
2632 mFieldConstraintStrength.insert( qMakePair( field, QgsFieldConstraints::ConstraintExpression ), static_cast< QgsFieldConstraints::ConstraintStrength >( expStrength ) );
2633 }
2634 }
2635 mFieldConstraintExpressions.clear();
2636 QDomNode constraintExpressionsNode = layerNode.namedItem( QStringLiteral( "constraintExpressions" ) );
2637 if ( !constraintExpressionsNode.isNull() )
2638 {
2639 QDomNodeList constraintNodeList = constraintExpressionsNode.toElement().elementsByTagName( QStringLiteral( "constraint" ) );
2640 for ( int i = 0; i < constraintNodeList.size(); ++i )
2641 {
2642 QDomElement constraintElem = constraintNodeList.at( i ).toElement();
2643
2644 QString field = constraintElem.attribute( QStringLiteral( "field" ), QString() );
2645 QString exp = constraintElem.attribute( QStringLiteral( "exp" ), QString() );
2646 QString desc = constraintElem.attribute( QStringLiteral( "desc" ), QString() );
2647 if ( field.isEmpty() || exp.isEmpty() )
2648 continue;
2649
2650 mFieldConstraintExpressions.insert( field, qMakePair( exp, desc ) );
2651 }
2652 }
2653
2654 updateFields();
2655 }
2656
2657 // load field configuration
2658 if ( categories.testFlag( Fields ) || categories.testFlag( Forms ) )
2659 {
2660 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Forms" ) );
2661
2662 QDomElement widgetsElem = layerNode.namedItem( QStringLiteral( "fieldConfiguration" ) ).toElement();
2663 QDomNodeList fieldConfigurationElementList = widgetsElem.elementsByTagName( QStringLiteral( "field" ) );
2664 for ( int i = 0; i < fieldConfigurationElementList.size(); ++i )
2665 {
2666 const QDomElement fieldConfigElement = fieldConfigurationElementList.at( i ).toElement();
2667 const QDomElement fieldWidgetElement = fieldConfigElement.elementsByTagName( QStringLiteral( "editWidget" ) ).at( 0 ).toElement();
2668
2669 QString fieldName = fieldConfigElement.attribute( QStringLiteral( "name" ) );
2670
2671 if ( categories.testFlag( Fields ) )
2672 mFieldConfigurationFlags[fieldName] = qgsFlagKeysToValue( fieldConfigElement.attribute( QStringLiteral( "configurationFlags" ) ), Qgis::FieldConfigurationFlag::NoFlag );
2673
2674 // load editor widget configuration
2675 if ( categories.testFlag( Forms ) )
2676 {
2677 const QString widgetType = fieldWidgetElement.attribute( QStringLiteral( "type" ) );
2678 const QDomElement cfgElem = fieldConfigElement.elementsByTagName( QStringLiteral( "config" ) ).at( 0 ).toElement();
2679 const QDomElement optionsElem = cfgElem.childNodes().at( 0 ).toElement();
2680 QVariantMap optionsMap = QgsXmlUtils::readVariant( optionsElem ).toMap();
2681 // translate widget configuration strings
2682 if ( widgetType == QStringLiteral( "ValueRelation" ) )
2683 {
2684 optionsMap[ QStringLiteral( "Value" ) ] = context.projectTranslator()->translate( QStringLiteral( "project:layers:%1:fields:%2:valuerelationvalue" ).arg( layerNode.namedItem( QStringLiteral( "id" ) ).toElement().text(), fieldName ), optionsMap[ QStringLiteral( "Value" ) ].toString() );
2685 }
2686 if ( widgetType == QStringLiteral( "ValueMap" ) )
2687 {
2688 if ( optionsMap[ QStringLiteral( "map" ) ].canConvert<QList<QVariant>>() )
2689 {
2690 QList<QVariant> translatedValueList;
2691 const QList<QVariant> valueList = optionsMap[ QStringLiteral( "map" )].toList();
2692 for ( int i = 0, row = 0; i < valueList.count(); i++, row++ )
2693 {
2694 QMap<QString, QVariant> translatedValueMap;
2695 QString translatedKey = context.projectTranslator()->translate( QStringLiteral( "project:layers:%1:fields:%2:valuemapdescriptions" ).arg( layerNode.namedItem( QStringLiteral( "id" ) ).toElement().text(), fieldName ), valueList[i].toMap().constBegin().key() );
2696 translatedValueMap.insert( translatedKey, valueList[i].toMap().constBegin().value() );
2697 translatedValueList.append( translatedValueMap );
2698 }
2699 optionsMap.insert( QStringLiteral( "map" ), translatedValueList );
2700 }
2701 }
2702 QgsEditorWidgetSetup setup = QgsEditorWidgetSetup( widgetType, optionsMap );
2703 mFieldWidgetSetups[fieldName] = setup;
2704 }
2705 }
2706 }
2707
2708 // Legacy reading for QGIS 3.14 and older projects
2709 // Attributes excluded from WMS and WFS
2710 if ( categories.testFlag( Fields ) )
2711 {
2712 const QList<QPair<QString, Qgis::FieldConfigurationFlag>> legacyConfig
2713 {
2714 qMakePair( QStringLiteral( "excludeAttributesWMS" ), Qgis::FieldConfigurationFlag::HideFromWms ),
2715 qMakePair( QStringLiteral( "excludeAttributesWFS" ), Qgis::FieldConfigurationFlag::HideFromWfs )
2716 };
2717 for ( const auto &config : legacyConfig )
2718 {
2719 QDomNode excludeNode = layerNode.namedItem( config.first );
2720 if ( !excludeNode.isNull() )
2721 {
2722 QDomNodeList attributeNodeList = excludeNode.toElement().elementsByTagName( QStringLiteral( "attribute" ) );
2723 for ( int i = 0; i < attributeNodeList.size(); ++i )
2724 {
2725 QString fieldName = attributeNodeList.at( i ).toElement().text();
2726 if ( !mFieldConfigurationFlags.contains( fieldName ) )
2727 mFieldConfigurationFlags[fieldName] = config.second;
2728 else
2729 mFieldConfigurationFlags[fieldName].setFlag( config.second, true );
2730 }
2731 }
2732 }
2733 }
2734
2735 if ( categories.testFlag( GeometryOptions ) )
2736 mGeometryOptions->readXml( layerNode.namedItem( QStringLiteral( "geometryOptions" ) ) );
2737
2738 if ( categories.testFlag( Forms ) )
2739 mEditFormConfig.readXml( layerNode, context );
2740
2741 if ( categories.testFlag( AttributeTable ) )
2742 {
2743 mAttributeTableConfig.readXml( layerNode );
2744 mConditionalStyles->readXml( layerNode, context );
2745 mStoredExpressionManager->readXml( layerNode );
2746 }
2747
2748 if ( categories.testFlag( CustomProperties ) )
2749 readCustomProperties( layerNode, QStringLiteral( "variable" ) );
2750
2751 QDomElement mapLayerNode = layerNode.toElement();
2752 if ( categories.testFlag( LayerConfiguration )
2753 && mapLayerNode.attribute( QStringLiteral( "readOnly" ), QStringLiteral( "0" ) ).toInt() == 1 )
2754 mReadOnly = true;
2755
2756 updateFields();
2757
2758 if ( categories.testFlag( Legend ) )
2759 {
2760 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Legend" ) );
2761
2762 const QDomElement legendElem = layerNode.firstChildElement( QStringLiteral( "legend" ) );
2763 if ( !legendElem.isNull() )
2764 {
2765 std::unique_ptr< QgsMapLayerLegend > legend( QgsMapLayerLegend::defaultVectorLegend( this ) );
2766 legend->readXml( legendElem, context );
2767 setLegend( legend.release() );
2768 mSetLegendFromStyle = true;
2769 }
2770 }
2771
2772 return true;
2773}
2774
2775bool QgsVectorLayer::readStyle( const QDomNode &node, QString &errorMessage,
2777{
2779
2780 bool result = true;
2781 emit readCustomSymbology( node.toElement(), errorMessage );
2782
2783 // we must try to restore a renderer if our geometry type is unknown
2784 // as this allows the renderer to be correctly restored even for layers
2785 // with broken sources
2786 if ( isSpatial() || mWkbType == Qgis::WkbType::Unknown )
2787 {
2788 // defer style changed signal until we've set the renderer, labeling, everything.
2789 // we don't want multiple signals!
2790 ScopedIntIncrementor styleChangedSignalBlocker( &mBlockStyleChangedSignal );
2791
2792 // try renderer v2 first
2793 if ( categories.testFlag( Symbology ) )
2794 {
2795 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Symbology" ) );
2796
2797 QDomElement rendererElement = node.firstChildElement( RENDERER_TAG_NAME );
2798 if ( !rendererElement.isNull() )
2799 {
2800 QgsFeatureRenderer *r = QgsFeatureRenderer::load( rendererElement, context );
2801 if ( r )
2802 {
2803 setRenderer( r );
2804 }
2805 else
2806 {
2807 result = false;
2808 }
2809 }
2810 // make sure layer has a renderer - if none exists, fallback to a default renderer
2811 if ( isSpatial() && !renderer() )
2812 {
2814 }
2815
2816 if ( mSelectionProperties )
2817 mSelectionProperties->readXml( node.toElement(), context );
2818 }
2819
2820 // read labeling definition
2821 if ( categories.testFlag( Labeling ) )
2822 {
2823 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Labeling" ) );
2824
2825 QDomElement labelingElement = node.firstChildElement( QStringLiteral( "labeling" ) );
2827 if ( labelingElement.isNull() ||
2828 ( labelingElement.attribute( QStringLiteral( "type" ) ) == QLatin1String( "simple" ) && labelingElement.firstChildElement( QStringLiteral( "settings" ) ).isNull() ) )
2829 {
2830 // make sure we have custom properties for labeling for 2.x projects
2831 // (custom properties should be already loaded when reading the whole layer from XML,
2832 // but when reading style, custom properties are not read)
2833 readCustomProperties( node, QStringLiteral( "labeling" ) );
2834
2835 // support for pre-QGIS 3 labeling configurations written in custom properties
2836 labeling = readLabelingFromCustomProperties();
2837 }
2838 else
2839 {
2840 labeling = QgsAbstractVectorLayerLabeling::create( labelingElement, context );
2841 }
2843
2844 if ( node.toElement().hasAttribute( QStringLiteral( "labelsEnabled" ) ) )
2845 mLabelsEnabled = node.toElement().attribute( QStringLiteral( "labelsEnabled" ) ).toInt();
2846 else
2847 mLabelsEnabled = true;
2848 }
2849
2850 if ( categories.testFlag( Symbology ) )
2851 {
2852 // get and set the blend mode if it exists
2853 QDomNode blendModeNode = node.namedItem( QStringLiteral( "blendMode" ) );
2854 if ( !blendModeNode.isNull() )
2855 {
2856 QDomElement e = blendModeNode.toElement();
2857 setBlendMode( QgsPainting::getCompositionMode( static_cast< Qgis::BlendMode >( e.text().toInt() ) ) );
2858 }
2859
2860 // get and set the feature blend mode if it exists
2861 QDomNode featureBlendModeNode = node.namedItem( QStringLiteral( "featureBlendMode" ) );
2862 if ( !featureBlendModeNode.isNull() )
2863 {
2864 QDomElement e = featureBlendModeNode.toElement();
2865 setFeatureBlendMode( QgsPainting::getCompositionMode( static_cast< Qgis::BlendMode >( e.text().toInt() ) ) );
2866 }
2867 }
2868
2869 // get and set the layer transparency and scale visibility if they exists
2870 if ( categories.testFlag( Rendering ) )
2871 {
2872 QDomNode layerTransparencyNode = node.namedItem( QStringLiteral( "layerTransparency" ) );
2873 if ( !layerTransparencyNode.isNull() )
2874 {
2875 QDomElement e = layerTransparencyNode.toElement();
2876 setOpacity( 1.0 - e.text().toInt() / 100.0 );
2877 }
2878 QDomNode layerOpacityNode = node.namedItem( QStringLiteral( "layerOpacity" ) );
2879 if ( !layerOpacityNode.isNull() )
2880 {
2881 QDomElement e = layerOpacityNode.toElement();
2882 setOpacity( e.text().toDouble() );
2883 }
2884
2885 const bool hasScaleBasedVisibiliy { node.attributes().namedItem( QStringLiteral( "hasScaleBasedVisibilityFlag" ) ).nodeValue() == '1' };
2886 setScaleBasedVisibility( hasScaleBasedVisibiliy );
2887 bool ok;
2888 const double maxScale { node.attributes().namedItem( QStringLiteral( "maxScale" ) ).nodeValue().toDouble( &ok ) };
2889 if ( ok )
2890 {
2891 setMaximumScale( maxScale );
2892 }
2893 const double minScale { node.attributes().namedItem( QStringLiteral( "minScale" ) ).nodeValue().toDouble( &ok ) };
2894 if ( ok )
2895 {
2896 setMinimumScale( minScale );
2897 }
2898
2899 QDomElement e = node.toElement();
2900
2901 // get the simplification drawing settings
2902 mSimplifyMethod.setSimplifyHints( static_cast< Qgis::VectorRenderingSimplificationFlags >( e.attribute( QStringLiteral( "simplifyDrawingHints" ), QStringLiteral( "1" ) ).toInt() ) );
2903 mSimplifyMethod.setSimplifyAlgorithm( static_cast< Qgis::VectorSimplificationAlgorithm >( e.attribute( QStringLiteral( "simplifyAlgorithm" ), QStringLiteral( "0" ) ).toInt() ) );
2904 mSimplifyMethod.setThreshold( e.attribute( QStringLiteral( "simplifyDrawingTol" ), QStringLiteral( "1" ) ).toFloat() );
2905 mSimplifyMethod.setForceLocalOptimization( e.attribute( QStringLiteral( "simplifyLocal" ), QStringLiteral( "1" ) ).toInt() );
2906 mSimplifyMethod.setMaximumScale( e.attribute( QStringLiteral( "simplifyMaxScale" ), QStringLiteral( "1" ) ).toFloat() );
2907
2908 if ( mRenderer )
2909 mRenderer->setReferenceScale( e.attribute( QStringLiteral( "symbologyReferenceScale" ), QStringLiteral( "-1" ) ).toDouble() );
2910 }
2911
2912 //diagram renderer and diagram layer settings
2913 if ( categories.testFlag( Diagrams ) )
2914 {
2915 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Diagrams" ) );
2916
2917 delete mDiagramRenderer;
2918 mDiagramRenderer = nullptr;
2919 QDomElement singleCatDiagramElem = node.firstChildElement( QStringLiteral( "SingleCategoryDiagramRenderer" ) );
2920 if ( !singleCatDiagramElem.isNull() )
2921 {
2922 mDiagramRenderer = new QgsSingleCategoryDiagramRenderer();
2923 mDiagramRenderer->readXml( singleCatDiagramElem, context );
2924 }
2925 QDomElement linearDiagramElem = node.firstChildElement( QStringLiteral( "LinearlyInterpolatedDiagramRenderer" ) );
2926 if ( !linearDiagramElem.isNull() )
2927 {
2928 if ( linearDiagramElem.hasAttribute( QStringLiteral( "classificationAttribute" ) ) )
2929 {
2930 // fix project from before QGIS 3.0
2931 int idx = linearDiagramElem.attribute( QStringLiteral( "classificationAttribute" ) ).toInt();
2932 if ( idx >= 0 && idx < mFields.count() )
2933 linearDiagramElem.setAttribute( QStringLiteral( "classificationField" ), mFields.at( idx ).name() );
2934 }
2935
2936 mDiagramRenderer = new QgsLinearlyInterpolatedDiagramRenderer();
2937 mDiagramRenderer->readXml( linearDiagramElem, context );
2938 }
2939 QDomElement stackedDiagramElem = node.firstChildElement( QStringLiteral( "StackedDiagramRenderer" ) );
2940 if ( !stackedDiagramElem.isNull() )
2941 {
2942 mDiagramRenderer = new QgsStackedDiagramRenderer();
2943 mDiagramRenderer->readXml( stackedDiagramElem, context );
2944 }
2945
2946 if ( mDiagramRenderer )
2947 {
2948 QDomElement diagramSettingsElem = node.firstChildElement( QStringLiteral( "DiagramLayerSettings" ) );
2949 if ( !diagramSettingsElem.isNull() )
2950 {
2951 bool oldXPos = diagramSettingsElem.hasAttribute( QStringLiteral( "xPosColumn" ) );
2952 bool oldYPos = diagramSettingsElem.hasAttribute( QStringLiteral( "yPosColumn" ) );
2953 bool oldShow = diagramSettingsElem.hasAttribute( QStringLiteral( "showColumn" ) );
2954 if ( oldXPos || oldYPos || oldShow )
2955 {
2956 // fix project from before QGIS 3.0
2958 if ( oldXPos )
2959 {
2960 int xPosColumn = diagramSettingsElem.attribute( QStringLiteral( "xPosColumn" ) ).toInt();
2961 if ( xPosColumn >= 0 && xPosColumn < mFields.count() )
2963 }
2964 if ( oldYPos )
2965 {
2966 int yPosColumn = diagramSettingsElem.attribute( QStringLiteral( "yPosColumn" ) ).toInt();
2967 if ( yPosColumn >= 0 && yPosColumn < mFields.count() )
2969 }
2970 if ( oldShow )
2971 {
2972 int showColumn = diagramSettingsElem.attribute( QStringLiteral( "showColumn" ) ).toInt();
2973 if ( showColumn >= 0 && showColumn < mFields.count() )
2974 ddp.setProperty( QgsDiagramLayerSettings::Property::Show, QgsProperty::fromField( mFields.at( showColumn ).name(), true ) );
2975 }
2976 QDomElement propertiesElem = diagramSettingsElem.ownerDocument().createElement( QStringLiteral( "properties" ) );
2978 {
2979 { static_cast< int >( QgsDiagramLayerSettings::Property::PositionX ), QgsPropertyDefinition( "positionX", QObject::tr( "Position (X)" ), QgsPropertyDefinition::Double ) },
2980 { static_cast< int >( QgsDiagramLayerSettings::Property::PositionY ), QgsPropertyDefinition( "positionY", QObject::tr( "Position (Y)" ), QgsPropertyDefinition::Double ) },
2981 { static_cast< int >( QgsDiagramLayerSettings::Property::Show ), QgsPropertyDefinition( "show", QObject::tr( "Show diagram" ), QgsPropertyDefinition::Boolean ) },
2982 };
2983 ddp.writeXml( propertiesElem, defs );
2984 diagramSettingsElem.appendChild( propertiesElem );
2985 }
2986
2987 delete mDiagramLayerSettings;
2988 mDiagramLayerSettings = new QgsDiagramLayerSettings();
2989 mDiagramLayerSettings->readXml( diagramSettingsElem );
2990 }
2991 }
2992 }
2993 // end diagram
2994
2995 styleChangedSignalBlocker.release();
2997 }
2998 return result;
2999}
3000
3001
3002bool QgsVectorLayer::writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage,
3003 const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories ) const
3004{
3006
3007 QDomElement layerElement = node.toElement();
3008 writeCommonStyle( layerElement, doc, context, categories );
3009
3010 ( void )writeStyle( node, doc, errorMessage, context, categories );
3011
3012 if ( categories.testFlag( GeometryOptions ) )
3013 mGeometryOptions->writeXml( node );
3014
3015 if ( categories.testFlag( Legend ) && legend() )
3016 {
3017 QDomElement legendElement = legend()->writeXml( doc, context );
3018 if ( !legendElement.isNull() )
3019 node.appendChild( legendElement );
3020 }
3021
3022 // Relation information for both referenced and referencing sides
3023 if ( categories.testFlag( Relations ) )
3024 {
3025 if ( QgsProject *p = project() )
3026 {
3027 // Store referenced layers: relations where "this" is the child layer (the referencing part, that holds the FK)
3028 QDomElement referencedLayersElement = doc.createElement( QStringLiteral( "referencedLayers" ) );
3029 node.appendChild( referencedLayersElement );
3030
3031 const QList<QgsRelation> referencingRelations { p->relationManager()->referencingRelations( this ) };
3032 for ( const QgsRelation &rel : referencingRelations )
3033 {
3034 switch ( rel.type() )
3035 {
3037 QgsWeakRelation::writeXml( this, QgsWeakRelation::Referencing, rel, referencedLayersElement, doc );
3038 break;
3040 break;
3041 }
3042 }
3043
3044 // Store referencing layers: relations where "this" is the parent layer (the referenced part, that holds the FK)
3045 QDomElement referencingLayersElement = doc.createElement( QStringLiteral( "referencingLayers" ) );
3046 node.appendChild( referencedLayersElement );
3047
3048 const QList<QgsRelation> referencedRelations { p->relationManager()->referencedRelations( this ) };
3049 for ( const QgsRelation &rel : referencedRelations )
3050 {
3051 switch ( rel.type() )
3052 {
3054 QgsWeakRelation::writeXml( this, QgsWeakRelation::Referenced, rel, referencingLayersElement, doc );
3055 break;
3057 break;
3058 }
3059 }
3060 }
3061 }
3062
3063 // write field configurations
3064 if ( categories.testFlag( Fields ) || categories.testFlag( Forms ) )
3065 {
3066 QDomElement fieldConfigurationElement;
3067 // field configuration flag
3068 fieldConfigurationElement = doc.createElement( QStringLiteral( "fieldConfiguration" ) );
3069 node.appendChild( fieldConfigurationElement );
3070
3071 for ( const QgsField &field : std::as_const( mFields ) )
3072 {
3073 QDomElement fieldElement = doc.createElement( QStringLiteral( "field" ) );
3074 fieldElement.setAttribute( QStringLiteral( "name" ), field.name() );
3075 fieldConfigurationElement.appendChild( fieldElement );
3076
3077 if ( categories.testFlag( Fields ) )
3078 {
3079 fieldElement.setAttribute( QStringLiteral( "configurationFlags" ), qgsFlagValueToKeys( field.configurationFlags() ) );
3080 }
3081
3082 if ( categories.testFlag( Forms ) )
3083 {
3084 QgsEditorWidgetSetup widgetSetup = field.editorWidgetSetup();
3085
3086 // TODO : wrap this part in an if to only save if it was user-modified
3087 QDomElement editWidgetElement = doc.createElement( QStringLiteral( "editWidget" ) );
3088 fieldElement.appendChild( editWidgetElement );
3089 editWidgetElement.setAttribute( QStringLiteral( "type" ), field.editorWidgetSetup().type() );
3090 QDomElement editWidgetConfigElement = doc.createElement( QStringLiteral( "config" ) );
3091
3092 editWidgetConfigElement.appendChild( QgsXmlUtils::writeVariant( widgetSetup.config(), doc ) );
3093 editWidgetElement.appendChild( editWidgetConfigElement );
3094 // END TODO : wrap this part in an if to only save if it was user-modified
3095 }
3096 }
3097 }
3098
3099 if ( categories.testFlag( Fields ) )
3100 {
3101 //attribute aliases
3102 QDomElement aliasElem = doc.createElement( QStringLiteral( "aliases" ) );
3103 for ( const QgsField &field : std::as_const( mFields ) )
3104 {
3105 QDomElement aliasEntryElem = doc.createElement( QStringLiteral( "alias" ) );
3106 aliasEntryElem.setAttribute( QStringLiteral( "field" ), field.name() );
3107 aliasEntryElem.setAttribute( QStringLiteral( "index" ), mFields.indexFromName( field.name() ) );
3108 aliasEntryElem.setAttribute( QStringLiteral( "name" ), field.alias() );
3109 aliasElem.appendChild( aliasEntryElem );
3110 }
3111 node.appendChild( aliasElem );
3112
3113 //split policies
3114 {
3115 QDomElement splitPoliciesElement = doc.createElement( QStringLiteral( "splitPolicies" ) );
3116 for ( const QgsField &field : std::as_const( mFields ) )
3117 {
3118 QDomElement splitPolicyElem = doc.createElement( QStringLiteral( "policy" ) );
3119 splitPolicyElem.setAttribute( QStringLiteral( "field" ), field.name() );
3120 splitPolicyElem.setAttribute( QStringLiteral( "policy" ), qgsEnumValueToKey( field.splitPolicy() ) );
3121 splitPoliciesElement.appendChild( splitPolicyElem );
3122 }
3123 node.appendChild( splitPoliciesElement );
3124 }
3125
3126 //duplicate policies
3127 {
3128 QDomElement duplicatePoliciesElement = doc.createElement( QStringLiteral( "duplicatePolicies" ) );
3129 for ( const QgsField &field : std::as_const( mFields ) )
3130 {
3131 QDomElement duplicatePolicyElem = doc.createElement( QStringLiteral( "policy" ) );
3132 duplicatePolicyElem.setAttribute( QStringLiteral( "field" ), field.name() );
3133 duplicatePolicyElem.setAttribute( QStringLiteral( "policy" ), qgsEnumValueToKey( field.duplicatePolicy() ) );
3134 duplicatePoliciesElement.appendChild( duplicatePolicyElem );
3135 }
3136 node.appendChild( duplicatePoliciesElement );
3137 }
3138
3139 //default expressions
3140 QDomElement defaultsElem = doc.createElement( QStringLiteral( "defaults" ) );
3141 for ( const QgsField &field : std::as_const( mFields ) )
3142 {
3143 QDomElement defaultElem = doc.createElement( QStringLiteral( "default" ) );
3144 defaultElem.setAttribute( QStringLiteral( "field" ), field.name() );
3145 defaultElem.setAttribute( QStringLiteral( "expression" ), field.defaultValueDefinition().expression() );
3146 defaultElem.setAttribute( QStringLiteral( "applyOnUpdate" ), field.defaultValueDefinition().applyOnUpdate() ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
3147 defaultsElem.appendChild( defaultElem );
3148 }
3149 node.appendChild( defaultsElem );
3150
3151 // constraints
3152 QDomElement constraintsElem = doc.createElement( QStringLiteral( "constraints" ) );
3153 for ( const QgsField &field : std::as_const( mFields ) )
3154 {
3155 QDomElement constraintElem = doc.createElement( QStringLiteral( "constraint" ) );
3156 constraintElem.setAttribute( QStringLiteral( "field" ), field.name() );
3157 constraintElem.setAttribute( QStringLiteral( "constraints" ), field.constraints().constraints() );
3158 constraintElem.setAttribute( QStringLiteral( "unique_strength" ), field.constraints().constraintStrength( QgsFieldConstraints::ConstraintUnique ) );
3159 constraintElem.setAttribute( QStringLiteral( "notnull_strength" ), field.constraints().constraintStrength( QgsFieldConstraints::ConstraintNotNull ) );
3160 constraintElem.setAttribute( QStringLiteral( "exp_strength" ), field.constraints().constraintStrength( QgsFieldConstraints::ConstraintExpression ) );
3161
3162 constraintsElem.appendChild( constraintElem );
3163 }
3164 node.appendChild( constraintsElem );
3165
3166 // constraint expressions
3167 QDomElement constraintExpressionsElem = doc.createElement( QStringLiteral( "constraintExpressions" ) );
3168 for ( const QgsField &field : std::as_const( mFields ) )
3169 {
3170 QDomElement constraintExpressionElem = doc.createElement( QStringLiteral( "constraint" ) );
3171 constraintExpressionElem.setAttribute( QStringLiteral( "field" ), field.name() );
3172 constraintExpressionElem.setAttribute( QStringLiteral( "exp" ), field.constraints().constraintExpression() );
3173 constraintExpressionElem.setAttribute( QStringLiteral( "desc" ), field.constraints().constraintDescription() );
3174 constraintExpressionsElem.appendChild( constraintExpressionElem );
3175 }
3176 node.appendChild( constraintExpressionsElem );
3177
3178 // save expression fields
3179 if ( !mExpressionFieldBuffer )
3180 {
3181 // can happen when saving style on a invalid layer
3183 dummy.writeXml( node, doc );
3184 }
3185 else
3186 {
3187 mExpressionFieldBuffer->writeXml( node, doc );
3188 }
3189 }
3190
3191 // add attribute actions
3192 if ( categories.testFlag( Actions ) )
3193 mActions->writeXml( node );
3194
3195 if ( categories.testFlag( AttributeTable ) )
3196 {
3197 mAttributeTableConfig.writeXml( node );
3198 mConditionalStyles->writeXml( node, doc, context );
3199 mStoredExpressionManager->writeXml( node );
3200 }
3201
3202 if ( categories.testFlag( Forms ) )
3203 mEditFormConfig.writeXml( node, context );
3204
3205 // save readonly state
3206 if ( categories.testFlag( LayerConfiguration ) )
3207 node.toElement().setAttribute( QStringLiteral( "readOnly" ), mReadOnly );
3208
3209 // save preview expression
3210 if ( categories.testFlag( LayerConfiguration ) )
3211 {
3212 QDomElement prevExpElem = doc.createElement( QStringLiteral( "previewExpression" ) );
3213 QDomText prevExpText = doc.createTextNode( mDisplayExpression );
3214 prevExpElem.appendChild( prevExpText );
3215 node.appendChild( prevExpElem );
3216 }
3217
3218 // save map tip
3219 if ( categories.testFlag( MapTips ) )
3220 {
3221 QDomElement mapTipElem = doc.createElement( QStringLiteral( "mapTip" ) );
3222 mapTipElem.setAttribute( QStringLiteral( "enabled" ), mapTipsEnabled() );
3223 QDomText mapTipText = doc.createTextNode( mMapTipTemplate );
3224 mapTipElem.appendChild( mapTipText );
3225 node.toElement().appendChild( mapTipElem );
3226 }
3227
3228 return true;
3229}
3230
3231bool QgsVectorLayer::writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage,
3232 const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories ) const
3233{
3235
3236 QDomElement mapLayerNode = node.toElement();
3237
3238 emit writeCustomSymbology( mapLayerNode, doc, errorMessage );
3239
3240 // we must try to write the renderer if our geometry type is unknown
3241 // as this allows the renderer to be correctly restored even for layers
3242 // with broken sources
3243 if ( isSpatial() || mWkbType == Qgis::WkbType::Unknown )
3244 {
3245 if ( categories.testFlag( Symbology ) )
3246 {
3247 if ( mRenderer )
3248 {
3249 QDomElement rendererElement = mRenderer->save( doc, context );
3250 node.appendChild( rendererElement );
3251 }
3252 if ( mSelectionProperties )
3253 {
3254 mSelectionProperties->writeXml( mapLayerNode, doc, context );
3255 }
3256 }
3257
3258 if ( categories.testFlag( Labeling ) )
3259 {
3260 if ( mLabeling )
3261 {
3262 QDomElement labelingElement = mLabeling->save( doc, context );
3263 node.appendChild( labelingElement );
3264 }
3265 mapLayerNode.setAttribute( QStringLiteral( "labelsEnabled" ), mLabelsEnabled ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
3266 }
3267
3268 // save the simplification drawing settings
3269 if ( categories.testFlag( Rendering ) )
3270 {
3271 mapLayerNode.setAttribute( QStringLiteral( "simplifyDrawingHints" ), QString::number( static_cast< int >( mSimplifyMethod.simplifyHints() ) ) );
3272 mapLayerNode.setAttribute( QStringLiteral( "simplifyAlgorithm" ), QString::number( static_cast< int >( mSimplifyMethod.simplifyAlgorithm() ) ) );
3273 mapLayerNode.setAttribute( QStringLiteral( "simplifyDrawingTol" ), QString::number( mSimplifyMethod.threshold() ) );
3274 mapLayerNode.setAttribute( QStringLiteral( "simplifyLocal" ), mSimplifyMethod.forceLocalOptimization() ? 1 : 0 );
3275 mapLayerNode.setAttribute( QStringLiteral( "simplifyMaxScale" ), QString::number( mSimplifyMethod.maximumScale() ) );
3276 }
3277
3278 //save customproperties
3279 if ( categories.testFlag( CustomProperties ) )
3280 {
3281 writeCustomProperties( node, doc );
3282 }
3283
3284 if ( categories.testFlag( Symbology ) )
3285 {
3286 // add the blend mode field
3287 QDomElement blendModeElem = doc.createElement( QStringLiteral( "blendMode" ) );
3288 QDomText blendModeText = doc.createTextNode( QString::number( static_cast< int >( QgsPainting::getBlendModeEnum( blendMode() ) ) ) );
3289 blendModeElem.appendChild( blendModeText );
3290 node.appendChild( blendModeElem );
3291
3292 // add the feature blend mode field
3293 QDomElement featureBlendModeElem = doc.createElement( QStringLiteral( "featureBlendMode" ) );
3294 QDomText featureBlendModeText = doc.createTextNode( QString::number( static_cast< int >( QgsPainting::getBlendModeEnum( featureBlendMode() ) ) ) );
3295 featureBlendModeElem.appendChild( featureBlendModeText );
3296 node.appendChild( featureBlendModeElem );
3297 }
3298
3299 // add the layer opacity and scale visibility
3300 if ( categories.testFlag( Rendering ) )
3301 {
3302 QDomElement layerOpacityElem = doc.createElement( QStringLiteral( "layerOpacity" ) );
3303 QDomText layerOpacityText = doc.createTextNode( QString::number( opacity() ) );
3304 layerOpacityElem.appendChild( layerOpacityText );
3305 node.appendChild( layerOpacityElem );
3306 mapLayerNode.setAttribute( QStringLiteral( "hasScaleBasedVisibilityFlag" ), hasScaleBasedVisibility() ? 1 : 0 );
3307 mapLayerNode.setAttribute( QStringLiteral( "maxScale" ), maximumScale() );
3308 mapLayerNode.setAttribute( QStringLiteral( "minScale" ), minimumScale() );
3309
3310 mapLayerNode.setAttribute( QStringLiteral( "symbologyReferenceScale" ), mRenderer ? mRenderer->referenceScale() : -1 );
3311 }
3312
3313 if ( categories.testFlag( Diagrams ) && mDiagramRenderer )
3314 {
3315 mDiagramRenderer->writeXml( mapLayerNode, doc, context );
3316 if ( mDiagramLayerSettings )
3317 mDiagramLayerSettings->writeXml( mapLayerNode, doc );
3318 }
3319 }
3320 return true;
3321}
3322
3323bool QgsVectorLayer::readSld( const QDomNode &node, QString &errorMessage )
3324{
3326
3327 // get the Name element
3328 QDomElement nameElem = node.firstChildElement( QStringLiteral( "Name" ) );
3329 if ( nameElem.isNull() )
3330 {
3331 errorMessage = QStringLiteral( "Warning: Name element not found within NamedLayer while it's required." );
3332 }
3333
3334 if ( isSpatial() )
3335 {
3336 QgsFeatureRenderer *r = QgsFeatureRenderer::loadSld( node, geometryType(), errorMessage );
3337 if ( !r )
3338 return false;
3339
3340 // defer style changed signal until we've set the renderer, labeling, everything.
3341 // we don't want multiple signals!
3342 ScopedIntIncrementor styleChangedSignalBlocker( &mBlockStyleChangedSignal );
3343
3344 setRenderer( r );
3345
3346 // labeling
3347 readSldLabeling( node );
3348
3349 styleChangedSignalBlocker.release();
3351 }
3352 return true;
3353}
3354
3355bool QgsVectorLayer::writeSld( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QVariantMap &props ) const
3356{
3358
3359 Q_UNUSED( errorMessage )
3360
3361 QVariantMap localProps = QVariantMap( props );
3363 {
3365 }
3366
3367 if ( isSpatial() )
3368 {
3369 // store the Name element
3370 QDomElement nameNode = doc.createElement( QStringLiteral( "se:Name" ) );
3371 nameNode.appendChild( doc.createTextNode( name() ) );
3372 node.appendChild( nameNode );
3373
3374 QDomElement userStyleElem = doc.createElement( QStringLiteral( "UserStyle" ) );
3375 node.appendChild( userStyleElem );
3376
3377 QDomElement nameElem = doc.createElement( QStringLiteral( "se:Name" ) );
3378 nameElem.appendChild( doc.createTextNode( name() ) );
3379
3380 userStyleElem.appendChild( nameElem );
3381
3382 QDomElement featureTypeStyleElem = doc.createElement( QStringLiteral( "se:FeatureTypeStyle" ) );
3383 userStyleElem.appendChild( featureTypeStyleElem );
3384
3385 mRenderer->toSld( doc, featureTypeStyleElem, localProps );
3386 if ( labelsEnabled() )
3387 {
3388 mLabeling->toSld( featureTypeStyleElem, localProps );
3389 }
3390 }
3391 return true;
3392}
3393
3394
3395bool QgsVectorLayer::changeGeometry( QgsFeatureId fid, QgsGeometry &geom, bool skipDefaultValue )
3396{
3398
3399 if ( !mEditBuffer || !mDataProvider )
3400 {
3401 return false;
3402 }
3403
3404 if ( mGeometryOptions->isActive() )
3405 mGeometryOptions->apply( geom );
3406
3407 updateExtents();
3408
3409 bool result = mEditBuffer->changeGeometry( fid, geom );
3410
3411 if ( result )
3412 {
3413 updateExtents();
3414 if ( !skipDefaultValue && !mDefaultValueOnUpdateFields.isEmpty() )
3415 updateDefaultValues( fid );
3416 }
3417 return result;
3418}
3419
3420
3421bool QgsVectorLayer::changeAttributeValue( QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue, bool skipDefaultValues, QgsVectorLayerToolsContext *context )
3422{
3424
3425 bool result = false;
3426
3427 switch ( fields().fieldOrigin( field ) )
3428 {
3430 result = mJoinBuffer->changeAttributeValue( fid, field, newValue, oldValue );
3431 if ( result )
3432 emit attributeValueChanged( fid, field, newValue );
3433 break;
3434
3438 {
3439 if ( mEditBuffer && mDataProvider )
3440 result = mEditBuffer->changeAttributeValue( fid, field, newValue, oldValue );
3441 break;
3442 }
3443
3445 break;
3446 }
3447
3448 if ( result && !skipDefaultValues && !mDefaultValueOnUpdateFields.isEmpty() )
3449 updateDefaultValues( fid, QgsFeature(), context ? context->expressionContext() : nullptr );
3450
3451 return result;
3452}
3453
3454bool QgsVectorLayer::changeAttributeValues( QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues, bool skipDefaultValues, QgsVectorLayerToolsContext *context )
3455{
3457
3458 bool result = true;
3459
3460 QgsAttributeMap newValuesJoin;
3461 QgsAttributeMap oldValuesJoin;
3462
3463 QgsAttributeMap newValuesNotJoin;
3464 QgsAttributeMap oldValuesNotJoin;
3465
3466 for ( auto it = newValues.constBegin(); it != newValues.constEnd(); ++it )
3467 {
3468 const int field = it.key();
3469 const QVariant newValue = it.value();
3470 QVariant oldValue;
3471
3472 if ( oldValues.contains( field ) )
3473 oldValue = oldValues[field];
3474
3475 switch ( fields().fieldOrigin( field ) )
3476 {
3478 newValuesJoin[field] = newValue;
3479 oldValuesJoin[field] = oldValue;
3480 break;
3481
3485 {
3486 newValuesNotJoin[field] = newValue;
3487 oldValuesNotJoin[field] = oldValue;
3488 break;
3489 }
3490
3492 break;
3493 }
3494 }
3495
3496 if ( ! newValuesJoin.isEmpty() && mJoinBuffer )
3497 {
3498 result = mJoinBuffer->changeAttributeValues( fid, newValuesJoin, oldValuesJoin );
3499 }
3500
3501 if ( ! newValuesNotJoin.isEmpty() )
3502 {
3503 if ( mEditBuffer && mDataProvider )
3504 result &= mEditBuffer->changeAttributeValues( fid, newValuesNotJoin, oldValues );
3505 else
3506 result = false;
3507 }
3508
3509 if ( result && !skipDefaultValues && !mDefaultValueOnUpdateFields.isEmpty() )
3510 {
3511 updateDefaultValues( fid, QgsFeature(), context ? context->expressionContext() : nullptr );
3512 }
3513
3514 return result;
3515}
3516
3518{
3520
3521 if ( !mEditBuffer || !mDataProvider )
3522 return false;
3523
3524 return mEditBuffer->addAttribute( field );
3525}
3526
3528{
3530
3531 if ( attIndex < 0 || attIndex >= fields().count() )
3532 return;
3533
3534 QString name = fields().at( attIndex ).name();
3535 mFields[ attIndex ].setAlias( QString() );
3536 if ( mAttributeAliasMap.contains( name ) )
3537 {
3538 mAttributeAliasMap.remove( name );
3539 updateFields();
3540 mEditFormConfig.setFields( mFields );
3541 emit layerModified();
3542 }
3543}
3544
3545bool QgsVectorLayer::renameAttribute( int index, const QString &newName )
3546{
3548
3549 if ( index < 0 || index >= fields().count() )
3550 return false;
3551
3552 switch ( mFields.fieldOrigin( index ) )
3553 {
3555 {
3556 if ( mExpressionFieldBuffer )
3557 {
3558 int oi = mFields.fieldOriginIndex( index );
3559 mExpressionFieldBuffer->renameExpression( oi, newName );
3560 updateFields();
3561 return true;
3562 }
3563 else
3564 {
3565 return false;
3566 }
3567 }
3568
3571
3572 if ( !mEditBuffer || !mDataProvider )
3573 return false;
3574
3575 return mEditBuffer->renameAttribute( index, newName );
3576
3579 return false;
3580
3581 }
3582
3583 return false; // avoid warning
3584}
3585
3586void QgsVectorLayer::setFieldAlias( int attIndex, const QString &aliasString )
3587{
3589
3590 if ( attIndex < 0 || attIndex >= fields().count() )
3591 return;
3592
3593 QString name = fields().at( attIndex ).name();
3594
3595 mAttributeAliasMap.insert( name, aliasString );
3596 mFields[ attIndex ].setAlias( aliasString );
3597 mEditFormConfig.setFields( mFields );
3598 emit layerModified(); // TODO[MD]: should have a different signal?
3599}
3600
3601QString QgsVectorLayer::attributeAlias( int index ) const
3602{
3604
3605 if ( index < 0 || index >= fields().count() )
3606 return QString();
3607
3608 return fields().at( index ).alias();
3609}
3610
3612{
3614
3615 if ( index >= 0 && index < mFields.count() )
3616 return mFields.at( index ).displayName();
3617 else
3618 return QString();
3619}
3620
3622{
3624
3625 return mAttributeAliasMap;
3626}
3627
3629{
3631
3632 if ( index < 0 || index >= fields().count() )
3633 return;
3634
3635 const QString name = fields().at( index ).name();
3636
3637 mAttributeSplitPolicy.insert( name, policy );
3638 mFields[ index ].setSplitPolicy( policy );
3639 mEditFormConfig.setFields( mFields );
3640 emit layerModified(); // TODO[MD]: should have a different signal?
3641}
3642
3644{
3646
3647 if ( index < 0 || index >= fields().count() )
3648 return;
3649
3650 const QString name = fields().at( index ).name();
3651
3652 mAttributeDuplicatePolicy.insert( name, policy );
3653 mFields[ index ].setDuplicatePolicy( policy );
3654 mEditFormConfig.setFields( mFields );
3655 emit layerModified(); // TODO[MD]: should have a different signal?
3656}
3657
3658
3660{
3662
3663 QSet<QString> excludeList;
3664 QMap< QString, Qgis::FieldConfigurationFlags >::const_iterator flagsIt = mFieldConfigurationFlags.constBegin();
3665 for ( ; flagsIt != mFieldConfigurationFlags.constEnd(); ++flagsIt )
3666 {
3667 if ( flagsIt->testFlag( Qgis::FieldConfigurationFlag::HideFromWms ) )
3668 {
3669 excludeList << flagsIt.key();
3670 }
3671 }
3672 return excludeList;
3673}
3674
3675void QgsVectorLayer::setExcludeAttributesWms( const QSet<QString> &att )
3676{
3678
3679 QMap< QString, Qgis::FieldConfigurationFlags >::iterator flagsIt = mFieldConfigurationFlags.begin();
3680 for ( ; flagsIt != mFieldConfigurationFlags.end(); ++flagsIt )
3681 {
3682 flagsIt->setFlag( Qgis::FieldConfigurationFlag::HideFromWms, att.contains( flagsIt.key() ) );
3683 }
3684 updateFields();
3685}
3686
3688{
3690
3691 QSet<QString> excludeList;
3692 QMap< QString, Qgis::FieldConfigurationFlags >::const_iterator flagsIt = mFieldConfigurationFlags.constBegin();
3693 for ( ; flagsIt != mFieldConfigurationFlags.constEnd(); ++flagsIt )
3694 {
3695 if ( flagsIt->testFlag( Qgis::FieldConfigurationFlag::HideFromWfs ) )
3696 {
3697 excludeList << flagsIt.key();
3698 }
3699 }
3700 return excludeList;
3701}
3702
3703void QgsVectorLayer::setExcludeAttributesWfs( const QSet<QString> &att )
3704{
3706
3707 QMap< QString, Qgis::FieldConfigurationFlags >::iterator flagsIt = mFieldConfigurationFlags.begin();
3708 for ( ; flagsIt != mFieldConfigurationFlags.end(); ++flagsIt )
3709 {
3710 flagsIt->setFlag( Qgis::FieldConfigurationFlag::HideFromWfs, att.contains( flagsIt.key() ) );
3711 }
3712 updateFields();
3713}
3714
3716{
3718
3719 if ( index < 0 || index >= fields().count() )
3720 return false;
3721
3722 if ( mFields.fieldOrigin( index ) == Qgis::FieldOrigin::Expression )
3723 {
3724 removeExpressionField( index );
3725 return true;
3726 }
3727
3728 if ( !mEditBuffer || !mDataProvider )
3729 return false;
3730
3731 return mEditBuffer->deleteAttribute( index );
3732}
3733
3734bool QgsVectorLayer::deleteAttributes( const QList<int> &attrs )
3735{
3737
3738 bool deleted = false;
3739
3740 // Remove multiple occurrences of same attribute
3741 QList<int> attrList = qgis::setToList( qgis::listToSet( attrs ) );
3742
3743 std::sort( attrList.begin(), attrList.end(), std::greater<int>() );
3744
3745 for ( int attr : std::as_const( attrList ) )
3746 {
3747 if ( deleteAttribute( attr ) )
3748 {
3749 deleted = true;
3750 }
3751 }
3752
3753 return deleted;
3754}
3755
3756bool QgsVectorLayer::deleteFeatureCascade( QgsFeatureId fid, QgsVectorLayer::DeleteContext *context )
3757{
3759
3760 if ( !mEditBuffer )
3761 return false;
3762
3763 if ( context && context->cascade )
3764 {
3765 const QList<QgsRelation> relations = context->project->relationManager()->referencedRelations( this );
3766 const bool hasRelationsOrJoins = !relations.empty() || mJoinBuffer->containsJoins();
3767 if ( hasRelationsOrJoins )
3768 {
3769 if ( context->mHandledFeatures.contains( this ) )
3770 {
3771 QgsFeatureIds &handledFeatureIds = context->mHandledFeatures[ this ];
3772 if ( handledFeatureIds.contains( fid ) )
3773 {
3774 // avoid endless recursion
3775 return false;
3776 }
3777 else
3778 {
3779 // add feature id
3780 handledFeatureIds << fid;
3781 }
3782 }
3783 else
3784 {
3785 // add layer and feature id
3786 context->mHandledFeatures.insert( this, QgsFeatureIds() << fid );
3787 }
3788
3789 for ( const QgsRelation &relation : relations )
3790 {
3791 //check if composition (and not association)
3792 switch ( relation.strength() )
3793 {
3795 {
3796 //get features connected over this relation
3797 QgsFeatureIterator relatedFeaturesIt = relation.getRelatedFeatures( getFeature( fid ) );
3798 QgsFeatureIds childFeatureIds;
3799 QgsFeature childFeature;
3800 while ( relatedFeaturesIt.nextFeature( childFeature ) )
3801 {
3802 childFeatureIds.insert( childFeature.id() );
3803 }
3804 if ( childFeatureIds.count() > 0 )
3805 {
3806 relation.referencingLayer()->startEditing();
3807 relation.referencingLayer()->deleteFeatures( childFeatureIds, context );
3808 }
3809 break;
3810 }
3811
3813 break;
3814 }
3815 }
3816 }
3817 }
3818
3819 if ( mJoinBuffer->containsJoins() )
3820 mJoinBuffer->deleteFeature( fid, context );
3821
3822 bool res = mEditBuffer->deleteFeature( fid );
3823
3824 return res;
3825}
3826
3828{
3830
3831 if ( !mEditBuffer )
3832 return false;
3833
3834 return deleteFeatureCascade( fid, context );
3835}
3836
3838{
3840
3841 bool res = true;
3842
3843 if ( ( context && context->cascade ) || mJoinBuffer->containsJoins() )
3844 {
3845 // should ideally be "deleteFeaturesCascade" for performance!
3846 for ( QgsFeatureId fid : fids )
3847 res = deleteFeatureCascade( fid, context ) && res;
3848 }
3849 else
3850 {
3851 res = mEditBuffer && mEditBuffer->deleteFeatures( fids );
3852 }
3853
3854 if ( res )
3855 {
3856 mSelectedFeatureIds.subtract( fids ); // remove it from selection
3857 updateExtents();
3858 }
3859
3860 return res;
3861}
3862
3864{
3865 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
3867
3868 return mFields;
3869}
3870
3872{
3874
3875 QgsAttributeList pkAttributesList;
3876 if ( !mDataProvider )
3877 return pkAttributesList;
3878
3879 QgsAttributeList providerIndexes = mDataProvider->pkAttributeIndexes();
3880 for ( int i = 0; i < mFields.count(); ++i )
3881 {
3882 if ( mFields.fieldOrigin( i ) == Qgis::FieldOrigin::Provider &&
3883 providerIndexes.contains( mFields.fieldOriginIndex( i ) ) )
3884 pkAttributesList << i;
3885 }
3886
3887 return pkAttributesList;
3888}
3889
3891{
3893
3894 if ( !mDataProvider )
3895 return static_cast< long long >( Qgis::FeatureCountState::UnknownCount );
3896 return mDataProvider->featureCount() +
3897 ( mEditBuffer && ! mDataProvider->transaction() ? mEditBuffer->addedFeatures().size() - mEditBuffer->deletedFeatureIds().size() : 0 );
3898}
3899
3901{
3903
3904 const QgsFeatureIds deletedFeatures( mEditBuffer && ! mDataProvider->transaction() ? mEditBuffer->deletedFeatureIds() : QgsFeatureIds() );
3905 const QgsFeatureMap addedFeatures( mEditBuffer && ! mDataProvider->transaction() ? mEditBuffer->addedFeatures() : QgsFeatureMap() );
3906
3907 if ( mEditBuffer && !deletedFeatures.empty() )
3908 {
3909 if ( addedFeatures.size() > deletedFeatures.size() )
3911 else
3913 }
3914
3915 if ( ( !mEditBuffer || addedFeatures.empty() ) && mDataProvider && mDataProvider->empty() )
3917 else
3919}
3920
3921bool QgsVectorLayer::commitChanges( bool stopEditing )
3922{
3924
3925 if ( project() && project()->transactionMode() == Qgis::TransactionMode::BufferedGroups )
3926 return project()->commitChanges( mCommitErrors, stopEditing, this );
3927
3928 mCommitErrors.clear();
3929
3930 if ( !mDataProvider )
3931 {
3932 mCommitErrors << tr( "ERROR: no provider" );
3933 return false;
3934 }
3935
3936 if ( !mEditBuffer )
3937 {
3938 mCommitErrors << tr( "ERROR: layer not editable" );
3939 return false;
3940 }
3941
3942 emit beforeCommitChanges( stopEditing );
3943
3944 if ( !mAllowCommit )
3945 return false;
3946
3947 mCommitChangesActive = true;
3948
3949 bool success = false;
3950 if ( mEditBuffer->editBufferGroup() )
3951 success = mEditBuffer->editBufferGroup()->commitChanges( mCommitErrors, stopEditing );
3952 else
3953 success = mEditBuffer->commitChanges( mCommitErrors );
3954
3955 mCommitChangesActive = false;
3956
3957 if ( !mDeletedFids.empty() )
3958 {
3959 emit featuresDeleted( mDeletedFids );
3960 mDeletedFids.clear();
3961 }
3962
3963 if ( success )
3964 {
3965 if ( stopEditing )
3966 {
3967 clearEditBuffer();
3968 }
3969 undoStack()->clear();
3970 emit afterCommitChanges();
3971 if ( stopEditing )
3972 emit editingStopped();
3973 }
3974 else
3975 {
3976 QgsMessageLog::logMessage( tr( "Commit errors:\n %1" ).arg( mCommitErrors.join( QLatin1String( "\n " ) ) ) );
3977 }
3978
3979 updateFields();
3980
3981 mDataProvider->updateExtents();
3982
3983 if ( stopEditing )
3984 {
3985 mDataProvider->leaveUpdateMode();
3986 }
3987
3988 // This second call is required because OGR provider with JSON
3989 // driver might have changed fields order after the call to
3990 // leaveUpdateMode
3991 if ( mFields.names() != mDataProvider->fields().names() )
3992 {
3993 updateFields();
3994 }
3995
3997
3998 return success;
3999}
4000
4002{
4004
4005 return mCommitErrors;
4006}
4007
4008bool QgsVectorLayer::rollBack( bool deleteBuffer )
4009{
4011
4012 if ( project() && project()->transactionMode() == Qgis::TransactionMode::BufferedGroups )
4013 return project()->rollBack( mCommitErrors, deleteBuffer, this );
4014
4015 if ( !mEditBuffer )
4016 {
4017 return false;
4018 }
4019
4020 if ( !mDataProvider )
4021 {
4022 mCommitErrors << tr( "ERROR: no provider" );
4023 return false;
4024 }
4025
4026 bool rollbackExtent = !mDataProvider->transaction() && ( !mEditBuffer->deletedFeatureIds().isEmpty() ||
4027 !mEditBuffer->addedFeatures().isEmpty() ||
4028 !mEditBuffer->changedGeometries().isEmpty() );
4029
4030 emit beforeRollBack();
4031
4032 mEditBuffer->rollBack();
4033
4034 emit afterRollBack();
4035
4036 if ( isModified() )
4037 {
4038 // new undo stack roll back method
4039 // old method of calling every undo could cause many canvas refreshes
4040 undoStack()->setIndex( 0 );
4041 }
4042
4043 updateFields();
4044
4045 if ( deleteBuffer )
4046 {
4047 delete mEditBuffer;
4048 mEditBuffer = nullptr;
4049 undoStack()->clear();
4050 }
4051 emit editingStopped();
4052
4053 if ( rollbackExtent )
4054 updateExtents();
4055
4056 mDataProvider->leaveUpdateMode();
4057
4059 return true;
4060}
4061
4063{
4065
4066 return mSelectedFeatureIds.size();
4067}
4068
4070{
4071 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
4073
4074 return mSelectedFeatureIds;
4075}
4076
4078{
4080
4081 QgsFeatureList features;
4082 features.reserve( mSelectedFeatureIds.count() );
4083 QgsFeature f;
4084
4086
4087 while ( it.nextFeature( f ) )
4088 {
4089 features.push_back( f );
4090 }
4091
4092 return features;
4093}
4094
4096{
4098
4099 if ( mSelectedFeatureIds.isEmpty() )
4100 return QgsFeatureIterator();
4101
4104
4105 if ( mSelectedFeatureIds.count() == 1 )
4106 request.setFilterFid( *mSelectedFeatureIds.constBegin() );
4107 else
4108 request.setFilterFids( mSelectedFeatureIds );
4109
4110 return getFeatures( request );
4111}
4112
4114{
4116
4117 if ( !mEditBuffer || !mDataProvider )
4118 return false;
4119
4120 if ( mGeometryOptions->isActive() )
4121 {
4122 for ( auto feature = features.begin(); feature != features.end(); ++feature )
4123 {
4124 QgsGeometry geom = feature->geometry();
4125 mGeometryOptions->apply( geom );
4126 feature->setGeometry( geom );
4127 }
4128 }
4129
4130 bool res = mEditBuffer->addFeatures( features );
4131 updateExtents();
4132
4133 if ( res && mJoinBuffer->containsJoins() )
4134 res = mJoinBuffer->addFeatures( features );
4135
4136 return res;
4137}
4138
4140{
4142
4143 // if layer is not spatial, it has not CRS!
4144 setCrs( ( isSpatial() && mDataProvider ) ? mDataProvider->crs() : QgsCoordinateReferenceSystem() );
4145}
4146
4148{
4150
4152 if ( exp.isField() )
4153 {
4154 return static_cast<const QgsExpressionNodeColumnRef *>( exp.rootNode() )->name();
4155 }
4156
4157 return QString();
4158}
4159
4160void QgsVectorLayer::setDisplayExpression( const QString &displayExpression )
4161{
4163
4164 if ( mDisplayExpression == displayExpression )
4165 return;
4166
4167 mDisplayExpression = displayExpression;
4169}
4170
4172{
4174
4175 if ( !mDisplayExpression.isEmpty() || mFields.isEmpty() )
4176 {
4177 return mDisplayExpression;
4178 }
4179 else
4180 {
4181 const QString candidateName = QgsVectorLayerUtils::guessFriendlyIdentifierField( mFields );
4182 if ( !candidateName.isEmpty() )
4183 {
4184 return QgsExpression::quotedColumnRef( candidateName );
4185 }
4186 else
4187 {
4188 return QString();
4189 }
4190 }
4191}
4192
4194{
4196
4197 // display expressions are used as a fallback when no explicit map tip template is set
4198 return mapTipsEnabled() && ( !mapTipTemplate().isEmpty() || !displayExpression().isEmpty() );
4199}
4200
4202{
4204
4205 return ( mEditBuffer && mDataProvider );
4206}
4207
4209{
4210 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
4212
4215}
4216
4217bool QgsVectorLayer::isReadOnly() const
4218{
4220
4221 return mDataSourceReadOnly || mReadOnly;
4222}
4223
4224bool QgsVectorLayer::setReadOnly( bool readonly )
4225{
4227
4228 // exit if the layer is in editing mode
4229 if ( readonly && mEditBuffer )
4230 return false;
4231
4232 // exit if the data source is in read-only mode
4233 if ( !readonly && mDataSourceReadOnly )
4234 return false;
4235
4236 mReadOnly = readonly;
4237 emit readOnlyChanged();
4238 return true;
4239}
4240
4242{
4244
4245 if ( ! mDataProvider )
4246 return false;
4247
4248 if ( mDataSourceReadOnly )
4249 return false;
4250
4251 return mDataProvider->capabilities() & QgsVectorDataProvider::EditingCapabilities && ! mReadOnly;
4252}
4253
4255{
4257
4258 emit beforeModifiedCheck();
4259 return mEditBuffer && mEditBuffer->isModified();
4260}
4261
4262bool QgsVectorLayer::isAuxiliaryField( int index, int &srcIndex ) const
4263{
4265
4266 bool auxiliaryField = false;
4267 srcIndex = -1;
4268
4269 if ( !auxiliaryLayer() )
4270 return auxiliaryField;
4271
4272 if ( index >= 0 && fields().fieldOrigin( index ) == Qgis::FieldOrigin::Join )
4273 {
4274 const QgsVectorLayerJoinInfo *info = mJoinBuffer->joinForFieldIndex( index, fields(), srcIndex );
4275
4276 if ( info && info->joinLayerId() == auxiliaryLayer()->id() )
4277 auxiliaryField = true;
4278 }
4279
4280 return auxiliaryField;
4281}
4282
4284{
4286
4287 // we must allow setting a renderer if our geometry type is unknown
4288 // as this allows the renderer to be correctly set even for layers
4289 // with broken sources
4290 // (note that we allow REMOVING the renderer for non-spatial layers,
4291 // e.g. to permit removing the renderer when the layer changes from
4292 // a spatial layer to a non-spatial one)
4293 if ( r && !isSpatial() && mWkbType != Qgis::WkbType::Unknown )
4294 return;
4295
4296 if ( r != mRenderer )
4297 {
4298 delete mRenderer;
4299 mRenderer = r;
4300 mSymbolFeatureCounted = false;
4301 mSymbolFeatureCountMap.clear();
4302 mSymbolFeatureIdMap.clear();
4303
4304 if ( mRenderer )
4305 {
4306 const double refreshRate = QgsSymbolLayerUtils::rendererFrameRate( mRenderer );
4307 if ( refreshRate <= 0 )
4308 {
4309 mRefreshRendererTimer->stop();
4310 mRefreshRendererTimer->setInterval( 0 );
4311 }
4312 else
4313 {
4314 mRefreshRendererTimer->setInterval( 1000 / refreshRate );
4315 mRefreshRendererTimer->start();
4316 }
4317 }
4318
4319 emit rendererChanged();
4321 }
4322}
4323
4325{
4327
4328 if ( generator )
4329 {
4330 mRendererGenerators << generator;
4331 }
4332}
4333
4335{
4337
4338 for ( int i = mRendererGenerators.count() - 1; i >= 0; --i )
4339 {
4340 if ( mRendererGenerators.at( i )->id() == id )
4341 {
4342 delete mRendererGenerators.at( i );
4343 mRendererGenerators.removeAt( i );
4344 }
4345 }
4346}
4347
4348QList<const QgsFeatureRendererGenerator *> QgsVectorLayer::featureRendererGenerators() const
4349{
4350 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
4352
4353 QList< const QgsFeatureRendererGenerator * > res;
4354 for ( const QgsFeatureRendererGenerator *generator : mRendererGenerators )
4355 res << generator;
4356 return res;
4357}
4358
4359void QgsVectorLayer::beginEditCommand( const QString &text )
4360{
4362
4363 if ( !mDataProvider )
4364 {
4365 return;
4366 }
4367 if ( mDataProvider->transaction() )
4368 {
4369 QString ignoredError;
4370 mDataProvider->transaction()->createSavepoint( ignoredError );
4371 }
4372 undoStack()->beginMacro( text );
4373 mEditCommandActive = true;
4374 emit editCommandStarted( text );
4375}
4376
4378{
4380
4381 if ( !mDataProvider )
4382 {
4383 return;
4384 }
4385 undoStack()->endMacro();
4386 mEditCommandActive = false;
4387 if ( !mDeletedFids.isEmpty() )
4388 {
4389 if ( selectedFeatureCount() > 0 )
4390 {
4391 mSelectedFeatureIds.subtract( mDeletedFids );
4392 }
4393 emit featuresDeleted( mDeletedFids );
4394 mDeletedFids.clear();
4395 }
4396 emit editCommandEnded();
4397}
4398
4400{
4402
4403 if ( !mDataProvider )
4404 {
4405 return;
4406 }
4407 undoStack()->endMacro();
4408 undoStack()->undo();
4409
4410 // it's not directly possible to pop the last command off the stack (the destroyed one)
4411 // and delete, so we add a dummy obsolete command to force this to occur.
4412 // Pushing the new command deletes the destroyed one, and since the new
4413 // command is obsolete it's automatically deleted by the undo stack.
4414 auto command = std::make_unique< QUndoCommand >();
4415 command->setObsolete( true );
4416 undoStack()->push( command.release() );
4417
4418 mEditCommandActive = false;
4419 mDeletedFids.clear();
4420 emit editCommandDestroyed();
4421}
4422
4424{
4426
4427 return mJoinBuffer->addJoin( joinInfo );
4428}
4429
4430bool QgsVectorLayer::removeJoin( const QString &joinLayerId )
4431{
4433
4434 return mJoinBuffer->removeJoin( joinLayerId );
4435}
4436
4437const QList< QgsVectorLayerJoinInfo > QgsVectorLayer::vectorJoins() const
4438{
4440
4441 return mJoinBuffer->vectorJoins();
4442}
4443
4444int QgsVectorLayer::addExpressionField( const QString &exp, const QgsField &fld )
4445{
4447
4448 emit beforeAddingExpressionField( fld.name() );
4449 mExpressionFieldBuffer->addExpression( exp, fld );
4450 updateFields();
4451 int idx = mFields.indexFromName( fld.name() );
4452 emit attributeAdded( idx );
4453 return idx;
4454}
4455
4457{
4459
4460 emit beforeRemovingExpressionField( index );
4461 int oi = mFields.fieldOriginIndex( index );
4462 mExpressionFieldBuffer->removeExpression( oi );
4463 updateFields();
4464 emit attributeDeleted( index );
4465}
4466
4467QString QgsVectorLayer::expressionField( int index ) const
4468{
4470
4471 if ( mFields.fieldOrigin( index ) != Qgis::FieldOrigin::Expression )
4472 return QString();
4473
4474 int oi = mFields.fieldOriginIndex( index );
4475 if ( oi < 0 || oi >= mExpressionFieldBuffer->expressions().size() )
4476 return QString();
4477
4478 return mExpressionFieldBuffer->expressions().at( oi ).cachedExpression.expression();
4479}
4480
4481void QgsVectorLayer::updateExpressionField( int index, const QString &exp )
4482{
4484
4485 int oi = mFields.fieldOriginIndex( index );
4486 mExpressionFieldBuffer->updateExpression( oi, exp );
4487}
4488
4490{
4491 // non fatal for now -- the QgsVirtualLayerTask class is not thread safe and calls this
4493
4494 if ( !mDataProvider )
4495 return;
4496
4497 QgsFields oldFields = mFields;
4498
4499 mFields = mDataProvider->fields();
4500
4501 // added / removed fields
4502 if ( mEditBuffer )
4503 mEditBuffer->updateFields( mFields );
4504
4505 // joined fields
4506 if ( mJoinBuffer->containsJoins() )
4507 mJoinBuffer->updateFields( mFields );
4508
4509 if ( mExpressionFieldBuffer )
4510 mExpressionFieldBuffer->updateFields( mFields );
4511
4512 // set aliases and default values
4513 for ( auto aliasIt = mAttributeAliasMap.constBegin(); aliasIt != mAttributeAliasMap.constEnd(); ++aliasIt )
4514 {
4515 int index = mFields.lookupField( aliasIt.key() );
4516 if ( index < 0 )
4517 continue;
4518
4519 mFields[ index ].setAlias( aliasIt.value() );
4520 }
4521
4522 for ( auto splitPolicyIt = mAttributeSplitPolicy.constBegin(); splitPolicyIt != mAttributeSplitPolicy.constEnd(); ++splitPolicyIt )
4523 {
4524 int index = mFields.lookupField( splitPolicyIt.key() );
4525 if ( index < 0 )
4526 continue;
4527
4528 mFields[ index ].setSplitPolicy( splitPolicyIt.value() );
4529 }
4530
4531 for ( auto duplicatePolicyIt = mAttributeDuplicatePolicy.constBegin(); duplicatePolicyIt != mAttributeDuplicatePolicy.constEnd(); ++duplicatePolicyIt )
4532 {
4533 int index = mFields.lookupField( duplicatePolicyIt.key() );
4534 if ( index < 0 )
4535 continue;
4536
4537 mFields[ index ].setDuplicatePolicy( duplicatePolicyIt.value() );
4538 }
4539
4540 // Update configuration flags
4541 QMap< QString, Qgis::FieldConfigurationFlags >::const_iterator flagsIt = mFieldConfigurationFlags.constBegin();
4542 for ( ; flagsIt != mFieldConfigurationFlags.constEnd(); ++flagsIt )
4543 {
4544 int index = mFields.lookupField( flagsIt.key() );
4545 if ( index < 0 )
4546 continue;
4547
4548 mFields[index].setConfigurationFlags( flagsIt.value() );
4549 }
4550
4551 // Update default values
4552 mDefaultValueOnUpdateFields.clear();
4553 QMap< QString, QgsDefaultValue >::const_iterator defaultIt = mDefaultExpressionMap.constBegin();
4554 for ( ; defaultIt != mDefaultExpressionMap.constEnd(); ++defaultIt )
4555 {
4556 int index = mFields.lookupField( defaultIt.key() );
4557 if ( index < 0 )
4558 continue;
4559
4560 mFields[ index ].setDefaultValueDefinition( defaultIt.value() );
4561 if ( defaultIt.value().applyOnUpdate() )
4562 mDefaultValueOnUpdateFields.insert( index );
4563 }
4564
4565 QMap< QString, QgsFieldConstraints::Constraints >::const_iterator constraintIt = mFieldConstraints.constBegin();
4566 for ( ; constraintIt != mFieldConstraints.constEnd(); ++constraintIt )
4567 {
4568 int index = mFields.lookupField( constraintIt.key() );
4569 if ( index < 0 )
4570 continue;
4571
4572 QgsFieldConstraints constraints = mFields.at( index ).constraints();
4573
4574 // always keep provider constraints intact
4575 if ( !( constraints.constraints() & QgsFieldConstraints::ConstraintNotNull ) && ( constraintIt.value() & QgsFieldConstraints::ConstraintNotNull ) )
4577 if ( !( constraints.constraints() & QgsFieldConstraints::ConstraintUnique ) && ( constraintIt.value() & QgsFieldConstraints::ConstraintUnique ) )
4579 if ( !( constraints.constraints() & QgsFieldConstraints::ConstraintExpression ) && ( constraintIt.value() & QgsFieldConstraints::ConstraintExpression ) )
4581 mFields[ index ].setConstraints( constraints );
4582 }
4583
4584 QMap< QString, QPair< QString, QString > >::const_iterator constraintExpIt = mFieldConstraintExpressions.constBegin();
4585 for ( ; constraintExpIt != mFieldConstraintExpressions.constEnd(); ++constraintExpIt )
4586 {
4587 int index = mFields.lookupField( constraintExpIt.key() );
4588 if ( index < 0 )
4589 continue;
4590
4591 QgsFieldConstraints constraints = mFields.at( index ).constraints();
4592
4593 // always keep provider constraints intact
4595 continue;
4596
4597 constraints.setConstraintExpression( constraintExpIt.value().first, constraintExpIt.value().second );
4598 mFields[ index ].setConstraints( constraints );
4599 }
4600
4601 QMap< QPair< QString, QgsFieldConstraints::Constraint >, QgsFieldConstraints::ConstraintStrength >::const_iterator constraintStrengthIt = mFieldConstraintStrength.constBegin();
4602 for ( ; constraintStrengthIt != mFieldConstraintStrength.constEnd(); ++constraintStrengthIt )
4603 {
4604 int index = mFields.lookupField( constraintStrengthIt.key().first );
4605 if ( index < 0 )
4606 continue;
4607
4608 QgsFieldConstraints constraints = mFields.at( index ).constraints();
4609
4610 // always keep provider constraints intact
4612 continue;
4613
4614 constraints.setConstraintStrength( constraintStrengthIt.key().second, constraintStrengthIt.value() );
4615 mFields[ index ].setConstraints( constraints );
4616 }
4617
4618 auto fieldWidgetIterator = mFieldWidgetSetups.constBegin();
4619 for ( ; fieldWidgetIterator != mFieldWidgetSetups.constEnd(); ++ fieldWidgetIterator )
4620 {
4621 int index = mFields.indexOf( fieldWidgetIterator.key() );
4622 if ( index < 0 )
4623 continue;
4624
4625 mFields[index].setEditorWidgetSetup( fieldWidgetIterator.value() );
4626 }
4627
4628 if ( oldFields != mFields )
4629 {
4630 emit updatedFields();
4631 mEditFormConfig.setFields( mFields );
4632 }
4633
4634}
4635
4636QVariant QgsVectorLayer::defaultValue( int index, const QgsFeature &feature, QgsExpressionContext *context ) const
4637{
4639
4640 if ( index < 0 || index >= mFields.count() || !mDataProvider )
4641 return QVariant();
4642
4643 QString expression = mFields.at( index ).defaultValueDefinition().expression();
4644 if ( expression.isEmpty() )
4645 return mDataProvider->defaultValue( index );
4646
4647 QgsExpressionContext *evalContext = context;
4648 std::unique_ptr< QgsExpressionContext > tempContext;
4649 if ( !evalContext )
4650 {
4651 // no context passed, so we create a default one
4653 evalContext = tempContext.get();
4654 }
4655
4656 if ( feature.isValid() )
4657 {
4659 featScope->setFeature( feature );
4660 featScope->setFields( feature.fields() );
4661 evalContext->appendScope( featScope );
4662 }
4663
4664 QVariant val;
4665 QgsExpression exp( expression );
4666 exp.prepare( evalContext );
4667 if ( exp.hasEvalError() )
4668 {
4669 QgsLogger::warning( "Error evaluating default value: " + exp.evalErrorString() );
4670 }
4671 else
4672 {
4673 val = exp.evaluate( evalContext );
4674 }
4675
4676 if ( feature.isValid() )
4677 {
4678 delete evalContext->popScope();
4679 }
4680
4681 return val;
4682}
4683
4685{
4687
4688 if ( index < 0 || index >= mFields.count() )
4689 return;
4690
4691 if ( definition.isValid() )
4692 {
4693 mDefaultExpressionMap.insert( mFields.at( index ).name(), definition );
4694 }
4695 else
4696 {
4697 mDefaultExpressionMap.remove( mFields.at( index ).name() );
4698 }
4699 updateFields();
4700}
4701
4703{
4705
4706 if ( index < 0 || index >= mFields.count() )
4707 return QgsDefaultValue();
4708 else
4709 return mFields.at( index ).defaultValueDefinition();
4710}
4711
4712QSet<QVariant> QgsVectorLayer::uniqueValues( int index, int limit ) const
4713{
4715
4716 QSet<QVariant> uniqueValues;
4717 if ( !mDataProvider )
4718 {
4719 return uniqueValues;
4720 }
4721
4722 Qgis::FieldOrigin origin = mFields.fieldOrigin( index );
4723 switch ( origin )
4724 {
4726 return uniqueValues;
4727
4728 case Qgis::FieldOrigin::Provider: //a provider field
4729 {
4730 uniqueValues = mDataProvider->uniqueValues( index, limit );
4731
4732 if ( mEditBuffer && ! mDataProvider->transaction() )
4733 {
4734 QSet<QString> vals;
4735 const auto constUniqueValues = uniqueValues;
4736 for ( const QVariant &v : constUniqueValues )
4737 {
4738 vals << v.toString();
4739 }
4740
4741 QgsFeatureMap added = mEditBuffer->addedFeatures();
4742 QMapIterator< QgsFeatureId, QgsFeature > addedIt( added );
4743 while ( addedIt.hasNext() && ( limit < 0 || uniqueValues.count() < limit ) )
4744 {
4745 addedIt.next();
4746 QVariant v = addedIt.value().attribute( index );
4747 if ( v.isValid() )
4748 {
4749 QString vs = v.toString();
4750 if ( !vals.contains( vs ) )
4751 {
4752 vals << vs;
4753 uniqueValues << v;
4754 }
4755 }
4756 }
4757
4758 QMapIterator< QgsFeatureId, QgsAttributeMap > it( mEditBuffer->changedAttributeValues() );
4759 while ( it.hasNext() && ( limit < 0 || uniqueValues.count() < limit ) )
4760 {
4761 it.next();
4762 QVariant v = it.value().value( index );
4763 if ( v.isValid() )
4764 {
4765 QString vs = v.toString();
4766 if ( !vals.contains( vs ) )
4767 {
4768 vals << vs;
4769 uniqueValues << v;
4770 }
4771 }
4772 }
4773 }
4774
4775 return uniqueValues;
4776 }
4777
4779 // the layer is editable, but in certain cases it can still be avoided going through all features
4780 if ( mDataProvider->transaction() || (
4781 mEditBuffer->deletedFeatureIds().isEmpty() &&
4782 mEditBuffer->addedFeatures().isEmpty() &&
4783 !mEditBuffer->deletedAttributeIds().contains( index ) &&
4784 mEditBuffer->changedAttributeValues().isEmpty() ) )
4785 {
4786 uniqueValues = mDataProvider->uniqueValues( index, limit );
4787 return uniqueValues;
4788 }
4789 [[fallthrough]];
4790 //we need to go through each feature
4793 {
4794 QgsAttributeList attList;
4795 attList << index;
4796
4799 .setSubsetOfAttributes( attList ) );
4800
4801 QgsFeature f;
4802 QVariant currentValue;
4803 QHash<QString, QVariant> val;
4804 while ( fit.nextFeature( f ) )
4805 {
4806 currentValue = f.attribute( index );
4807 val.insert( currentValue.toString(), currentValue );
4808 if ( limit >= 0 && val.size() >= limit )
4809 {
4810 break;
4811 }
4812 }
4813
4814 return qgis::listToSet( val.values() );
4815 }
4816 }
4817
4818 Q_ASSERT_X( false, "QgsVectorLayer::uniqueValues()", "Unknown source of the field!" );
4819 return uniqueValues;
4820}
4821
4822QStringList QgsVectorLayer::uniqueStringsMatching( int index, const QString &substring, int limit, QgsFeedback *feedback ) const
4823{
4825
4826 QStringList results;
4827 if ( !mDataProvider )
4828 {
4829 return results;
4830 }
4831
4832 Qgis::FieldOrigin origin = mFields.fieldOrigin( index );
4833 switch ( origin )
4834 {
4836 return results;
4837
4838 case Qgis::FieldOrigin::Provider: //a provider field
4839 {
4840 results = mDataProvider->uniqueStringsMatching( index, substring, limit, feedback );
4841
4842 if ( mEditBuffer && ! mDataProvider->transaction() )
4843 {
4844 QgsFeatureMap added = mEditBuffer->addedFeatures();
4845 QMapIterator< QgsFeatureId, QgsFeature > addedIt( added );
4846 while ( addedIt.hasNext() && ( limit < 0 || results.count() < limit ) && ( !feedback || !feedback->isCanceled() ) )
4847 {
4848 addedIt.next();
4849 QVariant v = addedIt.value().attribute( index );
4850 if ( v.isValid() )
4851 {
4852 QString vs = v.toString();
4853 if ( vs.contains( substring, Qt::CaseInsensitive ) && !results.contains( vs ) )
4854 {
4855 results << vs;
4856 }
4857 }
4858 }
4859
4860 QMapIterator< QgsFeatureId, QgsAttributeMap > it( mEditBuffer->changedAttributeValues() );
4861 while ( it.hasNext() && ( limit < 0 || results.count() < limit ) && ( !feedback || !feedback->isCanceled() ) )
4862 {
4863 it.next();
4864 QVariant v = it.value().value( index );
4865 if ( v.isValid() )
4866 {
4867 QString vs = v.toString();
4868 if ( vs.contains( substring, Qt::CaseInsensitive ) && !results.contains( vs ) )
4869 {
4870 results << vs;
4871 }
4872 }
4873 }
4874 }
4875
4876 return results;
4877 }
4878
4880 // the layer is editable, but in certain cases it can still be avoided going through all features
4881 if ( mDataProvider->transaction() || ( mEditBuffer->deletedFeatureIds().isEmpty() &&
4882 mEditBuffer->addedFeatures().isEmpty() &&
4883 !mEditBuffer->deletedAttributeIds().contains( index ) &&
4884 mEditBuffer->changedAttributeValues().isEmpty() ) )
4885 {
4886 return mDataProvider->uniqueStringsMatching( index, substring, limit, feedback );
4887 }
4888 [[fallthrough]];
4889 //we need to go through each feature
4892 {
4893 QgsAttributeList attList;
4894 attList << index;
4895
4896 QgsFeatureRequest request;
4897 request.setSubsetOfAttributes( attList );
4899 QString fieldName = mFields.at( index ).name();
4900 request.setFilterExpression( QStringLiteral( "\"%1\" ILIKE '%%2%'" ).arg( fieldName, substring ) );
4901 QgsFeatureIterator fit = getFeatures( request );
4902
4903 QgsFeature f;
4904 QString currentValue;
4905 while ( fit.nextFeature( f ) )
4906 {
4907 currentValue = f.attribute( index ).toString();
4908 if ( !results.contains( currentValue ) )
4909 results << currentValue;
4910
4911 if ( ( limit >= 0 && results.size() >= limit ) || ( feedback && feedback->isCanceled() ) )
4912 {
4913 break;
4914 }
4915 }
4916
4917 return results;
4918 }
4919 }
4920
4921 Q_ASSERT_X( false, "QgsVectorLayer::uniqueStringsMatching()", "Unknown source of the field!" );
4922 return results;
4923}
4924
4925QVariant QgsVectorLayer::minimumValue( int index ) const
4926{
4928
4929 QVariant minimum;
4930 minimumOrMaximumValue( index, &minimum, nullptr );
4931 return minimum;
4932}
4933
4934QVariant QgsVectorLayer::maximumValue( int index ) const
4935{
4937
4938 QVariant maximum;
4939 minimumOrMaximumValue( index, nullptr, &maximum );
4940 return maximum;
4941}
4942
4943void QgsVectorLayer::minimumAndMaximumValue( int index, QVariant &minimum, QVariant &maximum ) const
4944{
4946
4947 minimumOrMaximumValue( index, &minimum, &maximum );
4948}
4949
4950void QgsVectorLayer::minimumOrMaximumValue( int index, QVariant *minimum, QVariant *maximum ) const
4951{
4953
4954 if ( minimum )
4955 *minimum = QVariant();
4956 if ( maximum )
4957 *maximum = QVariant();
4958
4959 if ( !mDataProvider )
4960 {
4961 return;
4962 }
4963
4964 Qgis::FieldOrigin origin = mFields.fieldOrigin( index );
4965
4966 switch ( origin )
4967 {
4969 {
4970 return;
4971 }
4972
4973 case Qgis::FieldOrigin::Provider: //a provider field
4974 {
4975 if ( minimum )
4976 *minimum = mDataProvider->minimumValue( index );
4977 if ( maximum )
4978 *maximum = mDataProvider->maximumValue( index );
4979 if ( mEditBuffer && ! mDataProvider->transaction() )
4980 {
4981 const QgsFeatureMap added = mEditBuffer->addedFeatures();
4982 QMapIterator< QgsFeatureId, QgsFeature > addedIt( added );
4983 while ( addedIt.hasNext() )
4984 {
4985 addedIt.next();
4986 const QVariant v = addedIt.value().attribute( index );
4987 if ( minimum && v.isValid() && qgsVariantLessThan( v, *minimum ) )
4988 *minimum = v;
4989 if ( maximum && v.isValid() && qgsVariantGreaterThan( v, *maximum ) )
4990 *maximum = v;
4991 }
4992
4993 QMapIterator< QgsFeatureId, QgsAttributeMap > it( mEditBuffer->changedAttributeValues() );
4994 while ( it.hasNext() )
4995 {
4996 it.next();
4997 const QVariant v = it.value().value( index );
4998 if ( minimum && v.isValid() && qgsVariantLessThan( v, *minimum ) )
4999 *minimum = v;
5000 if ( maximum && v.isValid() && qgsVariantGreaterThan( v, *maximum ) )
5001 *maximum = v;
5002 }
5003 }
5004 return;
5005 }
5006
5008 {
5009 // the layer is editable, but in certain cases it can still be avoided going through all features
5010 if ( mDataProvider->transaction() || ( mEditBuffer->deletedFeatureIds().isEmpty() &&
5011 mEditBuffer->addedFeatures().isEmpty() &&
5012 !mEditBuffer->deletedAttributeIds().contains( index ) &&
5013 mEditBuffer->changedAttributeValues().isEmpty() ) )
5014 {
5015 if ( minimum )
5016 *minimum = mDataProvider->minimumValue( index );
5017 if ( maximum )
5018 *maximum = mDataProvider->maximumValue( index );
5019 return;
5020 }
5021 }
5022 [[fallthrough]];
5023 // no choice but to go through all features
5026 {
5027 // we need to go through each feature
5028 QgsAttributeList attList;
5029 attList << index;
5030
5033 .setSubsetOfAttributes( attList ) );
5034
5035 QgsFeature f;
5036 bool firstValue = true;
5037 while ( fit.nextFeature( f ) )
5038 {
5039 const QVariant currentValue = f.attribute( index );
5040 if ( QgsVariantUtils::isNull( currentValue ) )
5041 continue;
5042
5043 if ( firstValue )
5044 {
5045 if ( minimum )
5046 *minimum = currentValue;
5047 if ( maximum )
5048 *maximum = currentValue;
5049 firstValue = false;
5050 }
5051 else
5052 {
5053 if ( minimum && currentValue.isValid() && qgsVariantLessThan( currentValue, *minimum ) )
5054 *minimum = currentValue;
5055 if ( maximum && currentValue.isValid() && qgsVariantGreaterThan( currentValue, *maximum ) )
5056 *maximum = currentValue;
5057 }
5058 }
5059 return;
5060 }
5061 }
5062
5063 Q_ASSERT_X( false, "QgsVectorLayer::minimumOrMaximumValue()", "Unknown source of the field!" );
5064}
5065
5066void QgsVectorLayer::createEditBuffer()
5067{
5069
5070 if ( mEditBuffer )
5071 clearEditBuffer();
5072
5073 if ( mDataProvider->transaction() )
5074 {
5075 mEditBuffer = new QgsVectorLayerEditPassthrough( this );
5076
5077 connect( mDataProvider->transaction(), &QgsTransaction::dirtied, this, &QgsVectorLayer::onDirtyTransaction, Qt::UniqueConnection );
5078 }
5079 else
5080 {
5081 mEditBuffer = new QgsVectorLayerEditBuffer( this );
5082 }
5083 // forward signals
5084 connect( mEditBuffer, &QgsVectorLayerEditBuffer::layerModified, this, &QgsVectorLayer::invalidateSymbolCountedFlag );
5085 connect( mEditBuffer, &QgsVectorLayerEditBuffer::layerModified, this, &QgsVectorLayer::layerModified ); // TODO[MD]: necessary?
5086 //connect( mEditBuffer, SIGNAL( layerModified() ), this, SLOT( triggerRepaint() ) ); // TODO[MD]: works well?
5087 connect( mEditBuffer, &QgsVectorLayerEditBuffer::featureAdded, this, &QgsVectorLayer::onFeatureAdded );
5088 connect( mEditBuffer, &QgsVectorLayerEditBuffer::featureDeleted, this, &QgsVectorLayer::onFeatureDeleted );
5099
5100}
5101
5102void QgsVectorLayer::clearEditBuffer()
5103{
5105
5106 delete mEditBuffer;
5107 mEditBuffer = nullptr;
5108}
5109
5110QVariant QgsVectorLayer::aggregate( Qgis::Aggregate aggregate, const QString &fieldOrExpression,
5112 bool *ok, QgsFeatureIds *fids, QgsFeedback *feedback, QString *error ) const
5113{
5114 // non fatal for now -- the aggregate expression functions are not thread safe and call this
5116
5117 if ( ok )
5118 *ok = false;
5119 if ( error )
5120 error->clear();
5121
5122 if ( !mDataProvider )
5123 {
5124 if ( error )
5125 *error = tr( "Layer is invalid" );
5126 return QVariant();
5127 }
5128
5129 // test if we are calculating based on a field
5130 const int attrIndex = QgsExpression::expressionToLayerFieldIndex( fieldOrExpression, this );
5131 if ( attrIndex >= 0 )
5132 {
5133 // aggregate is based on a field - if it's a provider field, we could possibly hand over the calculation
5134 // to the provider itself
5135 Qgis::FieldOrigin origin = mFields.fieldOrigin( attrIndex );
5136 if ( origin == Qgis::FieldOrigin::Provider )
5137 {
5138 bool providerOk = false;
5139 QVariant val = mDataProvider->aggregate( aggregate, attrIndex, parameters, context, providerOk, fids );
5140 if ( providerOk )
5141 {
5142 // provider handled calculation
5143 if ( ok )
5144 *ok = true;
5145 return val;
5146 }
5147 }
5148 }
5149
5150 // fallback to using aggregate calculator to determine aggregate
5151 QgsAggregateCalculator c( this );
5152 if ( fids )
5153 c.setFidsFilter( *fids );
5154 c.setParameters( parameters );
5155 bool aggregateOk = false;
5156 const QVariant result = c.calculate( aggregate, fieldOrExpression, context, &aggregateOk, feedback );
5157 if ( ok )
5158 *ok = aggregateOk;
5159 if ( !aggregateOk && error )
5160 *error = c.lastError();
5161
5162 return result;
5163}
5164
5165void QgsVectorLayer::setFeatureBlendMode( QPainter::CompositionMode featureBlendMode )
5166{
5168
5169 if ( mFeatureBlendMode == featureBlendMode )
5170 return;
5171
5172 mFeatureBlendMode = featureBlendMode;
5175}
5176
5177QPainter::CompositionMode QgsVectorLayer::featureBlendMode() const
5178{
5179 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
5181
5182 return mFeatureBlendMode;
5183}
5184
5185void QgsVectorLayer::readSldLabeling( const QDomNode &node )
5186{
5188
5189 setLabeling( nullptr ); // start with no labeling
5190 setLabelsEnabled( false );
5191
5192 QDomElement element = node.toElement();
5193 if ( element.isNull() )
5194 return;
5195
5196 QDomElement userStyleElem = element.firstChildElement( QStringLiteral( "UserStyle" ) );
5197 if ( userStyleElem.isNull() )
5198 {
5199 QgsDebugMsgLevel( QStringLiteral( "Info: UserStyle element not found." ), 4 );
5200 return;
5201 }
5202
5203 QDomElement featTypeStyleElem = userStyleElem.firstChildElement( QStringLiteral( "FeatureTypeStyle" ) );
5204 if ( featTypeStyleElem.isNull() )
5205 {
5206 QgsDebugMsgLevel( QStringLiteral( "Info: FeatureTypeStyle element not found." ), 4 );
5207 return;
5208 }
5209
5210 // create empty FeatureTypeStyle element to merge TextSymbolizer's Rule's from all FeatureTypeStyle's
5211 QDomElement mergedFeatTypeStyle = featTypeStyleElem.cloneNode( false ).toElement();
5212
5213 // use the RuleRenderer when more rules are present or the rule
5214 // has filters or min/max scale denominators set,
5215 // otherwise use the Simple labeling
5216 bool needRuleBasedLabeling = false;
5217 int ruleCount = 0;
5218
5219 while ( !featTypeStyleElem.isNull() )
5220 {
5221 QDomElement ruleElem = featTypeStyleElem.firstChildElement( QStringLiteral( "Rule" ) );
5222 while ( !ruleElem.isNull() )
5223 {
5224 // test rule children element to check if we need to create RuleRenderer
5225 // and if the rule has a symbolizer
5226 bool hasTextSymbolizer = false;
5227 bool hasRuleBased = false;
5228 QDomElement ruleChildElem = ruleElem.firstChildElement();
5229 while ( !ruleChildElem.isNull() )
5230 {
5231 // rule has filter or min/max scale denominator, use the RuleRenderer
5232 if ( ruleChildElem.localName() == QLatin1String( "Filter" ) ||
5233 ruleChildElem.localName() == QLatin1String( "MinScaleDenominator" ) ||
5234 ruleChildElem.localName() == QLatin1String( "MaxScaleDenominator" ) )
5235 {
5236 hasRuleBased = true;
5237 }
5238 // rule has a renderer symbolizer, not a text symbolizer
5239 else if ( ruleChildElem.localName() == QLatin1String( "TextSymbolizer" ) )
5240 {
5241 QgsDebugMsgLevel( QStringLiteral( "Info: TextSymbolizer element found" ), 4 );
5242 hasTextSymbolizer = true;
5243 }
5244
5245 ruleChildElem = ruleChildElem.nextSiblingElement();
5246 }
5247
5248 if ( hasTextSymbolizer )
5249 {
5250 ruleCount++;
5251
5252 // append a clone of all Rules to the merged FeatureTypeStyle element
5253 mergedFeatTypeStyle.appendChild( ruleElem.cloneNode().toElement() );
5254
5255 if ( hasRuleBased )
5256 {
5257 QgsDebugMsgLevel( QStringLiteral( "Info: Filter or Min/MaxScaleDenominator element found: need a RuleBasedLabeling" ), 4 );
5258 needRuleBasedLabeling = true;
5259 }
5260 }
5261
5262 // more rules present, use the RuleRenderer
5263 if ( ruleCount > 1 )
5264 {
5265 QgsDebugMsgLevel( QStringLiteral( "Info: More Rule elements found: need a RuleBasedLabeling" ), 4 );
5266 needRuleBasedLabeling = true;
5267 }
5268
5269 // not use the rule based labeling if no rules with textSymbolizer
5270 if ( ruleCount == 0 )
5271 {
5272 needRuleBasedLabeling = false;
5273 }
5274
5275 ruleElem = ruleElem.nextSiblingElement( QStringLiteral( "Rule" ) );
5276 }
5277 featTypeStyleElem = featTypeStyleElem.nextSiblingElement( QStringLiteral( "FeatureTypeStyle" ) );
5278 }
5279
5280 if ( ruleCount == 0 )
5281 {
5282 QgsDebugMsgLevel( QStringLiteral( "Info: No TextSymbolizer element." ), 4 );
5283 return;
5284 }
5285
5286 QDomElement ruleElem = mergedFeatTypeStyle.firstChildElement( QStringLiteral( "Rule" ) );
5287
5288 if ( needRuleBasedLabeling )
5289 {
5290 QgsDebugMsgLevel( QStringLiteral( "Info: rule based labeling" ), 4 );
5291 QgsRuleBasedLabeling::Rule *rootRule = new QgsRuleBasedLabeling::Rule( nullptr );
5292 while ( !ruleElem.isNull() )
5293 {
5294
5295 QString label, description, filterExp;
5296 int scaleMinDenom = 0, scaleMaxDenom = 0;
5297 QgsPalLayerSettings settings;
5298
5299 // retrieve the Rule element child nodes
5300 QDomElement childElem = ruleElem.firstChildElement();
5301 while ( !childElem.isNull() )
5302 {
5303 if ( childElem.localName() == QLatin1String( "Name" ) )
5304 {
5305 // <se:Name> tag contains the rule identifier,
5306 // so prefer title tag for the label property value
5307 if ( label.isEmpty() )
5308 label = childElem.firstChild().nodeValue();
5309 }
5310 else if ( childElem.localName() == QLatin1String( "Description" ) )
5311 {
5312 // <se:Description> can contains a title and an abstract
5313 QDomElement titleElem = childElem.firstChildElement( QStringLiteral( "Title" ) );
5314 if ( !titleElem.isNull() )
5315 {
5316 label = titleElem.firstChild().nodeValue();
5317 }
5318
5319 QDomElement abstractElem = childElem.firstChildElement( QStringLiteral( "Abstract" ) );
5320 if ( !abstractElem.isNull() )
5321 {
5322 description = abstractElem.firstChild().nodeValue();
5323 }
5324 }
5325 else if ( childElem.localName() == QLatin1String( "Abstract" ) )
5326 {
5327 // <sld:Abstract> (v1.0)
5328 description = childElem.firstChild().nodeValue();
5329 }
5330 else if ( childElem.localName() == QLatin1String( "Title" ) )
5331 {
5332 // <sld:Title> (v1.0)
5333 label = childElem.firstChild().nodeValue();
5334 }
5335 else if ( childElem.localName() == QLatin1String( "Filter" ) )
5336 {
5338 if ( filter )
5339 {
5340 if ( filter->hasParserError() )
5341 {
5342 QgsDebugMsgLevel( QStringLiteral( "SLD Filter parsing error: %1" ).arg( filter->parserErrorString() ), 3 );
5343 }
5344 else
5345 {
5346 filterExp = filter->expression();
5347 }
5348 delete filter;
5349 }
5350 }
5351 else if ( childElem.localName() == QLatin1String( "MinScaleDenominator" ) )
5352 {
5353 bool ok;
5354 int v = childElem.firstChild().nodeValue().toInt( &ok );
5355 if ( ok )
5356 scaleMinDenom = v;
5357 }
5358 else if ( childElem.localName() == QLatin1String( "MaxScaleDenominator" ) )
5359 {
5360 bool ok;
5361 int v = childElem.firstChild().nodeValue().toInt( &ok );
5362 if ( ok )
5363 scaleMaxDenom = v;
5364 }
5365 else if ( childElem.localName() == QLatin1String( "TextSymbolizer" ) )
5366 {
5367 readSldTextSymbolizer( childElem, settings );
5368 }
5369
5370 childElem = childElem.nextSiblingElement();
5371 }
5372
5373 QgsRuleBasedLabeling::Rule *ruleLabeling = new QgsRuleBasedLabeling::Rule( new QgsPalLayerSettings( settings ), scaleMinDenom, scaleMaxDenom, filterExp, label );
5374 rootRule->appendChild( ruleLabeling );
5375
5376 ruleElem = ruleElem.nextSiblingElement();
5377 }
5378
5379 setLabeling( new QgsRuleBasedLabeling( rootRule ) );
5380 setLabelsEnabled( true );
5381 }
5382 else
5383 {
5384 QgsDebugMsgLevel( QStringLiteral( "Info: simple labeling" ), 4 );
5385 // retrieve the TextSymbolizer element child node
5386 QDomElement textSymbolizerElem = ruleElem.firstChildElement( QStringLiteral( "TextSymbolizer" ) );
5388 if ( readSldTextSymbolizer( textSymbolizerElem, s ) )
5389 {
5391 setLabelsEnabled( true );
5392 }
5393 }
5394}
5395
5396bool QgsVectorLayer::readSldTextSymbolizer( const QDomNode &node, QgsPalLayerSettings &settings ) const
5397{
5399
5400 if ( node.localName() != QLatin1String( "TextSymbolizer" ) )
5401 {
5402 QgsDebugMsgLevel( QStringLiteral( "Not a TextSymbolizer element: %1" ).arg( node.localName() ), 3 );
5403 return false;
5404 }
5405 QDomElement textSymbolizerElem = node.toElement();
5406 // Label
5407 QDomElement labelElem = textSymbolizerElem.firstChildElement( QStringLiteral( "Label" ) );
5408 if ( !labelElem.isNull() )
5409 {
5410 QDomElement propertyNameElem = labelElem.firstChildElement( QStringLiteral( "PropertyName" ) );
5411 if ( !propertyNameElem.isNull() )
5412 {
5413 // set labeling defaults
5414
5415 // label attribute
5416 QString labelAttribute = propertyNameElem.text();
5417 settings.fieldName = labelAttribute;
5418 settings.isExpression = false;
5419
5420 int fieldIndex = mFields.lookupField( labelAttribute );
5421 if ( fieldIndex == -1 )
5422 {
5423 // label attribute is not in columns, check if it is an expression
5424 QgsExpression exp( labelAttribute );
5425 if ( !exp.hasEvalError() )
5426 {
5427 settings.isExpression = true;
5428 }
5429 else
5430 {
5431 QgsDebugMsgLevel( QStringLiteral( "SLD label attribute error: %1" ).arg( exp.evalErrorString() ), 3 );
5432 }
5433 }
5434 }
5435 else
5436 {
5437 QgsDebugMsgLevel( QStringLiteral( "Info: PropertyName element not found." ), 4 );
5438 return false;
5439 }
5440 }
5441 else
5442 {
5443 QgsDebugMsgLevel( QStringLiteral( "Info: Label element not found." ), 4 );
5444 return false;
5445 }
5446
5448 if ( textSymbolizerElem.hasAttribute( QStringLiteral( "uom" ) ) )
5449 {
5450 sldUnitSize = QgsSymbolLayerUtils::decodeSldUom( textSymbolizerElem.attribute( QStringLiteral( "uom" ) ) );
5451 }
5452
5453 QString fontFamily = QStringLiteral( "Sans-Serif" );
5454 int fontPointSize = 10;
5456 int fontWeight = -1;
5457 bool fontItalic = false;
5458 bool fontUnderline = false;
5459
5460 // Font
5461 QDomElement fontElem = textSymbolizerElem.firstChildElement( QStringLiteral( "Font" ) );
5462 if ( !fontElem.isNull() )
5463 {
5464 QgsStringMap fontSvgParams = QgsSymbolLayerUtils::getSvgParameterList( fontElem );
5465 for ( QgsStringMap::iterator it = fontSvgParams.begin(); it != fontSvgParams.end(); ++it )
5466 {
5467 QgsDebugMsgLevel( QStringLiteral( "found fontSvgParams %1: %2" ).arg( it.key(), it.value() ), 4 );
5468
5469 if ( it.key() == QLatin1String( "font-family" ) )
5470 {
5471 fontFamily = it.value();
5472 }
5473 else if ( it.key() == QLatin1String( "font-style" ) )
5474 {
5475 fontItalic = ( it.value() == QLatin1String( "italic" ) ) || ( it.value() == QLatin1String( "Italic" ) );
5476 }
5477 else if ( it.key() == QLatin1String( "font-size" ) )
5478 {
5479 bool ok;
5480 int fontSize = it.value().toInt( &ok );
5481 if ( ok )
5482 {
5483 fontPointSize = fontSize;
5484 fontUnitSize = sldUnitSize;
5485 }
5486 }
5487 else if ( it.key() == QLatin1String( "font-weight" ) )
5488 {
5489 if ( ( it.value() == QLatin1String( "bold" ) ) || ( it.value() == QLatin1String( "Bold" ) ) )
5490 fontWeight = QFont::Bold;
5491 }
5492 else if ( it.key() == QLatin1String( "font-underline" ) )
5493 {
5494 fontUnderline = ( it.value() == QLatin1String( "underline" ) ) || ( it.value() == QLatin1String( "Underline" ) );
5495 }
5496 }
5497 }
5498
5499 QgsTextFormat format;
5500 QFont font( fontFamily, fontPointSize, fontWeight, fontItalic );
5501 font.setUnderline( fontUnderline );
5502 format.setFont( font );
5503 format.setSize( fontPointSize );
5504 format.setSizeUnit( fontUnitSize );
5505
5506 // Fill
5507 QDomElement fillElem = textSymbolizerElem.firstChildElement( QStringLiteral( "Fill" ) );
5508 QColor textColor;
5509 Qt::BrushStyle textBrush = Qt::SolidPattern;
5510 QgsSymbolLayerUtils::fillFromSld( fillElem, textBrush, textColor );
5511 if ( textColor.isValid() )
5512 {
5513 QgsDebugMsgLevel( QStringLiteral( "Info: textColor %1." ).arg( QVariant( textColor ).toString() ), 4 );
5514 format.setColor( textColor );
5515 }
5516
5517 QgsTextBufferSettings bufferSettings;
5518
5519 // Halo
5520 QDomElement haloElem = textSymbolizerElem.firstChildElement( QStringLiteral( "Halo" ) );
5521 if ( !haloElem.isNull() )
5522 {
5523 bufferSettings.setEnabled( true );
5524 bufferSettings.setSize( 1 );
5525
5526 QDomElement radiusElem = haloElem.firstChildElement( QStringLiteral( "Radius" ) );
5527 if ( !radiusElem.isNull() )
5528 {
5529 bool ok;
5530 double bufferSize = radiusElem.text().toDouble( &ok );
5531 if ( ok )
5532 {
5533 bufferSettings.setSize( bufferSize );
5534 bufferSettings.setSizeUnit( sldUnitSize );
5535 }
5536 }
5537
5538 QDomElement haloFillElem = haloElem.firstChildElement( QStringLiteral( "Fill" ) );
5539 QColor bufferColor;
5540 Qt::BrushStyle bufferBrush = Qt::SolidPattern;
5541 QgsSymbolLayerUtils::fillFromSld( haloFillElem, bufferBrush, bufferColor );
5542 if ( bufferColor.isValid() )
5543 {
5544 QgsDebugMsgLevel( QStringLiteral( "Info: bufferColor %1." ).arg( QVariant( bufferColor ).toString() ), 4 );
5545 bufferSettings.setColor( bufferColor );
5546 }
5547 }
5548
5549 // LabelPlacement
5550 QDomElement labelPlacementElem = textSymbolizerElem.firstChildElement( QStringLiteral( "LabelPlacement" ) );
5551 if ( !labelPlacementElem.isNull() )
5552 {
5553 // PointPlacement
5554 QDomElement pointPlacementElem = labelPlacementElem.firstChildElement( QStringLiteral( "PointPlacement" ) );
5555 if ( !pointPlacementElem.isNull() )
5556 {
5559 {
5561 }
5562
5563 QDomElement displacementElem = pointPlacementElem.firstChildElement( QStringLiteral( "Displacement" ) );
5564 if ( !displacementElem.isNull() )
5565 {
5566 QDomElement displacementXElem = displacementElem.firstChildElement( QStringLiteral( "DisplacementX" ) );
5567 if ( !displacementXElem.isNull() )
5568 {
5569 bool ok;
5570 double xOffset = displacementXElem.text().toDouble( &ok );
5571 if ( ok )
5572 {
5573 settings.xOffset = xOffset;
5574 settings.offsetUnits = sldUnitSize;
5575 }
5576 }
5577 QDomElement displacementYElem = displacementElem.firstChildElement( QStringLiteral( "DisplacementY" ) );
5578 if ( !displacementYElem.isNull() )
5579 {
5580 bool ok;
5581 double yOffset = displacementYElem.text().toDouble( &ok );
5582 if ( ok )
5583 {
5584 settings.yOffset = yOffset;
5585 settings.offsetUnits = sldUnitSize;
5586 }
5587 }
5588 }
5589 QDomElement anchorPointElem = pointPlacementElem.firstChildElement( QStringLiteral( "AnchorPoint" ) );
5590 if ( !anchorPointElem.isNull() )
5591 {
5592 QDomElement anchorPointXElem = anchorPointElem.firstChildElement( QStringLiteral( "AnchorPointX" ) );
5593 if ( !anchorPointXElem.isNull() )
5594 {
5595 bool ok;
5596 double xOffset = anchorPointXElem.text().toDouble( &ok );
5597 if ( ok )
5598 {
5599 settings.xOffset = xOffset;
5600 settings.offsetUnits = sldUnitSize;
5601 }
5602 }
5603 QDomElement anchorPointYElem = anchorPointElem.firstChildElement( QStringLiteral( "AnchorPointY" ) );
5604 if ( !anchorPointYElem.isNull() )
5605 {
5606 bool ok;
5607 double yOffset = anchorPointYElem.text().toDouble( &ok );
5608 if ( ok )
5609 {
5610 settings.yOffset = yOffset;
5611 settings.offsetUnits = sldUnitSize;
5612 }
5613 }
5614 }
5615
5616 QDomElement rotationElem = pointPlacementElem.firstChildElement( QStringLiteral( "Rotation" ) );
5617 if ( !rotationElem.isNull() )
5618 {
5619 bool ok;
5620 double rotation = rotationElem.text().toDouble( &ok );
5621 if ( ok )
5622 {
5623 settings.angleOffset = 360 - rotation;
5624 }
5625 }
5626 }
5627 else
5628 {
5629 // PointPlacement
5630 QDomElement linePlacementElem = labelPlacementElem.firstChildElement( QStringLiteral( "LinePlacement" ) );
5631 if ( !linePlacementElem.isNull() )
5632 {
5634 }
5635 }
5636 }
5637
5638 // read vendor options
5639 QgsStringMap vendorOptions;
5640 QDomElement vendorOptionElem = textSymbolizerElem.firstChildElement( QStringLiteral( "VendorOption" ) );
5641 while ( !vendorOptionElem.isNull() && vendorOptionElem.localName() == QLatin1String( "VendorOption" ) )
5642 {
5643 QString optionName = vendorOptionElem.attribute( QStringLiteral( "name" ) );
5644 QString optionValue;
5645 if ( vendorOptionElem.firstChild().nodeType() == QDomNode::TextNode )
5646 {
5647 optionValue = vendorOptionElem.firstChild().nodeValue();
5648 }
5649 else
5650 {
5651 if ( vendorOptionElem.firstChild().nodeType() == QDomNode::ElementNode &&
5652 vendorOptionElem.firstChild().localName() == QLatin1String( "Literal" ) )
5653 {
5654 QgsDebugMsgLevel( vendorOptionElem.firstChild().localName(), 2 );
5655 optionValue = vendorOptionElem.firstChild().firstChild().nodeValue();
5656 }
5657 else
5658 {
5659 QgsDebugError( QStringLiteral( "unexpected child of %1 named %2" ).arg( vendorOptionElem.localName(), optionName ) );
5660 }
5661 }
5662
5663 if ( !optionName.isEmpty() && !optionValue.isEmpty() )
5664 {
5665 vendorOptions[ optionName ] = optionValue;
5666 }
5667
5668 vendorOptionElem = vendorOptionElem.nextSiblingElement();
5669 }
5670 if ( !vendorOptions.isEmpty() )
5671 {
5672 for ( QgsStringMap::iterator it = vendorOptions.begin(); it != vendorOptions.end(); ++it )
5673 {
5674 if ( it.key() == QLatin1String( "underlineText" ) && it.value() == QLatin1String( "true" ) )
5675 {
5676 font.setUnderline( true );
5677 format.setFont( font );
5678 }
5679 else if ( it.key() == QLatin1String( "strikethroughText" ) && it.value() == QLatin1String( "true" ) )
5680 {
5681 font.setStrikeOut( true );
5682 format.setFont( font );
5683 }
5684 else if ( it.key() == QLatin1String( "maxDisplacement" ) )
5685 {
5687 }
5688 else if ( it.key() == QLatin1String( "followLine" ) && it.value() == QLatin1String( "true" ) )
5689 {
5691 {
5693 }
5694 else
5695 {
5697 }
5698 }
5699 else if ( it.key() == QLatin1String( "maxAngleDelta" ) )
5700 {
5701 bool ok;
5702 double angle = it.value().toDouble( &ok );
5703 if ( ok )
5704 {
5705 settings.maxCurvedCharAngleIn = angle;
5706 settings.maxCurvedCharAngleOut = angle;
5707 }
5708 }
5709 // miscellaneous options
5710 else if ( it.key() == QLatin1String( "conflictResolution" ) && it.value() == QLatin1String( "false" ) )
5711 {
5713 }
5714 else if ( it.key() == QLatin1String( "forceLeftToRight" ) && it.value() == QLatin1String( "false" ) )
5715 {
5717 }
5718 else if ( it.key() == QLatin1String( "group" ) && it.value() == QLatin1String( "yes" ) )
5719 {
5720 settings.lineSettings().setMergeLines( true );
5721 }
5722 else if ( it.key() == QLatin1String( "labelAllGroup" ) && it.value() == QLatin1String( "true" ) )
5723 {
5724 settings.lineSettings().setMergeLines( true );
5725 }
5726 }
5727 }
5728
5729 format.setBuffer( bufferSettings );
5730 settings.setFormat( format );
5731 return true;
5732}
5733
5735{
5737
5738 return mEditFormConfig;
5739}
5740
5742{
5744
5745 if ( mEditFormConfig == editFormConfig )
5746 return;
5747
5748 mEditFormConfig = editFormConfig;
5749 mEditFormConfig.onRelationsLoaded();
5750 emit editFormConfigChanged();
5751}
5752
5754{
5756
5757 QgsAttributeTableConfig config = mAttributeTableConfig;
5758
5759 if ( config.isEmpty() )
5760 config.update( fields() );
5761
5762 return config;
5763}
5764
5766{
5768
5769 if ( mAttributeTableConfig != attributeTableConfig )
5770 {
5771 mAttributeTableConfig = attributeTableConfig;
5772 emit configChanged();
5773 }
5774}
5775
5777{
5778 // called in a non-thread-safe way in some cases when calculating aggregates in a different thread
5780
5782}
5783
5790
5792{
5794
5795 if ( !mDiagramLayerSettings )
5796 mDiagramLayerSettings = new QgsDiagramLayerSettings();
5797 *mDiagramLayerSettings = s;
5798}
5799
5801{
5803
5804 QgsLayerMetadataFormatter htmlFormatter( metadata() );
5805 QString myMetadata = QStringLiteral( "<html><head></head>\n<body>\n" );
5806
5807 myMetadata += generalHtmlMetadata();
5808
5809 // Begin Provider section
5810 myMetadata += QStringLiteral( "<h1>" ) + tr( "Information from provider" ) + QStringLiteral( "</h1>\n<hr>\n" );
5811 myMetadata += QLatin1String( "<table class=\"list-view\">\n" );
5812
5813 // storage type
5814 if ( !storageType().isEmpty() )
5815 {
5816 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Storage" ) + QStringLiteral( "</td><td>" ) + storageType() + QStringLiteral( "</td></tr>\n" );
5817 }
5818
5819 // comment
5820 if ( !dataComment().isEmpty() )
5821 {
5822 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Comment" ) + QStringLiteral( "</td><td>" ) + dataComment() + QStringLiteral( "</td></tr>\n" );
5823 }
5824
5825 // encoding
5826 if ( const QgsVectorDataProvider *provider = dataProvider() )
5827 {
5828 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Encoding" ) + QStringLiteral( "</td><td>" ) + provider->encoding() + QStringLiteral( "</td></tr>\n" );
5829 myMetadata += provider->htmlMetadata();
5830 }
5831
5832 if ( isSpatial() )
5833 {
5834 // geom type
5836 if ( static_cast<int>( type ) < 0 || static_cast< int >( type ) > static_cast< int >( Qgis::GeometryType::Null ) )
5837 {
5838 QgsDebugMsgLevel( QStringLiteral( "Invalid vector type" ), 2 );
5839 }
5840 else
5841 {
5842 QString typeString( QStringLiteral( "%1 (%2)" ).arg( QgsWkbTypes::geometryDisplayString( geometryType() ),
5844 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Geometry" ) + QStringLiteral( "</td><td>" ) + typeString + QStringLiteral( "</td></tr>\n" );
5845 }
5846
5847 // Extent
5848 // Try to display extent 3D by default. If empty (probably because the data is 2D), fallback to the 2D version
5849 const QgsBox3D extentBox3D = extent3D();
5850 const QString extentAsStr = !extentBox3D.isEmpty() ? extentBox3D.toString() : extent().toString();
5851 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Extent" ) + QStringLiteral( "</td><td>" ) + extentAsStr + QStringLiteral( "</td></tr>\n" );
5852 }
5853
5854 // feature count
5855 QLocale locale = QLocale();
5856 locale.setNumberOptions( locale.numberOptions() &= ~QLocale::NumberOption::OmitGroupSeparator );
5857 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" )
5858 + tr( "Feature count" ) + QStringLiteral( "</td><td>" )
5859 + ( featureCount() == -1 ? tr( "unknown" ) : locale.toString( static_cast<qlonglong>( featureCount() ) ) )
5860 + QStringLiteral( "</td></tr>\n" );
5861
5862 // End Provider section
5863 myMetadata += QLatin1String( "</table>\n<br><br>" );
5864
5865 if ( isSpatial() )
5866 {
5867 // CRS
5868 myMetadata += crsHtmlMetadata();
5869 }
5870
5871 // identification section
5872 myMetadata += QStringLiteral( "<h1>" ) + tr( "Identification" ) + QStringLiteral( "</h1>\n<hr>\n" );
5873 myMetadata += htmlFormatter.identificationSectionHtml( );
5874 myMetadata += QLatin1String( "<br><br>\n" );
5875
5876 // extent section
5877 myMetadata += QStringLiteral( "<h1>" ) + tr( "Extent" ) + QStringLiteral( "</h1>\n<hr>\n" );
5878 myMetadata += htmlFormatter.extentSectionHtml( isSpatial() );
5879 myMetadata += QLatin1String( "<br><br>\n" );
5880
5881 // Start the Access section
5882 myMetadata += QStringLiteral( "<h1>" ) + tr( "Access" ) + QStringLiteral( "</h1>\n<hr>\n" );
5883 myMetadata += htmlFormatter.accessSectionHtml( );
5884 myMetadata += QLatin1String( "<br><br>\n" );
5885
5886 // Fields section
5887 myMetadata += QStringLiteral( "<h1>" ) + tr( "Fields" ) + QStringLiteral( "</h1>\n<hr>\n<table class=\"list-view\">\n" );
5888
5889 // primary key
5891 if ( !pkAttrList.isEmpty() )
5892 {
5893 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Primary key attributes" ) + QStringLiteral( "</td><td>" );
5894 const auto constPkAttrList = pkAttrList;
5895 for ( int idx : constPkAttrList )
5896 {
5897 myMetadata += fields().at( idx ).name() + ' ';
5898 }
5899 myMetadata += QLatin1String( "</td></tr>\n" );
5900 }
5901
5902 const QgsFields myFields = fields();
5903
5904 // count fields
5905 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Count" ) + QStringLiteral( "</td><td>" ) + QString::number( myFields.size() ) + QStringLiteral( "</td></tr>\n" );
5906
5907 myMetadata += QLatin1String( "</table>\n<br><table width=\"100%\" class=\"tabular-view\">\n" );
5908 myMetadata += QLatin1String( "<tr><th>" ) + tr( "Field" ) + QLatin1String( "</th><th>" ) + tr( "Type" ) + QLatin1String( "</th><th>" ) + tr( "Length" ) + QLatin1String( "</th><th>" ) + tr( "Precision" ) + QLatin1String( "</th><th>" ) + tr( "Comment" ) + QLatin1String( "</th></tr>\n" );
5909
5910 for ( int i = 0; i < myFields.size(); ++i )
5911 {
5912 QgsField myField = myFields.at( i );
5913 QString rowClass;
5914 if ( i % 2 )
5915 rowClass = QStringLiteral( "class=\"odd-row\"" );
5916 myMetadata += QLatin1String( "<tr " ) + rowClass + QLatin1String( "><td>" ) + myField.displayNameWithAlias() + QLatin1String( "</td><td>" ) + myField.typeName() + QLatin1String( "</td><td>" ) + QString::number( myField.length() ) + QLatin1String( "</td><td>" ) + QString::number( myField.precision() ) + QLatin1String( "</td><td>" ) + myField.comment() + QLatin1String( "</td></tr>\n" );
5917 }
5918
5919 //close field list
5920 myMetadata += QLatin1String( "</table>\n<br><br>" );
5921
5922 // Start the contacts section
5923 myMetadata += QStringLiteral( "<h1>" ) + tr( "Contacts" ) + QStringLiteral( "</h1>\n<hr>\n" );
5924 myMetadata += htmlFormatter.contactsSectionHtml( );
5925 myMetadata += QLatin1String( "<br><br>\n" );
5926
5927 // Start the links section
5928 myMetadata += QStringLiteral( "<h1>" ) + tr( "Links" ) + QStringLiteral( "</h1>\n<hr>\n" );
5929 myMetadata += htmlFormatter.linksSectionHtml( );
5930 myMetadata += QLatin1String( "<br><br>\n" );
5931
5932 // Start the history section
5933 myMetadata += QStringLiteral( "<h1>" ) + tr( "History" ) + QStringLiteral( "</h1>\n<hr>\n" );
5934 myMetadata += htmlFormatter.historySectionHtml( );
5935 myMetadata += QLatin1String( "<br><br>\n" );
5936
5937 myMetadata += customPropertyHtmlMetadata();
5938
5939 myMetadata += QLatin1String( "\n</body>\n</html>\n" );
5940 return myMetadata;
5941}
5942
5943void QgsVectorLayer::invalidateSymbolCountedFlag()
5944{
5946
5947 mSymbolFeatureCounted = false;
5948}
5949
5950void QgsVectorLayer::onFeatureCounterCompleted()
5951{
5953
5954 onSymbolsCounted();
5955 mFeatureCounter = nullptr;
5956}
5957
5958void QgsVectorLayer::onFeatureCounterTerminated()
5959{
5961
5962 mFeatureCounter = nullptr;
5963}
5964
5965void QgsVectorLayer::onJoinedFieldsChanged()
5966{
5968
5969 // some of the fields of joined layers have changed -> we need to update this layer's fields too
5970 updateFields();
5971}
5972
5973void QgsVectorLayer::onFeatureAdded( QgsFeatureId fid )
5974{
5976
5977 updateExtents();
5978
5979 emit featureAdded( fid );
5980}
5981
5982void QgsVectorLayer::onFeatureDeleted( QgsFeatureId fid )
5983{
5985
5986 updateExtents();
5987
5988 if ( mEditCommandActive || mCommitChangesActive )
5989 {
5990 mDeletedFids << fid;
5991 }
5992 else
5993 {
5994 mSelectedFeatureIds.remove( fid );
5995 emit featuresDeleted( QgsFeatureIds() << fid );
5996 }
5997
5998 emit featureDeleted( fid );
5999}
6000
6001void QgsVectorLayer::onRelationsLoaded()
6002{
6004
6005 mEditFormConfig.onRelationsLoaded();
6006}
6007
6008void QgsVectorLayer::onSymbolsCounted()
6009{
6011
6012 if ( mFeatureCounter )
6013 {
6014 mSymbolFeatureCounted = true;
6015 mSymbolFeatureCountMap = mFeatureCounter->symbolFeatureCountMap();
6016 mSymbolFeatureIdMap = mFeatureCounter->symbolFeatureIdMap();
6018 }
6019}
6020
6021QList<QgsRelation> QgsVectorLayer::referencingRelations( int idx ) const
6022{
6024
6025 if ( QgsProject *p = project() )
6026 return p->relationManager()->referencingRelations( this, idx );
6027 else
6028 return {};
6029}
6030
6031QList<QgsWeakRelation> QgsVectorLayer::weakRelations() const
6032{
6034
6035 return mWeakRelations;
6036}
6037
6038void QgsVectorLayer::setWeakRelations( const QList<QgsWeakRelation> &relations )
6039{
6041
6042 mWeakRelations = relations;
6043}
6044
6045bool QgsVectorLayer::loadAuxiliaryLayer( const QgsAuxiliaryStorage &storage, const QString &key )
6046{
6048
6049 bool rc = false;
6050
6051 QString joinKey = mAuxiliaryLayerKey;
6052 if ( !key.isEmpty() )
6053 joinKey = key;
6054
6055 if ( storage.isValid() && !joinKey.isEmpty() )
6056 {
6057 QgsAuxiliaryLayer *alayer = nullptr;
6058
6059 int idx = fields().lookupField( joinKey );
6060
6061 if ( idx >= 0 )
6062 {
6063 alayer = storage.createAuxiliaryLayer( fields().field( idx ), this );
6064
6065 if ( alayer )
6066 {
6067 setAuxiliaryLayer( alayer );
6068 rc = true;
6069 }
6070 }
6071 }
6072
6073 return rc;
6074}
6075
6077{
6079
6080 mAuxiliaryLayerKey.clear();
6081
6082 if ( mAuxiliaryLayer )
6083 removeJoin( mAuxiliaryLayer->id() );
6084
6085 if ( alayer )
6086 {
6087 addJoin( alayer->joinInfo() );
6088
6089 if ( !alayer->isEditable() )
6090 alayer->startEditing();
6091
6092 mAuxiliaryLayerKey = alayer->joinInfo().targetFieldName();
6093 }
6094
6095 mAuxiliaryLayer.reset( alayer );
6096 if ( mAuxiliaryLayer )
6097 mAuxiliaryLayer->setParent( this );
6098 updateFields();
6099}
6100
6102{
6104
6105 return mAuxiliaryLayer.get();
6106}
6107
6109{
6111
6112 return mAuxiliaryLayer.get();
6113}
6114
6115QSet<QgsMapLayerDependency> QgsVectorLayer::dependencies() const
6116{
6118
6119 if ( mDataProvider )
6120 return mDataProvider->dependencies() + mDependencies;
6121 return mDependencies;
6122}
6123
6124void QgsVectorLayer::emitDataChanged()
6125{
6127
6128 if ( mDataChangedFired )
6129 return;
6130
6131 // If we are asked to fire dataChanged from a layer we depend on,
6132 // be sure that this layer is not in the process of committing its changes, because
6133 // we will be asked to fire dataChanged at the end of his commit, and we don't
6134 // want to fire this signal more than necessary.
6135 if ( QgsVectorLayer *layerWeDependUpon = qobject_cast<QgsVectorLayer *>( sender() );
6136 layerWeDependUpon && layerWeDependUpon->mCommitChangesActive )
6137 return;
6138
6139 updateExtents(); // reset cached extent to reflect data changes
6140
6141 mDataChangedFired = true;
6142 emit dataChanged();
6143 mDataChangedFired = false;
6144}
6145
6146bool QgsVectorLayer::setDependencies( const QSet<QgsMapLayerDependency> &oDeps )
6147{
6149
6150 QSet<QgsMapLayerDependency> deps;
6151 const auto constODeps = oDeps;
6152 for ( const QgsMapLayerDependency &dep : constODeps )
6153 {
6154 if ( dep.origin() == QgsMapLayerDependency::FromUser )
6155 deps << dep;
6156 }
6157
6158 QSet<QgsMapLayerDependency> toAdd = deps - dependencies();
6159
6160 // disconnect layers that are not present in the list of dependencies anymore
6161 if ( QgsProject *p = project() )
6162 {
6163 for ( const QgsMapLayerDependency &dep : std::as_const( mDependencies ) )
6164 {
6165 QgsVectorLayer *lyr = static_cast<QgsVectorLayer *>( p->mapLayer( dep.layerId() ) );
6166 if ( !lyr )
6167 continue;
6168 disconnect( lyr, &QgsVectorLayer::featureAdded, this, &QgsVectorLayer::emitDataChanged );
6169 disconnect( lyr, &QgsVectorLayer::featureDeleted, this, &QgsVectorLayer::emitDataChanged );
6170 disconnect( lyr, &QgsVectorLayer::geometryChanged, this, &QgsVectorLayer::emitDataChanged );
6171 disconnect( lyr, &QgsVectorLayer::dataChanged, this, &QgsVectorLayer::emitDataChanged );
6173 disconnect( lyr, &QgsVectorLayer::afterCommitChanges, this, &QgsVectorLayer::emitDataChanged );
6174 }
6175 }
6176
6177 // assign new dependencies
6178 if ( mDataProvider )
6179 mDependencies = mDataProvider->dependencies() + deps;
6180 else
6181 mDependencies = deps;
6182 emit dependenciesChanged();
6183
6184 // connect to new layers
6185 if ( QgsProject *p = project() )
6186 {
6187 for ( const QgsMapLayerDependency &dep : std::as_const( mDependencies ) )
6188 {
6189 QgsVectorLayer *lyr = static_cast<QgsVectorLayer *>( p->mapLayer( dep.layerId() ) );
6190 if ( !lyr )
6191 continue;
6192 connect( lyr, &QgsVectorLayer::featureAdded, this, &QgsVectorLayer::emitDataChanged );
6193 connect( lyr, &QgsVectorLayer::featureDeleted, this, &QgsVectorLayer::emitDataChanged );
6194 connect( lyr, &QgsVectorLayer::geometryChanged, this, &QgsVectorLayer::emitDataChanged );
6195 connect( lyr, &QgsVectorLayer::dataChanged, this, &QgsVectorLayer::emitDataChanged );
6197 connect( lyr, &QgsVectorLayer::afterCommitChanges, this, &QgsVectorLayer::emitDataChanged );
6198 }
6199 }
6200
6201 // if new layers are present, emit a data change
6202 if ( ! toAdd.isEmpty() )
6203 emitDataChanged();
6204
6205 return true;
6206}
6207
6209{
6211
6212 if ( fieldIndex < 0 || fieldIndex >= mFields.count() || !mDataProvider )
6214
6215 QgsFieldConstraints::Constraints constraints = mFields.at( fieldIndex ).constraints().constraints();
6216
6217 // make sure provider constraints are always present!
6218 if ( mFields.fieldOrigin( fieldIndex ) == Qgis::FieldOrigin::Provider )
6219 {
6220 constraints |= mDataProvider->fieldConstraints( mFields.fieldOriginIndex( fieldIndex ) );
6221 }
6222
6223 return constraints;
6224}
6225
6226QMap< QgsFieldConstraints::Constraint, QgsFieldConstraints::ConstraintStrength> QgsVectorLayer::fieldConstraintsAndStrength( int fieldIndex ) const
6227{
6229
6230 QMap< QgsFieldConstraints::Constraint, QgsFieldConstraints::ConstraintStrength > m;
6231
6232 if ( fieldIndex < 0 || fieldIndex >= mFields.count() )
6233 return m;
6234
6235 QString name = mFields.at( fieldIndex ).name();
6236
6237 QMap< QPair< QString, QgsFieldConstraints::Constraint >, QgsFieldConstraints::ConstraintStrength >::const_iterator conIt = mFieldConstraintStrength.constBegin();
6238 for ( ; conIt != mFieldConstraintStrength.constEnd(); ++conIt )
6239 {
6240 if ( conIt.key().first == name )
6241 {
6242 m[ conIt.key().second ] = mFieldConstraintStrength.value( conIt.key() );
6243 }
6244 }
6245
6246 return m;
6247}
6248
6250{
6252
6253 if ( index < 0 || index >= mFields.count() )
6254 return;
6255
6256 QString name = mFields.at( index ).name();
6257
6258 // add constraint to existing constraints
6259 QgsFieldConstraints::Constraints constraints = mFieldConstraints.value( name, QgsFieldConstraints::Constraints() );
6260 constraints |= constraint;
6261 mFieldConstraints.insert( name, constraints );
6262
6263 mFieldConstraintStrength.insert( qMakePair( name, constraint ), strength );
6264
6265 updateFields();
6266}
6267
6269{
6271
6272 if ( index < 0 || index >= mFields.count() )
6273 return;
6274
6275 QString name = mFields.at( index ).name();
6276
6277 // remove constraint from existing constraints
6278 QgsFieldConstraints::Constraints constraints = mFieldConstraints.value( name, QgsFieldConstraints::Constraints() );
6279 constraints &= ~constraint;
6280 mFieldConstraints.insert( name, constraints );
6281
6282 mFieldConstraintStrength.remove( qMakePair( name, constraint ) );
6283
6284 updateFields();
6285}
6286
6288{
6290
6291 if ( index < 0 || index >= mFields.count() )
6292 return QString();
6293
6294 return mFields.at( index ).constraints().constraintExpression();
6295}
6296
6298{
6300
6301 if ( index < 0 || index >= mFields.count() )
6302 return QString();
6303
6304 return mFields.at( index ).constraints().constraintDescription();
6305}
6306
6307void QgsVectorLayer::setConstraintExpression( int index, const QString &expression, const QString &description )
6308{
6310
6311 if ( index < 0 || index >= mFields.count() )
6312 return;
6313
6314 if ( expression.isEmpty() )
6315 {
6316 mFieldConstraintExpressions.remove( mFields.at( index ).name() );
6317 }
6318 else
6319 {
6320 mFieldConstraintExpressions.insert( mFields.at( index ).name(), qMakePair( expression, description ) );
6321 }
6322 updateFields();
6323}
6324
6326{
6328
6329 if ( index < 0 || index >= mFields.count() )
6330 return;
6331
6332 mFieldConfigurationFlags.insert( mFields.at( index ).name(), flags );
6333 updateFields();
6334}
6335
6337{
6339
6340 if ( index < 0 || index >= mFields.count() )
6341 return;
6343 flags.setFlag( flag, active );
6345}
6346
6348{
6350
6351 if ( index < 0 || index >= mFields.count() )
6353
6354 return mFields.at( index ).configurationFlags();
6355}
6356
6358{
6360
6361 if ( index < 0 || index >= mFields.count() )
6362 return;
6363
6364 if ( setup.isNull() )
6365 mFieldWidgetSetups.remove( mFields.at( index ).name() );
6366 else
6367 mFieldWidgetSetups.insert( mFields.at( index ).name(), setup );
6368 updateFields();
6369}
6370
6372{
6374
6375 if ( index < 0 || index >= mFields.count() )
6376 return QgsEditorWidgetSetup();
6377
6378 return mFields.at( index ).editorWidgetSetup();
6379}
6380
6381QgsAbstractVectorLayerLabeling *QgsVectorLayer::readLabelingFromCustomProperties()
6382{
6384
6386 if ( customProperty( QStringLiteral( "labeling" ) ).toString() == QLatin1String( "pal" ) )
6387 {
6388 if ( customProperty( QStringLiteral( "labeling/enabled" ), QVariant( false ) ).toBool() )
6389 {
6390 // try to load from custom properties
6391 QgsPalLayerSettings settings;
6392 settings.readFromLayerCustomProperties( this );
6393 labeling = new QgsVectorLayerSimpleLabeling( settings );
6394 }
6395
6396 // also clear old-style labeling config
6397 removeCustomProperty( QStringLiteral( "labeling" ) );
6398 const auto constCustomPropertyKeys = customPropertyKeys();
6399 for ( const QString &key : constCustomPropertyKeys )
6400 {
6401 if ( key.startsWith( QLatin1String( "labeling/" ) ) )
6402 removeCustomProperty( key );
6403 }
6404 }
6405
6406 return labeling;
6407}
6408
6410{
6412
6413 return mAllowCommit;
6414}
6415
6416void QgsVectorLayer::setAllowCommit( bool allowCommit )
6417{
6419
6420 if ( mAllowCommit == allowCommit )
6421 return;
6422
6423 mAllowCommit = allowCommit;
6424 emit allowCommitChanged();
6425}
6426
6428{
6430
6431 return mGeometryOptions.get();
6432}
6433
6434void QgsVectorLayer::setReadExtentFromXml( bool readExtentFromXml )
6435{
6437
6438 mReadExtentFromXml = readExtentFromXml;
6439}
6440
6442{
6444
6445 return mReadExtentFromXml;
6446}
6447
6448void QgsVectorLayer::onDirtyTransaction( const QString &sql, const QString &name )
6449{
6451
6453 if ( tr && mEditBuffer )
6454 {
6455 qobject_cast<QgsVectorLayerEditPassthrough *>( mEditBuffer )->update( tr, sql, name );
6456 }
6457}
6458
6459QList<QgsVectorLayer *> QgsVectorLayer::DeleteContext::handledLayers( bool includeAuxiliaryLayers ) const
6460{
6461 QList<QgsVectorLayer *> layers;
6462 QMap<QgsVectorLayer *, QgsFeatureIds>::const_iterator i;
6463 for ( i = mHandledFeatures.begin(); i != mHandledFeatures.end(); ++i )
6464 {
6465 if ( includeAuxiliaryLayers || !qobject_cast< QgsAuxiliaryLayer * >( i.key() ) )
6466 layers.append( i.key() );
6467 }
6468 return layers;
6469}
6470
6472{
6473 return mHandledFeatures[layer];
6474}
The Qgis class provides global constants for use throughout the application.
Definition qgis.h:54
@ SelectAtId
Fast access to features using their ID.
@ CreateRenderer
Provider can create feature renderers using backend-specific formatting information....
@ CreateLabeling
Provider can set labeling settings using backend-specific formatting information. Since QGIS 3....
@ ReadLayerMetadata
Provider can read layer metadata from data store. Since QGIS 3.0. See QgsDataProvider::layerMetadata(...
@ DeleteFeatures
Allows deletion of features.
QFlags< VectorRenderingSimplificationFlag > VectorRenderingSimplificationFlags
Simplification flags for vector feature rendering.
Definition qgis.h:2938
@ Composition
Fix relation, related elements are part of the parent and a parent copy will copy any children or del...
@ Association
Loose relation, related elements are not part of the parent and a parent copy will not copy any child...
GeometryOperationResult
Success or failure of a geometry operation.
Definition qgis.h:2005
@ InvalidInputGeometryType
The input geometry (ring, part, split line, etc.) has not the correct geometry type.
@ Success
Operation succeeded.
@ SelectionIsEmpty
No features were selected.
@ AddRingNotInExistingFeature
The input ring doesn't have any existing ring to fit into.
@ AddRingNotClosed
The input ring is not closed.
@ SelectionIsGreaterThanOne
More than one features were selected.
@ LayerNotEditable
Cannot edit layer.
SpatialIndexPresence
Enumeration of spatial index presence states.
Definition qgis.h:522
@ Unknown
Spatial index presence cannot be determined, index may or may not exist.
VectorRenderingSimplificationFlag
Simplification flags for vector feature rendering.
Definition qgis.h:2923
@ NoSimplification
No simplification can be applied.
@ OverPoint
Arranges candidates over a point (or centroid of a polygon), or at a preset offset from the point....
@ Curved
Arranges candidates following the curvature of a line feature. Applies to line layers only.
@ AroundPoint
Arranges candidates in a circle around a point (or centroid of a polygon). Applies to point or polygo...
@ Line
Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon'...
@ Horizontal
Arranges horizontal candidates scattered throughout a polygon feature. Applies to polygon layers only...
@ PerimeterCurved
Arranges candidates following the curvature of a polygon's boundary. Applies to polygon layers only.
QFlags< VectorLayerTypeFlag > VectorLayerTypeFlags
Vector layer type flags.
Definition qgis.h:395
VectorSimplificationAlgorithm
Simplification algorithms for vector features.
Definition qgis.h:2907
@ Distance
The simplification uses the distance between points to remove duplicate points.
@ ExactIntersect
Use exact geometry intersection (slower) instead of bounding boxes.
@ SubsetOfAttributes
Fetch only a subset of attributes (setSubsetOfAttributes sets this flag)
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
@ FastExtent3D
Provider's 3D extent retrieval via QgsDataProvider::extent3D() is always guaranteed to be trivial/fas...
@ FastExtent2D
Provider's 2D extent retrieval via QgsDataProvider::extent() is always guaranteed to be trivial/fast ...
@ BufferedGroups
Buffered transactional editing means that all editable layers in the buffered transaction group are t...
FieldDomainSplitPolicy
Split policy for field domains.
Definition qgis.h:3757
@ Duplicate
Duplicate original value.
BlendMode
Blending modes defining the available composition modes that can be used when painting.
Definition qgis.h:4755
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:337
@ Polygon
Polygons.
@ Unknown
Unknown types.
@ Null
No geometry.
@ Generated
A generated relation is a child of a polymorphic relation.
@ Normal
A normal relation.
FieldDuplicatePolicy
Duplicate policy for fields.
Definition qgis.h:3789
@ Duplicate
Duplicate original value.
static const float DEFAULT_MAPTOPIXEL_THRESHOLD
Default threshold between map coordinates and device coordinates for map2pixel simplification.
Definition qgis.h:5881
QFlags< DataProviderReadFlag > DataProviderReadFlags
Flags which control data provider construction.
Definition qgis.h:450
FeatureAvailability
Possible return value for QgsFeatureSource::hasFeatures() to determine if a source is empty.
Definition qgis.h:541
@ FeaturesMaybeAvailable
There may be features available in this source.
@ FeaturesAvailable
There is at least one feature available in this source.
@ NoFeaturesAvailable
There are certainly no features available in this source.
@ Vector
Vector layer.
FieldOrigin
Field origin.
Definition qgis.h:1667
@ Provider
Field originates from the underlying data provider of the vector layer.
@ Edit
Field has been temporarily added in editing mode.
@ Unknown
The field origin has not been specified.
@ Expression
Field is calculated from an expression.
@ Join
Field originates from a joined layer.
RenderUnit
Rendering size units.
Definition qgis.h:5008
@ Points
Points (e.g., for font sizes)
@ LoadDefaultStyle
Reset the layer's style to the default for the datasource.
@ ForceReadOnly
Open layer in a read-only mode.
Aggregate
Available aggregates to calculate.
Definition qgis.h:5590
VertexMarkerType
Editing vertex markers, used for showing vertices during a edit operation.
Definition qgis.h:1796
@ SemiTransparentCircle
Semi-transparent circle marker.
@ Cross
Cross marker.
VectorEditResult
Specifies the result of a vector layer edit operation.
Definition qgis.h:1781
@ Success
Edit operation was successful.
@ InvalidLayer
Edit failed due to invalid layer.
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:256
@ Unknown
Unknown.
FieldConfigurationFlag
Configuration flags for fields These flags are meant to be user-configurable and are not describing a...
Definition qgis.h:1684
@ HideFromWfs
Field is not available if layer is served as WFS from QGIS server.
@ NoFlag
No flag is defined.
@ HideFromWms
Field is not available if layer is served as WMS from QGIS server.
@ AllowOverlapIfRequired
Avoids overlapping labels when possible, but permit overlaps if labels for features cannot otherwise ...
QFlags< FieldConfigurationFlag > FieldConfigurationFlags
Configuration flags for fields These flags are meant to be user-configurable and are not describing a...
Definition qgis.h:1699
@ AlwaysAllowUpsideDown
Show upside down for all labels, including dynamic ones.
SelectBehavior
Specifies how a selection should be applied.
Definition qgis.h:1734
@ SetSelection
Set selection, removing any existing selection.
@ AddToSelection
Add selection to current selection.
@ IntersectSelection
Modify current selection to include only select features which match.
@ RemoveFromSelection
Remove from current selection.
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...
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the labeling...
virtual void toSld(QDomNode &parent, const QVariantMap &props) const
Writes the SE 1.1 TextSymbolizer element based on the current layer labeling settings.
static QgsAbstractVectorLayerLabeling * create(const QDomElement &element, const QgsReadWriteContext &context)
Try to create instance of an implementation based on the XML data.
virtual QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context) const =0
Returns labeling configuration as XML element.
Storage and management of actions associated with a layer.
bool writeXml(QDomNode &layer_node) const
Writes the actions out in XML format.
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.
bool readXml(const QDomNode &layer_node)
Reads the actions in in XML format.
Utility class that encapsulates an action based on vector attributes.
Definition qgsaction.h:37
Utility class for calculating aggregates for a field (or expression) over the features from a vector ...
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.
This is a container for configuration of the attribute table.
void readXml(const QDomNode &node)
Deserialize to XML on layer load.
void update(const QgsFields &fields)
Update the configuration with the given fields.
void writeXml(QDomNode &node) const
Serialize to XML on layer save.
A vector of attributes.
Class allowing to manage the auxiliary storage for a vector layer.
QgsVectorLayerJoinInfo joinInfo() const
Returns information to use for joining with primary key and so on.
Class 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:43
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:325
bool isNull() const
Test if the box is null (holding no spatial information).
Definition qgsbox3d.cpp:310
bool isEmpty() const
Returns true if the box is empty.
Definition qgsbox3d.cpp:320
The QgsConditionalLayerStyles class holds conditional style information for a layer.
bool readXml(const QDomNode &node, const QgsReadWriteContext &context)
Reads the condition styles state from a DOM node.
bool writeXml(QDomNode &node, QDomDocument &doc, const QgsReadWriteContext &context) const
Writes the condition styles state to a DOM node.
This class 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.
Abstract base class for curved geometry type.
Definition qgscurve.h:35
virtual bool isClosed() const
Returns true if the curve is closed.
Definition qgscurve.cpp:53
QgsCurve * clone() const override=0
Clones the geometry by performing a deep copy.
virtual bool containsElevationData() const
Returns true if the data provider definitely contains elevation related data.
virtual bool leaveUpdateMode()
Leave update mode.
virtual QString subsetString() const
Returns the subset definition string currently in use by the layer and used by the provider to limit ...
QgsCoordinateTransformContext transformContext() const
Returns data provider coordinate transform context.
virtual Qgis::DataProviderFlags flags() const
Returns the generic data provider flags.
virtual QgsCoordinateReferenceSystem crs() const =0
Returns the coordinate system for the data source.
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 Qgis::ProviderStyleStorageCapabilities styleStorageCapabilities() const
Returns the style storage capabilities.
virtual QgsBox3D extent3D() const
Returns the 3D extent of the layer.
virtual QgsLayerMetadata layerMetadata() const
Returns layer metadata collected from the provider's source.
virtual bool isValid() const =0
Returns true if this is a valid layer.
virtual bool setSubsetString(const QString &subset, bool updateFeatureCount=true)
Set the subset string used to create a subset of features in the layer.
virtual QString dataSourceUri(bool expandAuthConfig=false) const
Gets the data source specification.
virtual void updateExtents()
Update the extents of the layer.
virtual void reloadData()
Reloads the data from the source for providers with data caches to synchronize, changes in the data s...
virtual bool enterUpdateMode()
Enter update mode.
virtual QgsRectangle extent() const =0
Returns the extent of the layer.
virtual void setTransformContext(const QgsCoordinateTransformContext &transformContext)
Sets data coordinate transform context to transformContext.
Class for storing the component parts of a RDBMS data source URI (e.g.
bool useEstimatedMetadata() const
Returns true if estimated metadata should be used for the connection.
The QgsDefaultValue class 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.
void readXml(const QDomElement &elem)
Reads the diagram settings from a DOM element.
void writeXml(QDomElement &layerElem, QDomDocument &doc) const
Writes the diagram settings to a DOM element.
Evaluates and returns the diagram settings relating to a diagram for a specific feature.
virtual void writeXml(QDomElement &layerElem, QDomDocument &doc, const QgsReadWriteContext &context) const =0
Writes diagram state to a DOM element.
virtual QList< QgsDiagramSettings > diagramSettings() const =0
Returns list with all diagram settings in the renderer.
virtual void readXml(const QDomElement &elem, const QgsReadWriteContext &context)=0
Reads diagram state from a DOM element.
Contains configuration settings for an editor form.
void readXml(const QDomNode &node, QgsReadWriteContext &context)
Read XML information Deserialize on project load.
void writeXml(QDomNode &node, const QgsReadWriteContext &context) const
Write XML information Serialize on project save.
Holder for the widget type and its configuration for a field.
QVariantMap config() const
void clear()
Clear error messages.
Definition qgserror.h:126
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 removeExpression(int index)
Remove an expression from the buffer.
void writeXml(QDomNode &layer_node, QDomDocument &document) const
Saves expressions to xml under the layer node.
void readXml(const QDomNode &layer_node)
Reads expressions from project file.
void updateFields(QgsFields &flds) const
Adds fields with the expressions buffered in this object to a QgsFields object.
void addExpression(const QString &exp, const QgsField &fld)
Add an expression to the buffer.
QList< QgsExpressionFieldBuffer::ExpressionField > expressions() const
void updateExpression(int index, const QString &exp)
Changes the expression at a given index.
void renameExpression(int index, const QString &name)
Renames an expression field at a given index.
An expression node which takes it value from a feature's field.
Class for 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.
virtual void toSld(QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const
used from subclasses to create SLD Rule elements following SLD v1.1 specs
virtual QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context)
Stores renderer properties to an XML element.
double referenceScale() const
Returns the symbology reference scale.
void setReferenceScale(double scale)
Sets the symbology reference scale.
static QgsFeatureRenderer * load(QDomElement &symbologyElem, const QgsReadWriteContext &context)
create a renderer from XML element
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer...
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 ...
This class wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFlags(Qgis::FeatureRequestFlags flags)
Sets flags that affect how features will be fetched.
QgsFeatureRequest & setFilterFids(const QgsFeatureIds &fids)
Sets the feature IDs that should be fetched.
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
QgsFeatureRequest & setFilterExpression(const QString &expression)
Set the filter expression.
QgsFeatureRequest & setExpressionContext(const QgsExpressionContext &context)
Sets the expression context used to evaluate filter expressions.
QgsFeatureRequest & setNoAttributes()
Set that no attributes will be fetched.
QgsFeatureRequest & setFilterFid(QgsFeatureId fid)
Sets the feature ID that should be fetched.
virtual bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags())
Adds a single feature to the sink.
QFlags< Flag > Flags
virtual QSet< QVariant > uniqueValues(int fieldIndex, int limit=-1) const
Returns the set of unique values contained within the specified fieldIndex from this source.
virtual Qgis::SpatialIndexPresence hasSpatialIndex() const
Returns an enum value representing the presence of a valid spatial index on the source,...
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:58
Q_INVOKABLE bool setAttribute(int field, const QVariant &attr)
Sets an attribute's value by field index.
QgsAttributes attributes
Definition qgsfeature.h:67
QgsFields fields
Definition qgsfeature.h:68
QgsFeatureId id
Definition qgsfeature.h:66
QgsGeometry geometry
Definition qgsfeature.h:69
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:53
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 ...
QString constraintExpression() const
Returns the constraint expression for the field, if set.
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().
QString constraintDescription() const
Returns the descriptive name for the constraint expression.
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:53
QString typeName() const
Gets the field type.
Definition qgsfield.cpp:162
QString name
Definition qgsfield.h:62
int precision
Definition qgsfield.h:59
int length
Definition qgsfield.h:58
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 displayName() const
Returns the name to use when displaying this field.
Definition qgsfield.cpp:96
Qgis::FieldConfigurationFlags configurationFlags
Definition qgsfield.h:66
QString alias
Definition qgsfield.h:63
QgsDefaultValue defaultValueDefinition
Definition qgsfield.h:64
QString comment
Definition qgsfield.h:61
QgsFieldConstraints constraints
Definition qgsfield.h:65
QgsEditorWidgetSetup editorWidgetSetup() const
Gets the editor widget setup for the field.
Definition qgsfield.cpp:746
Container of fields for a vector layer.
Definition qgsfields.h:46
int count
Definition qgsfields.h:50
bool isEmpty
Definition qgsfields.h:49
Q_INVOKABLE int indexFromName(const QString &fieldName) const
Gets the field index from the field name.
Q_INVOKABLE int indexOf(const QString &fieldName) const
Gets the field index from the field name.
Qgis::FieldOrigin fieldOrigin(int fieldIdx) const
Returns the field's origin (value from an enumeration).
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).
int fieldOriginIndex(int fieldIdx) const
Returns the field's origin index (its meaning is specific to each type of origin).
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
QStringList names
Definition qgsfields.h:51
The QgsGeometryOptions class contains options to automatically adjust geometries to constraints on a ...
A geometry is the spatial representation of a feature.
QgsBox3D boundingBox3D() const
Returns the 3D bounding box of the geometry.
bool equals(const QgsGeometry &geometry) const
Test if this geometry is exactly equal to another 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.
Class for metadata formatter.
A structured metadata store for a map layer.
void combine(const QgsAbstractMetadataBase *other) override
Combines the metadata from this object with the metadata from an other object.
Line string geometry type, with support for z-dimension and m-values.
Alters the size of rendered diagrams using a linear scaling.
static void warning(const QString &msg)
Goes to qWarning.
This class models dependencies with or between map layers.
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 void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Reads configuration from a DOM element previously written by writeXml()
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.
Base class for all map layer types.
Definition qgsmaplayer.h:76
QString name
Definition qgsmaplayer.h:80
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 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...
QgsMapLayer::LayerFlags flags() const
Returns the flags for this layer.
void editingStarted()
Emitted when editing on this layer has started.
QgsCoordinateReferenceSystem crs
Definition qgsmaplayer.h:83
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.
QString id
Definition qgsmaplayer.h:79
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:82
Qgis::LayerType type
Definition qgsmaplayer.h:86
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.
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:90
void setLegend(QgsMapLayerLegend *legend)
Assign a legend controller to the map layer.
double opacity
Definition qgsmaplayer.h:88
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:89
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())
Adds a message to the log instance (and creates it if necessary).
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.
A class to represent a 2D point.
Definition qgspointxy.h:60
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:49
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:107
QgsRelationManager * relationManager
Definition qgsproject.h:117
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 a 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:45
@ Double
Double value (including negative values)
Definition qgsproperty.h:55
@ Boolean
Boolean value.
Definition qgsproperty.h:51
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.
The class is used as a container of context for various read/write operations on other objects.
MAYBE_UNUSED NODISCARD 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 truncated to the sp...
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:44
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.
A child rule for QgsRuleBasedLabeling.
void appendChild(QgsRuleBasedLabeling::Rule *rule)
add child rule, take ownership, sets this as parent
Rule based labeling for a vector layer.
A boolean settings entry.
A double settings entry.
A template class for enum and flag settings entry.
static QgsSettingsTreeNode * sTreeQgis
This class is a composition of two QSettings instances:
Definition qgssettings.h:64
Renders the diagrams for all features with the same settings.
Renders diagrams using mixed diagram render types.
Manages stored expressions regarding creation, modification and storing in the project.
bool writeXml(QDomNode &layerNode) const
Writes the stored expressions out in XML format.
bool readXml(const QDomNode &layerNode)
Reads the stored expressions in in XML format.
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....
bool isActive() const
Returns true if the temporal property is active.
Container for settings relating to a text buffer.
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.
Container for all settings relating to text rendering.
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.
This class allows including a set of layers in a database-side transaction, provided the layer data p...
QString createSavepoint(QString &error)
creates a save point returns empty string on error returns the last created savepoint if it's not dir...
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.
This is the base class for vector data providers.
virtual QString dataComment() const override
Returns a short comment for the data that this provider is providing access to (e....
virtual QVariant aggregate(Qgis::Aggregate aggregate, int index, const QgsAggregateCalculator::AggregateParameters &parameters, QgsExpressionContext *context, bool &ok, QgsFeatureIds *fids=nullptr) const
Calculates an aggregated value from the layer's features.
static const int EditingCapabilities
Bitmask of all provider's editing capabilities.
long long featureCount() const override=0
Number of features in the layer.
virtual QgsFeatureRenderer * createRenderer(const QVariantMap &configuration=QVariantMap()) const
Creates a new vector layer feature renderer, using provider backend specific information.
virtual QString storageType() const
Returns the permanent storage type for this layer as a friendly name.
virtual 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) const
Signals an error in this provider.
virtual bool isSqlQuery() const
Returns true if the layer is a query (SQL) layer.
virtual bool empty() const
Returns true if the layer does not contain any feature.
virtual Q_INVOKABLE Qgis::VectorProviderCapabilities capabilities() const
Returns flags containing the supported capabilities.
virtual QgsAttributeList pkAttributeIndexes() const
Returns list of indexes of fields that make up the primary key.
virtual void handlePostCloneOperations(QgsVectorDataProvider *source)
Handles any post-clone operations required after this vector data provider was cloned from the source...
virtual QSet< QgsMapLayerDependency > dependencies() const
Gets the list of layer ids on which this layer depends.
virtual void setEncoding(const QString &e)
Set encoding used for accessing data from layer.
virtual Qgis::VectorLayerTypeFlags vectorLayerTypeFlags() const
Returns the vector layer type flags.
QVariant maximumValue(int index) const override
Returns the maximum value of an attribute.
QgsDataProviderElevationProperties * elevationProperties() override
Returns the provider's elevation properties.
QgsFields fields() const override=0
Returns the fields associated with this data provider.
Qgis::WkbType wkbType() const override=0
Returns the geometry type which is returned by this layer.
QVariant minimumValue(int index) const override
Returns the minimum value of an attribute.
QString encoding() const
Returns the encoding which is used for accessing data.
virtual QVariant defaultValue(int fieldIndex) const
Returns any literal default values which are present at the provider for a specified field index.
QgsFieldConstraints::Constraints fieldConstraints(int fieldIndex) const
Returns any constraints which are present at the provider for a specified field index.
virtual QgsTransaction * transaction() const
Returns the transaction this data provider is included in, if any.
virtual QgsAbstractVectorLayerLabeling * createLabeling(const QVariantMap &configuration=QVariantMap()) const
Creates labeling settings, using provider backend specific information.
QgsVectorDataProviderTemporalCapabilities * temporalCapabilities() override
Returns the provider's temporal capabilities.
QString capabilitiesString() const
Returns the above in friendly format.
bool commitChanges(QStringList &commitErrors, bool stopEditing=true)
Attempts to commit any changes to disk.
void committedAttributesDeleted(const QString &layerId, const QgsAttributeList &deletedAttributes)
Emitted after attribute deletion has been committed to the layer.
virtual bool deleteFeature(QgsFeatureId fid)
Delete a feature from the layer (but does not commit it)
QgsFeatureIds deletedFeatureIds() const
Returns a list of deleted feature IDs which are not committed.
QgsChangedAttributesMap changedAttributeValues() const
Returns a map of features with changed attributes values which are not committed.
void committedAttributeValuesChanges(const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues)
Emitted after feature attribute value changes have been committed to the layer.
virtual bool renameAttribute(int attr, const QString &newName)
Renames an attribute field (but does not commit it)
void geometryChanged(QgsFeatureId fid, const QgsGeometry &geom)
Emitted when a feature's geometry is changed.
virtual bool deleteFeatures(const QgsFeatureIds &fid)
Deletes a set of features from the layer (but does not commit it)
virtual bool addAttribute(const QgsField &field)
Adds an attribute field (but does not commit it) returns true if the field was added.
void committedAttributesAdded(const QString &layerId, const QList< QgsField > &addedAttributes)
Emitted after attribute addition has been committed to the layer.
virtual bool addFeatures(QgsFeatureList &features)
Insert a copy of the given features into the layer (but does not commit it)
virtual bool changeAttributeValues(QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues)
Changes values of attributes (but does not commit it).
QgsFeatureMap addedFeatures() const
Returns a map of new features which are not committed.
virtual bool isModified() const
Returns true if the provider has been modified since the last commit.
void updateFields(QgsFields &fields)
Updates fields.
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.
QgsGeometryMap changedGeometries() const
Returns a map of features with changed geometries which are not committed.
QgsVectorLayerEditBufferGroup * editBufferGroup() const
Returns the parent edit buffer group for this edit buffer, or nullptr if not part of a group.
QgsAttributeList deletedAttributeIds() const
Returns a list of deleted attributes fields which are not committed.
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.
virtual bool addFeature(QgsFeature &f)
Adds a feature.
virtual void rollBack()
Stop editing and discard the edits.
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.
virtual bool commitChanges(QStringList &commitErrors)
Attempts to commit any changes to disk.
virtual bool deleteAttribute(int attr)
Deletes an attribute field (but does not commit it)
virtual bool changeAttributeValue(QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant())
Changed an attribute value (but does not commit it)
virtual bool changeGeometry(QgsFeatureId fid, const QgsGeometry &geom)
Change feature's geometry.
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.
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.
Qgis::VectorEditResult deleteVertex(QgsFeatureId featureId, int vertex)
Deletes a vertex from a 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.
void setDefaultsFromLayer(QgsMapLayer *layer) override
Sets default properties based on sensible choices for the given map layer.
QgsVectorLayerElevationProperties * clone() const override
Creates a clone of the properties.
Counts the features in a QgsVectorLayer in task.
QHash< QString, long long > symbolFeatureCountMap() const
Returns the count for each symbol.
void cancel() override
Notifies the task that it should terminate.
QHash< QString, QgsFeatureIds > symbolFeatureIdMap() const
Returns the QgsFeatureIds for each symbol.
A feature iterator which iterates over features from a QgsVectorLayer.
Manages joined fields for a vector layer.
void resolveReferences(QgsProject *project)
Resolves layer IDs of joined layers using given project's available layers.
bool addJoin(const QgsVectorLayerJoinInfo &joinInfo)
Joins another vector layer to this layer.
void readXml(const QDomNode &layer_node)
Reads joins from project file.
void writeXml(QDomNode &layer_node, QDomDocument &document) const
Saves mVectorJoins to xml under the layer node.
const QgsVectorLayerJoinInfo * joinForFieldIndex(int index, const QgsFields &fields, int &sourceFieldIndex) const
Finds the vector join for a layer field index.
bool changeAttributeValue(QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant())
Changes attribute value in joined layers.
bool removeJoin(const QString &joinLayerId)
Removes a vector layer join.
bool containsJoins() const
Quick way to test if there is any join at all.
bool changeAttributeValues(QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues=QgsAttributeMap())
Changes attributes' values in joined layers.
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a list of features in joined layers.
void joinedFieldsChanged()
Emitted whenever the list of joined fields changes (e.g.
void updateFields(QgsFields &fields)
Updates field map with joined attributes.
bool deleteFeature(QgsFeatureId fid, QgsVectorLayer::DeleteContext *context=nullptr) const
Deletes a feature from joined layers.
const QgsVectorJoinList & vectorJoins() const
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.
QDomElement writeXml(QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) override
Writes the properties to a DOM element, to be used later with readXml().
bool readXml(const QDomElement &element, const QgsReadWriteContext &context) override
Reads temporal properties from a DOM element previously written by writeXml().
Basic implementation of the labeling interface.
Implementation of map layer temporal properties for vector layers.
void guessDefaultsFromFields(const QgsFields &fields)
Attempts to setup the temporal properties by scanning a set of fields and looking for standard naming...
void setDefaultsFromDataProviderTemporalCapabilities(const QgsDataProviderTemporalCapabilities *capabilities) override
Sets the layers temporal settings to appropriate defaults based on a provider's temporal capabilities...
Contains settings which reflect the context in which vector layer tool operations should consider.
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...
Represents a vector layer which manages a vector based data sets.
void setLabeling(QgsAbstractVectorLayerLabeling *labeling)
Sets labeling configuration.
QString attributeDisplayName(int index) const
Convenience function that returns the attribute alias if defined or the field name else.
QVariant maximumValue(int index) const FINAL
Returns the maximum value for an attribute column or an invalid variant in case of error.
int addExpressionField(const QString &exp, const QgsField &fld)
Add a new field which is calculated by the expression specified.
void committedFeaturesAdded(const QString &layerId, const QgsFeatureList &addedFeatures)
Emitted when features are added to the provider if not in transaction mode.
void setExtent(const QgsRectangle &rect) FINAL
Sets the extent.
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
QgsRectangle sourceExtent() const FINAL
Returns the extent of all geometries from the source.
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 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.
bool isModified() const override
Returns true if the provider has been modified since the last commit.
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 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 selectByRect(QgsRectangle &rect, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection)
Selects features found within the search rectangle (in layer's coordinates)
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.
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)
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...
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.
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.
QSet< QgsMapLayerDependency > dependencies() const FINAL
Gets the list of dependencies.
QgsMapLayerTemporalProperties * temporalProperties() override
Returns the layer's temporal properties.
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.
QgsExpressionContextScope * createExpressionContextScope() const FINAL
This method needs to be reimplemented in all classes which implement this interface and return an exp...
QgsMapLayerRenderer * createMapRenderer(QgsRenderContext &rendererContext) FINAL
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.
QgsVectorLayerFeatureCounter * countSymbolFeatures(bool storeSymbolFids=false)
Count features for symbols.
QPainter::CompositionMode featureBlendMode() const
Returns the current blending mode for features.
bool hasMapTips() const FINAL
Returns true if the layer contains map tips.
QString constraintExpression(int index) const
Returns the constraint expression for for a specified field index, if set.
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,...
bool isSpatial() const FINAL
Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeome...
const QgsDiagramLayerSettings * diagramLayerSettings() const
void setFieldConstraint(int index, QgsFieldConstraints::Constraint constraint, QgsFieldConstraints::ConstraintStrength strength=QgsFieldConstraints::ConstraintStrengthHard)
Sets a constraint for a specified field index.
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...
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
QgsAbstractProfileGenerator * createProfileGenerator(const QgsProfileRequest &request) override
Given a profile request, returns a new profile generator ready for generating elevation profiles.
QString htmlMetadata() const FINAL
Obtain a formatted HTML string containing assorted metadata for this layer.
Q_INVOKABLE QgsRectangle boundingBoxOfSelected() const
Returns the bounding box of the selected features. If there is no selection, QgsRectangle(0,...
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) FINAL
Adds a list of features to the sink.
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.
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.
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.
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.
QgsBox3D sourceExtent3D() const FINAL
Returns the 3D extent of all geometries from the source.
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.
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 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
~QgsVectorLayer() override
QgsCoordinateReferenceSystem sourceCrs() const FINAL
Returns the coordinate reference system for features in the source.
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.
QgsExpressionContext createExpressionContext() const FINAL
This method needs to be reimplemented in all classes which implement this interface and return an exp...
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.
bool setDependencies(const QSet< QgsMapLayerDependency > &layers) FINAL
Sets the list of dependencies.
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.
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.
void setProviderEncoding(const QString &encoding)
Sets the text encoding of the data provider.
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 bool deleteAttribute(int attr)
Deletes an attribute field (but does not commit it).
static const QgsSettingsEntryBool * settingsSimplifyLocal
void resolveReferences(QgsProject *project) FINAL
Resolves references to other layers (kept as layer IDs after reading XML) into layer objects.
bool simplifyDrawingCanbeApplied(const QgsRenderContext &renderContext, Qgis::VectorRenderingSimplificationFlag simplifyHint) const
Returns whether the VectorLayer can apply the specified simplification hint.
QgsMapLayerElevationProperties * elevationProperties() override
Returns the layer's elevation properties.
bool removeJoin(const QString &joinLayerId)
Removes a vector layer join.
Q_INVOKABLE void invertSelectionInRectangle(QgsRectangle &rect)
Inverts selection of features found within the search rectangle (in layer's coordinates)
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.
bool isEditable() const FINAL
Returns true if the provider is in editing mode.
QStringList commitErrors() const
Returns a list containing any error messages generated when attempting to commit changes to the layer...
QString storageType() const
Returns the permanent storage type for this layer as a friendly name.
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
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.
Q_INVOKABLE Qgis::WkbType wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
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.
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.
QVariant minimumValue(int index) const FINAL
Returns the minimum value for an attribute column or an invalid variant in case of error.
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.
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.
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
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 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.
long long featureCount() const FINAL
Returns feature count including changes which have not yet been committed If you need only the count ...
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.
bool readSld(const QDomNode &node, QString &errorMessage) FINAL
Q_INVOKABLE void selectByIds(const QgsFeatureIds &ids, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection)
Selects matching features using a list of feature IDs.
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.
void readOnlyChanged()
Emitted when the read only state of this layer is changed.
void removeExpressionField(int index)
Removes an expression field.
virtual 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.
bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) FINAL
Adds a single feature to the sink.
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.
QgsRectangle extent() const FINAL
Returns the extent of the layer.
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.
bool readXml(const QDomNode &layer_node, QgsReadWriteContext &context) FINAL
Reads vector layer specific state from project file Dom node.
void afterRollBack()
Emitted after changes are rolled back.
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...
void setDiagramLayerSettings(const QgsDiagramLayerSettings &s)
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.
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.
QString sourceName() const FINAL
Returns a friendly display name for the source.
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.
QgsBox3D extent3D() const FINAL
Returns the 3D extent of the layer.
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 reload() FINAL
Synchronises with changes in the datasource.
const QList< QgsVectorLayerJoinInfo > vectorJoins() const
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.
bool writeXml(QDomNode &layer_node, QDomDocument &doc, const QgsReadWriteContext &context) const FINAL
Writes vector layer specific state to project file Dom node.
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...
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.
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.
Qgis::FeatureAvailability hasFeatures() const FINAL
Determines if this vector layer has features.
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.
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
void setExtent3D(const QgsBox3D &rect) FINAL
Sets the extent.
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.
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
QSet< QVariant > uniqueValues(int fieldIndex, int limit=-1) const FINAL
Calculates a list of unique values contained within an attribute in the layer.
void setFieldSplitPolicy(int index, Qgis::FieldDomainSplitPolicy policy)
Sets a split policy for the field with the specified index.
bool forceLocalOptimization() const
Gets where the simplification executes, after fetch the geometries from provider, or when supported,...
Qgis::VectorRenderingSimplificationFlags simplifyHints() const
Gets the simplification hints of the vector layer managed.
float maximumScale() const
Gets the maximum scale at which the layer should be simplified.
Qgis::VectorSimplificationAlgorithm simplifyAlgorithm() const
Gets the local simplification algorithm of the vector layer managed.
void setThreshold(float threshold)
Sets the simplification threshold of the vector layer managed.
void setForceLocalOptimization(bool localOptimization)
Sets where the simplification executes, after fetch the geometries from provider, or when supported,...
void setSimplifyHints(Qgis::VectorRenderingSimplificationFlags simplifyHints)
Sets the simplification hints of the vector layer managed.
float threshold() const
Gets the simplification threshold of the vector layer managed.
void setMaximumScale(float maximumScale)
Sets the maximum scale at which the layer should be simplified.
void setSimplifyAlgorithm(Qgis::VectorSimplificationAlgorithm simplifyAlgorithm)
Sets the local simplification algorithm of the vector layer managed.
@ 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 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 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.
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:248
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:121
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:189
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:6429
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
Definition qgis.h:6410
QString qgsFlagValueToKeys(const T &value, bool *returnOk=nullptr)
Returns the value for the given keys of a flag.
Definition qgis.h:6468
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:6490
QMap< QString, QString > QgsStringMap
Definition qgis.h:6757
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
QList< int > QgsAttributeList
Definition qgsfield.h:27
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:41
#define QgsDebugError(str)
Definition qgslogger.h:40
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
#define RENDERER_TAG_NAME
Definition qgsrenderer.h:53
#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.