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