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