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