QGIS API Documentation 3.28.14-Firenze (exported)
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 "qgis.h" //for globals
25#include "qgssettings.h"
26#include "qgsvectorlayer.h"
27#include "qgsactionmanager.h"
28#include "qgsapplication.h"
29#include "qgsconditionalstyle.h"
31#include "qgscurve.h"
32#include "qgsdatasourceuri.h"
35#include "qgsfeature.h"
36#include "qgsfeaturerequest.h"
37#include "qgsfields.h"
38#include "qgsmaplayerfactory.h"
39#include "qgsgeometry.h"
41#include "qgslogger.h"
42#include "qgsmaplayerlegend.h"
43#include "qgsmessagelog.h"
44#include "qgsogcutils.h"
45#include "qgspainting.h"
46#include "qgspointxy.h"
47#include "qgsproject.h"
48#include "qgsproviderregistry.h"
49#include "qgsrectangle.h"
50#include "qgsrelationmanager.h"
51#include "qgsweakrelation.h"
52#include "qgsrendercontext.h"
64#include "qgspoint.h"
65#include "qgsrenderer.h"
66#include "qgssymbollayer.h"
67#include "qgsdiagramrenderer.h"
68#include "qgspallabeling.h"
72#include "qgsfeedback.h"
73#include "qgsxmlutils.h"
74#include "qgsunittypes.h"
75#include "qgstaskmanager.h"
76#include "qgstransaction.h"
77#include "qgsauxiliarystorage.h"
78#include "qgsgeometryoptions.h"
80#include "qgsruntimeprofiler.h"
82#include "qgsvectorlayerutils.h"
84#include "qgsprofilerequest.h"
85#include "qgssymbollayerutils.h"
86
87#include <QDir>
88#include <QFile>
89#include <QImage>
90#include <QPainter>
91#include <QPainterPath>
92#include <QPolygonF>
93#include <QProgressDialog>
94#include <QString>
95#include <QDomNode>
96#include <QVector>
97#include <QStringBuilder>
98#include <QUrl>
99#include <QUndoCommand>
100#include <QUrlQuery>
101#include <QUuid>
102#include <QRegularExpression>
103#include <QTimer>
104
105#include <limits>
106#include <optional>
107
108#ifdef TESTPROVIDERLIB
109#include <dlfcn.h>
110#endif
111
112typedef bool saveStyle_t(
113 const QString &uri,
114 const QString &qmlStyle,
115 const QString &sldStyle,
116 const QString &styleName,
117 const QString &styleDescription,
118 const QString &uiFileContent,
119 bool useAsDefault,
120 QString &errCause
121);
122
123typedef QString loadStyle_t(
124 const QString &uri,
125 QString &errCause
126);
127
128typedef int listStyles_t(
129 const QString &uri,
130 QStringList &ids,
131 QStringList &names,
132 QStringList &descriptions,
133 QString &errCause
134);
135
136typedef QString getStyleById_t(
137 const QString &uri,
138 QString styleID,
139 QString &errCause
140);
141
142typedef bool deleteStyleById_t(
143 const QString &uri,
144 QString styleID,
145 QString &errCause
146);
147
148
149QgsVectorLayer::QgsVectorLayer( const QString &vectorLayerPath,
150 const QString &baseName,
151 const QString &providerKey,
152 const QgsVectorLayer::LayerOptions &options )
153 : QgsMapLayer( QgsMapLayerType::VectorLayer, baseName, vectorLayerPath )
154 , mTemporalProperties( new QgsVectorLayerTemporalProperties( this ) )
155 , mElevationProperties( new QgsVectorLayerElevationProperties( this ) )
156 , mAuxiliaryLayer( nullptr )
157 , mAuxiliaryLayerKey( QString() )
158 , mReadExtentFromXml( options.readExtentFromXml )
159 , mRefreshRendererTimer( new QTimer( this ) )
160{
162
163 if ( options.fallbackCrs.isValid() )
164 setCrs( options.fallbackCrs, false );
165 mWkbType = options.fallbackWkbType;
166
167 setProviderType( providerKey );
168
169 mGeometryOptions = std::make_unique<QgsGeometryOptions>();
170 mActions = new QgsActionManager( this );
171 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 = new 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 QgsDataProvider::ReadFlags providerFlags = QgsDataProvider::ReadFlags();
185 if ( options.loadDefaultStyle )
186 {
188 }
189 if ( options.forceReadOnly )
190 {
191 providerFlags |= QgsDataProvider::ForceReadOnly;
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, [ = ] { triggerRepaint(); } );
217 connect( QgsProject::instance()->relationManager(), &QgsRelationManager::relationsLoaded, this, &QgsVectorLayer::onRelationsLoaded );
218
222
223 // Default simplify drawing settings
224 QgsSettings settings;
225 mSimplifyMethod.setSimplifyHints( settings.flagValue( QStringLiteral( "qgis/simplifyDrawingHints" ), mSimplifyMethod.simplifyHints(), QgsSettings::NoSection ) );
226 mSimplifyMethod.setSimplifyAlgorithm( settings.enumValue( QStringLiteral( "qgis/simplifyAlgorithm" ), mSimplifyMethod.simplifyAlgorithm() ) );
227 mSimplifyMethod.setThreshold( settings.value( QStringLiteral( "qgis/simplifyDrawingTol" ), mSimplifyMethod.threshold() ).toFloat() );
228 mSimplifyMethod.setForceLocalOptimization( settings.value( QStringLiteral( "qgis/simplifyLocal" ), mSimplifyMethod.forceLocalOptimization() ).toBool() );
229 mSimplifyMethod.setMaximumScale( settings.value( QStringLiteral( "qgis/simplifyMaxScale" ), mSimplifyMethod.maximumScale() ).toFloat() );
230
231 connect( mRefreshRendererTimer, &QTimer::timeout, this, [ = ] { triggerRepaint( true ); } );
232}
233
235{
236 emit willBeDeleted();
237
238 setValid( false );
239
240 delete mDataProvider;
241 delete mEditBuffer;
242 delete mJoinBuffer;
243 delete mExpressionFieldBuffer;
244 delete mLabeling;
245 delete mDiagramLayerSettings;
246 delete mDiagramRenderer;
247
248 delete mActions;
249
250 delete mRenderer;
251 delete mConditionalStyles;
252 delete mStoredExpressionManager;
253
254 if ( mFeatureCounter )
255 mFeatureCounter->cancel();
256
257 qDeleteAll( mRendererGenerators );
258}
259
261{
263 // We get the data source string from the provider when
264 // possible because some providers may have changed it
265 // directly (memory provider does that).
266 QString dataSource;
267 if ( mDataProvider )
268 {
269 dataSource = mDataProvider->dataSourceUri();
270 options.transformContext = mDataProvider->transformContext();
271 }
272 else
273 {
274 dataSource = source();
275 }
276 options.forceReadOnly = mDataSourceReadOnly;
277 QgsVectorLayer *layer = new QgsVectorLayer( dataSource, name(), mProviderKey, options );
278 if ( mDataProvider && layer->dataProvider() )
279 {
280 layer->dataProvider()->handlePostCloneOperations( mDataProvider );
281 }
282 QgsMapLayer::clone( layer );
283
284 QList<QgsVectorLayerJoinInfo> joins = vectorJoins();
285 const auto constJoins = joins;
286 for ( const QgsVectorLayerJoinInfo &join : constJoins )
287 {
288 // do not copy join information for auxiliary layer
289 if ( !auxiliaryLayer()
290 || ( auxiliaryLayer() && auxiliaryLayer()->id() != join.joinLayerId() ) )
291 layer->addJoin( join );
292 }
293
294 if ( mDataProvider )
295 layer->setProviderEncoding( mDataProvider->encoding() );
296 layer->setSubsetString( subsetString() );
299 layer->setReadOnly( isReadOnly() );
304
305 const auto constActions = actions()->actions();
306 for ( const QgsAction &action : constActions )
307 {
308 layer->actions()->addAction( action );
309 }
310
311 if ( auto *lRenderer = renderer() )
312 {
313 layer->setRenderer( lRenderer->clone() );
314 }
315
316 if ( auto *lLabeling = labeling() )
317 {
318 layer->setLabeling( lLabeling->clone() );
319 }
321
323
324 if ( auto *lDiagramRenderer = diagramRenderer() )
325 {
326 layer->setDiagramRenderer( lDiagramRenderer->clone() );
327 }
328
329 if ( auto *lDiagramLayerSettings = diagramLayerSettings() )
330 {
331 layer->setDiagramLayerSettings( *lDiagramLayerSettings );
332 }
333
334 for ( int i = 0; i < fields().count(); i++ )
335 {
336 layer->setFieldAlias( i, attributeAlias( i ) );
338 layer->setEditorWidgetSetup( i, editorWidgetSetup( i ) );
341
342 QMap< QgsFieldConstraints::Constraint, QgsFieldConstraints::ConstraintStrength> constraints = fieldConstraintsAndStrength( i );
343 auto constraintIt = constraints.constBegin();
344 for ( ; constraintIt != constraints.constEnd(); ++ constraintIt )
345 {
346 layer->setFieldConstraint( i, constraintIt.key(), constraintIt.value() );
347 }
348
349 if ( fields().fieldOrigin( i ) == QgsFields::OriginExpression )
350 {
351 layer->addExpressionField( expressionField( i ), fields().at( i ) );
352 }
353 }
354
356
357 if ( auto *lAuxiliaryLayer = auxiliaryLayer() )
358 layer->setAuxiliaryLayer( lAuxiliaryLayer->clone( layer ) );
359
360 layer->mElevationProperties = mElevationProperties->clone();
361 layer->mElevationProperties->setParent( layer );
362
363 return layer;
364}
365
367{
368 if ( mDataProvider )
369 {
370 return mDataProvider->storageType();
371 }
372 return QString();
373}
374
375
377{
378 if ( mDataProvider )
379 {
380 return mDataProvider->capabilitiesString();
381 }
382 return QString();
383}
384
386{
387 return mDataProvider && mDataProvider->isSqlQuery();
388}
389
390Qgis::VectorLayerTypeFlags QgsVectorLayer::vectorLayerTypeFlags() const
391{
392 return mDataProvider ? mDataProvider->vectorLayerTypeFlags() : Qgis::VectorLayerTypeFlags();
393}
394
396{
397 if ( mDataProvider )
398 {
399 return mDataProvider->dataComment();
400 }
401 return QString();
402}
403
408
410{
411 return name();
412}
413
415{
416 if ( mDataProvider )
417 {
418 mDataProvider->reloadData();
419 updateFields();
420 }
421}
422
424{
425 return new QgsVectorLayerRenderer( this, rendererContext );
426}
427
428
429void QgsVectorLayer::drawVertexMarker( double x, double y, QPainter &p, Qgis::VertexMarkerType type, int m )
430{
431 switch ( type )
432 {
434 p.setPen( QColor( 50, 100, 120, 200 ) );
435 p.setBrush( QColor( 200, 200, 210, 120 ) );
436 p.drawEllipse( x - m, y - m, m * 2 + 1, m * 2 + 1 );
437 break;
438
440 p.setPen( QColor( 255, 0, 0 ) );
441 p.drawLine( x - m, y + m, x + m, y - m );
442 p.drawLine( x - m, y - m, x + m, y + m );
443 break;
444
446 break;
447 }
448}
449
451{
452 mSelectedFeatureIds.insert( fid );
453 mPreviousSelectedFeatureIds.clear();
454
455 emit selectionChanged( QgsFeatureIds() << fid, QgsFeatureIds(), false );
456}
457
458void QgsVectorLayer::select( const QgsFeatureIds &featureIds )
459{
460 mSelectedFeatureIds.unite( featureIds );
461 mPreviousSelectedFeatureIds.clear();
462
463 emit selectionChanged( featureIds, QgsFeatureIds(), false );
464}
465
467{
468 mSelectedFeatureIds.remove( fid );
469 mPreviousSelectedFeatureIds.clear();
470
471 emit selectionChanged( QgsFeatureIds(), QgsFeatureIds() << fid, false );
472}
473
475{
476 mSelectedFeatureIds.subtract( featureIds );
477 mPreviousSelectedFeatureIds.clear();
478
479 emit selectionChanged( QgsFeatureIds(), featureIds, false );
480}
481
483{
484 // normalize the rectangle
485 rect.normalize();
486
487 QgsFeatureIds newSelection;
488
490 .setFilterRect( rect )
492 .setNoAttributes() );
493
494 QgsFeature feat;
495 while ( features.nextFeature( feat ) )
496 {
497 newSelection << feat.id();
498 }
499 features.close();
500
501 selectByIds( newSelection, behavior );
502}
503
504void QgsVectorLayer::selectByExpression( const QString &expression, Qgis::SelectBehavior behavior, QgsExpressionContext *context )
505{
506 QgsFeatureIds newSelection;
507
508 std::optional< QgsExpressionContext > defaultContext;
509 if ( !context )
510 {
511 defaultContext.emplace( QgsExpressionContextUtils::globalProjectLayerScopes( this ) );
512 context = &defaultContext.value();
513 }
514
516 {
518 .setExpressionContext( *context )
521
522 QgsFeatureIterator features = getFeatures( request );
523
524 if ( behavior == Qgis::SelectBehavior::AddToSelection )
525 {
526 newSelection = selectedFeatureIds();
527 }
528 QgsFeature feat;
529 while ( features.nextFeature( feat ) )
530 {
531 newSelection << feat.id();
532 }
533 features.close();
534 }
536 {
537 QgsExpression exp( expression );
538 exp.prepare( context );
539
540 QgsFeatureIds oldSelection = selectedFeatureIds();
541 QgsFeatureRequest request = QgsFeatureRequest().setFilterFids( oldSelection );
542
543 //refine request
544 if ( !exp.needsGeometry() )
547
548 QgsFeatureIterator features = getFeatures( request );
549 QgsFeature feat;
550 while ( features.nextFeature( feat ) )
551 {
552 context->setFeature( feat );
553 bool matches = exp.evaluate( context ).toBool();
554
555 if ( matches && behavior == Qgis::SelectBehavior::IntersectSelection )
556 {
557 newSelection << feat.id();
558 }
559 else if ( !matches && behavior == Qgis::SelectBehavior::RemoveFromSelection )
560 {
561 newSelection << feat.id();
562 }
563 }
564 }
565
566 selectByIds( newSelection );
567}
568
570{
571 QgsFeatureIds newSelection;
572
573 switch ( behavior )
574 {
576 newSelection = ids;
577 break;
578
580 newSelection = mSelectedFeatureIds + ids;
581 break;
582
584 newSelection = mSelectedFeatureIds - ids;
585 break;
586
588 newSelection = mSelectedFeatureIds.intersect( ids );
589 break;
590 }
591
592 QgsFeatureIds deselectedFeatures = mSelectedFeatureIds - newSelection;
593 mSelectedFeatureIds = newSelection;
594 mPreviousSelectedFeatureIds.clear();
595
596 emit selectionChanged( newSelection, deselectedFeatures, true );
597}
598
599void QgsVectorLayer::modifySelection( const QgsFeatureIds &selectIds, const QgsFeatureIds &deselectIds )
600{
601 QgsFeatureIds intersectingIds = selectIds & deselectIds;
602 if ( !intersectingIds.isEmpty() )
603 {
604 QgsDebugMsgLevel( QStringLiteral( "Trying to select and deselect the same item at the same time. Unsure what to do. Selecting dubious items." ), 3 );
605 }
606
607 mSelectedFeatureIds -= deselectIds;
608 mSelectedFeatureIds += selectIds;
609 mPreviousSelectedFeatureIds.clear();
610
611 emit selectionChanged( selectIds, deselectIds - intersectingIds, false );
612}
613
615{
617 ids.subtract( mSelectedFeatureIds );
618 selectByIds( ids );
619}
620
625
627{
628 // normalize the rectangle
629 rect.normalize();
630
632 .setFilterRect( rect )
634 .setNoAttributes() );
635
636 QgsFeatureIds selectIds;
637 QgsFeatureIds deselectIds;
638
639 QgsFeature fet;
640 while ( fit.nextFeature( fet ) )
641 {
642 if ( mSelectedFeatureIds.contains( fet.id() ) )
643 {
644 deselectIds << fet.id();
645 }
646 else
647 {
648 selectIds << fet.id();
649 }
650 }
651
652 modifySelection( selectIds, deselectIds );
653}
654
656{
657 if ( mSelectedFeatureIds.isEmpty() )
658 return;
659
660 const QgsFeatureIds previous = mSelectedFeatureIds;
662 mPreviousSelectedFeatureIds = previous;
663}
664
666{
667 if ( mPreviousSelectedFeatureIds.isEmpty() || !mSelectedFeatureIds.empty() )
668 return;
669
670 selectByIds( mPreviousSelectedFeatureIds );
671}
672
674{
675 return mDataProvider;
676}
677
679{
680 return mDataProvider;
681}
682
684{
685 return mTemporalProperties;
686}
687
689{
690 return mElevationProperties;
691}
692
694{
695 QgsProfileRequest modifiedRequest( request );
697 return new QgsVectorLayerProfileGenerator( this, modifiedRequest );
698}
699
700void QgsVectorLayer::setProviderEncoding( const QString &encoding )
701{
702 if ( isValid() && mDataProvider && mDataProvider->encoding() != encoding )
703 {
704 mDataProvider->setEncoding( encoding );
705 updateFields();
706 }
707}
708
710{
711 delete mDiagramRenderer;
712 mDiagramRenderer = r;
713 emit rendererChanged();
714 emit styleChanged();
715}
716
721
723{
724 return mWkbType;
725}
726
728{
729 if ( !isValid() || !isSpatial() || mSelectedFeatureIds.isEmpty() || !mDataProvider ) //no selected features
730 {
731 return QgsRectangle( 0, 0, 0, 0 );
732 }
733
734 QgsRectangle r, retval;
735 retval.setMinimal();
736
737 QgsFeature fet;
738 if ( mDataProvider->capabilities() & QgsVectorDataProvider::SelectAtId )
739 {
741 .setFilterFids( mSelectedFeatureIds )
742 .setNoAttributes() );
743
744 while ( fit.nextFeature( fet ) )
745 {
746 if ( !fet.hasGeometry() )
747 continue;
748 r = fet.geometry().boundingBox();
749 retval.combineExtentWith( r );
750 }
751 }
752 else
753 {
755 .setNoAttributes() );
756
757 while ( fit.nextFeature( fet ) )
758 {
759 if ( mSelectedFeatureIds.contains( fet.id() ) )
760 {
761 if ( fet.hasGeometry() )
762 {
763 r = fet.geometry().boundingBox();
764 retval.combineExtentWith( r );
765 }
766 }
767 }
768 }
769
770 if ( retval.width() == 0.0 || retval.height() == 0.0 )
771 {
772 // If all of the features are at the one point, buffer the
773 // rectangle a bit. If they are all at zero, do something a bit
774 // more crude.
775
776 if ( retval.xMinimum() == 0.0 && retval.xMaximum() == 0.0 &&
777 retval.yMinimum() == 0.0 && retval.yMaximum() == 0.0 )
778 {
779 retval.set( -1.0, -1.0, 1.0, 1.0 );
780 }
781 }
782
783 return retval;
784}
785
787{
788 return mLabelsEnabled && static_cast< bool >( mLabeling );
789}
790
792{
793 mLabelsEnabled = enabled;
794}
795
797{
798 if ( !mDiagramRenderer || !mDiagramLayerSettings )
799 return false;
800
801 QList<QgsDiagramSettings> settingList = mDiagramRenderer->diagramSettings();
802 if ( !settingList.isEmpty() )
803 {
804 return settingList.at( 0 ).enabled;
805 }
806 return false;
807}
808
809long long QgsVectorLayer::featureCount( const QString &legendKey ) const
810{
811 if ( !mSymbolFeatureCounted )
812 return -1;
813
814 return mSymbolFeatureCountMap.value( legendKey, -1 );
815}
816
817QgsFeatureIds QgsVectorLayer::symbolFeatureIds( const QString &legendKey ) const
818{
819 if ( !mSymbolFeatureCounted )
820 return QgsFeatureIds();
821
822 return mSymbolFeatureIdMap.value( legendKey, QgsFeatureIds() );
823}
825{
826 if ( ( mSymbolFeatureCounted || mFeatureCounter ) && !( storeSymbolFids && mSymbolFeatureIdMap.isEmpty() ) )
827 return mFeatureCounter;
828
829 mSymbolFeatureCountMap.clear();
830 mSymbolFeatureIdMap.clear();
831
832 if ( !isValid() )
833 {
834 QgsDebugMsgLevel( QStringLiteral( "invoked with invalid layer" ), 3 );
835 return mFeatureCounter;
836 }
837 if ( !mDataProvider )
838 {
839 QgsDebugMsgLevel( QStringLiteral( "invoked with null mDataProvider" ), 3 );
840 return mFeatureCounter;
841 }
842 if ( !mRenderer )
843 {
844 QgsDebugMsgLevel( QStringLiteral( "invoked with null mRenderer" ), 3 );
845 return mFeatureCounter;
846 }
847
848 if ( !mFeatureCounter || ( storeSymbolFids && mSymbolFeatureIdMap.isEmpty() ) )
849 {
850 mFeatureCounter = new QgsVectorLayerFeatureCounter( this, QgsExpressionContext(), storeSymbolFids );
851 connect( mFeatureCounter, &QgsTask::taskCompleted, this, &QgsVectorLayer::onFeatureCounterCompleted, Qt::UniqueConnection );
852 connect( mFeatureCounter, &QgsTask::taskTerminated, this, &QgsVectorLayer::onFeatureCounterTerminated, Qt::UniqueConnection );
853 QgsApplication::taskManager()->addTask( mFeatureCounter );
854 }
855
856 return mFeatureCounter;
857}
858
860{
861 // do not update extent by default when trust project option is activated
862 if ( force || !mReadExtentFromXml || ( mReadExtentFromXml && mXmlExtent.isNull() ) )
863 mValidExtent = false;
864}
865
867{
869 mValidExtent = true;
870}
871
872void QgsVectorLayer::updateDefaultValues( QgsFeatureId fid, QgsFeature feature )
873{
874 if ( !mDefaultValueOnUpdateFields.isEmpty() )
875 {
876 if ( !feature.isValid() )
877 feature = getFeature( fid );
878
879 int size = mFields.size();
880 for ( int idx : std::as_const( mDefaultValueOnUpdateFields ) )
881 {
882 if ( idx < 0 || idx >= size )
883 continue;
884
885 feature.setAttribute( idx, defaultValue( idx, feature ) );
886 updateFeature( feature, true );
887 }
888 }
889}
890
892{
893 QgsRectangle rect;
894 rect.setMinimal();
895
896 if ( !isSpatial() )
897 return rect;
898
899 if ( !mValidExtent && mLazyExtent && mReadExtentFromXml && !mXmlExtent.isNull() )
900 {
901 updateExtent( mXmlExtent );
902 mValidExtent = true;
903 mLazyExtent = false;
904 }
905
906 if ( !mValidExtent && mLazyExtent && mDataProvider && mDataProvider->isValid() )
907 {
908 // store the extent
909 updateExtent( mDataProvider->extent() );
910 mValidExtent = true;
911 mLazyExtent = false;
912
913 // show the extent
914 QgsDebugMsgLevel( QStringLiteral( "Extent of layer: %1" ).arg( mExtent.toString() ), 3 );
915 }
916
917 if ( mValidExtent )
918 return QgsMapLayer::extent();
919
920 if ( !isValid() || !mDataProvider )
921 {
922 QgsDebugMsgLevel( QStringLiteral( "invoked with invalid layer or null mDataProvider" ), 3 );
923 return rect;
924 }
925
926 if ( !mEditBuffer ||
927 ( !mDataProvider->transaction() && ( mEditBuffer->deletedFeatureIds().isEmpty() && mEditBuffer->changedGeometries().isEmpty() ) ) ||
929 {
930 mDataProvider->updateExtents();
931
932 // get the extent of the layer from the provider
933 // but only when there are some features already
934 if ( mDataProvider->featureCount() != 0 )
935 {
936 const QgsRectangle r = mDataProvider->extent();
937 rect.combineExtentWith( r );
938 }
939
940 if ( mEditBuffer && !mDataProvider->transaction() )
941 {
942 const auto addedFeatures = mEditBuffer->addedFeatures();
943 for ( QgsFeatureMap::const_iterator it = addedFeatures.constBegin(); it != addedFeatures.constEnd(); ++it )
944 {
945 if ( it->hasGeometry() )
946 {
947 const QgsRectangle r = it->geometry().boundingBox();
948 rect.combineExtentWith( r );
949 }
950 }
951 }
952 }
953 else
954 {
956 .setNoAttributes() );
957
958 QgsFeature fet;
959 while ( fit.nextFeature( fet ) )
960 {
961 if ( fet.hasGeometry() && fet.geometry().type() != QgsWkbTypes::UnknownGeometry )
962 {
963 const QgsRectangle bb = fet.geometry().boundingBox();
964 rect.combineExtentWith( bb );
965 }
966 }
967 }
968
969 if ( rect.xMinimum() > rect.xMaximum() && rect.yMinimum() > rect.yMaximum() )
970 {
971 // special case when there are no features in provider nor any added
972 rect = QgsRectangle(); // use rectangle with zero coordinates
973 }
974
975 updateExtent( rect );
976 mValidExtent = true;
977
978 // Send this (hopefully) up the chain to the map canvas
979 emit recalculateExtents();
980
981 return rect;
982}
983
985{
986 return extent();
987}
988
990{
991 if ( !isValid() || !mDataProvider )
992 {
993 QgsDebugMsgLevel( QStringLiteral( "invoked with invalid layer or null mDataProvider" ), 3 );
994 return customProperty( QStringLiteral( "storedSubsetString" ) ).toString();
995 }
996 return mDataProvider->subsetString();
997}
998
999bool QgsVectorLayer::setSubsetString( const QString &subset )
1000{
1001 if ( !isValid() || !mDataProvider )
1002 {
1003 QgsDebugMsgLevel( QStringLiteral( "invoked with invalid layer or null mDataProvider or while editing" ), 3 );
1004 setCustomProperty( QStringLiteral( "storedSubsetString" ), subset );
1005 return false;
1006 }
1007 else if ( mEditBuffer )
1008 {
1009 QgsDebugMsgLevel( QStringLiteral( "invoked while editing" ), 3 );
1010 return false;
1011 }
1012
1013 if ( subset == mDataProvider->subsetString() )
1014 return true;
1015
1016 bool res = mDataProvider->setSubsetString( subset );
1017
1018 // get the updated data source string from the provider
1019 mDataSource = mDataProvider->dataSourceUri();
1020 updateExtents();
1021 updateFields();
1022
1023 if ( res )
1024 {
1025 emit subsetStringChanged();
1027 }
1028
1029 return res;
1030}
1031
1033{
1034 if ( isValid() && mDataProvider && !mEditBuffer && ( isSpatial() && geometryType() != QgsWkbTypes::PointGeometry ) && ( mSimplifyMethod.simplifyHints() & simplifyHint ) && renderContext.useRenderingOptimization() )
1035 {
1036 double maximumSimplificationScale = mSimplifyMethod.maximumScale();
1037
1038 // check maximum scale at which generalisation should be carried out
1039 return !( maximumSimplificationScale > 1 && renderContext.rendererScale() <= maximumSimplificationScale );
1040 }
1041 return false;
1042}
1043
1045{
1046 return mConditionalStyles;
1047}
1048
1050{
1051 if ( !isValid() || !mDataProvider )
1052 return QgsFeatureIterator();
1053
1054 return QgsFeatureIterator( new QgsVectorLayerFeatureIterator( new QgsVectorLayerFeatureSource( this ), true, request ) );
1055}
1056
1058{
1059 QgsFeature feature;
1061 if ( feature.isValid() )
1062 return feature.geometry();
1063 else
1064 return QgsGeometry();
1065}
1066
1068{
1069 if ( !isValid() || !mEditBuffer || !mDataProvider )
1070 return false;
1071
1072
1073 if ( mGeometryOptions->isActive() )
1074 {
1075 QgsGeometry geom = feature.geometry();
1076 mGeometryOptions->apply( geom );
1077 feature.setGeometry( geom );
1078 }
1079
1080 bool success = mEditBuffer->addFeature( feature );
1081
1082 if ( success )
1083 {
1084 updateExtents();
1085
1086 if ( mJoinBuffer->containsJoins() )
1087 success = mJoinBuffer->addFeature( feature );
1088 }
1089
1090 return success;
1091}
1092
1093bool QgsVectorLayer::updateFeature( QgsFeature &updatedFeature, bool skipDefaultValues )
1094{
1095 if ( !mEditBuffer || !mDataProvider )
1096 {
1097 return false;
1098 }
1099
1100 QgsFeature currentFeature = getFeature( updatedFeature.id() );
1101 if ( currentFeature.isValid() )
1102 {
1103 bool hasChanged = false;
1104 bool hasError = false;
1105
1106 if ( ( updatedFeature.hasGeometry() || currentFeature.hasGeometry() ) && !updatedFeature.geometry().equals( currentFeature.geometry() ) )
1107 {
1108 QgsGeometry geometry = updatedFeature.geometry();
1109 if ( changeGeometry( updatedFeature.id(), geometry, true ) )
1110 {
1111 hasChanged = true;
1112 updatedFeature.setGeometry( geometry );
1113 }
1114 else
1115 {
1116 QgsDebugMsgLevel( QStringLiteral( "geometry of feature %1 could not be changed." ).arg( updatedFeature.id() ), 3 );
1117 }
1118 }
1119
1120 QgsAttributes fa = updatedFeature.attributes();
1121 QgsAttributes ca = currentFeature.attributes();
1122
1123 for ( int attr = 0; attr < fa.count(); ++attr )
1124 {
1125 if ( !qgsVariantEqual( fa.at( attr ), ca.at( attr ) ) )
1126 {
1127 if ( changeAttributeValue( updatedFeature.id(), attr, fa.at( attr ), ca.at( attr ), true ) )
1128 {
1129 hasChanged = true;
1130 }
1131 else
1132 {
1133 QgsDebugMsgLevel( QStringLiteral( "attribute %1 of feature %2 could not be changed." ).arg( attr ).arg( updatedFeature.id() ), 3 );
1134 hasError = true;
1135 }
1136 }
1137 }
1138 if ( hasChanged && !mDefaultValueOnUpdateFields.isEmpty() && !skipDefaultValues )
1139 updateDefaultValues( updatedFeature.id(), updatedFeature );
1140
1141 return !hasError;
1142 }
1143 else
1144 {
1145 QgsDebugMsgLevel( QStringLiteral( "feature %1 could not be retrieved" ).arg( updatedFeature.id() ), 3 );
1146 return false;
1147 }
1148}
1149
1150
1151bool QgsVectorLayer::insertVertex( double x, double y, QgsFeatureId atFeatureId, int beforeVertex )
1152{
1153 if ( !isValid() || !mEditBuffer || !mDataProvider )
1154 return false;
1155
1156 QgsVectorLayerEditUtils utils( this );
1157 bool result = utils.insertVertex( x, y, atFeatureId, beforeVertex );
1158 if ( result )
1159 updateExtents();
1160 return result;
1161}
1162
1163
1164bool QgsVectorLayer::insertVertex( const QgsPoint &point, QgsFeatureId atFeatureId, int beforeVertex )
1165{
1166 if ( !isValid() || !mEditBuffer || !mDataProvider )
1167 return false;
1168
1169 QgsVectorLayerEditUtils utils( this );
1170 bool result = utils.insertVertex( point, atFeatureId, beforeVertex );
1171 if ( result )
1172 updateExtents();
1173 return result;
1174}
1175
1176
1177bool QgsVectorLayer::moveVertex( double x, double y, QgsFeatureId atFeatureId, int atVertex )
1178{
1179 if ( !isValid() || !mEditBuffer || !mDataProvider )
1180 return false;
1181
1182 QgsVectorLayerEditUtils utils( this );
1183 bool result = utils.moveVertex( x, y, atFeatureId, atVertex );
1184
1185 if ( result )
1186 updateExtents();
1187 return result;
1188}
1189
1190bool QgsVectorLayer::moveVertex( const QgsPoint &p, QgsFeatureId atFeatureId, int atVertex )
1191{
1192 if ( !isValid() || !mEditBuffer || !mDataProvider )
1193 return false;
1194
1195 QgsVectorLayerEditUtils utils( this );
1196 bool result = utils.moveVertex( p, atFeatureId, atVertex );
1197
1198 if ( result )
1199 updateExtents();
1200 return result;
1201}
1202
1204{
1205 if ( !isValid() || !mEditBuffer || !mDataProvider )
1207
1208 QgsVectorLayerEditUtils utils( this );
1209 Qgis::VectorEditResult result = utils.deleteVertex( featureId, vertex );
1210
1211 if ( result == Qgis::VectorEditResult::Success )
1212 updateExtents();
1213 return result;
1214}
1215
1216
1218{
1219 if ( !isValid() || !mDataProvider || !( mDataProvider->capabilities() & QgsVectorDataProvider::DeleteFeatures ) )
1220 {
1221 return false;
1222 }
1223
1224 if ( !isEditable() )
1225 {
1226 return false;
1227 }
1228
1229 int deleted = 0;
1230 int count = mSelectedFeatureIds.size();
1231 // Make a copy since deleteFeature modifies mSelectedFeatureIds
1232 QgsFeatureIds selectedFeatures( mSelectedFeatureIds );
1233 for ( QgsFeatureId fid : std::as_const( selectedFeatures ) )
1234 {
1235 deleted += deleteFeature( fid, context ); // removes from selection
1236 }
1237
1239 updateExtents();
1240
1241 if ( deletedCount )
1242 {
1243 *deletedCount = deleted;
1244 }
1245
1246 return deleted == count;
1247}
1248
1249static const QgsPointSequence vectorPointXY2pointSequence( const QVector<QgsPointXY> &points )
1250{
1251 QgsPointSequence pts;
1252 pts.reserve( points.size() );
1253 QVector<QgsPointXY>::const_iterator it = points.constBegin();
1254 while ( it != points.constEnd() )
1255 {
1256 pts.append( QgsPoint( *it ) );
1257 ++it;
1258 }
1259 return pts;
1260}
1261Qgis::GeometryOperationResult QgsVectorLayer::addRing( const QVector<QgsPointXY> &ring, QgsFeatureId *featureId )
1262{
1263 return addRing( vectorPointXY2pointSequence( ring ), featureId );
1264}
1265
1267{
1268 if ( !isValid() || !mEditBuffer || !mDataProvider )
1270
1271 QgsVectorLayerEditUtils utils( this );
1273
1274 //first try with selected features
1275 if ( !mSelectedFeatureIds.isEmpty() )
1276 {
1277 result = utils.addRing( ring, mSelectedFeatureIds, featureId );
1278 }
1279
1281 {
1282 //try with all intersecting features
1283 result = utils.addRing( ring, QgsFeatureIds(), featureId );
1284 }
1285
1286 return result;
1287}
1288
1290{
1291 if ( !isValid() || !mEditBuffer || !mDataProvider )
1292 {
1293 delete ring;
1295 }
1296
1297 if ( !ring )
1298 {
1300 }
1301
1302 if ( !ring->isClosed() )
1303 {
1304 delete ring;
1306 }
1307
1308 QgsVectorLayerEditUtils utils( this );
1310
1311 //first try with selected features
1312 if ( !mSelectedFeatureIds.isEmpty() )
1313 {
1314 result = utils.addRing( static_cast< QgsCurve * >( ring->clone() ), mSelectedFeatureIds, featureId );
1315 }
1316
1318 {
1319 //try with all intersecting features
1320 result = utils.addRing( static_cast< QgsCurve * >( ring->clone() ), QgsFeatureIds(), featureId );
1321 }
1322
1323 delete ring;
1324 return result;
1325}
1326
1328{
1329 QgsPointSequence pts;
1330 pts.reserve( points.size() );
1331 for ( QList<QgsPointXY>::const_iterator it = points.constBegin(); it != points.constEnd() ; ++it )
1332 {
1333 pts.append( QgsPoint( *it ) );
1334 }
1335 return addPart( pts );
1336}
1337
1338#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
1339Qgis::GeometryOperationResult QgsVectorLayer::addPart( const QVector<QgsPointXY> &points )
1340{
1341 return addPart( vectorPointXY2pointSequence( points ) );
1342}
1343#endif
1344
1346{
1347 if ( !isValid() || !mEditBuffer || !mDataProvider )
1349
1350 //number of selected features must be 1
1351
1352 if ( mSelectedFeatureIds.empty() )
1353 {
1354 QgsDebugMsgLevel( QStringLiteral( "Number of selected features <1" ), 3 );
1356 }
1357 else if ( mSelectedFeatureIds.size() > 1 )
1358 {
1359 QgsDebugMsgLevel( QStringLiteral( "Number of selected features >1" ), 3 );
1361 }
1362
1363 QgsVectorLayerEditUtils utils( this );
1364 Qgis::GeometryOperationResult result = utils.addPart( points, *mSelectedFeatureIds.constBegin() );
1365
1367 updateExtents();
1368 return result;
1369}
1370
1372{
1373 if ( !isValid() || !mEditBuffer || !mDataProvider )
1375
1376 //number of selected features must be 1
1377
1378 if ( mSelectedFeatureIds.empty() )
1379 {
1380 QgsDebugMsgLevel( QStringLiteral( "Number of selected features <1" ), 3 );
1382 }
1383 else if ( mSelectedFeatureIds.size() > 1 )
1384 {
1385 QgsDebugMsgLevel( QStringLiteral( "Number of selected features >1" ), 3 );
1387 }
1388
1389 QgsVectorLayerEditUtils utils( this );
1390 Qgis::GeometryOperationResult result = utils.addPart( ring, *mSelectedFeatureIds.constBegin() );
1391
1393 updateExtents();
1394 return result;
1395}
1396
1397// TODO QGIS 4.0 -- this should return Qgis::GeometryOperationResult, not int
1398int QgsVectorLayer::translateFeature( QgsFeatureId featureId, double dx, double dy )
1399{
1400 if ( !isValid() || !mEditBuffer || !mDataProvider )
1401 return static_cast< int >( Qgis::GeometryOperationResult::LayerNotEditable );
1402
1403 QgsVectorLayerEditUtils utils( this );
1404 int result = utils.translateFeature( featureId, dx, dy );
1405
1406 if ( result == static_cast< int >( Qgis::GeometryOperationResult::Success ) )
1407 updateExtents();
1408 return result;
1409}
1410
1411Qgis::GeometryOperationResult QgsVectorLayer::splitParts( const QVector<QgsPointXY> &splitLine, bool topologicalEditing )
1412{
1413 return splitParts( vectorPointXY2pointSequence( splitLine ), topologicalEditing );
1414}
1415
1417{
1418 if ( !isValid() || !mEditBuffer || !mDataProvider )
1420
1421 QgsVectorLayerEditUtils utils( this );
1422 return utils.splitParts( splitLine, topologicalEditing );
1423}
1424
1425Qgis::GeometryOperationResult QgsVectorLayer::splitFeatures( const QVector<QgsPointXY> &splitLine, bool topologicalEditing )
1426{
1427 return splitFeatures( vectorPointXY2pointSequence( splitLine ), topologicalEditing );
1428}
1429
1431{
1432 QgsLineString splitLineString( splitLine );
1433 QgsPointSequence topologyTestPoints;
1434 bool preserveCircular = false;
1435 return splitFeatures( &splitLineString, topologyTestPoints, preserveCircular, topologicalEditing );
1436}
1437
1438Qgis::GeometryOperationResult QgsVectorLayer::splitFeatures( const QgsCurve *curve, QgsPointSequence &topologyTestPoints, bool preserveCircular, bool topologicalEditing )
1439{
1440 if ( !isValid() || !mEditBuffer || !mDataProvider )
1442
1443 QgsVectorLayerEditUtils utils( this );
1444 return utils.splitFeatures( curve, topologyTestPoints, preserveCircular, topologicalEditing );
1445}
1446
1448{
1449 if ( !isValid() || !mEditBuffer || !mDataProvider )
1450 return -1;
1451
1452 QgsVectorLayerEditUtils utils( this );
1453 return utils.addTopologicalPoints( geom );
1454}
1455
1457{
1458 return addTopologicalPoints( QgsPoint( p ) );
1459}
1460
1462{
1463 if ( !isValid() || !mEditBuffer || !mDataProvider )
1464 return -1;
1465
1466 QgsVectorLayerEditUtils utils( this );
1467 return utils.addTopologicalPoints( p );
1468}
1469
1471{
1472 if ( !mValid || !mEditBuffer || !mDataProvider )
1473 return -1;
1474
1475 QgsVectorLayerEditUtils utils( this );
1476 return utils.addTopologicalPoints( ps );
1477}
1478
1480{
1481 if ( mLabeling == labeling )
1482 return;
1483
1484 delete mLabeling;
1485 mLabeling = labeling;
1486}
1487
1489{
1490 if ( project() && project()->transactionMode() == Qgis::TransactionMode::BufferedGroups )
1491 return project()->startEditing( this );
1492
1493 if ( !isValid() || !mDataProvider )
1494 {
1495 return false;
1496 }
1497
1498 // allow editing if provider supports any of the capabilities
1499 if ( !supportsEditing() )
1500 {
1501 return false;
1502 }
1503
1504 if ( mEditBuffer )
1505 {
1506 // editing already underway
1507 return false;
1508 }
1509
1510 mDataProvider->enterUpdateMode();
1511
1512 emit beforeEditingStarted();
1513
1514 createEditBuffer();
1515
1516 updateFields();
1517
1518 emit editingStarted();
1519
1520 return true;
1521}
1522
1524{
1525 if ( mDataProvider )
1526 mDataProvider->setTransformContext( transformContext );
1527}
1528
1533
1535{
1536 if ( mRenderer )
1537 if ( !mRenderer->accept( visitor ) )
1538 return false;
1539
1540 if ( mLabeling )
1541 if ( !mLabeling->accept( visitor ) )
1542 return false;
1543
1544 return true;
1545}
1546
1547bool QgsVectorLayer::readXml( const QDomNode &layer_node, QgsReadWriteContext &context )
1548{
1549 QgsDebugMsgLevel( QStringLiteral( "Datasource in QgsVectorLayer::readXml: %1" ).arg( mDataSource.toLocal8Bit().data() ), 3 );
1550
1551 //process provider key
1552 QDomNode pkeyNode = layer_node.namedItem( QStringLiteral( "provider" ) );
1553
1554 if ( pkeyNode.isNull() )
1555 {
1556 mProviderKey.clear();
1557 }
1558 else
1559 {
1560 QDomElement pkeyElt = pkeyNode.toElement();
1561 mProviderKey = pkeyElt.text();
1562 }
1563
1564 // determine type of vector layer
1565 if ( !mProviderKey.isNull() )
1566 {
1567 // if the provider string isn't empty, then we successfully
1568 // got the stored provider
1569 }
1570 else if ( mDataSource.contains( QLatin1String( "dbname=" ) ) )
1571 {
1572 mProviderKey = QStringLiteral( "postgres" );
1573 }
1574 else
1575 {
1576 mProviderKey = QStringLiteral( "ogr" );
1577 }
1578
1579 const QDomElement elem = layer_node.toElement();
1581 QgsDataProvider::ReadFlags flags;
1583 {
1585 }
1587 {
1589 mDataSourceReadOnly = true;
1590 }
1591 if ( ( mReadFlags & QgsMapLayer::FlagDontResolveLayers ) || !setDataProvider( mProviderKey, options, flags ) )
1592 {
1594 {
1595 QgsDebugMsg( QStringLiteral( "Could not set data provider for layer %1" ).arg( publicSource() ) );
1596 }
1597
1598 // for invalid layer sources, we fallback to stored wkbType if available
1599 if ( elem.hasAttribute( QStringLiteral( "wkbType" ) ) )
1600 mWkbType = qgsEnumKeyToValue( elem.attribute( QStringLiteral( "wkbType" ) ), mWkbType );
1601 }
1602
1603 QDomElement pkeyElem = pkeyNode.toElement();
1604 if ( !pkeyElem.isNull() )
1605 {
1606 QString encodingString = pkeyElem.attribute( QStringLiteral( "encoding" ) );
1607 if ( mDataProvider && !encodingString.isEmpty() )
1608 {
1609 mDataProvider->setEncoding( encodingString );
1610 }
1611 }
1612
1613 // load vector joins - does not resolve references to layers yet
1614 mJoinBuffer->readXml( layer_node );
1615
1616 updateFields();
1617
1618 // If style doesn't include a legend, we'll need to make a default one later...
1619 mSetLegendFromStyle = false;
1620
1621 QString errorMsg;
1622 if ( !readSymbology( layer_node, errorMsg, context ) )
1623 {
1624 return false;
1625 }
1626
1627 readStyleManager( layer_node );
1628
1629 QDomNode depsNode = layer_node.namedItem( QStringLiteral( "dataDependencies" ) );
1630 QDomNodeList depsNodes = depsNode.childNodes();
1631 QSet<QgsMapLayerDependency> sources;
1632 for ( int i = 0; i < depsNodes.count(); i++ )
1633 {
1634 QString source = depsNodes.at( i ).toElement().attribute( QStringLiteral( "id" ) );
1635 sources << QgsMapLayerDependency( source );
1636 }
1637 setDependencies( sources );
1638
1639 if ( !mSetLegendFromStyle )
1641
1642 // read extent
1644 {
1645 mReadExtentFromXml = true;
1646 }
1647 if ( mReadExtentFromXml )
1648 {
1649 const QDomNode extentNode = layer_node.namedItem( QStringLiteral( "extent" ) );
1650 if ( !extentNode.isNull() )
1651 {
1652 mXmlExtent = QgsXmlUtils::readRectangle( extentNode.toElement() );
1653 }
1654 }
1655
1656 // auxiliary layer
1657 const QDomNode asNode = layer_node.namedItem( QStringLiteral( "auxiliaryLayer" ) );
1658 const QDomElement asElem = asNode.toElement();
1659 if ( !asElem.isNull() )
1660 {
1661 mAuxiliaryLayerKey = asElem.attribute( QStringLiteral( "key" ) );
1662 }
1663
1664 // QGIS Server WMS Dimensions
1665 mServerProperties->readXml( layer_node );
1666
1667 return isValid(); // should be true if read successfully
1668
1669} // void QgsVectorLayer::readXml
1670
1671
1672void QgsVectorLayer::setDataSourcePrivate( const QString &dataSource, const QString &baseName, const QString &provider,
1673 const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags )
1674{
1676
1677 mDataSource = dataSource;
1678 setName( baseName );
1679 setDataProvider( provider, options, flags );
1680
1681 if ( !isValid() )
1682 {
1683 return;
1684 }
1685
1686 // Always set crs
1688
1689 bool loadDefaultStyleFlag = false;
1691 {
1692 loadDefaultStyleFlag = true;
1693 }
1694
1695 // reset style if loading default style, style is missing, or geometry type is has changed (and layer is valid)
1696 if ( !renderer() || !legend() || ( isValid() && geomType != geometryType() ) || loadDefaultStyleFlag )
1697 {
1698 std::unique_ptr< QgsScopedRuntimeProfile > profile;
1699 if ( QgsApplication::profiler()->groupIsActive( QStringLiteral( "projectload" ) ) )
1700 profile = std::make_unique< QgsScopedRuntimeProfile >( tr( "Load layer style" ), QStringLiteral( "projectload" ) );
1701
1702 bool defaultLoadedFlag = false;
1703
1704 // defer style changed signal until we've set the renderer, labeling, everything.
1705 // we don't want multiple signals!
1706 ScopedIntIncrementor styleChangedSignalBlocker( &mBlockStyleChangedSignal );
1707
1708 // need to check whether the default style included a legend, and if not, we need to make a default legend
1709 // later...
1710 mSetLegendFromStyle = false;
1711
1712 // first check if there is a default style / propertysheet defined
1713 // for this layer and if so apply it
1714 // this should take precedence over all
1715 if ( !defaultLoadedFlag && loadDefaultStyleFlag )
1716 {
1717 loadDefaultStyle( defaultLoadedFlag );
1718 }
1719
1720 if ( loadDefaultStyleFlag && !defaultLoadedFlag && isSpatial() && mDataProvider->capabilities() & QgsVectorDataProvider::CreateRenderer )
1721 {
1722 // if we didn't load a default style for this layer, try to create a renderer directly from the data provider
1723 std::unique_ptr< QgsFeatureRenderer > defaultRenderer( mDataProvider->createRenderer() );
1724 if ( defaultRenderer )
1725 {
1726 defaultLoadedFlag = true;
1727 setRenderer( defaultRenderer.release() );
1728 }
1729 }
1730
1731 // if the default style failed to load or was disabled use some very basic defaults
1732 if ( !defaultLoadedFlag && isSpatial() )
1733 {
1734 // add single symbol renderer
1736 }
1737
1738 if ( !mSetLegendFromStyle )
1740
1741 if ( mDataProvider->capabilities() & QgsVectorDataProvider::CreateLabeling )
1742 {
1743 std::unique_ptr< QgsAbstractVectorLayerLabeling > defaultLabeling( mDataProvider->createLabeling() );
1744 if ( defaultLabeling )
1745 {
1746 setLabeling( defaultLabeling.release() );
1747 setLabelsEnabled( true );
1748 }
1749 }
1750
1751 styleChangedSignalBlocker.release();
1753 }
1754}
1755
1756QString QgsVectorLayer::loadDefaultStyle( bool &resultFlag )
1757{
1758 // first try to load a user-defined default style - this should always take precedence
1759 QString res = QgsMapLayer::loadDefaultStyle( resultFlag );
1760 if ( resultFlag )
1761 return res;
1762
1763 if ( isSpatial() && mDataProvider->capabilities() & QgsVectorDataProvider::CreateRenderer )
1764 {
1765 // otherwise try to create a renderer directly from the data provider
1766 std::unique_ptr< QgsFeatureRenderer > defaultRenderer( mDataProvider->createRenderer() );
1767 if ( defaultRenderer )
1768 {
1769 resultFlag = true;
1770 setRenderer( defaultRenderer.release() );
1771 return QString();
1772 }
1773 }
1774
1775 return QString();
1776}
1777
1778bool QgsVectorLayer::setDataProvider( QString const &provider, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags )
1779{
1780 mProviderKey = provider;
1781 delete mDataProvider;
1782
1783 // For Postgres provider primary key unicity is tested at construction time,
1784 // so it has to be set before initializing the provider,
1785 // this manipulation is necessary to preserve default behavior when
1786 // "trust layer metadata" project level option is set and checkPrimaryKeyUnicity
1787 // was not explicitly passed in the uri
1788 if ( provider.compare( QLatin1String( "postgres" ) ) == 0 )
1789 {
1790 const QString checkUnicityKey { QStringLiteral( "checkPrimaryKeyUnicity" ) };
1792 if ( ! uri.hasParam( checkUnicityKey ) )
1793 {
1794 uri.setParam( checkUnicityKey, mReadExtentFromXml ? "0" : "1" );
1795 mDataSource = uri.uri( false );
1796 }
1797 }
1798
1799 std::unique_ptr< QgsScopedRuntimeProfile > profile;
1800 if ( QgsApplication::profiler()->groupIsActive( QStringLiteral( "projectload" ) ) )
1801 profile = std::make_unique< QgsScopedRuntimeProfile >( tr( "Create %1 provider" ).arg( provider ), QStringLiteral( "projectload" ) );
1802
1803 mDataProvider = qobject_cast<QgsVectorDataProvider *>( QgsProviderRegistry::instance()->createProvider( provider, mDataSource, options, flags ) );
1804 if ( !mDataProvider )
1805 {
1806 setValid( false );
1807 QgsDebugMsgLevel( QStringLiteral( "Unable to get data provider" ), 2 );
1808 return false;
1809 }
1810
1811 mDataProvider->setParent( this );
1812 connect( mDataProvider, &QgsVectorDataProvider::raiseError, this, &QgsVectorLayer::raiseError );
1813
1814 QgsDebugMsgLevel( QStringLiteral( "Instantiated the data provider plugin" ), 2 );
1815
1816 setValid( mDataProvider->isValid() );
1817 if ( !isValid() )
1818 {
1819 QgsDebugMsgLevel( QStringLiteral( "Invalid provider plugin %1" ).arg( QString( mDataSource.toUtf8() ) ), 2 );
1820 return false;
1821 }
1822
1823 if ( profile )
1824 profile->switchTask( tr( "Read layer metadata" ) );
1826 {
1827 // we combine the provider metadata with the layer's existing metadata, so as not to reset any user customizations to the metadata
1828 // back to the default if a layer's data source is changed
1829 QgsLayerMetadata newMetadata = mDataProvider->layerMetadata();
1830 // this overwrites the provider metadata with any properties which are non-empty from the existing layer metadata
1831 newMetadata.combine( &mMetadata );
1832
1833 setMetadata( newMetadata );
1834 QgsDebugMsgLevel( QStringLiteral( "Set Data provider QgsLayerMetadata identifier[%1]" ).arg( metadata().identifier() ), 4 );
1835 }
1836
1837 // TODO: Check if the provider has the capability to send fullExtentCalculated
1838 connect( mDataProvider, &QgsVectorDataProvider::fullExtentCalculated, this, [ = ] { updateExtents(); } );
1839
1840 // get and store the feature type
1841 mWkbType = mDataProvider->wkbType();
1842
1843 // before we update the layer fields from the provider, we first copy any default set alias and
1844 // editor widget config from the data provider fields, if present
1845 const QgsFields providerFields = mDataProvider->fields();
1846 for ( const QgsField &field : providerFields )
1847 {
1848 // we only copy defaults from the provider if we aren't overriding any configuration made in the layer
1849 if ( !field.editorWidgetSetup().isNull() && mFieldWidgetSetups.value( field.name() ).isNull() )
1850 {
1851 mFieldWidgetSetups[ field.name() ] = field.editorWidgetSetup();
1852 }
1853 if ( !field.alias().isEmpty() && mAttributeAliasMap.value( field.name() ).isEmpty() )
1854 {
1855 mAttributeAliasMap[ field.name() ] = field.alias();
1856 }
1857 }
1858
1859 if ( profile )
1860 profile->switchTask( tr( "Read layer fields" ) );
1861 updateFields();
1862
1863 if ( mProviderKey == QLatin1String( "postgres" ) )
1864 {
1865 // update datasource from data provider computed one
1866 mDataSource = mDataProvider->dataSourceUri( false );
1867
1868 QgsDebugMsgLevel( QStringLiteral( "Beautifying layer name %1" ).arg( name() ), 3 );
1869
1870 // adjust the display name for postgres layers
1871 const QRegularExpression reg( R"lit("[^"]+"\."([^"] + )"( \‍([^)]+\))?)lit" );
1872 const QRegularExpressionMatch match = reg.match( name() );
1873 if ( match.hasMatch() )
1874 {
1875 QStringList stuff = match.capturedTexts();
1876 QString lName = stuff[1];
1877
1878 const QMap<QString, QgsMapLayer *> &layers = QgsProject::instance()->mapLayers();
1879
1880 QMap<QString, QgsMapLayer *>::const_iterator it;
1881 for ( it = layers.constBegin(); it != layers.constEnd() && ( *it )->name() != lName; ++it )
1882 ;
1883
1884 if ( it != layers.constEnd() && stuff.size() > 2 )
1885 {
1886 lName += '.' + stuff[2].mid( 2, stuff[2].length() - 3 );
1887 }
1888
1889 if ( !lName.isEmpty() )
1890 setName( lName );
1891 }
1892 QgsDebugMsgLevel( QStringLiteral( "Beautified layer name %1" ).arg( name() ), 3 );
1893 }
1894 else if ( mProviderKey == QLatin1String( "osm" ) )
1895 {
1896 // make sure that the "observer" has been removed from URI to avoid crashes
1897 mDataSource = mDataProvider->dataSourceUri();
1898 }
1899 else if ( provider == QLatin1String( "ogr" ) )
1900 {
1901 // make sure that the /vsigzip or /vsizip is added to uri, if applicable
1902 mDataSource = mDataProvider->dataSourceUri();
1903 if ( mDataSource.right( 10 ) == QLatin1String( "|layerid=0" ) )
1904 mDataSource.chop( 10 );
1905 }
1906 else if ( provider == QLatin1String( "memory" ) )
1907 {
1908 // required so that source differs between memory layers
1909 mDataSource = mDataSource + QStringLiteral( "&uid=%1" ).arg( QUuid::createUuid().toString() );
1910 }
1911 else if ( provider == QLatin1String( "hana" ) )
1912 {
1913 // update datasource from data provider computed one
1914 mDataSource = mDataProvider->dataSourceUri( false );
1915 }
1916
1917 connect( mDataProvider, &QgsVectorDataProvider::dataChanged, this, &QgsVectorLayer::emitDataChanged );
1919
1920 return true;
1921} // QgsVectorLayer:: setDataProvider
1922
1923
1924
1925
1926/* virtual */
1927bool QgsVectorLayer::writeXml( QDomNode &layer_node,
1928 QDomDocument &document,
1929 const QgsReadWriteContext &context ) const
1930{
1931 // first get the layer element so that we can append the type attribute
1932
1933 QDomElement mapLayerNode = layer_node.toElement();
1934
1935 if ( mapLayerNode.isNull() || ( "maplayer" != mapLayerNode.nodeName() ) )
1936 {
1937 QgsDebugMsgLevel( QStringLiteral( "can't find <maplayer>" ), 2 );
1938 return false;
1939 }
1940
1941 mapLayerNode.setAttribute( QStringLiteral( "type" ), QgsMapLayerFactory::typeToString( QgsMapLayerType::VectorLayer ) );
1942
1943 // set the geometry type
1944 mapLayerNode.setAttribute( QStringLiteral( "geometry" ), QgsWkbTypes::geometryDisplayString( geometryType() ) );
1945 mapLayerNode.setAttribute( QStringLiteral( "wkbType" ), qgsEnumValueToKey( wkbType() ) );
1946
1947 // add provider node
1948 if ( mDataProvider )
1949 {
1950 QDomElement provider = document.createElement( QStringLiteral( "provider" ) );
1951 provider.setAttribute( QStringLiteral( "encoding" ), mDataProvider->encoding() );
1952 QDomText providerText = document.createTextNode( providerType() );
1953 provider.appendChild( providerText );
1954 layer_node.appendChild( provider );
1955 }
1956
1957 //save joins
1958 mJoinBuffer->writeXml( layer_node, document );
1959
1960 // dependencies
1961 QDomElement dependenciesElement = document.createElement( QStringLiteral( "layerDependencies" ) );
1962 const auto constDependencies = dependencies();
1963 for ( const QgsMapLayerDependency &dep : constDependencies )
1964 {
1966 continue;
1967 QDomElement depElem = document.createElement( QStringLiteral( "layer" ) );
1968 depElem.setAttribute( QStringLiteral( "id" ), dep.layerId() );
1969 dependenciesElement.appendChild( depElem );
1970 }
1971 layer_node.appendChild( dependenciesElement );
1972
1973 // change dependencies
1974 QDomElement dataDependenciesElement = document.createElement( QStringLiteral( "dataDependencies" ) );
1975 for ( const QgsMapLayerDependency &dep : constDependencies )
1976 {
1977 if ( dep.type() != QgsMapLayerDependency::DataDependency )
1978 continue;
1979 QDomElement depElem = document.createElement( QStringLiteral( "layer" ) );
1980 depElem.setAttribute( QStringLiteral( "id" ), dep.layerId() );
1981 dataDependenciesElement.appendChild( depElem );
1982 }
1983 layer_node.appendChild( dataDependenciesElement );
1984
1985 // save expression fields
1986 mExpressionFieldBuffer->writeXml( layer_node, document );
1987
1988 writeStyleManager( layer_node, document );
1989
1990 // auxiliary layer
1991 QDomElement asElem = document.createElement( QStringLiteral( "auxiliaryLayer" ) );
1992 if ( mAuxiliaryLayer )
1993 {
1994 const QString pkField = mAuxiliaryLayer->joinInfo().targetFieldName();
1995 asElem.setAttribute( QStringLiteral( "key" ), pkField );
1996 }
1997 layer_node.appendChild( asElem );
1998
1999 // save QGIS Server properties (WMS Dimension, metadata URLS...)
2000 mServerProperties->writeXml( layer_node, document );
2001
2002 // renderer specific settings
2003 QString errorMsg;
2004 return writeSymbology( layer_node, document, errorMsg, context );
2005}
2006
2007QString QgsVectorLayer::encodedSource( const QString &source, const QgsReadWriteContext &context ) const
2008{
2009 QString src( source );
2010
2011 // TODO: what about postgres, mysql and others, they should not go through writePath()
2012 if ( providerType() == QLatin1String( "spatialite" ) )
2013 {
2014 QgsDataSourceUri uri( src );
2015 QString database = context.pathResolver().writePath( uri.database() );
2016 uri.setConnection( uri.host(), uri.port(), database, uri.username(), uri.password() );
2017 src = uri.uri();
2018 }
2019 else if ( providerType() == QLatin1String( "ogr" ) )
2020 {
2021 QStringList theURIParts = src.split( '|' );
2022 theURIParts[0] = context.pathResolver().writePath( theURIParts[0] );
2023 src = theURIParts.join( QLatin1Char( '|' ) );
2024 }
2025 else if ( providerType() == QLatin1String( "gpx" ) )
2026 {
2027 QStringList theURIParts = src.split( '?' );
2028 theURIParts[0] = context.pathResolver().writePath( theURIParts[0] );
2029 src = theURIParts.join( QLatin1Char( '?' ) );
2030 }
2031 else if ( providerType() == QLatin1String( "delimitedtext" ) )
2032 {
2033 QUrl urlSource = QUrl::fromEncoded( src.toLatin1() );
2034 QUrl urlDest = QUrl::fromLocalFile( context.pathResolver().writePath( urlSource.toLocalFile() ) );
2035 urlDest.setQuery( urlSource.query() );
2036 src = QString::fromLatin1( urlDest.toEncoded() );
2037 }
2038 else if ( providerType() == QLatin1String( "memory" ) )
2039 {
2040 // Refetch the source from the provider, because adding fields actually changes the source for this provider.
2041 src = dataProvider()->dataSourceUri();
2042 }
2043 else if ( providerType() == QLatin1String( "virtual" ) )
2044 {
2045 QUrl urlSource = QUrl::fromEncoded( src.toLatin1() );
2046 QStringList theURIParts;
2047
2048 QUrlQuery query = QUrlQuery( urlSource.query() );
2049 QList<QPair<QString, QString> > queryItems = query.queryItems();
2050
2051 for ( int i = 0; i < queryItems.size(); i++ )
2052 {
2053 QString key = queryItems.at( i ).first;
2054 QString value = queryItems.at( i ).second;
2055 if ( key == QLatin1String( "layer" ) )
2056 {
2057 // syntax: provider:url_encoded_source_URI(:name(:encoding)?)?
2058 theURIParts = value.split( ':' );
2059 theURIParts[1] = QUrl::fromPercentEncoding( theURIParts[1].toUtf8() );
2060
2061 if ( theURIParts[0] == QLatin1String( "delimitedtext" ) )
2062 {
2063 QUrl urlSource = QUrl( theURIParts[1] );
2064 QUrl urlDest = QUrl::fromLocalFile( context.pathResolver().writePath( urlSource.toLocalFile() ) );
2065 urlDest.setQuery( urlSource.query() );
2066 theURIParts[1] = QUrl::toPercentEncoding( urlDest.toString(), QByteArray( "" ), QByteArray( ":" ) );
2067 }
2068 else
2069 {
2070 theURIParts[1] = context.pathResolver().writePath( theURIParts[1] );
2071 theURIParts[1] = QUrl::toPercentEncoding( theURIParts[1] );
2072 }
2073
2074 queryItems[i].second = theURIParts.join( QLatin1Char( ':' ) ) ;
2075 }
2076 }
2077
2078 query.setQueryItems( queryItems );
2079
2080 QUrl urlDest = QUrl( urlSource );
2081 urlDest.setQuery( query.query() );
2082 src = QString::fromLatin1( urlDest.toEncoded() );
2083 }
2084 else
2085 {
2086 src = context.pathResolver().writePath( src );
2087 }
2088
2089 return src;
2090}
2091
2092QString QgsVectorLayer::decodedSource( const QString &source, const QString &provider, const QgsReadWriteContext &context ) const
2093{
2094 QString src( source );
2095
2096 if ( provider == QLatin1String( "spatialite" ) )
2097 {
2098 QgsDataSourceUri uri( src );
2099 uri.setDatabase( context.pathResolver().readPath( uri.database() ) );
2100 src = uri.uri();
2101 }
2102 else if ( provider == QLatin1String( "ogr" ) )
2103 {
2104 QStringList theURIParts = src.split( '|' );
2105 theURIParts[0] = context.pathResolver().readPath( theURIParts[0] );
2106 src = theURIParts.join( QLatin1Char( '|' ) );
2107 }
2108 else if ( provider == QLatin1String( "gpx" ) )
2109 {
2110 QStringList theURIParts = src.split( '?' );
2111 theURIParts[0] = context.pathResolver().readPath( theURIParts[0] );
2112 src = theURIParts.join( QLatin1Char( '?' ) );
2113 }
2114 else if ( provider == QLatin1String( "delimitedtext" ) )
2115 {
2116 QUrl urlSource = QUrl::fromEncoded( src.toLatin1() );
2117
2118 if ( !src.startsWith( QLatin1String( "file:" ) ) )
2119 {
2120 QUrl file = QUrl::fromLocalFile( src.left( src.indexOf( '?' ) ) );
2121 urlSource.setScheme( QStringLiteral( "file" ) );
2122 urlSource.setPath( file.path() );
2123 }
2124
2125 QUrl urlDest = QUrl::fromLocalFile( context.pathResolver().readPath( urlSource.toLocalFile() ) );
2126 urlDest.setQuery( urlSource.query() );
2127 src = QString::fromLatin1( urlDest.toEncoded() );
2128 }
2129 else if ( provider == QLatin1String( "virtual" ) )
2130 {
2131 QUrl urlSource = QUrl::fromEncoded( src.toLatin1() );
2132 QStringList theURIParts;
2133
2134 QUrlQuery query = QUrlQuery( urlSource.query() );
2135 QList<QPair<QString, QString> > queryItems = query.queryItems();
2136
2137 for ( int i = 0; i < queryItems.size(); i++ )
2138 {
2139 QString key = queryItems.at( i ).first;
2140 QString value = queryItems.at( i ).second;
2141 if ( key == QLatin1String( "layer" ) )
2142 {
2143 // syntax: provider:url_encoded_source_URI(:name(:encoding)?)?
2144 theURIParts = value.split( ':' );
2145 theURIParts[1] = QUrl::fromPercentEncoding( theURIParts[1].toUtf8() );
2146
2147 if ( theURIParts[0] == QLatin1String( "delimitedtext" ) )
2148 {
2149 QUrl urlSource = QUrl( theURIParts[1] );
2150
2151 if ( !theURIParts[1].startsWith( QLatin1String( "file:" ) ) )
2152 {
2153 QUrl file = QUrl::fromLocalFile( theURIParts[1].left( theURIParts[1].indexOf( '?' ) ) );
2154 urlSource.setScheme( QStringLiteral( "file" ) );
2155 urlSource.setPath( file.path() );
2156 }
2157
2158 QUrl urlDest = QUrl::fromLocalFile( context.pathResolver().readPath( urlSource.toLocalFile() ) );
2159 urlDest.setQuery( urlSource.query() );
2160
2161 theURIParts[1] = urlDest.toString();
2162 }
2163 else
2164 {
2165 theURIParts[1] = context.pathResolver().readPath( theURIParts[1] );
2166 }
2167
2168 theURIParts[1] = QUrl::toPercentEncoding( theURIParts[1] );
2169 queryItems[i].second = theURIParts.join( QLatin1Char( ':' ) ) ;
2170 }
2171 }
2172
2173 query.setQueryItems( queryItems );
2174
2175 QUrl urlDest = QUrl( urlSource );
2176 urlDest.setQuery( query.query() );
2177 src = QString::fromLatin1( urlDest.toEncoded() );
2178 }
2179 else
2180 {
2181 src = context.pathResolver().readPath( src );
2182 }
2183
2184 return src;
2185}
2186
2187
2188
2194
2195
2196bool QgsVectorLayer::readSymbology( const QDomNode &layerNode, QString &errorMessage,
2197 QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories )
2198{
2199 if ( categories.testFlag( Fields ) )
2200 {
2201 if ( !mExpressionFieldBuffer )
2202 mExpressionFieldBuffer = new QgsExpressionFieldBuffer();
2203 mExpressionFieldBuffer->readXml( layerNode );
2204
2205 updateFields();
2206 }
2207
2208 if ( categories.testFlag( Relations ) )
2209 {
2210 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Relations" ) );
2211
2212 const QgsPathResolver resolver { QgsProject::instance()->pathResolver() };
2213
2214 // Restore referenced layers: relations where "this" is the child layer (the referencing part, that holds the FK)
2215 QDomNodeList referencedLayersNodeList = layerNode.toElement().elementsByTagName( QStringLiteral( "referencedLayers" ) );
2216 if ( referencedLayersNodeList.size() > 0 )
2217 {
2218 const QDomNodeList relationNodes { referencedLayersNodeList.at( 0 ).childNodes() };
2219 for ( int i = 0; i < relationNodes.length(); ++i )
2220 {
2221 const QDomElement relationElement = relationNodes.at( i ).toElement();
2222
2223 mWeakRelations.push_back( QgsWeakRelation::readXml( this, QgsWeakRelation::Referencing, relationElement, resolver ) );
2224 }
2225 }
2226
2227 // Restore referencing layers: relations where "this" is the parent layer (the referenced part where the FK points to)
2228 QDomNodeList referencingLayersNodeList = layerNode.toElement().elementsByTagName( QStringLiteral( "referencingLayers" ) );
2229 if ( referencingLayersNodeList.size() > 0 )
2230 {
2231 const QDomNodeList relationNodes { referencingLayersNodeList.at( 0 ).childNodes() };
2232 for ( int i = 0; i < relationNodes.length(); ++i )
2233 {
2234 const QDomElement relationElement = relationNodes.at( i ).toElement();
2235 mWeakRelations.push_back( QgsWeakRelation::readXml( this, QgsWeakRelation::Referenced, relationElement, resolver ) );
2236 }
2237 }
2238 }
2239
2240 QDomElement layerElement = layerNode.toElement();
2241
2242 readCommonStyle( layerElement, context, categories );
2243
2244 readStyle( layerNode, errorMessage, context, categories );
2245
2246 if ( categories.testFlag( MapTips ) )
2247 mMapTipTemplate = layerNode.namedItem( QStringLiteral( "mapTip" ) ).toElement().text();
2248
2249 if ( categories.testFlag( LayerConfiguration ) )
2250 mDisplayExpression = layerNode.namedItem( QStringLiteral( "previewExpression" ) ).toElement().text();
2251
2252 // Try to migrate pre QGIS 3.0 display field property
2253 QString displayField = layerNode.namedItem( QStringLiteral( "displayfield" ) ).toElement().text();
2254 if ( mFields.lookupField( displayField ) < 0 )
2255 {
2256 // if it's not a field, it's a maptip
2257 if ( mMapTipTemplate.isEmpty() && categories.testFlag( MapTips ) )
2258 mMapTipTemplate = displayField;
2259 }
2260 else
2261 {
2262 if ( mDisplayExpression.isEmpty() && categories.testFlag( LayerConfiguration ) )
2263 mDisplayExpression = QgsExpression::quotedColumnRef( displayField );
2264 }
2265
2266 // process the attribute actions
2267 if ( categories.testFlag( Actions ) )
2268 mActions->readXml( layerNode );
2269
2270 if ( categories.testFlag( Fields ) )
2271 {
2272 // IMPORTANT - we don't clear mAttributeAliasMap here, as it may contain aliases which are coming direct
2273 // from the data provider. Instead we leave any existing aliases and only overwrite them if the style
2274 // has a specific value for that field's alias
2275 QDomNode aliasesNode = layerNode.namedItem( QStringLiteral( "aliases" ) );
2276 if ( !aliasesNode.isNull() )
2277 {
2278 QDomElement aliasElem;
2279
2280 QDomNodeList aliasNodeList = aliasesNode.toElement().elementsByTagName( QStringLiteral( "alias" ) );
2281 for ( int i = 0; i < aliasNodeList.size(); ++i )
2282 {
2283 aliasElem = aliasNodeList.at( i ).toElement();
2284
2285 QString field;
2286 if ( aliasElem.hasAttribute( QStringLiteral( "field" ) ) )
2287 {
2288 field = aliasElem.attribute( QStringLiteral( "field" ) );
2289 }
2290 else
2291 {
2292 int index = aliasElem.attribute( QStringLiteral( "index" ) ).toInt();
2293
2294 if ( index >= 0 && index < fields().count() )
2295 field = fields().at( index ).name();
2296 }
2297
2298 QString alias;
2299
2300 if ( !aliasElem.attribute( QStringLiteral( "name" ) ).isEmpty() )
2301 {
2302 //if it has alias
2303 alias = context.projectTranslator()->translate( QStringLiteral( "project:layers:%1:fieldaliases" ).arg( layerNode.namedItem( QStringLiteral( "id" ) ).toElement().text() ), aliasElem.attribute( QStringLiteral( "name" ) ) );
2304 QgsDebugMsgLevel( "context" + QStringLiteral( "project:layers:%1:fieldaliases" ).arg( layerNode.namedItem( QStringLiteral( "id" ) ).toElement().text() ) + " source " + aliasElem.attribute( QStringLiteral( "name" ) ), 3 );
2305 }
2306 else
2307 {
2308 //if it has no alias, it should be the fields translation
2309 alias = context.projectTranslator()->translate( QStringLiteral( "project:layers:%1:fieldaliases" ).arg( layerNode.namedItem( QStringLiteral( "id" ) ).toElement().text() ), field );
2310 QgsDebugMsgLevel( "context" + QStringLiteral( "project:layers:%1:fieldaliases" ).arg( layerNode.namedItem( QStringLiteral( "id" ) ).toElement().text() ) + " source " + field, 3 );
2311 //if it gets the exact field value, there has been no translation (or not even translation loaded) - so no alias should be generated;
2312 if ( alias == aliasElem.attribute( QStringLiteral( "field" ) ) )
2313 alias.clear();
2314 }
2315
2316 QgsDebugMsgLevel( "field " + field + " origalias " + aliasElem.attribute( QStringLiteral( "name" ) ) + " trans " + alias, 3 );
2317 mAttributeAliasMap.insert( field, alias );
2318 }
2319 }
2320
2321 // default expressions
2322 mDefaultExpressionMap.clear();
2323 QDomNode defaultsNode = layerNode.namedItem( QStringLiteral( "defaults" ) );
2324 if ( !defaultsNode.isNull() )
2325 {
2326 QDomNodeList defaultNodeList = defaultsNode.toElement().elementsByTagName( QStringLiteral( "default" ) );
2327 for ( int i = 0; i < defaultNodeList.size(); ++i )
2328 {
2329 QDomElement defaultElem = defaultNodeList.at( i ).toElement();
2330
2331 QString field = defaultElem.attribute( QStringLiteral( "field" ), QString() );
2332 QString expression = defaultElem.attribute( QStringLiteral( "expression" ), QString() );
2333 bool applyOnUpdate = defaultElem.attribute( QStringLiteral( "applyOnUpdate" ), QStringLiteral( "0" ) ) == QLatin1String( "1" );
2334 if ( field.isEmpty() || expression.isEmpty() )
2335 continue;
2336
2337 mDefaultExpressionMap.insert( field, QgsDefaultValue( expression, applyOnUpdate ) );
2338 }
2339 }
2340
2341 // constraints
2342 mFieldConstraints.clear();
2343 mFieldConstraintStrength.clear();
2344 QDomNode constraintsNode = layerNode.namedItem( QStringLiteral( "constraints" ) );
2345 if ( !constraintsNode.isNull() )
2346 {
2347 QDomNodeList constraintNodeList = constraintsNode.toElement().elementsByTagName( QStringLiteral( "constraint" ) );
2348 for ( int i = 0; i < constraintNodeList.size(); ++i )
2349 {
2350 QDomElement constraintElem = constraintNodeList.at( i ).toElement();
2351
2352 QString field = constraintElem.attribute( QStringLiteral( "field" ), QString() );
2353 int constraints = constraintElem.attribute( QStringLiteral( "constraints" ), QStringLiteral( "0" ) ).toInt();
2354 if ( field.isEmpty() || constraints == 0 )
2355 continue;
2356
2357 mFieldConstraints.insert( field, static_cast< QgsFieldConstraints::Constraints >( constraints ) );
2358
2359 int uniqueStrength = constraintElem.attribute( QStringLiteral( "unique_strength" ), QStringLiteral( "1" ) ).toInt();
2360 int notNullStrength = constraintElem.attribute( QStringLiteral( "notnull_strength" ), QStringLiteral( "1" ) ).toInt();
2361 int expStrength = constraintElem.attribute( QStringLiteral( "exp_strength" ), QStringLiteral( "1" ) ).toInt();
2362
2363 mFieldConstraintStrength.insert( qMakePair( field, QgsFieldConstraints::ConstraintUnique ), static_cast< QgsFieldConstraints::ConstraintStrength >( uniqueStrength ) );
2364 mFieldConstraintStrength.insert( qMakePair( field, QgsFieldConstraints::ConstraintNotNull ), static_cast< QgsFieldConstraints::ConstraintStrength >( notNullStrength ) );
2365 mFieldConstraintStrength.insert( qMakePair( field, QgsFieldConstraints::ConstraintExpression ), static_cast< QgsFieldConstraints::ConstraintStrength >( expStrength ) );
2366 }
2367 }
2368 mFieldConstraintExpressions.clear();
2369 QDomNode constraintExpressionsNode = layerNode.namedItem( QStringLiteral( "constraintExpressions" ) );
2370 if ( !constraintExpressionsNode.isNull() )
2371 {
2372 QDomNodeList constraintNodeList = constraintExpressionsNode.toElement().elementsByTagName( QStringLiteral( "constraint" ) );
2373 for ( int i = 0; i < constraintNodeList.size(); ++i )
2374 {
2375 QDomElement constraintElem = constraintNodeList.at( i ).toElement();
2376
2377 QString field = constraintElem.attribute( QStringLiteral( "field" ), QString() );
2378 QString exp = constraintElem.attribute( QStringLiteral( "exp" ), QString() );
2379 QString desc = constraintElem.attribute( QStringLiteral( "desc" ), QString() );
2380 if ( field.isEmpty() || exp.isEmpty() )
2381 continue;
2382
2383 mFieldConstraintExpressions.insert( field, qMakePair( exp, desc ) );
2384 }
2385 }
2386
2387 updateFields();
2388 }
2389
2390 // load field configuration
2391 if ( categories.testFlag( Fields ) || categories.testFlag( Forms ) )
2392 {
2393 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Forms" ) );
2394
2395 QDomElement widgetsElem = layerNode.namedItem( QStringLiteral( "fieldConfiguration" ) ).toElement();
2396 QDomNodeList fieldConfigurationElementList = widgetsElem.elementsByTagName( QStringLiteral( "field" ) );
2397 for ( int i = 0; i < fieldConfigurationElementList.size(); ++i )
2398 {
2399 const QDomElement fieldConfigElement = fieldConfigurationElementList.at( i ).toElement();
2400 const QDomElement fieldWidgetElement = fieldConfigElement.elementsByTagName( QStringLiteral( "editWidget" ) ).at( 0 ).toElement();
2401
2402 QString fieldName = fieldConfigElement.attribute( QStringLiteral( "name" ) );
2403
2404 if ( categories.testFlag( Fields ) )
2405 mFieldConfigurationFlags[fieldName] = qgsFlagKeysToValue( fieldConfigElement.attribute( QStringLiteral( "configurationFlags" ) ), QgsField::ConfigurationFlag::None );
2406
2407 // Load editor widget configuration
2408 if ( categories.testFlag( Forms ) )
2409 {
2410 const QString widgetType = fieldWidgetElement.attribute( QStringLiteral( "type" ) );
2411 const QDomElement cfgElem = fieldConfigElement.elementsByTagName( QStringLiteral( "config" ) ).at( 0 ).toElement();
2412 const QDomElement optionsElem = cfgElem.childNodes().at( 0 ).toElement();
2413 QVariantMap optionsMap = QgsXmlUtils::readVariant( optionsElem ).toMap();
2414 if ( widgetType == QLatin1String( "ValueRelation" ) )
2415 {
2416 optionsMap[ QStringLiteral( "Value" ) ] = context.projectTranslator()->translate( QStringLiteral( "project:layers:%1:fields:%2:valuerelationvalue" ).arg( layerNode.namedItem( QStringLiteral( "id" ) ).toElement().text(), fieldName ), optionsMap[ QStringLiteral( "Value" ) ].toString() );
2417 }
2418 QgsEditorWidgetSetup setup = QgsEditorWidgetSetup( widgetType, optionsMap );
2419 mFieldWidgetSetups[fieldName] = setup;
2420 }
2421 }
2422 }
2423
2424 // Legacy reading for QGIS 3.14 and older projects
2425 // Attributes excluded from WMS and WFS
2426 if ( categories.testFlag( Fields ) )
2427 {
2428 const QList<QPair<QString, QgsField::ConfigurationFlag>> legacyConfig
2429 {
2430 qMakePair( QStringLiteral( "excludeAttributesWMS" ), QgsField::ConfigurationFlag::HideFromWms ),
2431 qMakePair( QStringLiteral( "excludeAttributesWFS" ), QgsField::ConfigurationFlag::HideFromWfs )
2432 };
2433 for ( const auto &config : legacyConfig )
2434 {
2435 QDomNode excludeNode = layerNode.namedItem( config.first );
2436 if ( !excludeNode.isNull() )
2437 {
2438 QDomNodeList attributeNodeList = excludeNode.toElement().elementsByTagName( QStringLiteral( "attribute" ) );
2439 for ( int i = 0; i < attributeNodeList.size(); ++i )
2440 {
2441 QString fieldName = attributeNodeList.at( i ).toElement().text();
2442 if ( !mFieldConfigurationFlags.contains( fieldName ) )
2443 mFieldConfigurationFlags[fieldName] = config.second;
2444 else
2445 mFieldConfigurationFlags[fieldName].setFlag( config.second, true );
2446 }
2447 }
2448 }
2449 }
2450
2451 if ( categories.testFlag( GeometryOptions ) )
2452 mGeometryOptions->readXml( layerNode.namedItem( QStringLiteral( "geometryOptions" ) ) );
2453
2454 if ( categories.testFlag( Forms ) )
2455 mEditFormConfig.readXml( layerNode, context );
2456
2457 if ( categories.testFlag( AttributeTable ) )
2458 {
2459 mAttributeTableConfig.readXml( layerNode );
2460 mConditionalStyles->readXml( layerNode, context );
2461 mStoredExpressionManager->readXml( layerNode );
2462 }
2463
2464 if ( categories.testFlag( CustomProperties ) )
2465 readCustomProperties( layerNode, QStringLiteral( "variable" ) );
2466
2467 QDomElement mapLayerNode = layerNode.toElement();
2468 if ( categories.testFlag( LayerConfiguration )
2469 && mapLayerNode.attribute( QStringLiteral( "readOnly" ), QStringLiteral( "0" ) ).toInt() == 1 )
2470 mReadOnly = true;
2471
2472 updateFields();
2473
2474 if ( categories.testFlag( Legend ) )
2475 {
2476 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Legend" ) );
2477
2478 const QDomElement legendElem = layerNode.firstChildElement( QStringLiteral( "legend" ) );
2479 if ( !legendElem.isNull() )
2480 {
2481 std::unique_ptr< QgsMapLayerLegend > legend( QgsMapLayerLegend::defaultVectorLegend( this ) );
2482 legend->readXml( legendElem, context );
2483 setLegend( legend.release() );
2484 mSetLegendFromStyle = true;
2485 }
2486 }
2487
2488 return true;
2489}
2490
2491bool QgsVectorLayer::readStyle( const QDomNode &node, QString &errorMessage,
2492 QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories )
2493{
2494 bool result = true;
2495 emit readCustomSymbology( node.toElement(), errorMessage );
2496
2497 // we must try to restore a renderer if our geometry type is unknown
2498 // as this allows the renderer to be correctly restored even for layers
2499 // with broken sources
2500 if ( isSpatial() || mWkbType == QgsWkbTypes::Unknown )
2501 {
2502 // defer style changed signal until we've set the renderer, labeling, everything.
2503 // we don't want multiple signals!
2504 ScopedIntIncrementor styleChangedSignalBlocker( &mBlockStyleChangedSignal );
2505
2506 // try renderer v2 first
2507 if ( categories.testFlag( Symbology ) )
2508 {
2509 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Symbology" ) );
2510
2511 QDomElement rendererElement = node.firstChildElement( RENDERER_TAG_NAME );
2512 if ( !rendererElement.isNull() )
2513 {
2514 QgsFeatureRenderer *r = QgsFeatureRenderer::load( rendererElement, context );
2515 if ( r )
2516 {
2517 setRenderer( r );
2518 }
2519 else
2520 {
2521 result = false;
2522 }
2523 }
2524 // make sure layer has a renderer - if none exists, fallback to a default renderer
2525 if ( isSpatial() && !renderer() )
2526 {
2528 }
2529 }
2530
2531 // read labeling definition
2532 if ( categories.testFlag( Labeling ) )
2533 {
2534 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Labeling" ) );
2535
2536 QDomElement labelingElement = node.firstChildElement( QStringLiteral( "labeling" ) );
2538 if ( labelingElement.isNull() ||
2539 ( labelingElement.attribute( QStringLiteral( "type" ) ) == QLatin1String( "simple" ) && labelingElement.firstChildElement( QStringLiteral( "settings" ) ).isNull() ) )
2540 {
2541 // make sure we have custom properties for labeling for 2.x projects
2542 // (custom properties should be already loaded when reading the whole layer from XML,
2543 // but when reading style, custom properties are not read)
2544 readCustomProperties( node, QStringLiteral( "labeling" ) );
2545
2546 // support for pre-QGIS 3 labeling configurations written in custom properties
2547 labeling = readLabelingFromCustomProperties();
2548 }
2549 else
2550 {
2551 labeling = QgsAbstractVectorLayerLabeling::create( labelingElement, context );
2552 }
2554
2555 if ( node.toElement().hasAttribute( QStringLiteral( "labelsEnabled" ) ) )
2556 mLabelsEnabled = node.toElement().attribute( QStringLiteral( "labelsEnabled" ) ).toInt();
2557 else
2558 mLabelsEnabled = true;
2559 }
2560
2561 if ( categories.testFlag( Symbology ) )
2562 {
2563 // get and set the blend mode if it exists
2564 QDomNode blendModeNode = node.namedItem( QStringLiteral( "blendMode" ) );
2565 if ( !blendModeNode.isNull() )
2566 {
2567 QDomElement e = blendModeNode.toElement();
2568 setBlendMode( QgsPainting::getCompositionMode( static_cast< QgsPainting::BlendMode >( e.text().toInt() ) ) );
2569 }
2570
2571 // get and set the feature blend mode if it exists
2572 QDomNode featureBlendModeNode = node.namedItem( QStringLiteral( "featureBlendMode" ) );
2573 if ( !featureBlendModeNode.isNull() )
2574 {
2575 QDomElement e = featureBlendModeNode.toElement();
2576 setFeatureBlendMode( QgsPainting::getCompositionMode( static_cast< QgsPainting::BlendMode >( e.text().toInt() ) ) );
2577 }
2578 }
2579
2580 // get and set the layer transparency and scale visibility if they exists
2581 if ( categories.testFlag( Rendering ) )
2582 {
2583 QDomNode layerTransparencyNode = node.namedItem( QStringLiteral( "layerTransparency" ) );
2584 if ( !layerTransparencyNode.isNull() )
2585 {
2586 QDomElement e = layerTransparencyNode.toElement();
2587 setOpacity( 1.0 - e.text().toInt() / 100.0 );
2588 }
2589 QDomNode layerOpacityNode = node.namedItem( QStringLiteral( "layerOpacity" ) );
2590 if ( !layerOpacityNode.isNull() )
2591 {
2592 QDomElement e = layerOpacityNode.toElement();
2593 setOpacity( e.text().toDouble() );
2594 }
2595
2596 const bool hasScaleBasedVisibiliy { node.attributes().namedItem( QStringLiteral( "hasScaleBasedVisibilityFlag" ) ).nodeValue() == '1' };
2597 setScaleBasedVisibility( hasScaleBasedVisibiliy );
2598 bool ok;
2599 const double maxScale { node.attributes().namedItem( QStringLiteral( "maxScale" ) ).nodeValue().toDouble( &ok ) };
2600 if ( ok )
2601 {
2602 setMaximumScale( maxScale );
2603 }
2604 const double minScale { node.attributes().namedItem( QStringLiteral( "minScale" ) ).nodeValue().toDouble( &ok ) };
2605 if ( ok )
2606 {
2607 setMinimumScale( minScale );
2608 }
2609
2610 QDomElement e = node.toElement();
2611
2612 // get the simplification drawing settings
2613 mSimplifyMethod.setSimplifyHints( static_cast< QgsVectorSimplifyMethod::SimplifyHints >( e.attribute( QStringLiteral( "simplifyDrawingHints" ), QStringLiteral( "1" ) ).toInt() ) );
2614 mSimplifyMethod.setSimplifyAlgorithm( static_cast< QgsVectorSimplifyMethod::SimplifyAlgorithm >( e.attribute( QStringLiteral( "simplifyAlgorithm" ), QStringLiteral( "0" ) ).toInt() ) );
2615 mSimplifyMethod.setThreshold( e.attribute( QStringLiteral( "simplifyDrawingTol" ), QStringLiteral( "1" ) ).toFloat() );
2616 mSimplifyMethod.setForceLocalOptimization( e.attribute( QStringLiteral( "simplifyLocal" ), QStringLiteral( "1" ) ).toInt() );
2617 mSimplifyMethod.setMaximumScale( e.attribute( QStringLiteral( "simplifyMaxScale" ), QStringLiteral( "1" ) ).toFloat() );
2618
2619 if ( mRenderer )
2620 mRenderer->setReferenceScale( e.attribute( QStringLiteral( "symbologyReferenceScale" ), QStringLiteral( "-1" ) ).toDouble() );
2621 }
2622
2623 //diagram renderer and diagram layer settings
2624 if ( categories.testFlag( Diagrams ) )
2625 {
2626 QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Diagrams" ) );
2627
2628 delete mDiagramRenderer;
2629 mDiagramRenderer = nullptr;
2630 QDomElement singleCatDiagramElem = node.firstChildElement( QStringLiteral( "SingleCategoryDiagramRenderer" ) );
2631 if ( !singleCatDiagramElem.isNull() )
2632 {
2633 mDiagramRenderer = new QgsSingleCategoryDiagramRenderer();
2634 mDiagramRenderer->readXml( singleCatDiagramElem, context );
2635 }
2636 QDomElement linearDiagramElem = node.firstChildElement( QStringLiteral( "LinearlyInterpolatedDiagramRenderer" ) );
2637 if ( !linearDiagramElem.isNull() )
2638 {
2639 if ( linearDiagramElem.hasAttribute( QStringLiteral( "classificationAttribute" ) ) )
2640 {
2641 // fix project from before QGIS 3.0
2642 int idx = linearDiagramElem.attribute( QStringLiteral( "classificationAttribute" ) ).toInt();
2643 if ( idx >= 0 && idx < mFields.count() )
2644 linearDiagramElem.setAttribute( QStringLiteral( "classificationField" ), mFields.at( idx ).name() );
2645 }
2646
2647 mDiagramRenderer = new QgsLinearlyInterpolatedDiagramRenderer();
2648 mDiagramRenderer->readXml( linearDiagramElem, context );
2649 }
2650
2651 if ( mDiagramRenderer )
2652 {
2653 QDomElement diagramSettingsElem = node.firstChildElement( QStringLiteral( "DiagramLayerSettings" ) );
2654 if ( !diagramSettingsElem.isNull() )
2655 {
2656 bool oldXPos = diagramSettingsElem.hasAttribute( QStringLiteral( "xPosColumn" ) );
2657 bool oldYPos = diagramSettingsElem.hasAttribute( QStringLiteral( "yPosColumn" ) );
2658 bool oldShow = diagramSettingsElem.hasAttribute( QStringLiteral( "showColumn" ) );
2659 if ( oldXPos || oldYPos || oldShow )
2660 {
2661 // fix project from before QGIS 3.0
2663 if ( oldXPos )
2664 {
2665 int xPosColumn = diagramSettingsElem.attribute( QStringLiteral( "xPosColumn" ) ).toInt();
2666 if ( xPosColumn >= 0 && xPosColumn < mFields.count() )
2667 ddp.setProperty( QgsDiagramLayerSettings::PositionX, QgsProperty::fromField( mFields.at( xPosColumn ).name(), true ) );
2668 }
2669 if ( oldYPos )
2670 {
2671 int yPosColumn = diagramSettingsElem.attribute( QStringLiteral( "yPosColumn" ) ).toInt();
2672 if ( yPosColumn >= 0 && yPosColumn < mFields.count() )
2673 ddp.setProperty( QgsDiagramLayerSettings::PositionY, QgsProperty::fromField( mFields.at( yPosColumn ).name(), true ) );
2674 }
2675 if ( oldShow )
2676 {
2677 int showColumn = diagramSettingsElem.attribute( QStringLiteral( "showColumn" ) ).toInt();
2678 if ( showColumn >= 0 && showColumn < mFields.count() )
2679 ddp.setProperty( QgsDiagramLayerSettings::Show, QgsProperty::fromField( mFields.at( showColumn ).name(), true ) );
2680 }
2681 QDomElement propertiesElem = diagramSettingsElem.ownerDocument().createElement( QStringLiteral( "properties" ) );
2683 {
2684 { QgsDiagramLayerSettings::PositionX, QgsPropertyDefinition( "positionX", QObject::tr( "Position (X)" ), QgsPropertyDefinition::Double ) },
2685 { QgsDiagramLayerSettings::PositionY, QgsPropertyDefinition( "positionY", QObject::tr( "Position (Y)" ), QgsPropertyDefinition::Double ) },
2686 { QgsDiagramLayerSettings::Show, QgsPropertyDefinition( "show", QObject::tr( "Show diagram" ), QgsPropertyDefinition::Boolean ) },
2687 };
2688 ddp.writeXml( propertiesElem, defs );
2689 diagramSettingsElem.appendChild( propertiesElem );
2690 }
2691
2692 delete mDiagramLayerSettings;
2693 mDiagramLayerSettings = new QgsDiagramLayerSettings();
2694 mDiagramLayerSettings->readXml( diagramSettingsElem );
2695 }
2696 }
2697 }
2698 // end diagram
2699
2700 styleChangedSignalBlocker.release();
2702 }
2703 return result;
2704}
2705
2706
2707bool QgsVectorLayer::writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage,
2708 const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories ) const
2709{
2710 QDomElement layerElement = node.toElement();
2711 writeCommonStyle( layerElement, doc, context, categories );
2712
2713 ( void )writeStyle( node, doc, errorMessage, context, categories );
2714
2715 if ( categories.testFlag( GeometryOptions ) )
2716 mGeometryOptions->writeXml( node );
2717
2718 if ( categories.testFlag( Legend ) && legend() )
2719 {
2720 QDomElement legendElement = legend()->writeXml( doc, context );
2721 if ( !legendElement.isNull() )
2722 node.appendChild( legendElement );
2723 }
2724
2725 // Relation information for both referenced and referencing sides
2726 if ( categories.testFlag( Relations ) )
2727 {
2728 // Store referenced layers: relations where "this" is the child layer (the referencing part, that holds the FK)
2729 QDomElement referencedLayersElement = doc.createElement( QStringLiteral( "referencedLayers" ) );
2730 node.appendChild( referencedLayersElement );
2731
2732 const QList<QgsRelation> referencingRelations { QgsProject::instance()->relationManager()->referencingRelations( this ) };
2733 for ( const QgsRelation &rel : referencingRelations )
2734 {
2735 switch ( rel.type() )
2736 {
2738 QgsWeakRelation::writeXml( this, QgsWeakRelation::Referencing, rel, referencedLayersElement, doc );
2739 break;
2741 break;
2742 }
2743 }
2744
2745 // Store referencing layers: relations where "this" is the parent layer (the referenced part, that holds the FK)
2746 QDomElement referencingLayersElement = doc.createElement( QStringLiteral( "referencingLayers" ) );
2747 node.appendChild( referencedLayersElement );
2748
2749 const QList<QgsRelation> referencedRelations { QgsProject::instance()->relationManager()->referencedRelations( this ) };
2750 for ( const QgsRelation &rel : referencedRelations )
2751 {
2752 switch ( rel.type() )
2753 {
2755 QgsWeakRelation::writeXml( this, QgsWeakRelation::Referenced, rel, referencingLayersElement, doc );
2756 break;
2758 break;
2759 }
2760 }
2761 }
2762
2763 // write field configurations
2764 if ( categories.testFlag( Fields ) || categories.testFlag( Forms ) )
2765 {
2766 QDomElement fieldConfigurationElement;
2767 // field configuration flag
2768 fieldConfigurationElement = doc.createElement( QStringLiteral( "fieldConfiguration" ) );
2769 node.appendChild( fieldConfigurationElement );
2770
2771 for ( const QgsField &field : std::as_const( mFields ) )
2772 {
2773 QDomElement fieldElement = doc.createElement( QStringLiteral( "field" ) );
2774 fieldElement.setAttribute( QStringLiteral( "name" ), field.name() );
2775 fieldConfigurationElement.appendChild( fieldElement );
2776
2777 if ( categories.testFlag( Fields ) )
2778 {
2779 fieldElement.setAttribute( QStringLiteral( "configurationFlags" ), qgsFlagValueToKeys( field.configurationFlags() ) );
2780 }
2781
2782 if ( categories.testFlag( Forms ) )
2783 {
2785
2786 // TODO : wrap this part in an if to only save if it was user-modified
2787 QDomElement editWidgetElement = doc.createElement( QStringLiteral( "editWidget" ) );
2788 fieldElement.appendChild( editWidgetElement );
2789 editWidgetElement.setAttribute( QStringLiteral( "type" ), field.editorWidgetSetup().type() );
2790 QDomElement editWidgetConfigElement = doc.createElement( QStringLiteral( "config" ) );
2791
2792 editWidgetConfigElement.appendChild( QgsXmlUtils::writeVariant( widgetSetup.config(), doc ) );
2793 editWidgetElement.appendChild( editWidgetConfigElement );
2794 // END TODO : wrap this part in an if to only save if it was user-modified
2795 }
2796 }
2797 }
2798
2799 if ( categories.testFlag( Fields ) )
2800 {
2801 //attribute aliases
2802 QDomElement aliasElem = doc.createElement( QStringLiteral( "aliases" ) );
2803 for ( const QgsField &field : std::as_const( mFields ) )
2804 {
2805 QDomElement aliasEntryElem = doc.createElement( QStringLiteral( "alias" ) );
2806 aliasEntryElem.setAttribute( QStringLiteral( "field" ), field.name() );
2807 aliasEntryElem.setAttribute( QStringLiteral( "index" ), mFields.indexFromName( field.name() ) );
2808 aliasEntryElem.setAttribute( QStringLiteral( "name" ), field.alias() );
2809 aliasElem.appendChild( aliasEntryElem );
2810 }
2811 node.appendChild( aliasElem );
2812
2813 //default expressions
2814 QDomElement defaultsElem = doc.createElement( QStringLiteral( "defaults" ) );
2815 for ( const QgsField &field : std::as_const( mFields ) )
2816 {
2817 QDomElement defaultElem = doc.createElement( QStringLiteral( "default" ) );
2818 defaultElem.setAttribute( QStringLiteral( "field" ), field.name() );
2819 defaultElem.setAttribute( QStringLiteral( "expression" ), field.defaultValueDefinition().expression() );
2820 defaultElem.setAttribute( QStringLiteral( "applyOnUpdate" ), field.defaultValueDefinition().applyOnUpdate() ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
2821 defaultsElem.appendChild( defaultElem );
2822 }
2823 node.appendChild( defaultsElem );
2824
2825 // constraints
2826 QDomElement constraintsElem = doc.createElement( QStringLiteral( "constraints" ) );
2827 for ( const QgsField &field : std::as_const( mFields ) )
2828 {
2829 QDomElement constraintElem = doc.createElement( QStringLiteral( "constraint" ) );
2830 constraintElem.setAttribute( QStringLiteral( "field" ), field.name() );
2831 constraintElem.setAttribute( QStringLiteral( "constraints" ), field.constraints().constraints() );
2832 constraintElem.setAttribute( QStringLiteral( "unique_strength" ), field.constraints().constraintStrength( QgsFieldConstraints::ConstraintUnique ) );
2833 constraintElem.setAttribute( QStringLiteral( "notnull_strength" ), field.constraints().constraintStrength( QgsFieldConstraints::ConstraintNotNull ) );
2834 constraintElem.setAttribute( QStringLiteral( "exp_strength" ), field.constraints().constraintStrength( QgsFieldConstraints::ConstraintExpression ) );
2835 constraintsElem.appendChild( constraintElem );
2836 }
2837 node.appendChild( constraintsElem );
2838
2839 // constraint expressions
2840 QDomElement constraintExpressionsElem = doc.createElement( QStringLiteral( "constraintExpressions" ) );
2841 for ( const QgsField &field : std::as_const( mFields ) )
2842 {
2843 QDomElement constraintExpressionElem = doc.createElement( QStringLiteral( "constraint" ) );
2844 constraintExpressionElem.setAttribute( QStringLiteral( "field" ), field.name() );
2845 constraintExpressionElem.setAttribute( QStringLiteral( "exp" ), field.constraints().constraintExpression() );
2846 constraintExpressionElem.setAttribute( QStringLiteral( "desc" ), field.constraints().constraintDescription() );
2847 constraintExpressionsElem.appendChild( constraintExpressionElem );
2848 }
2849 node.appendChild( constraintExpressionsElem );
2850
2851 // save expression fields
2852 if ( !mExpressionFieldBuffer )
2853 {
2854 // can happen when saving style on a invalid layer
2856 dummy.writeXml( node, doc );
2857 }
2858 else
2859 {
2860 mExpressionFieldBuffer->writeXml( node, doc );
2861 }
2862 }
2863
2864 // add attribute actions
2865 if ( categories.testFlag( Actions ) )
2866 mActions->writeXml( node );
2867
2868 if ( categories.testFlag( AttributeTable ) )
2869 {
2870 mAttributeTableConfig.writeXml( node );
2871 mConditionalStyles->writeXml( node, doc, context );
2872 mStoredExpressionManager->writeXml( node );
2873 }
2874
2875 if ( categories.testFlag( Forms ) )
2876 mEditFormConfig.writeXml( node, context );
2877
2878 // save readonly state
2879 if ( categories.testFlag( LayerConfiguration ) )
2880 node.toElement().setAttribute( QStringLiteral( "readOnly" ), mReadOnly );
2881
2882 // save preview expression
2883 if ( categories.testFlag( LayerConfiguration ) )
2884 {
2885 QDomElement prevExpElem = doc.createElement( QStringLiteral( "previewExpression" ) );
2886 QDomText prevExpText = doc.createTextNode( mDisplayExpression );
2887 prevExpElem.appendChild( prevExpText );
2888 node.appendChild( prevExpElem );
2889 }
2890
2891 // save map tip
2892 if ( categories.testFlag( MapTips ) )
2893 {
2894 QDomElement mapTipElem = doc.createElement( QStringLiteral( "mapTip" ) );
2895 QDomText mapTipText = doc.createTextNode( mMapTipTemplate );
2896 mapTipElem.appendChild( mapTipText );
2897 node.toElement().appendChild( mapTipElem );
2898 }
2899
2900 return true;
2901}
2902
2903bool QgsVectorLayer::writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage,
2904 const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories ) const
2905{
2906 QDomElement mapLayerNode = node.toElement();
2907
2908 emit writeCustomSymbology( mapLayerNode, doc, errorMessage );
2909
2910 // we must try to write the renderer if our geometry type is unknown
2911 // as this allows the renderer to be correctly restored even for layers
2912 // with broken sources
2913 if ( isSpatial() || mWkbType == QgsWkbTypes::Unknown )
2914 {
2915 if ( categories.testFlag( Symbology ) )
2916 {
2917 if ( mRenderer )
2918 {
2919 QDomElement rendererElement = mRenderer->save( doc, context );
2920 node.appendChild( rendererElement );
2921 }
2922 }
2923
2924 if ( categories.testFlag( Labeling ) )
2925 {
2926 if ( mLabeling )
2927 {
2928 QDomElement labelingElement = mLabeling->save( doc, context );
2929 node.appendChild( labelingElement );
2930 }
2931 mapLayerNode.setAttribute( QStringLiteral( "labelsEnabled" ), mLabelsEnabled ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
2932 }
2933
2934 // save the simplification drawing settings
2935 if ( categories.testFlag( Rendering ) )
2936 {
2937 mapLayerNode.setAttribute( QStringLiteral( "simplifyDrawingHints" ), QString::number( mSimplifyMethod.simplifyHints() ) );
2938 mapLayerNode.setAttribute( QStringLiteral( "simplifyAlgorithm" ), QString::number( mSimplifyMethod.simplifyAlgorithm() ) );
2939 mapLayerNode.setAttribute( QStringLiteral( "simplifyDrawingTol" ), QString::number( mSimplifyMethod.threshold() ) );
2940 mapLayerNode.setAttribute( QStringLiteral( "simplifyLocal" ), mSimplifyMethod.forceLocalOptimization() ? 1 : 0 );
2941 mapLayerNode.setAttribute( QStringLiteral( "simplifyMaxScale" ), QString::number( mSimplifyMethod.maximumScale() ) );
2942 }
2943
2944 //save customproperties
2945 if ( categories.testFlag( CustomProperties ) )
2946 {
2947 writeCustomProperties( node, doc );
2948 }
2949
2950 if ( categories.testFlag( Symbology ) )
2951 {
2952 // add the blend mode field
2953 QDomElement blendModeElem = doc.createElement( QStringLiteral( "blendMode" ) );
2954 QDomText blendModeText = doc.createTextNode( QString::number( QgsPainting::getBlendModeEnum( blendMode() ) ) );
2955 blendModeElem.appendChild( blendModeText );
2956 node.appendChild( blendModeElem );
2957
2958 // add the feature blend mode field
2959 QDomElement featureBlendModeElem = doc.createElement( QStringLiteral( "featureBlendMode" ) );
2960 QDomText featureBlendModeText = doc.createTextNode( QString::number( QgsPainting::getBlendModeEnum( featureBlendMode() ) ) );
2961 featureBlendModeElem.appendChild( featureBlendModeText );
2962 node.appendChild( featureBlendModeElem );
2963 }
2964
2965 // add the layer opacity and scale visibility
2966 if ( categories.testFlag( Rendering ) )
2967 {
2968 QDomElement layerOpacityElem = doc.createElement( QStringLiteral( "layerOpacity" ) );
2969 QDomText layerOpacityText = doc.createTextNode( QString::number( opacity() ) );
2970 layerOpacityElem.appendChild( layerOpacityText );
2971 node.appendChild( layerOpacityElem );
2972 mapLayerNode.setAttribute( QStringLiteral( "hasScaleBasedVisibilityFlag" ), hasScaleBasedVisibility() ? 1 : 0 );
2973 mapLayerNode.setAttribute( QStringLiteral( "maxScale" ), maximumScale() );
2974 mapLayerNode.setAttribute( QStringLiteral( "minScale" ), minimumScale() );
2975
2976 mapLayerNode.setAttribute( QStringLiteral( "symbologyReferenceScale" ), mRenderer ? mRenderer->referenceScale() : -1 );
2977 }
2978
2979 if ( categories.testFlag( Diagrams ) && mDiagramRenderer )
2980 {
2981 mDiagramRenderer->writeXml( mapLayerNode, doc, context );
2982 if ( mDiagramLayerSettings )
2983 mDiagramLayerSettings->writeXml( mapLayerNode, doc );
2984 }
2985 }
2986 return true;
2987}
2988
2989bool QgsVectorLayer::readSld( const QDomNode &node, QString &errorMessage )
2990{
2991 // get the Name element
2992 QDomElement nameElem = node.firstChildElement( QStringLiteral( "Name" ) );
2993 if ( nameElem.isNull() )
2994 {
2995 errorMessage = QStringLiteral( "Warning: Name element not found within NamedLayer while it's required." );
2996 }
2997
2998 if ( isSpatial() )
2999 {
3000 QgsFeatureRenderer *r = QgsFeatureRenderer::loadSld( node, geometryType(), errorMessage );
3001 if ( !r )
3002 return false;
3003
3004 // defer style changed signal until we've set the renderer, labeling, everything.
3005 // we don't want multiple signals!
3006 ScopedIntIncrementor styleChangedSignalBlocker( &mBlockStyleChangedSignal );
3007
3008 setRenderer( r );
3009
3010 // labeling
3011 readSldLabeling( node );
3012
3013 styleChangedSignalBlocker.release();
3015 }
3016 return true;
3017}
3018
3019bool QgsVectorLayer::writeSld( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QVariantMap &props ) const
3020{
3021 Q_UNUSED( errorMessage )
3022
3023 QVariantMap localProps = QVariantMap( props );
3025 {
3027 }
3028
3029 if ( isSpatial() )
3030 {
3031 // store the Name element
3032 QDomElement nameNode = doc.createElement( QStringLiteral( "se:Name" ) );
3033 nameNode.appendChild( doc.createTextNode( name() ) );
3034 node.appendChild( nameNode );
3035
3036 QDomElement userStyleElem = doc.createElement( QStringLiteral( "UserStyle" ) );
3037 node.appendChild( userStyleElem );
3038
3039 QDomElement nameElem = doc.createElement( QStringLiteral( "se:Name" ) );
3040 nameElem.appendChild( doc.createTextNode( name() ) );
3041
3042 userStyleElem.appendChild( nameElem );
3043
3044 QDomElement featureTypeStyleElem = doc.createElement( QStringLiteral( "se:FeatureTypeStyle" ) );
3045 userStyleElem.appendChild( featureTypeStyleElem );
3046
3047 mRenderer->toSld( doc, featureTypeStyleElem, localProps );
3048 if ( labelsEnabled() )
3049 {
3050 mLabeling->toSld( featureTypeStyleElem, localProps );
3051 }
3052 }
3053 return true;
3054}
3055
3056
3057bool QgsVectorLayer::changeGeometry( QgsFeatureId fid, QgsGeometry &geom, bool skipDefaultValue )
3058{
3059 if ( !mEditBuffer || !mDataProvider )
3060 {
3061 return false;
3062 }
3063
3064 if ( mGeometryOptions->isActive() )
3065 mGeometryOptions->apply( geom );
3066
3067 updateExtents();
3068
3069 bool result = mEditBuffer->changeGeometry( fid, geom );
3070
3071 if ( result )
3072 {
3073 updateExtents();
3074 if ( !skipDefaultValue && !mDefaultValueOnUpdateFields.isEmpty() )
3075 updateDefaultValues( fid );
3076 }
3077 return result;
3078}
3079
3080
3081bool QgsVectorLayer::changeAttributeValue( QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue, bool skipDefaultValues )
3082{
3083 bool result = false;
3084
3085 switch ( fields().fieldOrigin( field ) )
3086 {
3088 result = mJoinBuffer->changeAttributeValue( fid, field, newValue, oldValue );
3089 if ( result )
3090 emit attributeValueChanged( fid, field, newValue );
3091 break;
3092
3096 {
3097 if ( mEditBuffer && mDataProvider )
3098 result = mEditBuffer->changeAttributeValue( fid, field, newValue, oldValue );
3099 break;
3100 }
3101
3103 break;
3104 }
3105
3106 if ( result && !skipDefaultValues && !mDefaultValueOnUpdateFields.isEmpty() )
3107 updateDefaultValues( fid );
3108
3109 return result;
3110}
3111
3112bool QgsVectorLayer::changeAttributeValues( QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues, bool skipDefaultValues )
3113{
3114 bool result = true;
3115
3116 QgsAttributeMap newValuesJoin;
3117 QgsAttributeMap oldValuesJoin;
3118
3119 QgsAttributeMap newValuesNotJoin;
3120 QgsAttributeMap oldValuesNotJoin;
3121
3122 for ( auto it = newValues.constBegin(); it != newValues.constEnd(); ++it )
3123 {
3124 const int field = it.key();
3125 const QVariant newValue = it.value();
3126 QVariant oldValue;
3127
3128 if ( oldValues.contains( field ) )
3129 oldValue = oldValues[field];
3130
3131 switch ( fields().fieldOrigin( field ) )
3132 {
3134 newValuesJoin[field] = newValue;
3135 oldValuesJoin[field] = oldValue;
3136 break;
3137
3141 {
3142 newValuesNotJoin[field] = newValue;
3143 oldValuesNotJoin[field] = oldValue;
3144 break;
3145 }
3146
3148 break;
3149 }
3150 }
3151
3152 if ( ! newValuesJoin.isEmpty() && mJoinBuffer )
3153 {
3154 result = mJoinBuffer->changeAttributeValues( fid, newValuesJoin, oldValuesJoin );
3155 }
3156
3157 if ( ! newValuesNotJoin.isEmpty() )
3158 {
3159 if ( mEditBuffer && mDataProvider )
3160 result &= mEditBuffer->changeAttributeValues( fid, newValuesNotJoin, oldValues );
3161 else
3162 result = false;
3163 }
3164
3165 if ( result && !skipDefaultValues && !mDefaultValueOnUpdateFields.isEmpty() )
3166 {
3167 updateDefaultValues( fid );
3168 }
3169
3170 return result;
3171}
3172
3174{
3175 if ( !mEditBuffer || !mDataProvider )
3176 return false;
3177
3178 return mEditBuffer->addAttribute( field );
3179}
3180
3182{
3183 if ( attIndex < 0 || attIndex >= fields().count() )
3184 return;
3185
3186 QString name = fields().at( attIndex ).name();
3187 mFields[ attIndex ].setAlias( QString() );
3188 if ( mAttributeAliasMap.contains( name ) )
3189 {
3190 mAttributeAliasMap.remove( name );
3191 updateFields();
3192 mEditFormConfig.setFields( mFields );
3193 emit layerModified();
3194 }
3195}
3196
3197bool QgsVectorLayer::renameAttribute( int index, const QString &newName )
3198{
3199 if ( index < 0 || index >= fields().count() )
3200 return false;
3201
3202 switch ( mFields.fieldOrigin( index ) )
3203 {
3205 {
3206 if ( mExpressionFieldBuffer )
3207 {
3208 int oi = mFields.fieldOriginIndex( index );
3209 mExpressionFieldBuffer->renameExpression( oi, newName );
3210 updateFields();
3211 return true;
3212 }
3213 else
3214 {
3215 return false;
3216 }
3217 }
3218
3221
3222 if ( !mEditBuffer || !mDataProvider )
3223 return false;
3224
3225 return mEditBuffer->renameAttribute( index, newName );
3226
3229 return false;
3230
3231 }
3232
3233 return false; // avoid warning
3234}
3235
3236void QgsVectorLayer::setFieldAlias( int attIndex, const QString &aliasString )
3237{
3238 if ( attIndex < 0 || attIndex >= fields().count() )
3239 return;
3240
3241 QString name = fields().at( attIndex ).name();
3242
3243 mAttributeAliasMap.insert( name, aliasString );
3244 mFields[ attIndex ].setAlias( aliasString );
3245 mEditFormConfig.setFields( mFields );
3246 emit layerModified(); // TODO[MD]: should have a different signal?
3247}
3248
3249QString QgsVectorLayer::attributeAlias( int index ) const
3250{
3251 if ( index < 0 || index >= fields().count() )
3252 return QString();
3253
3254 return fields().at( index ).alias();
3255}
3256
3258{
3259 if ( index >= 0 && index < mFields.count() )
3260 return mFields.at( index ).displayName();
3261 else
3262 return QString();
3263}
3264
3266{
3267 return mAttributeAliasMap;
3268}
3269
3271{
3272 QSet<QString> excludeList;
3273 QMap< QString, QgsField::ConfigurationFlags >::const_iterator flagsIt = mFieldConfigurationFlags.constBegin();
3274 for ( ; flagsIt != mFieldConfigurationFlags.constEnd(); ++flagsIt )
3275 {
3276 if ( flagsIt->testFlag( QgsField::ConfigurationFlag::HideFromWms ) )
3277 {
3278 excludeList << flagsIt.key();
3279 }
3280 }
3281 return excludeList;
3282}
3283
3284void QgsVectorLayer::setExcludeAttributesWms( const QSet<QString> &att )
3285{
3286 QMap< QString, QgsField::ConfigurationFlags >::iterator flagsIt = mFieldConfigurationFlags.begin();
3287 for ( ; flagsIt != mFieldConfigurationFlags.end(); ++flagsIt )
3288 {
3289 flagsIt->setFlag( QgsField::ConfigurationFlag::HideFromWms, att.contains( flagsIt.key() ) );
3290 }
3291 updateFields();
3292}
3293
3295{
3296 QSet<QString> excludeList;
3297 QMap< QString, QgsField::ConfigurationFlags >::const_iterator flagsIt = mFieldConfigurationFlags.constBegin();
3298 for ( ; flagsIt != mFieldConfigurationFlags.constEnd(); ++flagsIt )
3299 {
3300 if ( flagsIt->testFlag( QgsField::ConfigurationFlag::HideFromWfs ) )
3301 {
3302 excludeList << flagsIt.key();
3303 }
3304 }
3305 return excludeList;
3306}
3307
3308void QgsVectorLayer::setExcludeAttributesWfs( const QSet<QString> &att )
3309{
3310 QMap< QString, QgsField::ConfigurationFlags >::iterator flagsIt = mFieldConfigurationFlags.begin();
3311 for ( ; flagsIt != mFieldConfigurationFlags.end(); ++flagsIt )
3312 {
3313 flagsIt->setFlag( QgsField::ConfigurationFlag::HideFromWfs, att.contains( flagsIt.key() ) );
3314 }
3315 updateFields();
3316}
3317
3319{
3320 if ( index < 0 || index >= fields().count() )
3321 return false;
3322
3323 if ( mFields.fieldOrigin( index ) == QgsFields::OriginExpression )
3324 {
3325 removeExpressionField( index );
3326 return true;
3327 }
3328
3329 if ( !mEditBuffer || !mDataProvider )
3330 return false;
3331
3332 return mEditBuffer->deleteAttribute( index );
3333}
3334
3335bool QgsVectorLayer::deleteAttributes( const QList<int> &attrs )
3336{
3337 bool deleted = false;
3338
3339 // Remove multiple occurrences of same attribute
3340 QList<int> attrList = qgis::setToList( qgis::listToSet( attrs ) );
3341
3342 std::sort( attrList.begin(), attrList.end(), std::greater<int>() );
3343
3344 for ( int attr : std::as_const( attrList ) )
3345 {
3346 if ( deleteAttribute( attr ) )
3347 {
3348 deleted = true;
3349 }
3350 }
3351
3352 return deleted;
3353}
3354
3355bool QgsVectorLayer::deleteFeatureCascade( QgsFeatureId fid, QgsVectorLayer::DeleteContext *context )
3356{
3357 if ( !mEditBuffer )
3358 return false;
3359
3360 if ( context && context->cascade )
3361 {
3362 const QList<QgsRelation> relations = context->project->relationManager()->referencedRelations( this );
3363 const bool hasRelationsOrJoins = !relations.empty() || mJoinBuffer->containsJoins();
3364 if ( hasRelationsOrJoins )
3365 {
3366 if ( context->mHandledFeatures.contains( this ) )
3367 {
3368 QgsFeatureIds &handledFeatureIds = context->mHandledFeatures[ this ];
3369 if ( handledFeatureIds.contains( fid ) )
3370 {
3371 // avoid endless recursion
3372 return false;
3373 }
3374 else
3375 {
3376 // add feature id
3377 handledFeatureIds << fid;
3378 }
3379 }
3380 else
3381 {
3382 // add layer and feature id
3383 context->mHandledFeatures.insert( this, QgsFeatureIds() << fid );
3384 }
3385
3386 for ( const QgsRelation &relation : relations )
3387 {
3388 //check if composition (and not association)
3389 switch ( relation.strength() )
3390 {
3392 {
3393 //get features connected over this relation
3394 QgsFeatureIterator relatedFeaturesIt = relation.getRelatedFeatures( getFeature( fid ) );
3395 QgsFeatureIds childFeatureIds;
3396 QgsFeature childFeature;
3397 while ( relatedFeaturesIt.nextFeature( childFeature ) )
3398 {
3399 childFeatureIds.insert( childFeature.id() );
3400 }
3401 if ( childFeatureIds.count() > 0 )
3402 {
3403 relation.referencingLayer()->startEditing();
3404 relation.referencingLayer()->deleteFeatures( childFeatureIds, context );
3405 }
3406 break;
3407 }
3408
3410 break;
3411 }
3412 }
3413 }
3414 }
3415
3416 if ( mJoinBuffer->containsJoins() )
3417 mJoinBuffer->deleteFeature( fid, context );
3418
3419 bool res = mEditBuffer->deleteFeature( fid );
3420
3421 return res;
3422}
3423
3425{
3426 if ( !mEditBuffer )
3427 return false;
3428
3429 bool res = deleteFeatureCascade( fid, context );
3430
3431 if ( res )
3432 {
3433 updateExtents();
3434 }
3435
3436 return res;
3437}
3438
3440{
3441 bool res = true;
3442
3443 if ( ( context && context->cascade ) || mJoinBuffer->containsJoins() )
3444 {
3445 // should ideally be "deleteFeaturesCascade" for performance!
3446 for ( QgsFeatureId fid : fids )
3447 res = deleteFeatureCascade( fid, context ) && res;
3448 }
3449 else
3450 {
3451 res = mEditBuffer && mEditBuffer->deleteFeatures( fids );
3452 }
3453
3454 if ( res )
3455 {
3456 mSelectedFeatureIds.subtract( fids ); // remove it from selection
3457 updateExtents();
3458 }
3459
3460 return res;
3461}
3462
3464{
3465 return mFields;
3466}
3467
3469{
3470 QgsAttributeList pkAttributesList;
3471 if ( !mDataProvider )
3472 return pkAttributesList;
3473
3474 QgsAttributeList providerIndexes = mDataProvider->pkAttributeIndexes();
3475 for ( int i = 0; i < mFields.count(); ++i )
3476 {
3477 if ( mFields.fieldOrigin( i ) == QgsFields::OriginProvider &&
3478 providerIndexes.contains( mFields.fieldOriginIndex( i ) ) )
3479 pkAttributesList << i;
3480 }
3481
3482 return pkAttributesList;
3483}
3484
3486{
3487 if ( !mDataProvider )
3488 return static_cast< long long >( Qgis::FeatureCountState::UnknownCount );
3489 return mDataProvider->featureCount() +
3490 ( mEditBuffer && ! mDataProvider->transaction() ? mEditBuffer->addedFeatures().size() - mEditBuffer->deletedFeatureIds().size() : 0 );
3491}
3492
3494{
3495 const QgsFeatureIds deletedFeatures( mEditBuffer && ! mDataProvider->transaction() ? mEditBuffer->deletedFeatureIds() : QgsFeatureIds() );
3496 const QgsFeatureMap addedFeatures( mEditBuffer && ! mDataProvider->transaction() ? mEditBuffer->addedFeatures() : QgsFeatureMap() );
3497
3498 if ( mEditBuffer && !deletedFeatures.empty() )
3499 {
3500 if ( addedFeatures.size() > deletedFeatures.size() )
3502 else
3504 }
3505
3506 if ( ( !mEditBuffer || addedFeatures.empty() ) && mDataProvider && mDataProvider->empty() )
3508 else
3510}
3511
3512bool QgsVectorLayer::commitChanges( bool stopEditing )
3513{
3514 if ( project() && project()->transactionMode() == Qgis::TransactionMode::BufferedGroups )
3515 return project()->commitChanges( mCommitErrors, stopEditing, this );
3516
3517 mCommitErrors.clear();
3518
3519 if ( !mDataProvider )
3520 {
3521 mCommitErrors << tr( "ERROR: no provider" );
3522 return false;
3523 }
3524
3525 if ( !mEditBuffer )
3526 {
3527 mCommitErrors << tr( "ERROR: layer not editable" );
3528 return false;
3529 }
3530
3531 emit beforeCommitChanges( stopEditing );
3532
3533 if ( !mAllowCommit )
3534 return false;
3535
3536 mCommitChangesActive = true;
3537
3538 bool success = false;
3539 if ( mEditBuffer->editBufferGroup() )
3540 success = mEditBuffer->editBufferGroup()->commitChanges( mCommitErrors, stopEditing );
3541 else
3542 success = mEditBuffer->commitChanges( mCommitErrors );
3543
3544 mCommitChangesActive = false;
3545
3546 if ( !mDeletedFids.empty() )
3547 {
3548 emit featuresDeleted( mDeletedFids );
3549 mDeletedFids.clear();
3550 }
3551
3552 if ( success )
3553 {
3554 if ( stopEditing )
3555 {
3556 clearEditBuffer();
3557 }
3558 undoStack()->clear();
3559 emit afterCommitChanges();
3560 if ( stopEditing )
3561 emit editingStopped();
3562 }
3563 else
3564 {
3565 QgsMessageLog::logMessage( tr( "Commit errors:\n %1" ).arg( mCommitErrors.join( QLatin1String( "\n " ) ) ) );
3566 }
3567
3568 updateFields();
3569
3570 mDataProvider->updateExtents();
3571 mDataProvider->leaveUpdateMode();
3572
3573 // This second call is required because OGR provider with JSON
3574 // driver might have changed fields order after the call to
3575 // leaveUpdateMode
3576 if ( mFields.names() != mDataProvider->fields().names() )
3577 {
3578 updateFields();
3579 }
3580
3582
3583 return success;
3584}
3585
3587{
3588 return mCommitErrors;
3589}
3590
3591bool QgsVectorLayer::rollBack( bool deleteBuffer )
3592{
3593 if ( project() && project()->transactionMode() == Qgis::TransactionMode::BufferedGroups )
3594 return project()->rollBack( mCommitErrors, deleteBuffer, this );
3595
3596 if ( !mEditBuffer )
3597 {
3598 return false;
3599 }
3600
3601 if ( !mDataProvider )
3602 {
3603 mCommitErrors << tr( "ERROR: no provider" );
3604 return false;
3605 }
3606
3607 bool rollbackExtent = !mDataProvider->transaction() && ( !mEditBuffer->deletedFeatureIds().isEmpty() ||
3608 !mEditBuffer->addedFeatures().isEmpty() ||
3609 !mEditBuffer->changedGeometries().isEmpty() );
3610
3611 emit beforeRollBack();
3612
3613 mEditBuffer->rollBack();
3614
3615 emit afterRollBack();
3616
3617 if ( isModified() )
3618 {
3619 // new undo stack roll back method
3620 // old method of calling every undo could cause many canvas refreshes
3621 undoStack()->setIndex( 0 );
3622 }
3623
3624 updateFields();
3625
3626 if ( deleteBuffer )
3627 {
3628 delete mEditBuffer;
3629 mEditBuffer = nullptr;
3630 undoStack()->clear();
3631 }
3632 emit editingStopped();
3633
3634 if ( rollbackExtent )
3635 updateExtents();
3636
3637 mDataProvider->leaveUpdateMode();
3638
3640 return true;
3641}
3642
3644{
3645 return mSelectedFeatureIds.size();
3646}
3647
3649{
3650 return mSelectedFeatureIds;
3651}
3652
3654{
3655 QgsFeatureList features;
3656 features.reserve( mSelectedFeatureIds.count() );
3657 QgsFeature f;
3658
3660
3661 while ( it.nextFeature( f ) )
3662 {
3663 features.push_back( f );
3664 }
3665
3666 return features;
3667}
3668
3670{
3671 if ( mSelectedFeatureIds.isEmpty() )
3672 return QgsFeatureIterator();
3673
3676
3677 if ( mSelectedFeatureIds.count() == 1 )
3678 request.setFilterFid( *mSelectedFeatureIds.constBegin() );
3679 else
3680 request.setFilterFids( mSelectedFeatureIds );
3681
3682 return getFeatures( request );
3683}
3684
3686{
3687 if ( !mEditBuffer || !mDataProvider )
3688 return false;
3689
3690 if ( mGeometryOptions->isActive() )
3691 {
3692 for ( auto feature = features.begin(); feature != features.end(); ++feature )
3693 {
3694 QgsGeometry geom = feature->geometry();
3695 mGeometryOptions->apply( geom );
3696 feature->setGeometry( geom );
3697 }
3698 }
3699
3700 bool res = mEditBuffer->addFeatures( features );
3701 updateExtents();
3702
3703 if ( res && mJoinBuffer->containsJoins() )
3704 res = mJoinBuffer->addFeatures( features );
3705
3706 return res;
3707}
3708
3710{
3711 // if layer is not spatial, it has not CRS!
3712 setCrs( ( isSpatial() && mDataProvider ) ? mDataProvider->crs() : QgsCoordinateReferenceSystem() );
3713}
3714
3716{
3718 if ( exp.isField() )
3719 {
3720 return static_cast<const QgsExpressionNodeColumnRef *>( exp.rootNode() )->name();
3721 }
3722
3723 return QString();
3724}
3725
3726void QgsVectorLayer::setDisplayExpression( const QString &displayExpression )
3727{
3728 if ( mDisplayExpression == displayExpression )
3729 return;
3730
3731 mDisplayExpression = displayExpression;
3733}
3734
3736{
3737 if ( !mDisplayExpression.isEmpty() || mFields.isEmpty() )
3738 {
3739 return mDisplayExpression;
3740 }
3741 else
3742 {
3743 const QString candidateName = QgsVectorLayerUtils::guessFriendlyIdentifierField( mFields );
3744 if ( !candidateName.isEmpty() )
3745 {
3746 return QgsExpression::quotedColumnRef( candidateName );
3747 }
3748 else
3749 {
3750 return QString();
3751 }
3752 }
3753}
3754
3756{
3757 return ( mEditBuffer && mDataProvider );
3758}
3759
3765
3766bool QgsVectorLayer::isReadOnly() const
3767{
3768 return mDataSourceReadOnly || mReadOnly;
3769}
3770
3771bool QgsVectorLayer::setReadOnly( bool readonly )
3772{
3773 // exit if the layer is in editing mode
3774 if ( readonly && mEditBuffer )
3775 return false;
3776
3777 // exit if the data source is in read-only mode
3778 if ( !readonly && mDataSourceReadOnly )
3779 return false;
3780
3781 mReadOnly = readonly;
3782 emit readOnlyChanged();
3783 return true;
3784}
3785
3787{
3788 if ( ! mDataProvider )
3789 return false;
3790
3791 if ( mDataSourceReadOnly )
3792 return false;
3793
3794 return mDataProvider->capabilities() & QgsVectorDataProvider::EditingCapabilities && ! mReadOnly;
3795}
3796
3798{
3799 emit beforeModifiedCheck();
3800 return mEditBuffer && mEditBuffer->isModified();
3801}
3802
3803bool QgsVectorLayer::isAuxiliaryField( int index, int &srcIndex ) const
3804{
3805 bool auxiliaryField = false;
3806 srcIndex = -1;
3807
3808 if ( !auxiliaryLayer() )
3809 return auxiliaryField;
3810
3811 if ( index >= 0 && fields().fieldOrigin( index ) == QgsFields::OriginJoin )
3812 {
3813 const QgsVectorLayerJoinInfo *info = mJoinBuffer->joinForFieldIndex( index, fields(), srcIndex );
3814
3815 if ( info && info->joinLayerId() == auxiliaryLayer()->id() )
3816 auxiliaryField = true;
3817 }
3818
3819 return auxiliaryField;
3820}
3821
3823{
3824 // we must allow setting a renderer if our geometry type is unknown
3825 // as this allows the renderer to be correctly set even for layers
3826 // with broken sources
3827 if ( !isSpatial() && mWkbType != QgsWkbTypes::Unknown )
3828 return;
3829
3830 if ( r != mRenderer )
3831 {
3832 delete mRenderer;
3833 mRenderer = r;
3834 mSymbolFeatureCounted = false;
3835 mSymbolFeatureCountMap.clear();
3836 mSymbolFeatureIdMap.clear();
3837
3838 if ( mRenderer )
3839 {
3840 const double refreshRate = QgsSymbolLayerUtils::rendererFrameRate( mRenderer );
3841 if ( refreshRate <= 0 )
3842 {
3843 mRefreshRendererTimer->stop();
3844 mRefreshRendererTimer->setInterval( 0 );
3845 }
3846 else
3847 {
3848 mRefreshRendererTimer->setInterval( 1000 / refreshRate );
3849 mRefreshRendererTimer->start();
3850 }
3851 }
3852
3853 emit rendererChanged();
3855 }
3856}
3857
3859{
3860 if ( generator )
3861 {
3862 mRendererGenerators << generator;
3863 }
3864}
3865
3867{
3868 for ( int i = mRendererGenerators.count() - 1; i >= 0; --i )
3869 {
3870 if ( mRendererGenerators.at( i )->id() == id )
3871 {
3872 delete mRendererGenerators.at( i );
3873 mRendererGenerators.removeAt( i );
3874 }
3875 }
3876}
3877
3878QList<const QgsFeatureRendererGenerator *> QgsVectorLayer::featureRendererGenerators() const
3879{
3880 QList< const QgsFeatureRendererGenerator * > res;
3881 for ( const QgsFeatureRendererGenerator *generator : mRendererGenerators )
3882 res << generator;
3883 return res;
3884}
3885
3886void QgsVectorLayer::beginEditCommand( const QString &text )
3887{
3888 if ( !mDataProvider )
3889 {
3890 return;
3891 }
3892 if ( mDataProvider->transaction() )
3893 {
3894 QString ignoredError;
3895 mDataProvider->transaction()->createSavepoint( ignoredError );
3896 }
3897 undoStack()->beginMacro( text );
3898 mEditCommandActive = true;
3899 emit editCommandStarted( text );
3900}
3901
3903{
3904 if ( !mDataProvider )
3905 {
3906 return;
3907 }
3908 undoStack()->endMacro();
3909 mEditCommandActive = false;
3910 if ( !mDeletedFids.isEmpty() )
3911 {
3912 if ( selectedFeatureCount() > 0 )
3913 {
3914 mSelectedFeatureIds.subtract( mDeletedFids );
3915 }
3916 emit featuresDeleted( mDeletedFids );
3917 mDeletedFids.clear();
3918 }
3919 emit editCommandEnded();
3920}
3921
3923{
3924 if ( !mDataProvider )
3925 {
3926 return;
3927 }
3928 undoStack()->endMacro();
3929 undoStack()->undo();
3930
3931 // it's not directly possible to pop the last command off the stack (the destroyed one)
3932 // and delete, so we add a dummy obsolete command to force this to occur.
3933 // Pushing the new command deletes the destroyed one, and since the new
3934 // command is obsolete it's automatically deleted by the undo stack.
3935 std::unique_ptr< QUndoCommand > command = std::make_unique< QUndoCommand >();
3936 command->setObsolete( true );
3937 undoStack()->push( command.release() );
3938
3939 mEditCommandActive = false;
3940 mDeletedFids.clear();
3941 emit editCommandDestroyed();
3942}
3943
3945{
3946 return mJoinBuffer->addJoin( joinInfo );
3947}
3948
3949
3950bool QgsVectorLayer::removeJoin( const QString &joinLayerId )
3951{
3952 return mJoinBuffer->removeJoin( joinLayerId );
3953}
3954
3955const QList< QgsVectorLayerJoinInfo > QgsVectorLayer::vectorJoins() const
3956{
3957 return mJoinBuffer->vectorJoins();
3958}
3959
3960int QgsVectorLayer::addExpressionField( const QString &exp, const QgsField &fld )
3961{
3962 emit beforeAddingExpressionField( fld.name() );
3963 mExpressionFieldBuffer->addExpression( exp, fld );
3964 updateFields();
3965 int idx = mFields.indexFromName( fld.name() );
3966 emit attributeAdded( idx );
3967 return idx;
3968}
3969
3971{
3972 emit beforeRemovingExpressionField( index );
3973 int oi = mFields.fieldOriginIndex( index );
3974 mExpressionFieldBuffer->removeExpression( oi );
3975 updateFields();
3976 emit attributeDeleted( index );
3977}
3978
3979QString QgsVectorLayer::expressionField( int index ) const
3980{
3981 if ( mFields.fieldOrigin( index ) != QgsFields::OriginExpression )
3982 return QString();
3983
3984 int oi = mFields.fieldOriginIndex( index );
3985 if ( oi < 0 || oi >= mExpressionFieldBuffer->expressions().size() )
3986 return QString();
3987
3988 return mExpressionFieldBuffer->expressions().at( oi ).cachedExpression.expression();
3989}
3990
3991void QgsVectorLayer::updateExpressionField( int index, const QString &exp )
3992{
3993 int oi = mFields.fieldOriginIndex( index );
3994 mExpressionFieldBuffer->updateExpression( oi, exp );
3995}
3996
3998{
3999 if ( !mDataProvider )
4000 return;
4001
4002 QgsFields oldFields = mFields;
4003
4004 mFields = mDataProvider->fields();
4005
4006 // added / removed fields
4007 if ( mEditBuffer )
4008 mEditBuffer->updateFields( mFields );
4009
4010 // joined fields
4011 if ( mJoinBuffer->containsJoins() )
4012 mJoinBuffer->updateFields( mFields );
4013
4014 if ( mExpressionFieldBuffer )
4015 mExpressionFieldBuffer->updateFields( mFields );
4016
4017 // set aliases and default values
4018 QMap< QString, QString >::const_iterator aliasIt = mAttributeAliasMap.constBegin();
4019 for ( ; aliasIt != mAttributeAliasMap.constEnd(); ++aliasIt )
4020 {
4021 int index = mFields.lookupField( aliasIt.key() );
4022 if ( index < 0 )
4023 continue;
4024
4025 mFields[ index ].setAlias( aliasIt.value() );
4026 }
4027
4028 // Update configuration flags
4029 QMap< QString, QgsField::ConfigurationFlags >::const_iterator flagsIt = mFieldConfigurationFlags.constBegin();
4030 for ( ; flagsIt != mFieldConfigurationFlags.constEnd(); ++flagsIt )
4031 {
4032 int index = mFields.lookupField( flagsIt.key() );
4033 if ( index < 0 )
4034 continue;
4035
4036 mFields[index].setConfigurationFlags( flagsIt.value() );
4037 }
4038
4039 // Update default values
4040 mDefaultValueOnUpdateFields.clear();
4041 QMap< QString, QgsDefaultValue >::const_iterator defaultIt = mDefaultExpressionMap.constBegin();
4042 for ( ; defaultIt != mDefaultExpressionMap.constEnd(); ++defaultIt )
4043 {
4044 int index = mFields.lookupField( defaultIt.key() );
4045 if ( index < 0 )
4046 continue;
4047
4048 mFields[ index ].setDefaultValueDefinition( defaultIt.value() );
4049 if ( defaultIt.value().applyOnUpdate() )
4050 mDefaultValueOnUpdateFields.insert( index );
4051 }
4052
4053 QMap< QString, QgsFieldConstraints::Constraints >::const_iterator constraintIt = mFieldConstraints.constBegin();
4054 for ( ; constraintIt != mFieldConstraints.constEnd(); ++constraintIt )
4055 {
4056 int index = mFields.lookupField( constraintIt.key() );
4057 if ( index < 0 )
4058 continue;
4059
4060 QgsFieldConstraints constraints = mFields.at( index ).constraints();
4061
4062 // always keep provider constraints intact
4063 if ( !( constraints.constraints() & QgsFieldConstraints::ConstraintNotNull ) && ( constraintIt.value() & QgsFieldConstraints::ConstraintNotNull ) )
4065 if ( !( constraints.constraints() & QgsFieldConstraints::ConstraintUnique ) && ( constraintIt.value() & QgsFieldConstraints::ConstraintUnique ) )
4067 if ( !( constraints.constraints() & QgsFieldConstraints::ConstraintExpression ) && ( constraintIt.value() & QgsFieldConstraints::ConstraintExpression ) )
4069 mFields[ index ].setConstraints( constraints );
4070 }
4071
4072 QMap< QString, QPair< QString, QString > >::const_iterator constraintExpIt = mFieldConstraintExpressions.constBegin();
4073 for ( ; constraintExpIt != mFieldConstraintExpressions.constEnd(); ++constraintExpIt )
4074 {
4075 int index = mFields.lookupField( constraintExpIt.key() );
4076 if ( index < 0 )
4077 continue;
4078
4079 QgsFieldConstraints constraints = mFields.at( index ).constraints();
4080
4081 // always keep provider constraints intact
4083 continue;
4084
4085 constraints.setConstraintExpression( constraintExpIt.value().first, constraintExpIt.value().second );
4086 mFields[ index ].setConstraints( constraints );
4087 }
4088
4089 QMap< QPair< QString, QgsFieldConstraints::Constraint >, QgsFieldConstraints::ConstraintStrength >::const_iterator constraintStrengthIt = mFieldConstraintStrength.constBegin();
4090 for ( ; constraintStrengthIt != mFieldConstraintStrength.constEnd(); ++constraintStrengthIt )
4091 {
4092 int index = mFields.lookupField( constraintStrengthIt.key().first );
4093 if ( index < 0 )
4094 continue;
4095
4096 QgsFieldConstraints constraints = mFields.at( index ).constraints();
4097
4098 // always keep provider constraints intact
4100 continue;
4101
4102 constraints.setConstraintStrength( constraintStrengthIt.key().second, constraintStrengthIt.value() );
4103 mFields[ index ].setConstraints( constraints );
4104 }
4105
4106 auto fieldWidgetIterator = mFieldWidgetSetups.constBegin();
4107 for ( ; fieldWidgetIterator != mFieldWidgetSetups.constEnd(); ++ fieldWidgetIterator )
4108 {
4109 int index = mFields.indexOf( fieldWidgetIterator.key() );
4110 if ( index < 0 )
4111 continue;
4112
4113 mFields[index].setEditorWidgetSetup( fieldWidgetIterator.value() );
4114 }
4115
4116 if ( oldFields != mFields )
4117 {
4118 emit updatedFields();
4119 mEditFormConfig.setFields( mFields );
4120 }
4121
4122}
4123
4124
4125QVariant QgsVectorLayer::defaultValue( int index, const QgsFeature &feature, QgsExpressionContext *context ) const
4126{
4127 if ( index < 0 || index >= mFields.count() || !mDataProvider )
4128 return QVariant();
4129
4130 QString expression = mFields.at( index ).defaultValueDefinition().expression();
4131 if ( expression.isEmpty() )
4132 return mDataProvider->defaultValue( index );
4133
4134 QgsExpressionContext *evalContext = context;
4135 std::unique_ptr< QgsExpressionContext > tempContext;
4136 if ( !evalContext )
4137 {
4138 // no context passed, so we create a default one
4140 evalContext = tempContext.get();
4141 }
4142
4143 if ( feature.isValid() )
4144 {
4146 featScope->setFeature( feature );
4147 featScope->setFields( feature.fields() );
4148 evalContext->appendScope( featScope );
4149 }
4150
4151 QVariant val;
4152 QgsExpression exp( expression );
4153 exp.prepare( evalContext );
4154 if ( exp.hasEvalError() )
4155 {
4156 QgsLogger::warning( "Error evaluating default value: " + exp.evalErrorString() );
4157 }
4158 else
4159 {
4160 val = exp.evaluate( evalContext );
4161 }
4162
4163 if ( feature.isValid() )
4164 {
4165 delete evalContext->popScope();
4166 }
4167
4168 return val;
4169}
4170
4172{
4173 if ( index < 0 || index >= mFields.count() )
4174 return;
4175
4176 if ( definition.isValid() )
4177 {
4178 mDefaultExpressionMap.insert( mFields.at( index ).name(), definition );
4179 }
4180 else
4181 {
4182 mDefaultExpressionMap.remove( mFields.at( index ).name() );
4183 }
4184 updateFields();
4185}
4186
4188{
4189 if ( index < 0 || index >= mFields.count() )
4190 return QgsDefaultValue();
4191 else
4192 return mFields.at( index ).defaultValueDefinition();
4193}
4194
4195QSet<QVariant> QgsVectorLayer::uniqueValues( int index, int limit ) const
4196{
4197 QSet<QVariant> uniqueValues;
4198 if ( !mDataProvider )
4199 {
4200 return uniqueValues;
4201 }
4202
4203 QgsFields::FieldOrigin origin = mFields.fieldOrigin( index );
4204 switch ( origin )
4205 {
4207 return uniqueValues;
4208
4209 case QgsFields::OriginProvider: //a provider field
4210 {
4211 uniqueValues = mDataProvider->uniqueValues( index, limit );
4212
4213 if ( mEditBuffer && ! mDataProvider->transaction() )
4214 {
4215 QSet<QString> vals;
4216 const auto constUniqueValues = uniqueValues;
4217 for ( const QVariant &v : constUniqueValues )
4218 {
4219 vals << v.toString();
4220 }
4221
4222 QgsFeatureMap added = mEditBuffer->addedFeatures();
4223 QMapIterator< QgsFeatureId, QgsFeature > addedIt( added );
4224 while ( addedIt.hasNext() && ( limit < 0 || uniqueValues.count() < limit ) )
4225 {
4226 addedIt.next();
4227 QVariant v = addedIt.value().attribute( index );
4228 if ( v.isValid() )
4229 {
4230 QString vs = v.toString();
4231 if ( !vals.contains( vs ) )
4232 {
4233 vals << vs;
4234 uniqueValues << v;
4235 }
4236 }
4237 }
4238
4239 QMapIterator< QgsFeatureId, QgsAttributeMap > it( mEditBuffer->changedAttributeValues() );
4240 while ( it.hasNext() && ( limit < 0 || uniqueValues.count() < limit ) )
4241 {
4242 it.next();
4243 QVariant v = it.value().value( index );
4244 if ( v.isValid() )
4245 {
4246 QString vs = v.toString();
4247 if ( !vals.contains( vs ) )
4248 {
4249 vals << vs;
4250 uniqueValues << v;
4251 }
4252 }
4253 }
4254 }
4255
4256 return uniqueValues;
4257 }
4258
4260 // the layer is editable, but in certain cases it can still be avoided going through all features
4261 if ( mDataProvider->transaction() || (
4262 mEditBuffer->deletedFeatureIds().isEmpty() &&
4263 mEditBuffer->addedFeatures().isEmpty() &&
4264 !mEditBuffer->deletedAttributeIds().contains( index ) &&
4265 mEditBuffer->changedAttributeValues().isEmpty() ) )
4266 {
4267 uniqueValues = mDataProvider->uniqueValues( index, limit );
4268 return uniqueValues;
4269 }
4271 //we need to go through each feature
4274 {
4275 QgsAttributeList attList;
4276 attList << index;
4277
4280 .setSubsetOfAttributes( attList ) );
4281
4282 QgsFeature f;
4283 QVariant currentValue;
4284 QHash<QString, QVariant> val;
4285 while ( fit.nextFeature( f ) )
4286 {
4287 currentValue = f.attribute( index );
4288 val.insert( currentValue.toString(), currentValue );
4289 if ( limit >= 0 && val.size() >= limit )
4290 {
4291 break;
4292 }
4293 }
4294
4295 return qgis::listToSet( val.values() );
4296 }
4297 }
4298
4299 Q_ASSERT_X( false, "QgsVectorLayer::uniqueValues()", "Unknown source of the field!" );
4300 return uniqueValues;
4301}
4302
4303QStringList QgsVectorLayer::uniqueStringsMatching( int index, const QString &substring, int limit, QgsFeedback *feedback ) const
4304{
4305 QStringList results;
4306 if ( !mDataProvider )
4307 {
4308 return results;
4309 }
4310
4311 QgsFields::FieldOrigin origin = mFields.fieldOrigin( index );
4312 switch ( origin )
4313 {
4315 return results;
4316
4317 case QgsFields::OriginProvider: //a provider field
4318 {
4319 results = mDataProvider->uniqueStringsMatching( index, substring, limit, feedback );
4320
4321 if ( mEditBuffer && ! mDataProvider->transaction() )
4322 {
4323 QgsFeatureMap added = mEditBuffer->addedFeatures();
4324 QMapIterator< QgsFeatureId, QgsFeature > addedIt( added );
4325 while ( addedIt.hasNext() && ( limit < 0 || results.count() < limit ) && ( !feedback || !feedback->isCanceled() ) )
4326 {
4327 addedIt.next();
4328 QVariant v = addedIt.value().attribute( index );
4329 if ( v.isValid() )
4330 {
4331 QString vs = v.toString();
4332 if ( vs.contains( substring, Qt::CaseInsensitive ) && !results.contains( vs ) )
4333 {
4334 results << vs;
4335 }
4336 }
4337 }
4338
4339 QMapIterator< QgsFeatureId, QgsAttributeMap > it( mEditBuffer->changedAttributeValues() );
4340 while ( it.hasNext() && ( limit < 0 || results.count() < limit ) && ( !feedback || !feedback->isCanceled() ) )
4341 {
4342 it.next();
4343 QVariant v = it.value().value( index );
4344 if ( v.isValid() )
4345 {
4346 QString vs = v.toString();
4347 if ( vs.contains( substring, Qt::CaseInsensitive ) && !results.contains( vs ) )
4348 {
4349 results << vs;
4350 }
4351 }
4352 }
4353 }
4354
4355 return results;
4356 }
4357
4359 // the layer is editable, but in certain cases it can still be avoided going through all features
4360 if ( mDataProvider->transaction() || ( mEditBuffer->deletedFeatureIds().isEmpty() &&
4361 mEditBuffer->addedFeatures().isEmpty() &&
4362 !mEditBuffer->deletedAttributeIds().contains( index ) &&
4363 mEditBuffer->changedAttributeValues().isEmpty() ) )
4364 {
4365 return mDataProvider->uniqueStringsMatching( index, substring, limit, feedback );
4366 }
4368 //we need to go through each feature
4371 {
4372 QgsAttributeList attList;
4373 attList << index;
4374
4375 QgsFeatureRequest request;
4376 request.setSubsetOfAttributes( attList );
4378 QString fieldName = mFields.at( index ).name();
4379 request.setFilterExpression( QStringLiteral( "\"%1\" ILIKE '%%2%'" ).arg( fieldName, substring ) );
4380 QgsFeatureIterator fit = getFeatures( request );
4381
4382 QgsFeature f;
4383 QString currentValue;
4384 while ( fit.nextFeature( f ) )
4385 {
4386 currentValue = f.attribute( index ).toString();
4387 if ( !results.contains( currentValue ) )
4388 results << currentValue;
4389
4390 if ( ( limit >= 0 && results.size() >= limit ) || ( feedback && feedback->isCanceled() ) )
4391 {
4392 break;
4393 }
4394 }
4395
4396 return results;
4397 }
4398 }
4399
4400 Q_ASSERT_X( false, "QgsVectorLayer::uniqueStringsMatching()", "Unknown source of the field!" );
4401 return results;
4402}
4403
4404QVariant QgsVectorLayer::minimumValue( int index ) const
4405{
4406 QVariant minimum;
4407 minimumOrMaximumValue( index, &minimum, nullptr );
4408 return minimum;
4409}
4410
4411QVariant QgsVectorLayer::maximumValue( int index ) const
4412{
4413 QVariant maximum;
4414 minimumOrMaximumValue( index, nullptr, &maximum );
4415 return maximum;
4416}
4417
4418void QgsVectorLayer::minimumAndMaximumValue( int index, QVariant &minimum, QVariant &maximum ) const
4419{
4420 minimumOrMaximumValue( index, &minimum, &maximum );
4421}
4422
4423void QgsVectorLayer::minimumOrMaximumValue( int index, QVariant *minimum, QVariant *maximum ) const
4424{
4425 if ( minimum )
4426 *minimum = QVariant();
4427 if ( maximum )
4428 *maximum = QVariant();
4429
4430 if ( !mDataProvider )
4431 {
4432 return;
4433 }
4434
4435 QgsFields::FieldOrigin origin = mFields.fieldOrigin( index );
4436
4437 switch ( origin )
4438 {
4440 {
4441 return;
4442 }
4443
4444 case QgsFields::OriginProvider: //a provider field
4445 {
4446 if ( minimum )
4447 *minimum = mDataProvider->minimumValue( index );
4448 if ( maximum )
4449 *maximum = mDataProvider->maximumValue( index );
4450 if ( mEditBuffer && ! mDataProvider->transaction() )
4451 {
4452 const QgsFeatureMap added = mEditBuffer->addedFeatures();
4453 QMapIterator< QgsFeatureId, QgsFeature > addedIt( added );
4454 while ( addedIt.hasNext() )
4455 {
4456 addedIt.next();
4457 const QVariant v = addedIt.value().attribute( index );
4458 if ( minimum && v.isValid() && qgsVariantLessThan( v, *minimum ) )
4459 *minimum = v;
4460 if ( maximum && v.isValid() && qgsVariantGreaterThan( v, *maximum ) )
4461 *maximum = v;
4462 }
4463
4464 QMapIterator< QgsFeatureId, QgsAttributeMap > it( mEditBuffer->changedAttributeValues() );
4465 while ( it.hasNext() )
4466 {
4467 it.next();
4468 const QVariant v = it.value().value( index );
4469 if ( minimum && v.isValid() && qgsVariantLessThan( v, *minimum ) )
4470 *minimum = v;
4471 if ( maximum && v.isValid() && qgsVariantGreaterThan( v, *maximum ) )
4472 *maximum = v;
4473 }
4474 }
4475 return;
4476 }
4477
4479 {
4480 // the layer is editable, but in certain cases it can still be avoided going through all features
4481 if ( mDataProvider->transaction() || ( mEditBuffer->deletedFeatureIds().isEmpty() &&
4482 mEditBuffer->addedFeatures().isEmpty() &&
4483 !mEditBuffer->deletedAttributeIds().contains( index ) &&
4484 mEditBuffer->changedAttributeValues().isEmpty() ) )
4485 {
4486 if ( minimum )
4487 *minimum = mDataProvider->minimumValue( index );
4488 if ( maximum )
4489 *maximum = mDataProvider->maximumValue( index );
4490 return;
4491 }
4492 }
4494 // no choice but to go through all features
4497 {
4498 // we need to go through each feature
4499 QgsAttributeList attList;
4500 attList << index;
4501
4504 .setSubsetOfAttributes( attList ) );
4505
4506 QgsFeature f;
4507 bool firstValue = true;
4508 while ( fit.nextFeature( f ) )
4509 {
4510 const QVariant currentValue = f.attribute( index );
4511 if ( QgsVariantUtils::isNull( currentValue ) )
4512 continue;
4513
4514 if ( firstValue )
4515 {
4516 if ( minimum )
4517 *minimum = currentValue;
4518 if ( maximum )
4519 *maximum = currentValue;
4520 firstValue = false;
4521 }
4522 else
4523 {
4524 if ( minimum && currentValue.isValid() && qgsVariantLessThan( currentValue, *minimum ) )
4525 *minimum = currentValue;
4526 if ( maximum && currentValue.isValid() && qgsVariantGreaterThan( currentValue, *maximum ) )
4527 *maximum = currentValue;
4528 }
4529 }
4530 return;
4531 }
4532 }
4533
4534 Q_ASSERT_X( false, "QgsVectorLayer::minimumOrMaximumValue()", "Unknown source of the field!" );
4535}
4536
4537void QgsVectorLayer::createEditBuffer()
4538{
4539 if ( mEditBuffer )
4540 clearEditBuffer();
4541
4542 if ( mDataProvider->transaction() )
4543 {
4544 mEditBuffer = new QgsVectorLayerEditPassthrough( this );
4545
4546 connect( mDataProvider->transaction(), &QgsTransaction::dirtied, this, &QgsVectorLayer::onDirtyTransaction, Qt::UniqueConnection );
4547 }
4548 else
4549 {
4550 mEditBuffer = new QgsVectorLayerEditBuffer( this );
4551 }
4552 // forward signals
4553 connect( mEditBuffer, &QgsVectorLayerEditBuffer::layerModified, this, &QgsVectorLayer::invalidateSymbolCountedFlag );
4554 connect( mEditBuffer, &QgsVectorLayerEditBuffer::layerModified, this, &QgsVectorLayer::layerModified ); // TODO[MD]: necessary?
4555 //connect( mEditBuffer, SIGNAL( layerModified() ), this, SLOT( triggerRepaint() ) ); // TODO[MD]: works well?
4557 connect( mEditBuffer, &QgsVectorLayerEditBuffer::featureDeleted, this, &QgsVectorLayer::onFeatureDeleted );
4568
4569}
4570
4571void QgsVectorLayer::clearEditBuffer()
4572{
4573 delete mEditBuffer;
4574 mEditBuffer = nullptr;
4575}
4576
4577QVariant QgsVectorLayer::aggregate( QgsAggregateCalculator::Aggregate aggregate, const QString &fieldOrExpression,
4579 bool *ok, QgsFeatureIds *fids, QgsFeedback *feedback, QString *error ) const
4580{
4581 if ( ok )
4582 *ok = false;
4583 if ( error )
4584 error->clear();
4585
4586 if ( !mDataProvider )
4587 {
4588 if ( error )
4589 *error = tr( "Layer is invalid" );
4590 return QVariant();
4591 }
4592
4593 // test if we are calculating based on a field
4594 const int attrIndex = QgsExpression::expressionToLayerFieldIndex( fieldOrExpression, this );
4595 if ( attrIndex >= 0 )
4596 {
4597 // aggregate is based on a field - if it's a provider field, we could possibly hand over the calculation
4598 // to the provider itself
4599 QgsFields::FieldOrigin origin = mFields.fieldOrigin( attrIndex );
4600 if ( origin == QgsFields::OriginProvider )
4601 {
4602 bool providerOk = false;
4603 QVariant val = mDataProvider->aggregate( aggregate, attrIndex, parameters, context, providerOk, fids );
4604 if ( providerOk )
4605 {
4606 // provider handled calculation
4607 if ( ok )
4608 *ok = true;
4609 return val;
4610 }
4611 }
4612 }
4613
4614 // fallback to using aggregate calculator to determine aggregate
4615 QgsAggregateCalculator c( this );
4616 if ( fids )
4617 c.setFidsFilter( *fids );
4618 c.setParameters( parameters );
4619 bool aggregateOk = false;
4620 const QVariant result = c.calculate( aggregate, fieldOrExpression, context, &aggregateOk, feedback );
4621 if ( ok )
4622 *ok = aggregateOk;
4623 if ( !aggregateOk && error )
4624 *error = c.lastError();
4625
4626 return result;
4627}
4628
4629void QgsVectorLayer::setFeatureBlendMode( QPainter::CompositionMode featureBlendMode )
4630{
4631 if ( mFeatureBlendMode == featureBlendMode )
4632 return;
4633
4634 mFeatureBlendMode = featureBlendMode;
4637}
4638
4639QPainter::CompositionMode QgsVectorLayer::featureBlendMode() const
4640{
4641 return mFeatureBlendMode;
4642}
4643
4644void QgsVectorLayer::readSldLabeling( const QDomNode &node )
4645{
4646 setLabeling( nullptr ); // start with no labeling
4647 setLabelsEnabled( false );
4648
4649 QDomElement element = node.toElement();
4650 if ( element.isNull() )
4651 return;
4652
4653 QDomElement userStyleElem = element.firstChildElement( QStringLiteral( "UserStyle" ) );
4654 if ( userStyleElem.isNull() )
4655 {
4656 QgsDebugMsgLevel( QStringLiteral( "Info: UserStyle element not found." ), 4 );
4657 return;
4658 }
4659
4660 QDomElement featTypeStyleElem = userStyleElem.firstChildElement( QStringLiteral( "FeatureTypeStyle" ) );
4661 if ( featTypeStyleElem.isNull() )
4662 {
4663 QgsDebugMsgLevel( QStringLiteral( "Info: FeatureTypeStyle element not found." ), 4 );
4664 return;
4665 }
4666
4667 // create empty FeatureTypeStyle element to merge TextSymbolizer's Rule's from all FeatureTypeStyle's
4668 QDomElement mergedFeatTypeStyle = featTypeStyleElem.cloneNode( false ).toElement();
4669
4670 // use the RuleRenderer when more rules are present or the rule
4671 // has filters or min/max scale denominators set,
4672 // otherwise use the Simple labeling
4673 bool needRuleBasedLabeling = false;
4674 int ruleCount = 0;
4675
4676 while ( !featTypeStyleElem.isNull() )
4677 {
4678 QDomElement ruleElem = featTypeStyleElem.firstChildElement( QStringLiteral( "Rule" ) );
4679 while ( !ruleElem.isNull() )
4680 {
4681 // test rule children element to check if we need to create RuleRenderer
4682 // and if the rule has a symbolizer
4683 bool hasTextSymbolizer = false;
4684 bool hasRuleBased = false;
4685 QDomElement ruleChildElem = ruleElem.firstChildElement();
4686 while ( !ruleChildElem.isNull() )
4687 {
4688 // rule has filter or min/max scale denominator, use the RuleRenderer
4689 if ( ruleChildElem.localName() == QLatin1String( "Filter" ) ||
4690 ruleChildElem.localName() == QLatin1String( "MinScaleDenominator" ) ||
4691 ruleChildElem.localName() == QLatin1String( "MaxScaleDenominator" ) )
4692 {
4693 hasRuleBased = true;
4694 }
4695 // rule has a renderer symbolizer, not a text symbolizer
4696 else if ( ruleChildElem.localName() == QLatin1String( "TextSymbolizer" ) )
4697 {
4698 QgsDebugMsgLevel( QStringLiteral( "Info: TextSymbolizer element found" ), 4 );
4699 hasTextSymbolizer = true;
4700 }
4701
4702 ruleChildElem = ruleChildElem.nextSiblingElement();
4703 }
4704
4705 if ( hasTextSymbolizer )
4706 {
4707 ruleCount++;
4708
4709 // append a clone of all Rules to the merged FeatureTypeStyle element
4710 mergedFeatTypeStyle.appendChild( ruleElem.cloneNode().toElement() );
4711
4712 if ( hasRuleBased )
4713 {
4714 QgsDebugMsgLevel( QStringLiteral( "Info: Filter or Min/MaxScaleDenominator element found: need a RuleBasedLabeling" ), 4 );
4715 needRuleBasedLabeling = true;
4716 }
4717 }
4718
4719 // more rules present, use the RuleRenderer
4720 if ( ruleCount > 1 )
4721 {
4722 QgsDebugMsgLevel( QStringLiteral( "Info: More Rule elements found: need a RuleBasedLabeling" ), 4 );
4723 needRuleBasedLabeling = true;
4724 }
4725
4726 // not use the rule based labeling if no rules with textSymbolizer
4727 if ( ruleCount == 0 )
4728 {
4729 needRuleBasedLabeling = false;
4730 }
4731
4732 ruleElem = ruleElem.nextSiblingElement( QStringLiteral( "Rule" ) );
4733 }
4734 featTypeStyleElem = featTypeStyleElem.nextSiblingElement( QStringLiteral( "FeatureTypeStyle" ) );
4735 }
4736
4737 if ( ruleCount == 0 )
4738 {
4739 QgsDebugMsgLevel( QStringLiteral( "Info: No TextSymbolizer element." ), 4 );
4740 return;
4741 }
4742
4743 QDomElement ruleElem = mergedFeatTypeStyle.firstChildElement( QStringLiteral( "Rule" ) );
4744
4745 if ( needRuleBasedLabeling )
4746 {
4747 QgsDebugMsgLevel( QStringLiteral( "Info: rule based labeling" ), 4 );
4748 QgsRuleBasedLabeling::Rule *rootRule = new QgsRuleBasedLabeling::Rule( nullptr );
4749 while ( !ruleElem.isNull() )
4750 {
4751
4752 QString label, description, filterExp;
4753 int scaleMinDenom = 0, scaleMaxDenom = 0;
4754 QgsPalLayerSettings settings;
4755
4756 // retrieve the Rule element child nodes
4757 QDomElement childElem = ruleElem.firstChildElement();
4758 while ( !childElem.isNull() )
4759 {
4760 if ( childElem.localName() == QLatin1String( "Name" ) )
4761 {
4762 // <se:Name> tag contains the rule identifier,
4763 // so prefer title tag for the label property value
4764 if ( label.isEmpty() )
4765 label = childElem.firstChild().nodeValue();
4766 }
4767 else if ( childElem.localName() == QLatin1String( "Description" ) )
4768 {
4769 // <se:Description> can contains a title and an abstract
4770 QDomElement titleElem = childElem.firstChildElement( QStringLiteral( "Title" ) );
4771 if ( !titleElem.isNull() )
4772 {
4773 label = titleElem.firstChild().nodeValue();
4774 }
4775
4776 QDomElement abstractElem = childElem.firstChildElement( QStringLiteral( "Abstract" ) );
4777 if ( !abstractElem.isNull() )
4778 {
4779 description = abstractElem.firstChild().nodeValue();
4780 }
4781 }
4782 else if ( childElem.localName() == QLatin1String( "Abstract" ) )
4783 {
4784 // <sld:Abstract> (v1.0)
4785 description = childElem.firstChild().nodeValue();
4786 }
4787 else if ( childElem.localName() == QLatin1String( "Title" ) )
4788 {
4789 // <sld:Title> (v1.0)
4790 label = childElem.firstChild().nodeValue();
4791 }
4792 else if ( childElem.localName() == QLatin1String( "Filter" ) )
4793 {
4795 if ( filter )
4796 {
4797 if ( filter->hasParserError() )
4798 {
4799 QgsDebugMsgLevel( QStringLiteral( "SLD Filter parsing error: %1" ).arg( filter->parserErrorString() ), 3 );
4800 }
4801 else
4802 {
4803 filterExp = filter->expression();
4804 }
4805 delete filter;
4806 }
4807 }
4808 else if ( childElem.localName() == QLatin1String( "MinScaleDenominator" ) )
4809 {
4810 bool ok;
4811 int v = childElem.firstChild().nodeValue().toInt( &ok );
4812 if ( ok )
4813 scaleMinDenom = v;
4814 }
4815 else if ( childElem.localName() == QLatin1String( "MaxScaleDenominator" ) )
4816 {
4817 bool ok;
4818 int v = childElem.firstChild().nodeValue().toInt( &ok );
4819 if ( ok )
4820 scaleMaxDenom = v;
4821 }
4822 else if ( childElem.localName() == QLatin1String( "TextSymbolizer" ) )
4823 {
4824 readSldTextSymbolizer( childElem, settings );
4825 }
4826
4827 childElem = childElem.nextSiblingElement();
4828 }
4829
4830 QgsRuleBasedLabeling::Rule *ruleLabeling = new QgsRuleBasedLabeling::Rule( new QgsPalLayerSettings( settings ), scaleMinDenom, scaleMaxDenom, filterExp, label );
4831 rootRule->appendChild( ruleLabeling );
4832
4833 ruleElem = ruleElem.nextSiblingElement();
4834 }
4835
4836 setLabeling( new QgsRuleBasedLabeling( rootRule ) );
4837 setLabelsEnabled( true );
4838 }
4839 else
4840 {
4841 QgsDebugMsgLevel( QStringLiteral( "Info: simple labeling" ), 4 );
4842 // retrieve the TextSymbolizer element child node
4843 QDomElement textSymbolizerElem = ruleElem.firstChildElement( QStringLiteral( "TextSymbolizer" ) );
4845 if ( readSldTextSymbolizer( textSymbolizerElem, s ) )
4846 {
4848 setLabelsEnabled( true );
4849 }
4850 }
4851}
4852
4853bool QgsVectorLayer::readSldTextSymbolizer( const QDomNode &node, QgsPalLayerSettings &settings ) const
4854{
4855 if ( node.localName() != QLatin1String( "TextSymbolizer" ) )
4856 {
4857 QgsDebugMsgLevel( QStringLiteral( "Not a TextSymbolizer element: %1" ).arg( node.localName() ), 3 );
4858 return false;
4859 }
4860 QDomElement textSymbolizerElem = node.toElement();
4861 // Label
4862 QDomElement labelElem = textSymbolizerElem.firstChildElement( QStringLiteral( "Label" ) );
4863 if ( !labelElem.isNull() )
4864 {
4865 QDomElement propertyNameElem = labelElem.firstChildElement( QStringLiteral( "PropertyName" ) );
4866 if ( !propertyNameElem.isNull() )
4867 {
4868 // set labeling defaults
4869
4870 // label attribute
4871 QString labelAttribute = propertyNameElem.text();
4872 settings.fieldName = labelAttribute;
4873 settings.isExpression = false;
4874
4875 int fieldIndex = mFields.lookupField( labelAttribute );
4876 if ( fieldIndex == -1 )
4877 {
4878 // label attribute is not in columns, check if it is an expression
4879 QgsExpression exp( labelAttribute );
4880 if ( !exp.hasEvalError() )
4881 {
4882 settings.isExpression = true;
4883 }
4884 else
4885 {
4886 QgsDebugMsgLevel( QStringLiteral( "SLD label attribute error: %1" ).arg( exp.evalErrorString() ), 3 );
4887 }
4888 }
4889 }
4890 else
4891 {
4892 QgsDebugMsgLevel( QStringLiteral( "Info: PropertyName element not found." ), 4 );
4893 return false;
4894 }
4895 }
4896 else
4897 {
4898 QgsDebugMsgLevel( QStringLiteral( "Info: Label element not found." ), 4 );
4899 return false;
4900 }
4901
4903 if ( textSymbolizerElem.hasAttribute( QStringLiteral( "uom" ) ) )
4904 {
4905 sldUnitSize = QgsSymbolLayerUtils::decodeSldUom( textSymbolizerElem.attribute( QStringLiteral( "uom" ) ) );
4906 }
4907
4908 QString fontFamily = QStringLiteral( "Sans-Serif" );
4909 int fontPointSize = 10;
4911 int fontWeight = -1;
4912 bool fontItalic = false;
4913 bool fontUnderline = false;
4914
4915 // Font
4916 QDomElement fontElem = textSymbolizerElem.firstChildElement( QStringLiteral( "Font" ) );
4917 if ( !fontElem.isNull() )
4918 {
4919 QgsStringMap fontSvgParams = QgsSymbolLayerUtils::getSvgParameterList( fontElem );
4920 for ( QgsStringMap::iterator it = fontSvgParams.begin(); it != fontSvgParams.end(); ++it )
4921 {
4922 QgsDebugMsgLevel( QStringLiteral( "found fontSvgParams %1: %2" ).arg( it.key(), it.value() ), 4 );
4923
4924 if ( it.key() == QLatin1String( "font-family" ) )
4925 {
4926 fontFamily = it.value();
4927 }
4928 else if ( it.key() == QLatin1String( "font-style" ) )
4929 {
4930 fontItalic = ( it.value() == QLatin1String( "italic" ) ) || ( it.value() == QLatin1String( "Italic" ) );
4931 }
4932 else if ( it.key() == QLatin1String( "font-size" ) )
4933 {
4934 bool ok;
4935 int fontSize = it.value().toInt( &ok );
4936 if ( ok )
4937 {
4938 fontPointSize = fontSize;
4939 fontUnitSize = sldUnitSize;
4940 }
4941 }
4942 else if ( it.key() == QLatin1String( "font-weight" ) )
4943 {
4944 if ( ( it.value() == QLatin1String( "bold" ) ) || ( it.value() == QLatin1String( "Bold" ) ) )
4945 fontWeight = QFont::Bold;
4946 }
4947 else if ( it.key() == QLatin1String( "font-underline" ) )
4948 {
4949 fontUnderline = ( it.value() == QLatin1String( "underline" ) ) || ( it.value() == QLatin1String( "Underline" ) );
4950 }
4951 }
4952 }
4953
4954 QgsTextFormat format;
4955 QFont font( fontFamily, fontPointSize, fontWeight, fontItalic );
4956 font.setUnderline( fontUnderline );
4957 format.setFont( font );
4958 format.setSize( fontPointSize );
4959 format.setSizeUnit( fontUnitSize );
4960
4961 // Fill
4962 QDomElement fillElem = textSymbolizerElem.firstChildElement( QStringLiteral( "Fill" ) );
4963 QColor textColor;
4964 Qt::BrushStyle textBrush = Qt::SolidPattern;
4965 QgsSymbolLayerUtils::fillFromSld( fillElem, textBrush, textColor );
4966 if ( textColor.isValid() )
4967 {
4968 QgsDebugMsgLevel( QStringLiteral( "Info: textColor %1." ).arg( QVariant( textColor ).toString() ), 4 );
4969 format.setColor( textColor );
4970 }
4971
4972 QgsTextBufferSettings bufferSettings;
4973
4974 // Halo
4975 QDomElement haloElem = textSymbolizerElem.firstChildElement( QStringLiteral( "Halo" ) );
4976 if ( !haloElem.isNull() )
4977 {
4978 bufferSettings.setEnabled( true );
4979 bufferSettings.setSize( 1 );
4980
4981 QDomElement radiusElem = haloElem.firstChildElement( QStringLiteral( "Radius" ) );
4982 if ( !radiusElem.isNull() )
4983 {
4984 bool ok;
4985 double bufferSize = radiusElem.text().toDouble( &ok );
4986 if ( ok )
4987 {
4988 bufferSettings.setSize( bufferSize );
4989 bufferSettings.setSizeUnit( sldUnitSize );
4990 }
4991 }
4992
4993 QDomElement haloFillElem = haloElem.firstChildElement( QStringLiteral( "Fill" ) );
4994 QColor bufferColor;
4995 Qt::BrushStyle bufferBrush = Qt::SolidPattern;
4996 QgsSymbolLayerUtils::fillFromSld( haloFillElem, bufferBrush, bufferColor );
4997 if ( bufferColor.isValid() )
4998 {
4999 QgsDebugMsgLevel( QStringLiteral( "Info: bufferColor %1." ).arg( QVariant( bufferColor ).toString() ), 4 );
5000 bufferSettings.setColor( bufferColor );
5001 }
5002 }
5003
5004 // LabelPlacement
5005 QDomElement labelPlacementElem = textSymbolizerElem.firstChildElement( QStringLiteral( "LabelPlacement" ) );
5006 if ( !labelPlacementElem.isNull() )
5007 {
5008 // PointPlacement
5009 QDomElement pointPlacementElem = labelPlacementElem.firstChildElement( QStringLiteral( "PointPlacement" ) );
5010 if ( !pointPlacementElem.isNull() )
5011 {
5014 {
5016 }
5017
5018 QDomElement displacementElem = pointPlacementElem.firstChildElement( QStringLiteral( "Displacement" ) );
5019 if ( !displacementElem.isNull() )
5020 {
5021 QDomElement displacementXElem = displacementElem.firstChildElement( QStringLiteral( "DisplacementX" ) );
5022 if ( !displacementXElem.isNull() )
5023 {
5024 bool ok;
5025 double xOffset = displacementXElem.text().toDouble( &ok );
5026 if ( ok )
5027 {
5028 settings.xOffset = xOffset;
5029 settings.offsetUnits = sldUnitSize;
5030 }
5031 }
5032 QDomElement displacementYElem = displacementElem.firstChildElement( QStringLiteral( "DisplacementY" ) );
5033 if ( !displacementYElem.isNull() )
5034 {
5035 bool ok;
5036 double yOffset = displacementYElem.text().toDouble( &ok );
5037 if ( ok )
5038 {
5039 settings.yOffset = yOffset;
5040 settings.offsetUnits = sldUnitSize;
5041 }
5042 }
5043 }
5044 QDomElement anchorPointElem = pointPlacementElem.firstChildElement( QStringLiteral( "AnchorPoint" ) );
5045 if ( !anchorPointElem.isNull() )
5046 {
5047 QDomElement anchorPointXElem = anchorPointElem.firstChildElement( QStringLiteral( "AnchorPointX" ) );
5048 if ( !anchorPointXElem.isNull() )
5049 {
5050 bool ok;
5051 double xOffset = anchorPointXElem.text().toDouble( &ok );
5052 if ( ok )
5053 {
5054 settings.xOffset = xOffset;
5055 settings.offsetUnits = sldUnitSize;
5056 }
5057 }
5058 QDomElement anchorPointYElem = anchorPointElem.firstChildElement( QStringLiteral( "AnchorPointY" ) );
5059 if ( !anchorPointYElem.isNull() )
5060 {
5061 bool ok;
5062 double yOffset = anchorPointYElem.text().toDouble( &ok );
5063 if ( ok )
5064 {
5065 settings.yOffset = yOffset;
5066 settings.offsetUnits = sldUnitSize;
5067 }
5068 }
5069 }
5070
5071 QDomElement rotationElem = pointPlacementElem.firstChildElement( QStringLiteral( "Rotation" ) );
5072 if ( !rotationElem.isNull() )
5073 {
5074 bool ok;
5075 double rotation = rotationElem.text().toDouble( &ok );
5076 if ( ok )
5077 {
5078 settings.angleOffset = 360 - rotation;
5079 }
5080 }
5081 }
5082 else
5083 {
5084 // PointPlacement
5085 QDomElement linePlacementElem = labelPlacementElem.firstChildElement( QStringLiteral( "LinePlacement" ) );
5086 if ( !linePlacementElem.isNull() )
5087 {
5089 }
5090 }
5091 }
5092
5093 // read vendor options
5094 QgsStringMap vendorOptions;
5095 QDomElement vendorOptionElem = textSymbolizerElem.firstChildElement( QStringLiteral( "VendorOption" ) );
5096 while ( !vendorOptionElem.isNull() && vendorOptionElem.localName() == QLatin1String( "VendorOption" ) )
5097 {
5098 QString optionName = vendorOptionElem.attribute( QStringLiteral( "name" ) );
5099 QString optionValue;
5100 if ( vendorOptionElem.firstChild().nodeType() == QDomNode::TextNode )
5101 {
5102 optionValue = vendorOptionElem.firstChild().nodeValue();
5103 }
5104 else
5105 {
5106 if ( vendorOptionElem.firstChild().nodeType() == QDomNode::ElementNode &&
5107 vendorOptionElem.firstChild().localName() == QLatin1String( "Literal" ) )
5108 {
5109 QgsDebugMsg( vendorOptionElem.firstChild().localName() );
5110 optionValue = vendorOptionElem.firstChild().firstChild().nodeValue();
5111 }
5112 else
5113 {
5114 QgsDebugMsg( QStringLiteral( "unexpected child of %1 named %2" ).arg( vendorOptionElem.localName(), optionName ) );
5115 }
5116 }
5117
5118 if ( !optionName.isEmpty() && !optionValue.isEmpty() )
5119 {
5120 vendorOptions[ optionName ] = optionValue;
5121 }
5122
5123 vendorOptionElem = vendorOptionElem.nextSiblingElement();
5124 }
5125 if ( !vendorOptions.isEmpty() )
5126 {
5127 for ( QgsStringMap::iterator it = vendorOptions.begin(); it != vendorOptions.end(); ++it )
5128 {
5129 if ( it.key() == QLatin1String( "underlineText" ) && it.value() == QLatin1String( "true" ) )
5130 {
5131 font.setUnderline( true );
5132 format.setFont( font );
5133 }
5134 else if ( it.key() == QLatin1String( "strikethroughText" ) && it.value() == QLatin1String( "true" ) )
5135 {
5136 font.setStrikeOut( true );
5137 format.setFont( font );
5138 }
5139 else if ( it.key() == QLatin1String( "maxDisplacement" ) )
5140 {
5142 }
5143 else if ( it.key() == QLatin1String( "followLine" ) && it.value() == QLatin1String( "true" ) )
5144 {
5146 {
5148 }
5149 else
5150 {
5152 }
5153 }
5154 else if ( it.key() == QLatin1String( "maxAngleDelta" ) )
5155 {
5156 bool ok;
5157 double angle = it.value().toDouble( &ok );
5158 if ( ok )
5159 {
5160 settings.maxCurvedCharAngleIn = angle;
5161 settings.maxCurvedCharAngleOut = angle;
5162 }
5163 }
5164 // miscellaneous options
5165 else if ( it.key() == QLatin1String( "conflictResolution" ) && it.value() == QLatin1String( "false" ) )
5166 {
5168 }
5169 else if ( it.key() == QLatin1String( "forceLeftToRight" ) && it.value() == QLatin1String( "false" ) )
5170 {
5172 }
5173 else if ( it.key() == QLatin1String( "group" ) && it.value() == QLatin1String( "yes" ) )
5174 {
5175 settings.lineSettings().setMergeLines( true );
5176 }
5177 else if ( it.key() == QLatin1String( "labelAllGroup" ) && it.value() == QLatin1String( "true" ) )
5178 {
5179 settings.lineSettings().setMergeLines( true );
5180 }
5181 }
5182 }
5183
5184 format.setBuffer( bufferSettings );
5185 settings.setFormat( format );
5186 return true;
5187}
5188
5190{
5191 return mEditFormConfig;
5192}
5193
5195{
5196 if ( mEditFormConfig == editFormConfig )
5197 return;
5198
5199 mEditFormConfig = editFormConfig;
5200 mEditFormConfig.onRelationsLoaded();
5201 emit editFormConfigChanged();
5202}
5203
5205{
5206 return mMapTipTemplate;
5207}
5208
5209void QgsVectorLayer::setMapTipTemplate( const QString &mapTip )
5210{
5211 if ( mMapTipTemplate == mapTip )
5212 return;
5213
5214 mMapTipTemplate = mapTip;
5215 emit mapTipTemplateChanged();
5216}
5217
5219{
5220 QgsAttributeTableConfig config = mAttributeTableConfig;
5221
5222 if ( config.isEmpty() )
5223 config.update( fields() );
5224
5225 return config;
5226}
5227
5229{
5230 if ( mAttributeTableConfig != attributeTableConfig )
5231 {
5232 mAttributeTableConfig = attributeTableConfig;
5233 emit configChanged();
5234 }
5235}
5236
5241
5246
5248{
5249 if ( !mDiagramLayerSettings )
5250 mDiagramLayerSettings = new QgsDiagramLayerSettings();
5251 *mDiagramLayerSettings = s;
5252}
5253
5255{
5256 QgsLayerMetadataFormatter htmlFormatter( metadata() );
5257 QString myMetadata = QStringLiteral( "<html><head></head>\n<body>\n" );
5258
5259 myMetadata += generalHtmlMetadata();
5260
5261 // Begin Provider section
5262 myMetadata += QStringLiteral( "<h1>" ) + tr( "Information from provider" ) + QStringLiteral( "</h1>\n<hr>\n" );
5263 myMetadata += QLatin1String( "<table class=\"list-view\">\n" );
5264
5265 // storage type
5266 if ( !storageType().isEmpty() )
5267 {
5268 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Storage" ) + QStringLiteral( "</td><td>" ) + storageType() + QStringLiteral( "</td></tr>\n" );
5269 }
5270
5271 // comment
5272 if ( !dataComment().isEmpty() )
5273 {
5274 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Comment" ) + QStringLiteral( "</td><td>" ) + dataComment() + QStringLiteral( "</td></tr>\n" );
5275 }
5276
5277 // encoding
5278 const QgsVectorDataProvider *provider = dataProvider();
5279 if ( provider )
5280 {
5281 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Encoding" ) + QStringLiteral( "</td><td>" ) + provider->encoding() + QStringLiteral( "</td></tr>\n" );
5282 }
5283
5284 if ( isSpatial() )
5285 {
5286 // geom type
5288 if ( type < 0 || type > QgsWkbTypes::NullGeometry )
5289 {
5290 QgsDebugMsgLevel( QStringLiteral( "Invalid vector type" ), 2 );
5291 }
5292 else
5293 {
5294 QString typeString( QStringLiteral( "%1 (%2)" ).arg( QgsWkbTypes::geometryDisplayString( geometryType() ),
5296 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Geometry" ) + QStringLiteral( "</td><td>" ) + typeString + QStringLiteral( "</td></tr>\n" );
5297 }
5298
5299 // Extent
5300 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Extent" ) + QStringLiteral( "</td><td>" ) + extent().toString() + QStringLiteral( "</td></tr>\n" );
5301 }
5302
5303 // feature count
5304 QLocale locale = QLocale();
5305 locale.setNumberOptions( locale.numberOptions() &= ~QLocale::NumberOption::OmitGroupSeparator );
5306 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" )
5307 + tr( "Feature count" ) + QStringLiteral( "</td><td>" )
5308 + ( featureCount() == -1 ? tr( "unknown" ) : locale.toString( static_cast<qlonglong>( featureCount() ) ) )
5309 + QStringLiteral( "</td></tr>\n" );
5310
5311 // End Provider section
5312 myMetadata += QLatin1String( "</table>\n<br><br>" );
5313
5314 if ( isSpatial() )
5315 {
5316 // CRS
5317 myMetadata += crsHtmlMetadata();
5318 }
5319
5320 // identification section
5321 myMetadata += QStringLiteral( "<h1>" ) + tr( "Identification" ) + QStringLiteral( "</h1>\n<hr>\n" );
5322 myMetadata += htmlFormatter.identificationSectionHtml( );
5323 myMetadata += QLatin1String( "<br><br>\n" );
5324
5325 // extent section
5326 myMetadata += QStringLiteral( "<h1>" ) + tr( "Extent" ) + QStringLiteral( "</h1>\n<hr>\n" );
5327 myMetadata += htmlFormatter.extentSectionHtml( isSpatial() );
5328 myMetadata += QLatin1String( "<br><br>\n" );
5329
5330 // Start the Access section
5331 myMetadata += QStringLiteral( "<h1>" ) + tr( "Access" ) + QStringLiteral( "</h1>\n<hr>\n" );
5332 myMetadata += htmlFormatter.accessSectionHtml( );
5333 myMetadata += QLatin1String( "<br><br>\n" );
5334
5335 // Fields section
5336 myMetadata += QStringLiteral( "<h1>" ) + tr( "Fields" ) + QStringLiteral( "</h1>\n<hr>\n<table class=\"list-view\">\n" );
5337
5338 // primary key
5340 if ( !pkAttrList.isEmpty() )
5341 {
5342 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Primary key attributes" ) + QStringLiteral( "</td><td>" );
5343 const auto constPkAttrList = pkAttrList;
5344 for ( int idx : constPkAttrList )
5345 {
5346 myMetadata += fields().at( idx ).name() + ' ';
5347 }
5348 myMetadata += QLatin1String( "</td></tr>\n" );
5349 }
5350
5351 const QgsFields myFields = fields();
5352
5353 // count fields
5354 myMetadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Count" ) + QStringLiteral( "</td><td>" ) + QString::number( myFields.size() ) + QStringLiteral( "</td></tr>\n" );
5355
5356 myMetadata += QLatin1String( "</table>\n<br><table width=\"100%\" class=\"tabular-view\">\n" );
5357 myMetadata += QLatin1String( "<tr><th>" ) + tr( "Field" ) + QLatin1String( "</th><th>" ) + tr( "Type" ) + QLatin1String( "</th><th>" ) + tr( "Length" ) + QLatin1String( "</th><th>" ) + tr( "Precision" ) + QLatin1String( "</th><th>" ) + tr( "Comment" ) + QLatin1String( "</th></tr>\n" );
5358
5359 for ( int i = 0; i < myFields.size(); ++i )
5360 {
5361 QgsField myField = myFields.at( i );
5362 QString rowClass;
5363 if ( i % 2 )
5364 rowClass = QStringLiteral( "class=\"odd-row\"" );
5365 myMetadata += QLatin1String( "<tr " ) + rowClass + QLatin1String( "><td>" ) + myField.name() + QLatin1String( "</td><td>" ) + myField.typeName() + QLatin1String( "</td><td>" ) + QString::number( myField.length() ) + QLatin1String( "</td><td>" ) + QString::number( myField.precision() ) + QLatin1String( "</td><td>" ) + myField.comment() + QLatin1String( "</td></tr>\n" );
5366 }
5367
5368 //close field list
5369 myMetadata += QLatin1String( "</table>\n<br><br>" );
5370
5371 // Start the contacts section
5372 myMetadata += QStringLiteral( "<h1>" ) + tr( "Contacts" ) + QStringLiteral( "</h1>\n<hr>\n" );
5373 myMetadata += htmlFormatter.contactsSectionHtml( );
5374 myMetadata += QLatin1String( "<br><br>\n" );
5375
5376 // Start the links section
5377 myMetadata += QStringLiteral( "<h1>" ) + tr( "Links" ) + QStringLiteral( "</h1>\n<hr>\n" );
5378 myMetadata += htmlFormatter.linksSectionHtml( );
5379 myMetadata += QLatin1String( "<br><br>\n" );
5380
5381 // Start the history section
5382 myMetadata += QStringLiteral( "<h1>" ) + tr( "History" ) + QStringLiteral( "</h1>\n<hr>\n" );
5383 myMetadata += htmlFormatter.historySectionHtml( );
5384 myMetadata += QLatin1String( "<br><br>\n" );
5385
5386 myMetadata += QLatin1String( "\n</body>\n</html>\n" );
5387 return myMetadata;
5388}
5389
5390void QgsVectorLayer::invalidateSymbolCountedFlag()
5391{
5392 mSymbolFeatureCounted = false;
5393}
5394
5395void QgsVectorLayer::onFeatureCounterCompleted()
5396{
5397 onSymbolsCounted();
5398 mFeatureCounter = nullptr;
5399}
5400
5401void QgsVectorLayer::onFeatureCounterTerminated()
5402{
5403 mFeatureCounter = nullptr;
5404}
5405
5406void QgsVectorLayer::onJoinedFieldsChanged()
5407{
5408 // some of the fields of joined layers have changed -> we need to update this layer's fields too
5409 updateFields();
5410}
5411
5412void QgsVectorLayer::onFeatureDeleted( QgsFeatureId fid )
5413{
5414 if ( mEditCommandActive || mCommitChangesActive )
5415 {
5416 mDeletedFids << fid;
5417 }
5418 else
5419 {
5420 mSelectedFeatureIds.remove( fid );
5421 emit featuresDeleted( QgsFeatureIds() << fid );
5422 }
5423
5424 emit featureDeleted( fid );
5425}
5426
5427void QgsVectorLayer::onRelationsLoaded()
5428{
5429 mEditFormConfig.onRelationsLoaded();
5430}
5431
5432void QgsVectorLayer::onSymbolsCounted()
5433{
5434 if ( mFeatureCounter )
5435 {
5436 mSymbolFeatureCounted = true;
5437 mSymbolFeatureCountMap = mFeatureCounter->symbolFeatureCountMap();
5438 mSymbolFeatureIdMap = mFeatureCounter->symbolFeatureIdMap();
5440 }
5441}
5442
5443QList<QgsRelation> QgsVectorLayer::referencingRelations( int idx ) const
5444{
5446}
5447
5448QList<QgsWeakRelation> QgsVectorLayer::weakRelations() const
5449{
5450 return mWeakRelations;
5451}
5452
5453void QgsVectorLayer::setWeakRelations( const QList<QgsWeakRelation> &relations )
5454{
5455 mWeakRelations = relations;
5456}
5457
5458int QgsVectorLayer::listStylesInDatabase( QStringList &ids, QStringList &names, QStringList &descriptions, QString &msgError )
5459{
5460 return QgsProviderRegistry::instance()->listStyles( mProviderKey, mDataSource, ids, names, descriptions, msgError );
5461}
5462
5463QString QgsVectorLayer::getStyleFromDatabase( const QString &styleId, QString &msgError )
5464{
5465 return QgsProviderRegistry::instance()->getStyleById( mProviderKey, mDataSource, styleId, msgError );
5466}
5467
5468bool QgsVectorLayer::deleteStyleFromDatabase( const QString &styleId, QString &msgError )
5469{
5471}
5472
5473
5474void QgsVectorLayer::saveStyleToDatabase( const QString &name, const QString &description,
5475 bool useAsDefault, const QString &uiFileContent, QString &msgError, QgsMapLayer::StyleCategories categories )
5476{
5477
5478 QString sldStyle, qmlStyle;
5479 QDomDocument qmlDocument, sldDocument;
5480 QgsReadWriteContext context;
5481 exportNamedStyle( qmlDocument, msgError, context, categories );
5482 if ( !msgError.isNull() )
5483 {
5484 return;
5485 }
5486 qmlStyle = qmlDocument.toString();
5487
5488 this->exportSldStyle( sldDocument, msgError );
5489 if ( !msgError.isNull() )
5490 {
5491 return;
5492 }
5493 sldStyle = sldDocument.toString();
5494
5496 mDataSource, qmlStyle, sldStyle, name,
5497 description, uiFileContent, useAsDefault, msgError );
5498}
5499
5500
5501
5502QString QgsVectorLayer::loadNamedStyle( const QString &theURI, bool &resultFlag, QgsMapLayer::StyleCategories categories )
5503{
5504 return loadNamedStyle( theURI, resultFlag, false, categories );
5505}
5506
5507bool QgsVectorLayer::loadAuxiliaryLayer( const QgsAuxiliaryStorage &storage, const QString &key )
5508{
5509 bool rc = false;
5510
5511 QString joinKey = mAuxiliaryLayerKey;
5512 if ( !key.isEmpty() )
5513 joinKey = key;
5514
5515 if ( storage.isValid() && !joinKey.isEmpty() )
5516 {
5517 QgsAuxiliaryLayer *alayer = nullptr;
5518
5519 int idx = fields().lookupField( joinKey );
5520
5521 if ( idx >= 0 )
5522 {
5523 alayer = storage.createAuxiliaryLayer( fields().field( idx ), this );
5524
5525 if ( alayer )
5526 {
5527 setAuxiliaryLayer( alayer );
5528 rc = true;
5529 }
5530 }
5531 }
5532
5533 return rc;
5534}
5535
5537{
5538 mAuxiliaryLayerKey.clear();
5539
5540 if ( mAuxiliaryLayer )
5541 removeJoin( mAuxiliaryLayer->id() );
5542
5543 if ( alayer )
5544 {
5545 addJoin( alayer->joinInfo() );
5546
5547 if ( !alayer->isEditable() )
5548 alayer->startEditing();
5549
5550 mAuxiliaryLayerKey = alayer->joinInfo().targetFieldName();
5551 }
5552
5553 mAuxiliaryLayer.reset( alayer );
5554 if ( mAuxiliaryLayer )
5555 mAuxiliaryLayer->setParent( this );
5556 updateFields();
5557}
5558
5560{
5561 return mAuxiliaryLayer.get();
5562}
5563
5565{
5566 return mAuxiliaryLayer.get();
5567}
5568
5569QString QgsVectorLayer::loadNamedStyle( const QString &theURI, bool &resultFlag, bool loadFromLocalDB, QgsMapLayer::StyleCategories categories )
5570{
5571 QgsDataSourceUri dsUri( theURI );
5572 QString returnMessage;
5573 QString qml, errorMsg;
5574 if ( !loadFromLocalDB && mDataProvider && mDataProvider->isSaveAndLoadStyleToDatabaseSupported() )
5575 {
5577 }
5578 if ( !qml.isEmpty() )
5579 {
5580 QDomDocument myDocument( QStringLiteral( "qgis" ) );
5581 myDocument.setContent( qml );
5582 resultFlag = importNamedStyle( myDocument, errorMsg );
5583 returnMessage = QObject::tr( "Loaded from Provider" );
5584 }
5585 else
5586 {
5587 returnMessage = QgsMapLayer::loadNamedStyle( theURI, resultFlag, categories );
5588 }
5589
5590 if ( resultFlag )
5591 emit styleLoaded( categories );
5592
5593 return returnMessage;
5594}
5595
5596QSet<QgsMapLayerDependency> QgsVectorLayer::dependencies() const
5597{
5598 if ( mDataProvider )
5599 return mDataProvider->dependencies() + mDependencies;
5600 return mDependencies;
5601}
5602
5603void QgsVectorLayer::emitDataChanged()
5604{
5605 if ( mDataChangedFired )
5606 return;
5607
5608 updateExtents(); // reset cached extent to reflect data changes
5609
5610 mDataChangedFired = true;
5611 emit dataChanged();
5612 mDataChangedFired = false;
5613}
5614
5615void QgsVectorLayer::onAfterCommitChangesDependency()
5616{
5617 mDataChangedFired = true;
5618 reload();
5619 mDataChangedFired = false;
5620}
5621
5622bool QgsVectorLayer::setDependencies( const QSet<QgsMapLayerDependency> &oDeps )
5623{
5624 QSet<QgsMapLayerDependency> deps;
5625 const auto constODeps = oDeps;
5626 for ( const QgsMapLayerDependency &dep : constODeps )
5627 {
5628 if ( dep.origin() == QgsMapLayerDependency::FromUser )
5629 deps << dep;
5630 }
5631
5632 QSet<QgsMapLayerDependency> toAdd = deps - dependencies();
5633
5634 // disconnect layers that are not present in the list of dependencies anymore
5635 for ( const QgsMapLayerDependency &dep : std::as_const( mDependencies ) )
5636 {
5637 QgsVectorLayer *lyr = static_cast<QgsVectorLayer *>( QgsProject::instance()->mapLayer( dep.layerId() ) );
5638 if ( !lyr )
5639 continue;
5640 disconnect( lyr, &QgsVectorLayer::featureAdded, this, &QgsVectorLayer::emitDataChanged );
5641 disconnect( lyr, &QgsVectorLayer::featureDeleted, this, &QgsVectorLayer::emitDataChanged );
5642 disconnect( lyr, &QgsVectorLayer::geometryChanged, this, &QgsVectorLayer::emitDataChanged );
5643 disconnect( lyr, &QgsVectorLayer::dataChanged, this, &QgsVectorLayer::emitDataChanged );
5645 disconnect( lyr, &QgsVectorLayer::afterCommitChanges, this, &QgsVectorLayer::onAfterCommitChangesDependency );
5646 }
5647
5648 // assign new dependencies
5649 if ( mDataProvider )
5650 mDependencies = mDataProvider->dependencies() + deps;
5651 else
5652 mDependencies = deps;
5653 emit dependenciesChanged();
5654
5655 // connect to new layers
5656 for ( const QgsMapLayerDependency &dep : std::as_const( mDependencies ) )
5657 {
5658 QgsVectorLayer *lyr = static_cast<QgsVectorLayer *>( QgsProject::instance()->mapLayer( dep.layerId() ) );
5659 if ( !lyr )
5660 continue;
5661 connect( lyr, &QgsVectorLayer::featureAdded, this, &QgsVectorLayer::emitDataChanged );
5662 connect( lyr, &QgsVectorLayer::featureDeleted, this, &QgsVectorLayer::emitDataChanged );
5663 connect( lyr, &QgsVectorLayer::geometryChanged, this, &QgsVectorLayer::emitDataChanged );
5664 connect( lyr, &QgsVectorLayer::dataChanged, this, &QgsVectorLayer::emitDataChanged );
5666 connect( lyr, &QgsVectorLayer::afterCommitChanges, this, &QgsVectorLayer::onAfterCommitChangesDependency );
5667 }
5668
5669 // if new layers are present, emit a data change
5670 if ( ! toAdd.isEmpty() )
5671 emitDataChanged();
5672
5673 return true;
5674}
5675
5676QgsFieldConstraints::Constraints QgsVectorLayer::fieldConstraints( int fieldIndex ) const
5677{
5678 if ( fieldIndex < 0 || fieldIndex >= mFields.count() || !mDataProvider )
5679 return QgsFieldConstraints::Constraints();
5680
5681 QgsFieldConstraints::Constraints constraints = mFields.at( fieldIndex ).constraints().constraints();
5682
5683 // make sure provider constraints are always present!
5684 if ( mFields.fieldOrigin( fieldIndex ) == QgsFields::OriginProvider )
5685 {
5686 constraints |= mDataProvider->fieldConstraints( mFields.fieldOriginIndex( fieldIndex ) );
5687 }
5688
5689 return constraints;
5690}
5691
5692QMap< QgsFieldConstraints::Constraint, QgsFieldConstraints::ConstraintStrength> QgsVectorLayer::fieldConstraintsAndStrength( int fieldIndex ) const
5693{
5694 QMap< QgsFieldConstraints::Constraint, QgsFieldConstraints::ConstraintStrength > m;
5695
5696 if ( fieldIndex < 0 || fieldIndex >= mFields.count() )
5697 return m;
5698
5699 QString name = mFields.at( fieldIndex ).name();
5700
5701 QMap< QPair< QString, QgsFieldConstraints::Constraint >, QgsFieldConstraints::ConstraintStrength >::const_iterator conIt = mFieldConstraintStrength.constBegin();
5702 for ( ; conIt != mFieldConstraintStrength.constEnd(); ++conIt )
5703 {
5704 if ( conIt.key().first == name )
5705 {
5706 m[ conIt.key().second ] = mFieldConstraintStrength.value( conIt.key() );
5707 }
5708 }
5709
5710 return m;
5711}
5712
5714{
5715 if ( index < 0 || index >= mFields.count() )
5716 return;
5717
5718 QString name = mFields.at( index ).name();
5719
5720 // add constraint to existing constraints
5721 QgsFieldConstraints::Constraints constraints = mFieldConstraints.value( name, QgsFieldConstraints::Constraints() );
5722 constraints |= constraint;
5723 mFieldConstraints.insert( name, constraints );
5724
5725 mFieldConstraintStrength.insert( qMakePair( name, constraint ), strength );
5726
5727 updateFields();
5728}
5729
5731{
5732 if ( index < 0 || index >= mFields.count() )
5733 return;
5734
5735 QString name = mFields.at( index ).name();
5736
5737 // remove constraint from existing constraints
5738 QgsFieldConstraints::Constraints constraints = mFieldConstraints.value( name, QgsFieldConstraints::Constraints() );
5739 constraints &= ~constraint;
5740 mFieldConstraints.insert( name, constraints );
5741
5742 mFieldConstraintStrength.remove( qMakePair( name, constraint ) );
5743
5744 updateFields();
5745}
5746
5748{
5749 if ( index < 0 || index >= mFields.count() )
5750 return QString();
5751
5752 return mFields.at( index ).constraints().constraintExpression();
5753}
5754
5756{
5757 if ( index < 0 || index >= mFields.count() )
5758 return QString();
5759
5760 return mFields.at( index ).constraints().constraintDescription();
5761}
5762
5763void QgsVectorLayer::setConstraintExpression( int index, const QString &expression, const QString &description )
5764{
5765 if ( index < 0 || index >= mFields.count() )
5766 return;
5767
5768 if ( expression.isEmpty() )
5769 {
5770 mFieldConstraintExpressions.remove( mFields.at( index ).name() );
5771 }
5772 else
5773 {
5774 mFieldConstraintExpressions.insert( mFields.at( index ).name(), qMakePair( expression, description ) );
5775 }
5776 updateFields();
5777}
5778
5779void QgsVectorLayer::setFieldConfigurationFlags( int index, QgsField::ConfigurationFlags flags )
5780{
5781 if ( index < 0 || index >= mFields.count() )
5782 return;
5783
5784 mFieldConfigurationFlags.insert( mFields.at( index ).name(), flags );
5785 updateFields();
5786}
5787
5789{
5790 if ( index < 0 || index >= mFields.count() )
5791 return;
5792 QgsField::ConfigurationFlags flags = mFields.at( index ).configurationFlags();
5793 flags.setFlag( flag, active );
5795}
5796
5797QgsField::ConfigurationFlags QgsVectorLayer::fieldConfigurationFlags( int index ) const
5798{
5799
5800 if ( index < 0 || index >= mFields.count() )
5802
5803 return mFields.at( index ).configurationFlags();
5804}
5805
5807{
5808 if ( index < 0 || index >= mFields.count() )
5809 return;
5810
5811 if ( setup.isNull() )
5812 mFieldWidgetSetups.remove( mFields.at( index ).name() );
5813 else
5814 mFieldWidgetSetups.insert( mFields.at( index ).name(), setup );
5815 updateFields();
5816}
5817
5819{
5820
5821 if ( index < 0 || index >= mFields.count() )
5822 return QgsEditorWidgetSetup();
5823
5824 return mFields.at( index ).editorWidgetSetup();
5825}
5826
5827QgsAbstractVectorLayerLabeling *QgsVectorLayer::readLabelingFromCustomProperties()
5828{
5830 if ( customProperty( QStringLiteral( "labeling" ) ).toString() == QLatin1String( "pal" ) )
5831 {
5832 if ( customProperty( QStringLiteral( "labeling/enabled" ), QVariant( false ) ).toBool() )
5833 {
5834 // try to load from custom properties
5835 QgsPalLayerSettings settings;
5836 settings.readFromLayerCustomProperties( this );
5837 labeling = new QgsVectorLayerSimpleLabeling( settings );
5838 }
5839
5840 // also clear old-style labeling config
5841 removeCustomProperty( QStringLiteral( "labeling" ) );
5842 const auto constCustomPropertyKeys = customPropertyKeys();
5843 for ( const QString &key : constCustomPropertyKeys )
5844 {
5845 if ( key.startsWith( QLatin1String( "labeling/" ) ) )
5846 removeCustomProperty( key );
5847 }
5848 }
5849
5850 return labeling;
5851}
5852
5854{
5855 return mAllowCommit;
5856}
5857
5858void QgsVectorLayer::setAllowCommit( bool allowCommit )
5859{
5860 if ( mAllowCommit == allowCommit )
5861 return;
5862
5863 mAllowCommit = allowCommit;
5864 emit allowCommitChanged();
5865}
5866
5868{
5869 return mGeometryOptions.get();
5870}
5871
5872void QgsVectorLayer::setReadExtentFromXml( bool readExtentFromXml )
5873{
5874 mReadExtentFromXml = readExtentFromXml;
5875}
5876
5878{
5879 return mReadExtentFromXml;
5880}
5881
5882void QgsVectorLayer::onDirtyTransaction( const QString &sql, const QString &name )
5883{
5885 if ( tr && mEditBuffer )
5886 {
5887 qobject_cast<QgsVectorLayerEditPassthrough *>( mEditBuffer )->update( tr, sql, name );
5888 }
5889}
5890
5891QList<QgsVectorLayer *> QgsVectorLayer::DeleteContext::handledLayers( bool includeAuxiliaryLayers ) const
5892{
5893 QList<QgsVectorLayer *> layers;
5894 QMap<QgsVectorLayer *, QgsFeatureIds>::const_iterator i;
5895 for ( i = mHandledFeatures.begin(); i != mHandledFeatures.end(); ++i )
5896 {
5897 if ( includeAuxiliaryLayers || !qobject_cast< QgsAuxiliaryLayer * >( i.key() ) )
5898 layers.append( i.key() );
5899 }
5900 return layers;
5901}
5902
5904{
5905 return mHandledFeatures[layer];
5906}
@ Composition
Fix relation, related elements are part of the parent and a parent copy will copy any children or del...
@ Association
Loose relation, related elements are not part of the parent and a parent copy will not copy any child...
GeometryOperationResult
Success or failure of a geometry operation.
Definition qgis.h:955
@ InvalidInputGeometryType
The input geometry (ring, part, split line, etc.) has not the correct geometry type.
@ Success
Operation succeeded.
@ SelectionIsEmpty
No features were selected.
@ AddRingNotInExistingFeature
The input ring doesn't have any existing ring to fit into.
@ AddRingNotClosed
The input ring is not closed.
@ SelectionIsGreaterThanOne
More than one features were selected.
@ LayerNotEditable
Cannot edit layer.
@ OverPoint
Arranges candidates over a point (or centroid of a polygon), or at a preset offset from the point....
@ Curved
Arranges candidates following the curvature of a line feature. Applies to line layers only.
@ AroundPoint
Arranges candidates in a circle around a point (or centroid of a polygon). Applies to point or polygo...
@ Line
Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon'...
@ Horizontal
Arranges horizontal candidates scattered throughout a polygon feature. Applies to polygon layers only...
@ PerimeterCurved
Arranges candidates following the curvature of a polygon's boundary. Applies to polygon layers only.
@ BufferedGroups
Buffered transactional editing means that all editable layers in the buffered transaction group are t...
@ Generated
A generated relation is a child of a polymorphic relation.
@ Normal
A normal relation.
VertexMarkerType
Editing vertex markers, used for showing vertices during a edit operation.
Definition qgis.h:860
@ SemiTransparentCircle
Semi-transparent circle marker.
@ Cross
Cross marker.
VectorEditResult
Flags which control feature selection behavior.
Definition qgis.h:845
@ Success
Edit operation was successful.
@ InvalidLayer
Edit failed due to invalid layer.
@ AllowOverlapIfRequired
Avoids overlapping labels when possible, but permit overlaps if labels for features cannot otherwise ...
@ AlwaysAllowUpsideDown
Show upside down for all labels, including dynamic ones.
SelectBehavior
Specifies how a selection should be applied.
Definition qgis.h:798
@ SetSelection
Set selection, removing any existing selection.
@ AddToSelection
Add selection to current selection.
@ IntersectSelection
Modify current selection to include only select features which match.
@ RemoveFromSelection
Remove from current selection.
Abstract base class for objects which generate elevation profiles.
virtual bool writeXml(QDomElement &collectionElem, const QgsPropertiesDefinition &definitions) const
Writes the current state of the property collection into an XML element.
Abstract base class - its implementations define different approaches to the labeling of a vector lay...
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the labeling...
virtual void toSld(QDomNode &parent, const QVariantMap &props) const
Writes the SE 1.1 TextSymbolizer element based on the current layer labeling settings.
static QgsAbstractVectorLayerLabeling * create(const QDomElement &element, const QgsReadWriteContext &context)
Try to create instance of an implementation based on the XML data.
virtual QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context) const =0
Returns labeling configuration as XML element.
Storage and management of actions associated with a layer.
bool writeXml(QDomNode &layer_node) const
Writes the actions out in XML format.
QList< QgsAction > actions(const QString &actionScope=QString()) const
Returns a list of actions that are available in the given action scope.
QUuid addAction(QgsAction::ActionType type, const QString &name, const QString &command, bool capture=false)
Add an action with the given name and action details.
bool readXml(const QDomNode &layer_node)
Reads the actions in in XML format.
Utility class that encapsulates an action based on vector attributes.
Definition qgsaction.h:35
Utility class for calculating aggregates for a field (or expression) over the features from a vector ...
Aggregate
Available aggregates to calculate.
static QgsRuntimeProfiler * profiler()
Returns the application runtime profiler.
static QgsTaskManager * taskManager()
Returns the application's task manager, used for managing application wide background task handling.
This is a container for configuration of the attribute table.
bool isEmpty() const
Returns true if the configuration is empty, ie it contains no columns.
void readXml(const QDomNode &node)
Deserialize to XML on layer load.
void update(const QgsFields &fields)
Update the configuration with the given fields.
void writeXml(QDomNode &node) const
Serialize to XML on layer save.
A vector of attributes.
Class allowing to manage the auxiliary storage for a vector layer.
QgsVectorLayerJoinInfo joinInfo() const
Returns information to use for joining with primary key and so on.
Class providing some utility methods to manage auxiliary storage.
QgsAuxiliaryLayer * createAuxiliaryLayer(const QgsField &field, QgsVectorLayer *layer) const
Creates an auxiliary layer for a vector layer.
bool isValid() const
Returns the status of the auxiliary storage currently defined.
The QgsConditionalLayerStyles class holds conditional style information for a layer.
bool readXml(const QDomNode &node, const QgsReadWriteContext &context)
Reads the condition styles state from a DOM node.
bool writeXml(QDomNode &node, QDomDocument &doc, const QgsReadWriteContext &context) const
Writes the condition styles state to a DOM node.
This class represents a coordinate reference system (CRS).
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
Contains information about the context in which a coordinate transform is executed.
Abstract base class for curved geometry type.
Definition qgscurve.h:36
virtual bool isClosed() const
Returns true if the curve is closed.
Definition qgscurve.cpp:53
QgsCurve * clone() const override=0
Clones the geometry by performing a deep copy.
virtual bool leaveUpdateMode()
Leave update mode.
@ FlagLoadDefaultStyle
Reset the layer's style to the default for the datasource.
@ FlagTrustDataSource
Trust datasource config (primary key unicity, geometry type and srid, etc). Improves provider load ti...
@ ForceReadOnly
Open layer in a read-only mode (since QGIS 3.28)
QgsCoordinateTransformContext transformContext() const
Returns data provider coordinate transform context.
virtual QgsCoordinateReferenceSystem crs() const =0
Returns the coordinate system for the data source.
void dataChanged()
Emitted whenever a change is made to the data provider which may have caused changes in the provider'...
void fullExtentCalculated()
Emitted whenever a deferred extent calculation is completed by the provider.
virtual QString subsetString() const
Returns the subset definition string (typically sql) currently in use by the layer and used by the pr...
virtual QgsLayerMetadata layerMetadata() const
Returns layer metadata collected from the provider's source.
virtual bool isValid() const =0
Returns true if this is a valid layer.
virtual QString dataSourceUri(bool expandAuthConfig=false) const
Gets the data source specification.
virtual void updateExtents()
Update the extents of the layer.
virtual bool setSubsetString(const QString &subset, bool updateFeatureCount=true)
Set the subset string used to create a subset of features in the layer.
virtual void reloadData()
Reloads the data from the source for providers with data caches to synchronize, changes in the data s...
virtual bool enterUpdateMode()
Enter update mode.
virtual QgsRectangle extent() const =0
Returns the extent of the layer.
virtual void setTransformContext(const QgsCoordinateTransformContext &transformContext)
Sets data coordinate transform context to transformContext.
Class for storing the component parts of a RDBMS data source URI (e.g.
void setConnection(const QString &aHost, const QString &aPort, const QString &aDatabase, const QString &aUsername, const QString &aPassword, SslMode sslmode=SslPrefer, const QString &authConfigId=QString())
Sets all connection related members at once.
QString uri(bool expandAuthConfig=true) const
Returns the complete URI as a string.
QString username() const
Returns the username stored in the URI.
QString host() const
Returns the host name stored in the URI.
bool useEstimatedMetadata() const
Returns true if estimated metadata should be used for the connection.
QString password() const
Returns the password stored in the URI.
QString port() const
Returns the port stored in the URI.
QString database() const
Returns the database name stored in the URI.
void setDatabase(const QString &database)
Sets the URI database name.
The QgsDefaultValue class provides a container for managing client side default values for fields.
bool isValid() const
Returns if this default value should be applied.
Stores the settings for rendering of all diagrams for a layer.
@ PositionX
X-coordinate data defined diagram position.
@ Show
Whether to show the diagram.
@ PositionY
Y-coordinate data defined diagram position.
void readXml(const QDomElement &elem)
Reads the diagram settings from a DOM element.
void writeXml(QDomElement &layerElem, QDomDocument &doc) const
Writes the diagram settings to a DOM element.
Evaluates and returns the diagram settings relating to a diagram for a specific feature.
virtual void writeXml(QDomElement &layerElem, QDomDocument &doc, const QgsReadWriteContext &context) const =0
Writes diagram state to a DOM element.
virtual QList< QgsDiagramSettings > diagramSettings() const =0
Returns list with all diagram settings in the renderer.
virtual void readXml(const QDomElement &elem, const QgsReadWriteContext &context)=0
Reads diagram state from a DOM element.
Contains configuration settings for an editor form.
void readXml(const QDomNode &node, QgsReadWriteContext &context)
Read XML information Deserialize on project load.
void writeXml(QDomNode &node, const QgsReadWriteContext &context) const
Write XML information Serialize on project save.
Holder for the widget type and its configuration for a field.
QVariantMap config() const
void clear()
Clear error messages.
Definition qgserror.h:127
Single scope for storing variables and functions for use within a QgsExpressionContext.
void setFields(const QgsFields &fields)
Convenience function for setting a fields for the scope.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the scope.
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
QgsExpressionContextScope * popScope()
Removes the last scope from the expression context and return it.
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
Buffers information about expression fields for a vector layer.
void removeExpression(int index)
Remove an expression from the buffer.
void writeXml(QDomNode &layer_node, QDomDocument &document) const
Saves expressions to xml under the layer node.
void readXml(const QDomNode &layer_node)
Reads expressions from project file.
void updateFields(QgsFields &flds) const
Adds fields with the expressions buffered in this object to a QgsFields object.
void addExpression(const QString &exp, const QgsField &fld)
Add an expression to the buffer.
QList< QgsExpressionFieldBuffer::ExpressionField > expressions() const
void updateExpression(int index, const QString &exp)
Changes the expression at a given index.
void renameExpression(int index, const QString &name)
Renames an expression field at a given index.
An expression node which takes it value from a feature's field.
Class for parsing and evaluation of expressions (formerly called "search strings").
bool prepare(const QgsExpressionContext *context)
Gets the expression ready for evaluation - find out column indexes.
QString expression() const
Returns the original, unmodified expression string.
bool hasParserError() const
Returns true if an error occurred when parsing the input expression.
QString evalErrorString() const
Returns evaluation error.
QString parserErrorString() const
Returns parser error.
bool isField() const
Checks whether an expression consists only of a single field reference.
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)
const QgsExpressionNode * rootNode() const
Returns the root node of the expression.
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)
An interface for objects which generate feature renderers for vector layers.
static QgsFeatureRenderer * defaultRenderer(QgsWkbTypes::GeometryType geomType)
Returns a new renderer - used by default in vector layers.
virtual void toSld(QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const
used from subclasses to create SLD Rule elements following SLD v1.1 specs
virtual QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context)
Stores renderer properties to an XML element.
double referenceScale() const
Returns the symbology reference scale.
static QgsFeatureRenderer * loadSld(const QDomNode &node, QgsWkbTypes::GeometryType geomType, QString &errorMessage)
Create a new renderer according to the information contained in the UserStyle element of a SLD style ...
void setReferenceScale(double scale)
Sets the symbology reference scale.
static QgsFeatureRenderer * load(QDomElement &symbologyElem, const QgsReadWriteContext &context)
create a renderer from XML element
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer...
This class wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFilterFids(const QgsFeatureIds &fids)
Sets the feature IDs that should be fetched.
QgsFeatureRequest & setFlags(QgsFeatureRequest::Flags flags)
Sets flags that affect how features will 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.
@ SubsetOfAttributes
Fetch only a subset of attributes (setSubsetOfAttributes sets this flag)
@ ExactIntersect
Use exact geometry intersection (slower) instead of bounding boxes.
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
QgsFeatureRequest & setExpressionContext(const QgsExpressionContext &context)
Sets the expression context used to evaluate filter expressions.
QgsFeatureRequest & setNoAttributes()
Set that no attributes will be fetched.
QgsFeatureRequest & setFilterFid(QgsFeatureId fid)
Sets the feature ID that should be fetched.
virtual bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags())
Adds a single feature to the sink.
virtual QSet< QVariant > uniqueValues(int fieldIndex, int limit=-1) const
Returns the set of unique values contained within the specified fieldIndex from this source.
SpatialIndexPresence
Enumeration of spatial index presence states.
@ SpatialIndexUnknown
Spatial index presence cannot be determined, index may or may not exist.
FeatureAvailability
Possible return value for hasFeatures() to determine if a source is empty.
@ FeaturesMaybeAvailable
There may be features available in this source.
@ NoFeaturesAvailable
There are certainly no features available in this source.
@ FeaturesAvailable
There is at least one feature available in this source.
virtual QgsFeatureIds allFeatureIds() const
Returns a list of all feature IDs for features present in the source.
virtual SpatialIndexPresence hasSpatialIndex() const
Returns an enum value representing the presence of a valid spatial index on the source,...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:56
bool setAttribute(int field, const QVariant &attr)
Sets an attribute's value by field index.
QgsAttributes attributes
Definition qgsfeature.h:65
QgsFields fields
Definition qgsfeature.h:66
QgsFeatureId id
Definition qgsfeature.h:64
QgsGeometry geometry
Definition qgsfeature.h:67
bool hasGeometry() const
Returns true if the feature has an associated geometry.
bool isValid() const
Returns the validity of this feature.
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:45
bool isCanceled() const
Tells whether the operation has been canceled already.
Definition qgsfeedback.h:54
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.
ConstraintStrength constraintStrength(Constraint constraint) const
Returns the strength of a field constraint, or ConstraintStrengthNotSet if the constraint is not pres...
ConstraintOrigin constraintOrigin(Constraint constraint) const
Returns the origin of a field constraint, or ConstraintOriginNotSet if the constraint is not present ...
QString constraintExpression() const
Returns the constraint expression for the field, if set.
Constraint
Constraints which may be present on a field.
@ ConstraintNotNull
Field may not be null.
@ ConstraintUnique
Field must have a unique value.
@ ConstraintExpression
Field has an expression constraint set. See constraintExpression().
QString constraintDescription() const
Returns the descriptive name for the constraint expression.
void setConstraint(Constraint constraint, ConstraintOrigin origin=ConstraintOriginLayer)
Sets a constraint on the field.
Encapsulate a field in an attribute table or data source.
Definition qgsfield.h:51
QString typeName() const
Gets the field type.
Definition qgsfield.cpp:152
QString name
Definition qgsfield.h:60
int precision
Definition qgsfield.h:57
int length
Definition qgsfield.h:56
QString displayName() const
Returns the name to use when displaying this field.
Definition qgsfield.cpp:90
ConfigurationFlags configurationFlags
Definition qgsfield.h:64
QString alias
Definition qgsfield.h:61
QgsDefaultValue defaultValueDefinition
Definition qgsfield.h:62
QString comment
Definition qgsfield.h:59
QgsFieldConstraints constraints
Definition qgsfield.h:63
ConfigurationFlag
Configuration flags for fields These flags are meant to be user-configurable and are not describing a...
Definition qgsfield.h:80
@ HideFromWfs
Field is not available if layer is served as WFS from QGIS server.
@ None
No flag is defined.
@ HideFromWms
Field is not available if layer is served as WMS from QGIS server.
QgsEditorWidgetSetup editorWidgetSetup() const
Gets the editor widget setup for the field.
Definition qgsfield.cpp:672
Container of fields for a vector layer.
Definition qgsfields.h:45
int indexFromName(const QString &fieldName) const
Gets the field index from the field name.
int indexOf(const QString &fieldName) const
Gets the field index from the field name.
@ OriginExpression
Field is calculated from an expression.
Definition qgsfields.h:54
@ OriginEdit
Field has been temporarily added in editing mode (originIndex = index in the list of added attributes...
Definition qgsfields.h:53
@ OriginUnknown
It has not been specified where the field comes from.
Definition qgsfields.h:50
@ OriginJoin
Field comes from a joined layer (originIndex / 1000 = index of the join, originIndex % 1000 = index w...
Definition qgsfields.h:52
@ OriginProvider
Field comes from the underlying data provider of the vector layer (originIndex = index in provider's ...
Definition qgsfields.h:51
int count() const
Returns number of items.
FieldOrigin fieldOrigin(int fieldIdx) const
Returns the field's origin (value from an enumeration).
bool isEmpty() const
Checks whether the container is empty.
int size() const
Returns number of items.
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
int fieldOriginIndex(int fieldIdx) const
Returns the field's origin index (its meaning is specific to each type of origin).
int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
QStringList names() const
Returns a list with field names.
The QgsGeometryOptions class contains options to automatically adjust geometries to constraints on a ...
A geometry is the spatial representation of a feature.
bool equals(const QgsGeometry &geometry) const
Test if this geometry is exactly equal to another geometry.
QgsWkbTypes::GeometryType type
QgsRectangle boundingBox() const
Returns the bounding box of the geometry.
void setMergeLines(bool merge)
Sets whether connected line features with identical label text should be merged prior to generating l...
void setOverlapHandling(Qgis::LabelOverlapHandling handling)
Sets the technique used to handle overlapping labels.
Class for metadata formatter.
QString linksSectionHtml() const
Formats the "Links" section according to a metadata object.
QString extentSectionHtml(const bool showSpatialExtent=true) const
Formats the "Extents" section according to a metadata object (extent and temporal).
QString contactsSectionHtml() const
Formats the "Contacts" section according to a metadata object.
QString identificationSectionHtml() const
Formats the "Identification" section according to a metadata object.
QString historySectionHtml() const
Formats the "History" section according to a metadata object.
QString accessSectionHtml() const
Formats the "Access" section according to a metadata object.
A structured metadata store for a map layer.
void combine(const QgsAbstractMetadataBase *other) override
Combines the metadata from this object with the metadata from an other object.
Line string geometry type, with support for z-dimension and m-values.
static void warning(const QString &msg)
Goes to qWarning.
This class models dependencies with or between map layers.
Base class for storage of map layer elevation properties.
static QString typeToString(QgsMapLayerType type)
Converts a map layer type to a string value.
virtual void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Reads configuration from a DOM element previously written by writeXml()
virtual QDomElement writeXml(QDomDocument &doc, const QgsReadWriteContext &context) const
Writes configuration to a DOM element, to be used later with readXml()
static QgsMapLayerLegend * defaultVectorLegend(QgsVectorLayer *vl)
Create new legend implementation for vector layer.
Base class for utility classes that encapsulate information necessary for rendering of map layers.
Base class for storage of map layer temporal properties.
Base class for all map layer types.
Definition qgsmaplayer.h:73
QString name
Definition qgsmaplayer.h:76
void readStyleManager(const QDomNode &layerNode)
Read style manager's configuration (if any). To be called by subclasses.
virtual void exportNamedStyle(QDomDocument &doc, QString &errorMsg, const QgsReadWriteContext &context=QgsReadWriteContext(), QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const
Export the properties of this layer as named style in a QDomDocument.
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.
virtual bool importNamedStyle(QDomDocument &doc, QString &errorMsg, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories)
Import the properties of this layer from a QDomDocument.
void editingStopped()
Emitted when edited changes have been successfully written to the data provider.
void recalculateExtents() const
This is used to send a request that any mapcanvas using this layer update its extents.
virtual QgsRectangle extent() const
Returns the extent of the layer.
QString source() const
Returns the source for the layer.
Q_INVOKABLE QVariant customProperty(const QString &value, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer.
int mBlockStyleChangedSignal
If non-zero, the styleChanged signal should not be emitted.
QString providerType() const
Returns the provider type (provider key) for this layer.
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.
QgsMapLayerType type
Definition qgsmaplayer.h:80
void configChanged()
Emitted whenever the configuration is changed.
void setMinimumScale(double scale)
Sets the minimum map scale (i.e.
QString publicSource() const
Gets a version of the internal layer definition that has sensitive bits removed (for example,...
QgsMapLayer::LayerFlags flags() const
Returns the flags for this layer.
void editingStarted()
Emitted when editing on this layer has started.
QgsCoordinateReferenceSystem crs
Definition qgsmaplayer.h:79
friend class QgsVectorLayer
void writeCustomProperties(QDomNode &layerNode, QDomDocument &doc) const
Write custom properties to project file.
QString id() const
Returns the layer's unique ID, which is used to access this layer from QgsProject.
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 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:78
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.
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.
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.
void rendererChanged()
Signal emitted when renderer is changed.
virtual QgsError error() const
Gets current status error.
void setScaleBasedVisibility(bool enabled)
Sets whether scale based visibility is enabled for the layer.
void dataSourceChanged()
Emitted whenever the layer's data source has been changed.
bool hasScaleBasedVisibility() const
Returns whether scale based visibility is enabled for the layer.
virtual QString loadNamedStyle(const QString &uri, bool &resultFlag, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories)
Retrieve a named style for this layer if one exists (either as a .qml file on disk or as a record in ...
void styleLoaded(QgsMapLayer::StyleCategories categories)
Emitted when a style has been loaded.
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 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.
@ FlagReadExtentFromXml
Read extent from xml and skip get extent from provider.
@ FlagTrustLayerMetadata
Trust layer metadata. Improves layer load time by skipping expensive checks like primary key unicity,...
@ 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.
void setDataSource(const QString &dataSource, const QString &baseName, const QString &provider, bool loadDefaultStyleFlag=false)
Updates the data source of the layer.
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...
virtual void exportSldStyle(QDomDocument &doc, QString &errorMsg) const
Export the properties of this layer as SLD style in a QDomDocument.
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.
void setLegend(QgsMapLayerLegend *legend)
Assign a legend controller to the map layer.
double opacity
Definition qgsmaplayer.h:82
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 (since QGIS 3.16)
@ 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 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.
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)
Adds a message to the log instance (and creates it if necessary).
static QgsExpression * expressionFromOgcFilter(const QDomElement &element, QgsVectorLayer *layer=nullptr)
Parse XML with OGC filter into QGIS expression.
static QgsPainting::BlendMode getBlendModeEnum(QPainter::CompositionMode blendMode)
Returns a BlendMode corresponding to a QPainter::CompositionMode.
static QPainter::CompositionMode getCompositionMode(QgsPainting::BlendMode blendMode)
Returns a QPainter::CompositionMode corresponding to a BlendMode.
BlendMode
Blending modes enum defining the available composition modes that can be used when rendering a layer.
Definition qgspainting.h:37
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.
QgsUnitTypes::RenderUnit offsetUnits
Units for offsets of label.
double angleOffset
Label rotation, in degrees clockwise.
double maxCurvedCharAngleOut
Maximum angle between outside curved label characters (valid range -20.0 to -95.0)
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.
Resolves relative paths into absolute paths and vice versa.
QString writePath(const QString &filename) const
Prepare a filename to save it to the project file.
QString readPath(const QString &filename) const
Turn filename read from the project file to an absolute path.
A class to represent a 2D point.
Definition qgspointxy.h:59
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:49
Encapsulates properties and constraints relating to fetching elevation profiles from different source...
QgsExpressionContext & expressionContext()
Returns the expression context used to evaluate expressions.
virtual QString translate(const QString &context, const QString &sourceText, const char *disambiguation=nullptr, int n=-1) const =0
The derived translate() translates with QTranslator and qm file the sourceText.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:104
QgsRelationManager * relationManager
Definition qgsproject.h:114
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.
Q_INVOKABLE QgsMapLayer * mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layer ID.
bool rollBack(QStringList &rollbackErrors, bool stopEditing=true, QgsVectorLayer *vectorLayer=nullptr)
Stops a current editing operation on vectorLayer and discards any uncommitted edits.
QgsPathResolver pathResolver() const
Returns path resolver object with considering whether the project uses absolute or relative paths and...
bool startEditing(QgsVectorLayer *vectorLayer=nullptr)
Makes the layer editable.
QMap< QString, QgsMapLayer * > mapLayers(const bool validOnly=false) const
Returns a map of all registered layers by layer ID.
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
void setProperty(int key, const QgsProperty &property)
Adds a property to the collection and takes ownership of it.
Definition for a property.
Definition qgsproperty.h:46
@ 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 loadStyle(const QString &providerKey, const QString &uri, QString &errCause)
Loads a layer style defined by uri.
QString getStyleById(const QString &providerKey, const QString &uri, const QString &styleId, QString &errCause)
Gets a layer style defined by styleId.
static QgsProviderRegistry * instance(const QString &pluginPath=QString())
Means of accessing canonical single instance.
bool deleteStyleById(const QString &providerKey, const QString &uri, const QString &styleId, QString &errCause)
Deletes a layer style defined by styleId.
int listStyles(const QString &providerKey, const QString &uri, QStringList &ids, QStringList &names, QStringList &descriptions, QString &errCause)
Lists stored layer styles in the provider defined by providerKey and uri.
bool saveStyle(const QString &providerKey, const QString &uri, const QString &qmlStyle, const QString &sldStyle, const QString &styleName, const QString &styleDescription, const QString &uiFileContent, bool useAsDefault, QString &errCause)
Saves a layer style to provider.
Allows entering a context category and takes care of leaving this category on deletion of the class.
The class is used as a container of context for various read/write operations on other objects.
MAYBE_UNUSED NODISCARD QgsReadWriteContextCategoryPopper enterCategory(const QString &category, const QString &details=QString()) const
Push a category to the stack.
const QgsProjectTranslator * projectTranslator() const
Returns the project translator.
QgsCoordinateTransformContext transformContext() const
Returns data provider coordinate transform context.
const QgsPathResolver & pathResolver() const
Returns path resolver for conversion between relative and absolute paths.
A rectangle specified with double values.
QString toString(int precision=16) const
Returns a string representation of form xmin,ymin : xmax,ymax Coordinates will be truncated to the sp...
double xMinimum() const
Returns the x minimum value (left side of rectangle).
double yMinimum() const
Returns the y minimum value (bottom side of rectangle).
void setMinimal()
Set a rectangle so that min corner is at max and max corner is at min.
double width() const
Returns the width of the rectangle.
double xMaximum() const
Returns the x maximum value (right side of rectangle).
bool isNull() const
Test if the rectangle is null (all coordinates zero or after call to setMinimal()).
double yMaximum() const
Returns the y maximum value (top side of rectangle).
void set(const QgsPointXY &p1, const QgsPointXY &p2, bool normalize=true)
Sets the rectangle from two QgsPoints.
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.
double height() const
Returns the height of the rectangle.
QList< QgsRelation > referencedRelations(const QgsVectorLayer *layer=nullptr) const
Gets all relations where this layer is the referenced part (i.e.
QList< QgsRelation > referencingRelations(const QgsVectorLayer *layer=nullptr, int fieldIdx=-2) const
Gets all relations where the specified layer (and field) is the referencing part (i....
void relationsLoaded()
Emitted when the relations were loaded after reading a project.
Contains information about the context of a rendering operation.
double rendererScale() const
Returns the renderer map scale.
bool useRenderingOptimization() const
Returns true if the rendering optimization (geometry simplification) can be executed.
A child rule for QgsRuleBasedLabeling.
void appendChild(QgsRuleBasedLabeling::Rule *rule)
add child rule, take ownership, sets this as parent
Rule based labeling for a vector layer.
This class is a composition of two QSettings instances:
Definition qgssettings.h:62
T flagValue(const QString &key, const T &defaultValue, const Section section=NoSection)
Returns the setting value for a setting based on a flag.
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
T enumValue(const QString &key, const T &defaultValue, const Section section=NoSection)
Returns the setting value for a setting based on an enum.
Renders the diagrams for all features with the same settings.
Manages stored expressions regarding creation, modification and storing in the project.
bool writeXml(QDomNode &layerNode) const
Writes the stored expressions out in XML format.
bool readXml(const QDomNode &layerNode)
Reads the stored expressions in in XML format.
An interface for classes which can visit style entity (e.g.
static QgsUnitTypes::RenderUnit decodeSldUom(const QString &str, double *scaleFactor=nullptr)
Decodes a SLD unit of measure string to a render unit.
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)
long addTask(QgsTask *task, int priority=0)
Adds a task to the manager.
void taskCompleted()
Will be emitted by task to indicate its successful completion.
void taskTerminated()
Will be emitted by task if it has terminated for any reason other then completion (e....
bool isActive() const
Returns true if the temporal property is active.
Container for settings relating to a text buffer.
void setColor(const QColor &color)
Sets the color for the buffer.
void setEnabled(bool enabled)
Sets whether the text buffer will be drawn.
void setSizeUnit(QgsUnitTypes::RenderUnit unit)
Sets the units used for the buffer size.
void setSize(double size)
Sets the size of the buffer.
Container for all settings relating to text rendering.
void setColor(const QColor &color)
Sets the color that text will be rendered in.
void setSize(double size)
Sets the size for rendered text.
void setFont(const QFont &font)
Sets the font used for rendering text.
void setBuffer(const QgsTextBufferSettings &bufferSettings)
Sets the text's buffer settings.
void setSizeUnit(QgsUnitTypes::RenderUnit unit)
Sets the units for the size of rendered text.
This class allows including a set of layers in a database-side transaction, provided the layer data p...
QString createSavepoint(QString &error)
creates a save point returns empty string on error returns the last created savepoint if it's not dir...
void dirtied(const QString &sql, const QString &name)
Emitted if a sql query is executed and the underlying data is modified.
RenderUnit
Rendering size units.
@ RenderPoints
Points (e.g., for font sizes)
@ RenderPixels
Pixels.
static bool isNull(const QVariant &variant)
Returns true if the specified variant should be considered a NULL value.
This is the base class for vector data providers.
virtual QString dataComment() const override
Returns a short comment for the data that this provider is providing access to (e....
@ ReadLayerMetadata
Provider can read layer metadata from data store. Since QGIS 3.0. See QgsDataProvider::layerMetadata(...
@ SelectAtId
Fast access to features using their ID.
@ DeleteFeatures
Allows deletion of features.
@ CreateLabeling
Provider can set labeling settings using backend-specific formatting information. Since QGIS 3....
@ CreateRenderer
Provider can create feature renderers using backend-specific formatting information....
QgsWkbTypes::Type wkbType() const override=0
Returns the geometry type which is returned by this layer.
virtual bool isSaveAndLoadStyleToDatabaseSupported() const
It returns false by default.
static const int EditingCapabilities
Bitmask of all provider's editing capabilities.
long long featureCount() const override=0
Number of features in the layer.
virtual QgsFeatureRenderer * createRenderer(const QVariantMap &configuration=QVariantMap()) const
Creates a new vector layer feature renderer, using provider backend specific information.
virtual QString storageType() const
Returns the permanent storage type for this layer as a friendly name.
virtual QStringList uniqueStringsMatching(int index, const QString &substring, int limit=-1, QgsFeedback *feedback=nullptr) const
Returns unique string values of an attribute which contain a specified subset string.
void raiseError(const QString &msg) const
Signals an error in this provider.
virtual bool isSqlQuery() const
Returns true if the layer is a query (SQL) layer.
virtual bool empty() const
Returns true if the layer does not contain any feature.
virtual QgsAttributeList pkAttributeIndexes() const
Returns list of indexes of fields that make up the primary key.
virtual void handlePostCloneOperations(QgsVectorDataProvider *source)
Handles any post-clone operations required after this vector data provider was cloned from the source...
virtual QSet< QgsMapLayerDependency > dependencies() const
Gets the list of layer ids on which this layer depends.
virtual void setEncoding(const QString &e)
Set encoding used for accessing data from layer.
virtual Qgis::VectorLayerTypeFlags vectorLayerTypeFlags() const
Returns the vector layer type flags.
QVariant maximumValue(int index) const override
Returns the maximum value of an attribute.
QgsFields fields() const override=0
Returns the fields associated with this data provider.
QVariant minimumValue(int index) const override
Returns the minimum value of an attribute.
virtual QVariant aggregate(QgsAggregateCalculator::Aggregate aggregate, int index, const QgsAggregateCalculator::AggregateParameters &parameters, QgsExpressionContext *context, bool &ok, QgsFeatureIds *fids=nullptr) const
Calculates an aggregated value from the layer's features.
QString encoding() const
Returns the encoding which is used for accessing data.
virtual QVariant defaultValue(int fieldIndex) const
Returns any literal default values which are present at the provider for a specified field index.
QgsFieldConstraints::Constraints fieldConstraints(int fieldIndex) const
Returns any constraints which are present at the provider for a specified field index.
virtual QgsTransaction * transaction() const
Returns the transaction this data provider is included in, if any.
virtual QgsAbstractVectorLayerLabeling * createLabeling(const QVariantMap &configuration=QVariantMap()) const
Creates labeling settings, using provider backend specific information.
virtual Q_INVOKABLE QgsVectorDataProvider::Capabilities capabilities() const
Returns flags containing the supported capabilities.
QgsVectorDataProviderTemporalCapabilities * temporalCapabilities() override
Returns the provider's temporal capabilities.
QString capabilitiesString() const
Returns the above in friendly format.
bool commitChanges(QStringList &commitErrors, bool stopEditing=true)
Attempts to commit any changes to disk.
void committedAttributesDeleted(const QString &layerId, const QgsAttributeList &deletedAttributes)
Signals emitted after committing changes.
virtual bool deleteFeature(QgsFeatureId fid)
Delete a feature from the layer (but does not commit it)
QgsFeatureIds deletedFeatureIds() const
Returns a list of deleted feature IDs which are not committed.
QgsChangedAttributesMap changedAttributeValues() const
Returns a map of features with changed attributes values which are not committed.
void committedAttributeValuesChanges(const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues)
virtual bool renameAttribute(int attr, const QString &newName)
Renames an attribute field (but does not commit it)
void geometryChanged(QgsFeatureId fid, const QgsGeometry &geom)
Emitted when a feature's geometry is changed.
virtual bool deleteFeatures(const QgsFeatureIds &fid)
Deletes a set of features from the layer (but does not commit it)
virtual bool addAttribute(const QgsField &field)
Adds an attribute field (but does not commit it) returns true if the field was added.
void committedAttributesAdded(const QString &layerId, const QList< QgsField > &addedAttributes)
virtual bool addFeatures(QgsFeatureList &features)
Insert a copy of the given features into the layer (but does not commit it)
virtual bool changeAttributeValues(QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues)
Changes values of attributes (but does not commit it).
QgsFeatureMap addedFeatures() const
Returns a map of new features which are not committed.
virtual bool isModified() const
Returns true if the provider has been modified since the last commit.
void updateFields(QgsFields &fields)
Updates fields.
void committedFeaturesAdded(const QString &layerId, const QgsFeatureList &addedFeatures)
void featureDeleted(QgsFeatureId fid)
QgsGeometryMap changedGeometries() const
Returns a map of features with changed geometries which are not committed.
QgsVectorLayerEditBufferGroup * editBufferGroup() const
Returns the parent edit buffer group for this edit buffer, or nullptr if not part of a group.
QgsAttributeList deletedAttributeIds() const
Returns a list of deleted attributes fields which are not committed.
void attributeAdded(int idx)
void committedGeometriesChanges(const QString &layerId, const QgsGeometryMap &changedGeometries)
virtual bool addFeature(QgsFeature &f)
Adds a feature.
virtual void rollBack()
Stop editing and discard the edits.
void attributeDeleted(int idx)
void featureAdded(QgsFeatureId fid)
void attributeValueChanged(QgsFeatureId fid, int idx, const QVariant &)
virtual bool commitChanges(QStringList &commitErrors)
Attempts to commit any changes to disk.
virtual bool deleteAttribute(int attr)
Deletes an attribute field (but does not commit it)
virtual bool changeAttributeValue(QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant())
Changed an attribute value (but does not commit it)
virtual bool changeGeometry(QgsFeatureId fid, const QgsGeometry &geom)
Change feature's geometry.
void layerModified()
Emitted when modifications has been done on layer.
void committedFeaturesRemoved(const QString &layerId, const QgsFeatureIds &deletedFeatureIds)
int translateFeature(QgsFeatureId featureId, double dx, double dy)
Translates feature by dx, dy.
bool insertVertex(double x, double y, QgsFeatureId atFeatureId, int beforeVertex)
Insert a new vertex before the given vertex number, in the given ring, item (first number is index 0)...
Q_DECL_DEPRECATED Qgis::GeometryOperationResult addPart(const QVector< QgsPointXY > &ring, QgsFeatureId featureId)
Adds a new part polygon to a multipart feature.
Qgis::VectorEditResult deleteVertex(QgsFeatureId featureId, int vertex)
Deletes a vertex from a feature.
int addTopologicalPoints(const QgsGeometry &geom)
Adds topological points for every vertex of the geometry.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult splitParts(const QVector< QgsPointXY > &splitLine, bool topologicalEditing=false)
Splits parts cut by the given line.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult splitFeatures(const QVector< QgsPointXY > &splitLine, bool topologicalEditing=false)
Splits features cut by the given line.
bool moveVertex(double x, double y, QgsFeatureId atFeatureId, int atVertex)
Moves the vertex at the given position number, ring and item (first number is index 0),...
Q_DECL_DEPRECATED Qgis::GeometryOperationResult addRing(const QVector< QgsPointXY > &ring, const QgsFeatureIds &targetFeatureIds=QgsFeatureIds(), QgsFeatureId *modifiedFeatureId=nullptr)
Adds a ring to polygon/multipolygon features.
Vector layer specific subclass of QgsMapLayerElevationProperties.
void setDefaultsFromLayer(QgsMapLayer *layer) override
Sets default properties based on sensible choices for the given map layer.
QgsVectorLayerElevationProperties * clone() const override
Creates a clone of the properties.
Counts the features in a QgsVectorLayer in task.
QHash< QString, long long > symbolFeatureCountMap() const
Returns the count for each symbol.
void cancel() override
Notifies the task that it should terminate.
QHash< QString, QgsFeatureIds > symbolFeatureIdMap() const
Returns the QgsFeatureIds for each symbol.
Manages joined fields for a vector layer.
void resolveReferences(QgsProject *project)
Resolves layer IDs of joined layers using given project's available layers.
bool addJoin(const QgsVectorLayerJoinInfo &joinInfo)
Joins another vector layer to this layer.
void readXml(const QDomNode &layer_node)
Reads joins from project file.
void writeXml(QDomNode &layer_node, QDomDocument &document) const
Saves mVectorJoins to xml under the layer node.
const QgsVectorLayerJoinInfo * joinForFieldIndex(int index, const QgsFields &fields, int &sourceFieldIndex) const
Finds the vector join for a layer field index.
bool changeAttributeValue(QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant())
Changes attribute value in joined layers.
bool removeJoin(const QString &joinLayerId)
Removes a vector layer join.
bool containsJoins() const
Quick way to test if there is any join at all.
bool changeAttributeValues(QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues=QgsAttributeMap())
Changes attributes' values in joined layers.
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a list of features in joined layers.
void joinedFieldsChanged()
Emitted whenever the list of joined fields changes (e.g.
void updateFields(QgsFields &fields)
Updates field map with joined attributes.
bool deleteFeature(QgsFeatureId fid, QgsVectorLayer::DeleteContext *context=nullptr) const
Deletes a feature from joined layers.
const QgsVectorJoinList & vectorJoins() const
Defines left outer join from our vector layer to some other vector layer.
QString targetFieldName() const
Returns name of the field of our layer that will be used for join.
QString joinLayerId() const
ID of the joined layer - may be used to resolve reference to the joined layer.
Implementation of QgsAbstractProfileGenerator for vector layers.
Implementation of threaded rendering for vector layers.
Basic implementation of the labeling interface.
Implementation of map layer temporal properties for vector layers.
void guessDefaultsFromFields(const QgsFields &fields)
Attempts to setup the temporal properties by scanning a set of fields and looking for standard naming...
void setDefaultsFromDataProviderTemporalCapabilities(const QgsDataProviderTemporalCapabilities *capabilities) override
Sets the layers temporal settings to appropriate defaults based on a provider's temporal capabilities...
static QString guessFriendlyIdentifierField(const QgsFields &fields, bool *foundFriendly=nullptr)
Given a set of fields, attempts to pick the "most useful" field for user-friendly identification of f...
Represents a vector layer which manages a vector based data sets.
void setLabeling(QgsAbstractVectorLayerLabeling *labeling)
Sets labeling configuration.
QString attributeDisplayName(int index) const
Convenience function that returns the attribute alias if defined or the field name else.
Q_INVOKABLE QgsWkbTypes::Type wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
QVariant maximumValue(int index) const FINAL
Returns the maximum value for an attribute column or an invalid variant in case of error.
int addExpressionField(const QString &exp, const QgsField &fld)
Add a new field which is calculated by the expression specified.
void committedFeaturesAdded(const QString &layerId, const QgsFeatureList &addedFeatures)
Emitted when features are added to the provider if not in transaction mode.
void setExtent(const QgsRectangle &rect) FINAL
Sets the extent.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult addPart(const QList< QgsPointXY > &ring)
Adds a new part polygon to a multipart feature.
QgsRectangle sourceExtent() const FINAL
Returns the extent of all geometries from the source.
void featureBlendModeChanged(QPainter::CompositionMode blendMode)
Signal emitted when setFeatureBlendMode() is called.
bool labelsEnabled() const
Returns whether the layer contains labels which are enabled and should be drawn.
bool writeSymbology(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const FINAL
bool isModified() const override
Returns true if the provider has been modified since the last commit.
bool writeStyle(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const FINAL
void addFeatureRendererGenerator(QgsFeatureRendererGenerator *generator)
Adds a new feature renderer generator to the layer.
Q_DECL_DEPRECATED void setExcludeAttributesWfs(const QSet< QString > &att)
A set of attributes that are not advertised in WFS requests with QGIS server.
Q_INVOKABLE bool deleteSelectedFeatures(int *deletedCount=nullptr, QgsVectorLayer::DeleteContext *context=nullptr)
Deletes the selected features.
Q_INVOKABLE void selectByRect(QgsRectangle &rect, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection)
Selects features found within the search rectangle (in layer's coordinates)
void removeFieldAlias(int index)
Removes an alias (a display name) for attributes to display in dialogs.
void setAuxiliaryLayer(QgsAuxiliaryLayer *layer=nullptr)
Sets the current auxiliary layer.
void beforeRemovingExpressionField(int idx)
Will be emitted, when an expression field is going to be deleted from this vector layer.
virtual void saveStyleToDatabase(const QString &name, const QString &description, bool useAsDefault, const QString &uiFileContent, QString &msgError, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories)
Saves named and sld style of the layer to the style table in the db.
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...
Q_INVOKABLE QgsWkbTypes::GeometryType geometryType() const
Returns point, line or polygon.
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.
QMap< QgsFieldConstraints::Constraint, QgsFieldConstraints::ConstraintStrength > fieldConstraintsAndStrength(int fieldIndex) const
Returns a map of constraint with their strength for a specific field of the layer.
bool addJoin(const QgsVectorLayerJoinInfo &joinInfo)
Joins another vector layer to this layer.
QSet< QgsMapLayerDependency > dependencies() const FINAL
Gets the list of dependencies.
QgsMapLayerTemporalProperties * temporalProperties() override
Returns the layer's temporal properties.
void mapTipTemplateChanged()
Emitted when the map tip changes.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult splitFeatures(const QVector< QgsPointXY > &splitLine, bool topologicalEditing=false)
Splits features cut by the given line.
QgsDefaultValue defaultValueDefinition(int index) const
Returns the definition of the expression used when calculating the default value for a field.
QgsExpressionContextScope * createExpressionContextScope() const FINAL
This method needs to be reimplemented in all classes which implement this interface and return an exp...
QgsMapLayerRenderer * createMapRenderer(QgsRenderContext &rendererContext) FINAL
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.
QgsVectorLayerFeatureCounter * countSymbolFeatures(bool storeSymbolFids=false)
Count features for symbols.
QPainter::CompositionMode featureBlendMode() const
Returns the current blending mode for features.
QString constraintExpression(int index) const
Returns the constraint expression for for a specified field index, if set.
bool addAttribute(const QgsField &field)
Add an attribute field (but does not commit it) returns true if the field was added.
void attributeAdded(int idx)
Will be emitted, when a new attribute has been added to this vector layer.
QString capabilitiesString() const
Capabilities for this layer, comma separated and translated.
void deselect(QgsFeatureId featureId)
Deselects feature by its ID.
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.
void allowCommitChanged()
Emitted whenever the allowCommitChanged() property of this layer changes.
friend class QgsVectorLayerEditBuffer
void editCommandStarted(const QString &text)
Signal emitted when a new edit command has been started.
void updateFields()
Will regenerate the fields property of this layer by obtaining all fields from the dataProvider,...
bool isSpatial() const FINAL
Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeome...
virtual QString loadNamedStyle(const QString &theURI, bool &resultFlag, bool loadFromLocalDb, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories)
Loads a named style from file/local db/datasource db.
const QgsDiagramLayerSettings * diagramLayerSettings() const
void setFieldConstraint(int index, QgsFieldConstraints::Constraint constraint, QgsFieldConstraints::ConstraintStrength strength=QgsFieldConstraints::ConstraintStrengthHard)
Sets a constraint for a specified field index.
bool loadAuxiliaryLayer(const QgsAuxiliaryStorage &storage, const QString &key=QString())
Loads the auxiliary layer for this vector layer.
bool deleteFeature(QgsFeatureId fid, DeleteContext *context=nullptr)
Deletes a feature from the layer (but does not commit it).
bool insertVertex(double x, double y, QgsFeatureId atFeatureId, int beforeVertex)
Inserts a new vertex before the given vertex number, in the given ring, item (first number is index 0...
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
QgsAbstractProfileGenerator * createProfileGenerator(const QgsProfileRequest &request) override
Given a profile request, returns a new profile generator ready for generating elevation profiles.
QString htmlMetadata() const FINAL
Obtain a formatted HTML string containing assorted metadata for this layer.
Q_INVOKABLE QgsRectangle boundingBoxOfSelected() const
Returns the bounding box of the selected features. If there is no selection, QgsRectangle(0,...
QgsFields fields() const FINAL
Returns the list of fields of this layer.
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) FINAL
Adds a list of features to the sink.
Q_INVOKABLE QgsFeatureList selectedFeatures() const
Returns a copy of the user-selected features.
QString expressionField(int index) const
Returns the expression used for a given expression field.
bool readSymbology(const QDomNode &layerNode, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) FINAL
void removeFeatureRendererGenerator(const QString &id)
Removes the feature renderer with matching id from the layer.
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.
QgsFieldConstraints::Constraints fieldConstraints(int fieldIndex) const
Returns any constraints which are present for a specified field index.
bool deleteFeatures(const QgsFeatureIds &fids, DeleteContext *context=nullptr)
Deletes a set of features from the layer (but does not commit it)
void setMapTipTemplate(const QString &mapTipTemplate)
The mapTip is a pretty, html representation for feature information.
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.
virtual QString getStyleFromDatabase(const QString &styleId, QString &msgError)
Returns the named style corresponding to style id provided.
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.
void setFieldConfigurationFlags(int index, QgsField::ConfigurationFlags flags)
Sets the configuration flags of the field at given index.
QgsAuxiliaryLayer * auxiliaryLayer()
Returns the current auxiliary layer.
void setCoordinateSystem()
Setup the coordinate system transformation for the layer.
void committedFeaturesRemoved(const QString &layerId, const QgsFeatureIds &deletedFeatureIds)
Emitted when features are deleted from the provider if not in transaction mode.
void updateExpressionField(int index, const QString &exp)
Changes the expression used to define an expression based (virtual) field.
Q_INVOKABLE void selectByExpression(const QString &expression, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection, QgsExpressionContext *context=nullptr)
Selects matching features using an expression.
~QgsVectorLayer() override
QgsCoordinateReferenceSystem sourceCrs() const FINAL
Returns the coordinate reference system for features in the source.
void endEditCommand()
Finish edit command and add it to undo/redo stack.
void destroyEditCommand()
Destroy active command and reverts all changes in it.
bool isAuxiliaryField(int index, int &srcIndex) const
Returns true if the field comes from the auxiliary layer, false otherwise.
QgsExpressionContext createExpressionContext() const FINAL
This method needs to be reimplemented in all classes which implement this interface and return an exp...
QList< QgsRelation > referencingRelations(int idx) const
Returns the layer's relations, where the foreign key is on this layer.
Q_DECL_DEPRECATED QSet< QString > excludeAttributesWfs() const
A set of attributes that are not advertised in WFS requests with QGIS server.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult splitParts(const QVector< QgsPointXY > &splitLine, bool topologicalEditing=false)
Splits parts cut by the given line.
void setDefaultValueDefinition(int index, const QgsDefaultValue &definition)
Sets the definition of the expression to use when calculating the default value for a field.
bool diagramsEnabled() const
Returns whether the layer contains diagrams which are enabled and should be drawn.
void setAllowCommit(bool allowCommit)
Controls, if the layer is allowed to commit changes.
bool setDependencies(const QSet< QgsMapLayerDependency > &layers) FINAL
Sets the list of dependencies.
void symbolFeatureCountMapChanged()
Emitted when the feature count for symbols on this layer has been recalculated.
Q_INVOKABLE const QgsFeatureIds & selectedFeatureIds() const
Returns a list of the selected features IDs in this layer.
Qgis::VectorEditResult deleteVertex(QgsFeatureId featureId, int vertex)
Deletes a vertex from a feature.
void setFeatureBlendMode(QPainter::CompositionMode blendMode)
Sets the blending mode used for rendering each feature.
QString constraintDescription(int index) const
Returns the descriptive name for the constraint expression for a specified field index.
void writeCustomSymbology(QDomElement &element, QDomDocument &doc, QString &errorMessage) const
Signal emitted whenever the symbology (QML-file) for this layer is being written.
const QgsAbstractVectorLayerLabeling * labeling() const
Access to const labeling configuration.
void setProviderEncoding(const QString &encoding)
Sets the text encoding of the data provider.
bool writeSld(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QVariantMap &props=QVariantMap()) const
Writes the symbology of the layer into the document provided in SLD 1.1 format.
void setDisplayExpression(const QString &displayExpression)
Set the preview expression, used to create a human readable preview string.
virtual bool deleteAttribute(int attr)
Deletes an attribute field (but does not commit it).
void resolveReferences(QgsProject *project) FINAL
Resolves references to other layers (kept as layer IDs after reading XML) into layer objects.
bool changeAttributeValues(QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues=QgsAttributeMap(), bool skipDefaultValues=false)
Changes attributes' values for a feature (but does not immediately commit the changes).
QgsMapLayerElevationProperties * elevationProperties() override
Returns the layer's elevation properties.
bool removeJoin(const QString &joinLayerId)
Removes a vector layer join.
Q_INVOKABLE void invertSelectionInRectangle(QgsRectangle &rect)
Inverts selection of features found within the search rectangle (in layer's coordinates)
void setRenderer(QgsFeatureRenderer *r)
Sets the feature renderer which will be invoked to represent this layer in 2D map views.
Q_INVOKABLE void selectAll()
Select all the features.
bool isEditable() const FINAL
Returns true if the provider is in editing mode.
QStringList commitErrors() const
Returns a list containing any error messages generated when attempting to commit changes to the layer...
QString storageType() const
Returns the permanent storage type for this layer as a friendly name.
bool readExtentFromXml() const
Returns true if the extent is read from the XML document when data source has no metadata,...
QString dataComment() const
Returns a description for this layer as defined in the data provider.
bool accept(QgsStyleEntityVisitorInterface *visitor) const override
QgsGeometryOptions * geometryOptions() const
Configuration and logic to apply automatically on any edit happening on this layer.
QgsStringMap attributeAliases() const
Returns a map of field name to attribute alias.
Q_INVOKABLE int translateFeature(QgsFeatureId featureId, double dx, double dy)
Translates feature by dx, dy.
virtual void updateExtents(bool force=false)
Update the extents for the layer.
void attributeDeleted(int idx)
Will be emitted, when an attribute has been deleted from this vector layer.
QgsFeatureRenderer * renderer()
Returns the feature renderer used for rendering the features in the layer in 2D map views.
void beforeEditingStarted()
Emitted before editing on this layer is started.
void committedAttributeValuesChanges(const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues)
Emitted when attribute value changes are saved to the provider if not in transaction mode.
void committedAttributesAdded(const QString &layerId, const QList< QgsField > &addedAttributes)
Emitted when attributes are added to the provider if not in transaction mode.
void setEditFormConfig(const QgsEditFormConfig &editFormConfig)
Sets the editFormConfig (configuration) of the form used to represent this vector layer.
void committedAttributesDeleted(const QString &layerId, const QgsAttributeList &deletedAttributes)
Emitted when attributes are deleted from the provider if not in transaction mode.
QString displayExpression
void displayExpressionChanged()
Emitted when the display expression changes.
QVariant minimumValue(int index) const FINAL
Returns the minimum value for an attribute column or an invalid variant in case of error.
QgsFeatureIterator getSelectedFeatures(QgsFeatureRequest request=QgsFeatureRequest()) const
Returns an iterator of the selected features.
void setEditorWidgetSetup(int index, const QgsEditorWidgetSetup &setup)
The editor widget setup defines which QgsFieldFormatter and editor widget will be used for the field ...
void setConstraintExpression(int index, const QString &expression, const QString &description=QString())
Sets the constraint expression for the specified field index.
Q_INVOKABLE bool rollBack(bool deleteBuffer=true)
Stops a current editing operation and discards any uncommitted edits.
bool readStyle(const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) FINAL
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...
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
bool setReadOnly(bool readonly=true)
Makes layer read-only (editing disabled) or not.
QgsField::ConfigurationFlags fieldConfigurationFlags(int index) const
Returns the configuration flags of the field at given index.
void editFormConfigChanged()
Will be emitted whenever the edit form configuration of this layer changes.
Q_INVOKABLE void modifySelection(const QgsFeatureIds &selectIds, const QgsFeatureIds &deselectIds)
Modifies the current selection on this layer.
void setWeakRelations(const QList< QgsWeakRelation > &relations)
Sets the layer's weak relations.
void reselect()
Reselects the previous set of selected features.
void select(QgsFeatureId featureId)
Selects feature by its ID.
QgsEditorWidgetSetup editorWidgetSetup(int index) const
The editor widget setup defines which QgsFieldFormatter and editor widget will be used for the field ...
long long featureCount() const FINAL
Returns feature count including changes which have not yet been committed If you need only the count ...
virtual bool deleteStyleFromDatabase(const QString &styleId, QString &msgError)
Deletes a style from the database.
void setReadExtentFromXml(bool readExtentFromXml)
Flag allowing to indicate if the extent has to be read from the XML document when data source has no ...
void afterCommitChanges()
Emitted after changes are committed to the data provider.
QgsVectorLayer * clone() const override
Returns a new instance equivalent to this one.
QgsAttributeTableConfig attributeTableConfig() const
Returns the attribute table configuration object.
QgsActionManager * actions()
Returns all layer actions defined on this layer.
bool readSld(const QDomNode &node, QString &errorMessage) FINAL
QgsFeature getFeature(QgsFeatureId fid) const
Queries the layer for the feature with the given id.
Q_INVOKABLE void selectByIds(const QgsFeatureIds &ids, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection)
Selects matching features using a list of feature IDs.
QStringList uniqueStringsMatching(int index, const QString &substring, int limit=-1, QgsFeedback *feedback=nullptr) const
Returns unique string values of an attribute which contain a specified subset string.
void raiseError(const QString &msg)
Signals an error related to this vector layer.
void editCommandEnded()
Signal emitted, when an edit command successfully ended.
void supportsEditingChanged()
Emitted when the read only state or the data provider of this layer is changed.
QgsFeatureSource::SpatialIndexPresence hasSpatialIndex() const override
void readOnlyChanged()
Emitted when the read only state of this layer is changed.
void removeExpressionField(int index)
Removes an expression field.
virtual void setTransformContext(const QgsCoordinateTransformContext &transformContext) override
Sets the coordinate transform context to transformContext.
void attributeValueChanged(QgsFeatureId fid, int idx, const QVariant &value)
Emitted whenever an attribute value change is done in the edit buffer.
static Q_DECL_DEPRECATED void drawVertexMarker(double x, double y, QPainter &p, Qgis::VertexMarkerType type, int vertexSize)
Draws a vertex symbol at (screen) coordinates x, y.
bool changeAttributeValue(QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant(), bool skipDefaultValues=false)
Changes an attribute value for a feature (but does not immediately commit the changes).
void setFieldConfigurationFlag(int index, QgsField::ConfigurationFlag flag, bool active)
Sets the given configuration flag for the field at given index to be active or not.
bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) FINAL
Adds a single feature to the sink.
void setFieldAlias(int index, const QString &aliasString)
Sets an alias (a display name) for attributes to display in dialogs.
friend class QgsVectorLayerFeatureSource
void minimumAndMaximumValue(int index, QVariant &minimum, QVariant &maximum) const
Calculates both the minimum and maximum value for an attribute column.
QgsRectangle extent() const FINAL
Returns the extent of the layer.
Q_DECL_DEPRECATED void setExcludeAttributesWms(const QSet< QString > &att)
A set of attributes that are not advertised in WMS requests with QGIS server.
void setAttributeTableConfig(const QgsAttributeTableConfig &attributeTableConfig)
Sets the attribute table configuration object.
virtual bool setSubsetString(const QString &subset)
Sets the string (typically sql) used to define a subset of the layer.
bool readXml(const QDomNode &layer_node, QgsReadWriteContext &context) FINAL
Reads vector layer specific state from project file Dom node.
FeatureAvailability hasFeatures() const FINAL
Determines if this vector layer has features.
void afterRollBack()
Emitted after changes are rolled back.
QString decodedSource(const QString &source, const QString &provider, const QgsReadWriteContext &context) const FINAL
Called by readLayerXML(), used by derived classes to decode provider's specific data source from proj...
void setDiagramLayerSettings(const QgsDiagramLayerSettings &s)
QList< QgsWeakRelation > weakRelations() const
Returns the layer's weak relations as specified in the layer's style.
const QgsVectorSimplifyMethod & simplifyMethod() const
Returns the simplification settings for fast rendering of features.
void selectionChanged(const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect)
Emitted when selection was changed.
void beforeAddingExpressionField(const QString &fieldName)
Will be emitted, when an expression field is going to be added to this vector layer.
bool deleteAttributes(const QList< int > &attrs)
Deletes a list of attribute fields (but does not commit it)
void updatedFields()
Emitted whenever the fields available from this layer have been changed.
QVariant defaultValue(int index, const QgsFeature &feature=QgsFeature(), QgsExpressionContext *context=nullptr) const
Returns the calculated default value for the specified field index.
void featureAdded(QgsFeatureId fid)
Emitted when a new feature has been added to the layer.
QString sourceName() const FINAL
Returns a friendly display name for the source.
QString attributeAlias(int index) const
Returns the alias of an attribute name or a null string if there is no alias.
void featureDeleted(QgsFeatureId fid)
Emitted when a feature has been deleted.
Q_INVOKABLE void removeSelection()
Clear selection.
bool allowCommit() const
Controls, if the layer is allowed to commit changes.
QgsConditionalLayerStyles * conditionalStyles() const
Returns the conditional styles that are set for this layer.
void readCustomSymbology(const QDomElement &element, QString &errorMessage)
Signal emitted whenever the symbology (QML-file) for this layer is being read.
void reload() FINAL
Synchronises with changes in the datasource.
const QList< QgsVectorLayerJoinInfo > vectorJoins() const
bool renameAttribute(int index, const QString &newName)
Renames an attribute field (but does not commit it).
bool isSqlQuery() const
Returns true if the layer is a query (SQL) layer.
bool simplifyDrawingCanbeApplied(const QgsRenderContext &renderContext, QgsVectorSimplifyMethod::SimplifyHint simplifyHint) const
Returns whether the VectorLayer can apply the specified simplification hint.
void beforeRollBack()
Emitted before changes are rolled back.
QgsAttributeList primaryKeyAttributes() const
Returns the list of attributes which make up the layer's primary keys.
bool writeXml(QDomNode &layer_node, QDomDocument &doc, const QgsReadWriteContext &context) const FINAL
Writes vector layer specific state to project file Dom node.
QString encodedSource(const QString &source, const QgsReadWriteContext &context) const FINAL
Called by writeLayerXML(), used by derived classes to encode provider's specific data source to proje...
void beginEditCommand(const QString &text)
Create edit command for undo/redo operations.
QString displayField() const
This is a shorthand for accessing the displayExpression if it is a simple field.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult addRing(const QVector< QgsPointXY > &ring, QgsFeatureId *featureId=nullptr)
Adds a ring to polygon/multipolygon features.
void setDiagramRenderer(QgsDiagramRenderer *r)
Sets diagram rendering object (takes ownership)
void geometryChanged(QgsFeatureId fid, const QgsGeometry &geometry)
Emitted whenever a geometry change is done in the edit buffer.
QgsEditFormConfig editFormConfig
QList< const QgsFeatureRendererGenerator * > featureRendererGenerators() const
Returns a list of the feature renderer generators owned by the layer.
bool moveVertex(double x, double y, QgsFeatureId atFeatureId, int atVertex)
Moves the vertex at the given position number, ring and item (first number is index 0),...
QgsGeometry getGeometry(QgsFeatureId fid) const
Queries the layer for the geometry at the given id.
int addTopologicalPoints(const QgsGeometry &geom)
Adds topological points for every vertex of the geometry.
void beforeModifiedCheck() const
Emitted when the layer is checked for modifications. Use for last-minute additions.
Q_INVOKABLE void invertSelection()
Selects not selected features and deselects selected ones.
const QgsDiagramRenderer * diagramRenderer() const
QVariant aggregate(QgsAggregateCalculator::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.
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...
QSet< QVariant > uniqueValues(int fieldIndex, int limit=-1) const FINAL
Calculates a list of unique values contained within an attribute in the layer.
bool forceLocalOptimization() const
Gets where the simplification executes, after fetch the geometries from provider, or when supported,...
void setSimplifyHints(SimplifyHints simplifyHints)
Sets the simplification hints of the vector layer managed.
float maximumScale() const
Gets the maximum scale at which the layer should be simplified.
void setThreshold(float threshold)
Sets the simplification threshold of the vector layer managed.
void setSimplifyAlgorithm(SimplifyAlgorithm simplifyAlgorithm)
Sets the local simplification algorithm of the vector layer managed.
void setForceLocalOptimization(bool localOptimization)
Sets where the simplification executes, after fetch the geometries from provider, or when supported,...
SimplifyHints simplifyHints() const
Gets the simplification hints of the vector layer managed.
SimplifyAlgorithm simplifyAlgorithm() const
Gets the local simplification algorithm of the vector layer managed.
float threshold() const
Gets the simplification threshold of the vector layer managed.
SimplifyHint
Simplification flags for fast rendering of features.
SimplifyAlgorithm
Types of local simplification algorithms that can be used.
void setMaximumScale(float maximumScale)
Sets the maximum scale at which the layer should be simplified.
@ 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 QString geometryDisplayString(GeometryType type)
Returns a display string for a geometry type.
static GeometryType geometryType(Type type)
Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a Polyg...
GeometryType
The geometry types are used to group QgsWkbTypes::Type in a coarse way.
Type
The WKB type describes the number of dimensions a geometry has.
Definition qgswkbtypes.h:70
static QString displayString(Type type)
Returns a non-translated display string type for a WKB type, e.g., the geometry name used in WKT geom...
static QDomElement writeVariant(const QVariant &value, QDomDocument &doc)
Write a QVariant to a QDomElement.
static QVariant readVariant(const QDomElement &element)
Read a QVariant from a QDomElement.
static QgsRectangle readRectangle(const QDomElement &element)
QgsMapLayerType
Types of layers that can be added to a map.
Definition qgis.h:47
@ UnknownCount
Provider returned an unknown feature count.
@ VectorLayer
Vector layer.
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:266
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:119
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:187
#define FALLTHROUGH
Definition qgis.h:3088
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:2700
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
Definition qgis.h:2681
QString qgsFlagValueToKeys(const T &value, bool *returnOk=nullptr)
Returns the value for the given keys of a flag.
Definition qgis.h:2739
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:2761
QMap< QString, QString > QgsStringMap
Definition qgis.h:3022
QVector< QgsPoint > QgsPointSequence
QMap< int, QVariant > QgsAttributeMap
QList< QgsFeature > QgsFeatureList
Definition qgsfeature.h:922
QSet< QgsFeatureId > QgsFeatureIds
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
QList< int > QgsAttributeList
Definition qgsfield.h:26
const QgsField & field
Definition qgsfield.h:476
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:39
#define QgsDebugMsg(str)
Definition qgslogger.h:38
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
#define RENDERER_TAG_NAME
Definition qgsrenderer.h:50
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.
QgsWkbTypes::Type fallbackWkbType
Fallback geometry type.
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.