QGIS API Documentation 3.41.0-Master (fda2aa46e9a)
Loading...
Searching...
No Matches
qgsmaplayer.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsmaplayer.cpp - description
3 -------------------
4 begin : Fri Jun 28 2002
5 copyright : (C) 2002 by Gary E.Sherman
6 email : sherman at mrcc.com
7***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18
19#include "qgssqliteutils.h"
22#include "qgsapplication.h"
25#include "qgsdatasourceuri.h"
26#include "qgsfileutils.h"
27#include "qgslogger.h"
28#include "qgsauthmanager.h"
29#include "qgsmaplayer.h"
30#include "moc_qgsmaplayer.cpp"
31#include "qgsmaplayerlegend.h"
33#include "qgspathresolver.h"
35#include "qgsproject.h"
36#include "qgsproviderregistry.h"
37#include "qgsprovidermetadata.h"
38#include "qgsrasterlayer.h"
39#include "qgsreadwritecontext.h"
40#include "qgsrectangle.h"
41#include "qgsscaleutils.h"
42#include "qgssldexportcontext.h"
43#include "qgsvectorlayer.h"
44#include "qgsxmlutils.h"
45#include "qgsstringutils.h"
46#include "qgsmessagelog.h"
49#include "qgslayernotesutils.h"
50#include "qgsdatums.h"
51#include "qgsprojoperation.h"
52#include "qgsthreadingutils.h"
53#include "qgsunittypes.h"
54
55#include <QDir>
56#include <QDomDocument>
57#include <QDomElement>
58#include <QDomImplementation>
59#include <QDomNode>
60#include <QFile>
61#include <QFileInfo>
62#include <QLocale>
63#include <QTextStream>
64#include <QUrl>
65#include <QTimer>
66#include <QStandardPaths>
67#include <QUuid>
68#include <QRegularExpression>
69
70#include <sqlite3.h>
71
73{
74 switch ( type )
75 {
76 case Metadata:
77 return QStringLiteral( ".qmd" );
78
79 case Style:
80 return QStringLiteral( ".qml" );
81 }
82 return QString();
83}
84
86 const QString &lyrname,
87 const QString &source )
88 : mDataSource( source )
89 , mLayerName( lyrname )
90 , mLayerType( type )
91 , mServerProperties( std::make_unique<QgsMapLayerServerProperties>( this ) )
92 , mUndoStack( new QUndoStack( this ) )
93 , mUndoStackStyles( new QUndoStack( this ) )
94 , mStyleManager( new QgsMapLayerStyleManager( this ) )
95 , mRefreshTimer( new QTimer( this ) )
96{
97 mID = generateId( lyrname );
100 connect( mRefreshTimer, &QTimer::timeout, this, [this]
101 {
102
103 switch ( mAutoRefreshMode )
104 {
106 break;
108 triggerRepaint( true );
109 break;
111 reload();
112 break;
113 }
114 } );
115}
116
118{
119 if ( project() && project()->pathResolver().writePath( mDataSource ).startsWith( "attachment:" ) )
120 {
122 }
123
124 delete m3DRenderer;
125 delete mLegend;
126 delete mStyleManager;
127}
128
129void QgsMapLayer::clone( QgsMapLayer *layer ) const
130{
132
133 QgsDebugMsgLevel( QStringLiteral( "Cloning layer '%1'" ).arg( name() ), 3 );
134 layer->setBlendMode( blendMode() );
135
136 const auto constStyles = styleManager()->styles();
137 for ( const QString &s : constStyles )
138 {
139 layer->styleManager()->addStyle( s, styleManager()->style( s ) );
140 }
141
142 layer->setName( name() );
143
144 if ( layer->dataProvider() && layer->dataProvider()->elevationProperties() )
145 {
147 layer->mExtent3D = mExtent3D;
148 else
149 layer->mExtent2D = mExtent2D;
150 }
151
152 layer->setMaximumScale( maximumScale() );
153 layer->setMinimumScale( minimumScale() );
155 layer->setLegendUrl( legendUrl() );
157 layer->setDependencies( dependencies() );
159 layer->setCrs( crs() );
160 layer->setCustomProperties( mCustomProperties );
161 layer->setOpacity( mLayerOpacity );
162 layer->setMetadata( mMetadata );
163 layer->serverProperties()->copyTo( mServerProperties.get() );
164}
165
167{
168 // because QgsVirtualLayerProvider is not anywhere NEAR thread safe:
170
171 return mLayerType;
172}
173
180
182{
184
185 if ( flags == mFlags )
186 return;
187
188 mFlags = flags;
189 emit flagsChanged();
190}
191
198
199QString QgsMapLayer::id() const
200{
201 // because QgsVirtualLayerProvider is not anywhere NEAR thread safe:
203
204 return mID;
205}
206
207bool QgsMapLayer::setId( const QString &id )
208{
210 if ( qobject_cast< QgsMapLayerStore * >( parent() ) )
211 {
212 // layer is already registered, cannot change id
213 return false;
214 }
215
216 if ( id == mID )
217 return false;
218
219 mID = id;
220 emit idChanged( id );
221 return true;
222}
223
224void QgsMapLayer::setName( const QString &name )
225{
227
228 if ( name == mLayerName )
229 return;
230
232
233 emit nameChanged();
234}
235
236QString QgsMapLayer::name() const
237{
238 // because QgsVirtualLayerProvider is not anywhere NEAR thread safe:
240
241 QgsDebugMsgLevel( "returning name '" + mLayerName + '\'', 4 );
242 return mLayerName;
243}
244
251
253{
255
256 return nullptr;
257}
258
263
264void QgsMapLayer::setShortName( const QString &shortName )
265{
267
268 mServerProperties->setShortName( shortName );
269}
270
272{
274
275 return mServerProperties->shortName();
276}
277
278void QgsMapLayer::setTitle( const QString &title )
279{
281
282 mServerProperties->setTitle( title );
283}
284
285QString QgsMapLayer::title() const
286{
288
289 return mServerProperties->title();
290}
291
292void QgsMapLayer::setAbstract( const QString &abstract )
293{
295
296 mServerProperties->setAbstract( abstract );
297}
298
300{
302
303 return mServerProperties->abstract();
304}
305
306void QgsMapLayer::setKeywordList( const QString &keywords )
307{
309
310 mServerProperties->setKeywordList( keywords );
311}
312
314{
316
317 return mServerProperties->keywordList();
318}
319
320void QgsMapLayer::setDataUrl( const QString &dataUrl )
321{
323
324 mServerProperties->setDataUrl( dataUrl );
325}
326
327QString QgsMapLayer::dataUrl() const
328{
330
331 return mServerProperties->dataUrl();
332}
333
334void QgsMapLayer::setDataUrlFormat( const QString &dataUrlFormat )
335{
337
338 mServerProperties->setDataUrlFormat( dataUrlFormat );
339}
340
342{
344
345 return mServerProperties->dataUrlFormat();
346}
347
348void QgsMapLayer::setAttribution( const QString &attrib )
349{
351
352 mServerProperties->setAttribution( attrib );
353}
354
356{
358
359 return mServerProperties->attribution();
360}
361
362void QgsMapLayer::setAttributionUrl( const QString &attribUrl )
363{
365
366 mServerProperties->setAttributionUrl( attribUrl );
367}
368
370{
372
373 return mServerProperties->attributionUrl();
374
375}
376
377void QgsMapLayer::setMetadataUrl( const QString &metaUrl )
378{
380
381 QList<QgsMapLayerServerProperties::MetadataUrl> urls = serverProperties()->metadataUrls();
382 if ( urls.isEmpty() )
383 {
384 const QgsMapLayerServerProperties::MetadataUrl newItem = QgsMapLayerServerProperties::MetadataUrl( metaUrl, QLatin1String(), QLatin1String() );
385 urls.prepend( newItem );
386 }
387 else
388 {
389 const QgsMapLayerServerProperties::MetadataUrl old = urls.takeFirst();
390 const QgsMapLayerServerProperties::MetadataUrl newItem( metaUrl, old.type, old.format );
391 urls.prepend( newItem );
392 }
394}
395
397{
399
400 if ( mServerProperties->metadataUrls().isEmpty() )
401 {
402 return QLatin1String();
403 }
404 else
405 {
406 return mServerProperties->metadataUrls().first().url;
407 }
408}
409
410void QgsMapLayer::setMetadataUrlType( const QString &metaUrlType )
411{
413
414 QList<QgsMapLayerServerProperties::MetadataUrl> urls = mServerProperties->metadataUrls();
415 if ( urls.isEmpty() )
416 {
417 const QgsMapLayerServerProperties::MetadataUrl newItem( QLatin1String(), metaUrlType, QLatin1String() );
418 urls.prepend( newItem );
419 }
420 else
421 {
422 const QgsMapLayerServerProperties::MetadataUrl old = urls.takeFirst();
423 const QgsMapLayerServerProperties::MetadataUrl newItem( old.url, metaUrlType, old.format );
424 urls.prepend( newItem );
425 }
426 mServerProperties->setMetadataUrls( urls );
427}
428
430{
432
433 if ( mServerProperties->metadataUrls().isEmpty() )
434 {
435 return QLatin1String();
436 }
437 else
438 {
439 return mServerProperties->metadataUrls().first().type;
440 }
441}
442
443void QgsMapLayer::setMetadataUrlFormat( const QString &metaUrlFormat )
444{
446
447 QList<QgsMapLayerServerProperties::MetadataUrl> urls = mServerProperties->metadataUrls();
448 if ( urls.isEmpty() )
449 {
450 const QgsMapLayerServerProperties::MetadataUrl newItem( QLatin1String(), QLatin1String(), metaUrlFormat );
451 urls.prepend( newItem );
452 }
453 else
454 {
455 const QgsMapLayerServerProperties::MetadataUrl old = urls.takeFirst( );
456 const QgsMapLayerServerProperties::MetadataUrl newItem( old.url, old.type, metaUrlFormat );
457 urls.prepend( newItem );
458 }
459 mServerProperties->setMetadataUrls( urls );
460}
461
463{
465
466 if ( mServerProperties->metadataUrls().isEmpty() )
467 {
468 return QString();
469 }
470 else
471 {
472 return mServerProperties->metadataUrls().first().format;
473 }
474}
475
476QString QgsMapLayer::publicSource( bool hidePassword ) const
477{
479
480 // Redo this every time we're asked for it, as we don't know if
481 // dataSource has changed.
482 QString safeName = QgsDataSourceUri::removePassword( mDataSource, hidePassword );
483 return safeName;
484}
485
486QString QgsMapLayer::source() const
487{
489
490 return mDataSource;
491}
492
494{
496
497 return mExtent2D.isNull() ? mExtent3D.toRectangle() : mExtent2D;
498}
499
501{
503
504 return mExtent3D;
505}
506
507void QgsMapLayer::setBlendMode( const QPainter::CompositionMode blendMode )
508{
510
511 if ( mBlendMode == blendMode )
512 return;
513
514 mBlendMode = blendMode;
517}
518
519QPainter::CompositionMode QgsMapLayer::blendMode() const
520{
521 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
523
524 return mBlendMode;
525}
526
527void QgsMapLayer::setOpacity( double opacity )
528{
530
532 return;
534 emit opacityChanged( opacity );
536}
537
539{
540 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
542
543 return mLayerOpacity;
544}
545
546bool QgsMapLayer::readLayerXml( const QDomElement &layerElement, QgsReadWriteContext &context, QgsMapLayer::ReadFlags flags, QgsDataProvider *preloadedProvider )
547{
549
550 mPreloadedProvider.reset( preloadedProvider );
551
552 bool layerError;
554
555 QDomNode mnl;
556 QDomElement mne;
557
558 // read provider
559 QString provider;
560 mnl = layerElement.namedItem( QStringLiteral( "provider" ) );
561 mne = mnl.toElement();
562 provider = mne.text();
563
564 // set data source
565 mnl = layerElement.namedItem( QStringLiteral( "datasource" ) );
566 mne = mnl.toElement();
567 const QString dataSourceRaw = mne.text();
568 mDataSource = provider.isEmpty() ? dataSourceRaw : QgsProviderRegistry::instance()->relativeToAbsoluteUri( provider, dataSourceRaw, context );
569
570 // if the layer needs authentication, ensure the master password is set
571 const thread_local QRegularExpression rx( "authcfg=([a-z]|[A-Z]|[0-9]){7}" );
572 if ( rx.match( mDataSource ).hasMatch()
574 {
575 return false;
576 }
577
578 mDataSource = decodedSource( mDataSource, provider, context );
579
580 // Set the CRS from project file, asking the user if necessary.
581 // Make it the saved CRS to have WMS layer projected correctly.
582 // We will still overwrite whatever GDAL etc picks up anyway
583 // further down this function.
584 mnl = layerElement.namedItem( QStringLiteral( "layername" ) );
585 mne = mnl.toElement();
586
588 CUSTOM_CRS_VALIDATION savedValidation;
589
590 const QDomNode srsNode = layerElement.namedItem( QStringLiteral( "srs" ) );
591 mCRS.readXml( srsNode );
592 mCRS.setValidationHint( tr( "Specify CRS for layer %1" ).arg( mne.text() ) );
594 mCRS.validate();
595 savedCRS = mCRS;
596
597 // Do not validate any projections in children, they will be overwritten anyway.
598 // No need to ask the user for a projections when it is overwritten, is there?
601
602 const QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Layer" ), mne.text() );
603
604 // the internal name is just the data source basename
605 //QFileInfo dataSourceFileInfo( mDataSource );
606 //internalName = dataSourceFileInfo.baseName();
607
608 // set ID
609 mnl = layerElement.namedItem( QStringLiteral( "id" ) );
610 if ( ! mnl.isNull() )
611 {
612 mne = mnl.toElement();
613 if ( ! mne.isNull() && mne.text().length() > 10 ) // should be at least 17 (yyyyMMddhhmmsszzz)
614 {
615 const QString newId = mne.text();
616 if ( newId != mID )
617 {
618 mID = mne.text();
619 emit idChanged( mID );
620 }
621 }
622 }
623
624 // set name
625 mnl = layerElement.namedItem( QStringLiteral( "layername" ) );
626 mne = mnl.toElement();
627
628 //name can be translated
629 setName( context.projectTranslator()->translate( QStringLiteral( "project:layers:%1" ).arg( layerElement.namedItem( QStringLiteral( "id" ) ).toElement().text() ), mne.text() ) );
630
631 // now let the children grab what they need from the Dom node.
632 layerError = !readXml( layerElement, context );
633
634 const QgsCoordinateReferenceSystem oldVerticalCrs = verticalCrs();
635 const QgsCoordinateReferenceSystem oldCrs3D = mCrs3D;
636
637 // overwrite CRS with what we read from project file before the raster/vector
638 // file reading functions changed it. They will if projections is specified in the file.
639 // FIXME: is this necessary? Yes, it is (autumn 2019)
641 mCRS = savedCRS;
642
643 //vertical CRS
644 {
646 const QDomNode verticalCrsNode = layerElement.firstChildElement( QStringLiteral( "verticalCrs" ) );
647 if ( !verticalCrsNode.isNull() )
648 {
649 verticalCrs.readXml( verticalCrsNode );
650 }
651 mVerticalCrs = verticalCrs;
652 }
653 rebuildCrs3D();
654
655 //legendUrl
656 const QDomElement legendUrlElem = layerElement.firstChildElement( QStringLiteral( "legendUrl" ) );
657 if ( !legendUrlElem.isNull() )
658 {
659 mLegendUrl = legendUrlElem.text();
660 mLegendUrlFormat = legendUrlElem.attribute( QStringLiteral( "format" ), QString() );
661 }
662
663 serverProperties()->readXml( layerElement );
664
665 if ( serverProperties()->metadataUrls().isEmpty() )
666 {
667 // metadataUrl is still empty, maybe it's a QGIS Project < 3.22
668 // keep for legacy
669 const QDomElement metaUrlElem = layerElement.firstChildElement( QStringLiteral( "metadataUrl" ) );
670 if ( !metaUrlElem.isNull() )
671 {
672 const QString url = metaUrlElem.text();
673 const QString type = metaUrlElem.attribute( QStringLiteral( "type" ), QString() );
674 const QString format = metaUrlElem.attribute( QStringLiteral( "format" ), QString() );
675 const QgsMapLayerServerProperties::MetadataUrl newItem( url, type, format );
676 mServerProperties->setMetadataUrls( QList<QgsMapLayerServerProperties::MetadataUrl>() << newItem );
677 }
678 }
679
680 // mMetadata.readFromLayer( this );
681 const QDomElement metadataElem = layerElement.firstChildElement( QStringLiteral( "resourceMetadata" ) );
682 mMetadata.readMetadataXml( metadataElem );
683
684 setAutoRefreshInterval( layerElement.attribute( QStringLiteral( "autoRefreshTime" ), QStringLiteral( "0" ) ).toInt() );
685 if ( layerElement.hasAttribute( QStringLiteral( "autoRefreshMode" ) ) )
686 {
687 setAutoRefreshMode( qgsEnumKeyToValue( layerElement.attribute( QStringLiteral( "autoRefreshMode" ) ), Qgis::AutoRefreshMode::Disabled ) );
688 }
689 else
690 {
691 setAutoRefreshMode( layerElement.attribute( QStringLiteral( "autoRefreshEnabled" ), QStringLiteral( "0" ) ).toInt() ? Qgis::AutoRefreshMode::RedrawOnly : Qgis::AutoRefreshMode::Disabled );
692 }
693 setRefreshOnNofifyMessage( layerElement.attribute( QStringLiteral( "refreshOnNotifyMessage" ), QString() ) );
694 setRefreshOnNotifyEnabled( layerElement.attribute( QStringLiteral( "refreshOnNotifyEnabled" ), QStringLiteral( "0" ) ).toInt() );
695
696 // geographic extent is read only if necessary
698 {
699 const QDomNode wgs84ExtentNode = layerElement.namedItem( QStringLiteral( "wgs84extent" ) );
700 if ( !wgs84ExtentNode.isNull() )
701 mWgs84Extent = QgsXmlUtils::readRectangle( wgs84ExtentNode.toElement() );
702 }
703
704 mLegendPlaceholderImage = layerElement.attribute( QStringLiteral( "legendPlaceholderImage" ) );
705
706 if ( verticalCrs() != oldVerticalCrs )
707 emit verticalCrsChanged();
708 if ( mCrs3D != oldCrs3D )
709 emit crs3DChanged();
710
711 return ! layerError;
712} // bool QgsMapLayer::readLayerXML
713
714
715bool QgsMapLayer::readXml( const QDomNode &layer_node, QgsReadWriteContext &context )
716{
718
719 Q_UNUSED( layer_node )
720 Q_UNUSED( context )
721 // NOP by default; children will over-ride with behavior specific to them
722
723 // read Extent
725 {
726 const QDomNode extent3DNode = layer_node.namedItem( QStringLiteral( "extent3D" ) );
727 if ( extent3DNode.isNull() )
728 {
729 const QDomNode extentNode = layer_node.namedItem( QStringLiteral( "extent" ) );
730 if ( !extentNode.isNull() )
731 {
732 mExtent2D = QgsXmlUtils::readRectangle( extentNode.toElement() );
733 }
734 }
735 else
736 {
737 mExtent3D = QgsXmlUtils::readBox3D( extent3DNode.toElement() );
738 }
739 }
740
741 return true;
742} // void QgsMapLayer::readXml
743
744
745bool QgsMapLayer::writeLayerXml( QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context ) const
746{
748
749 if ( !mExtent3D.isNull() && dataProvider() && dataProvider()->elevationProperties() && dataProvider()->elevationProperties()->containsElevationData() )
750 layerElement.appendChild( QgsXmlUtils::writeBox3D( mExtent3D, document ) );
751 else if ( !mExtent2D.isNull() )
752 layerElement.appendChild( QgsXmlUtils::writeRectangle( mExtent2D, document ) );
753
754 if ( const QgsRectangle lWgs84Extent = wgs84Extent( true ); !lWgs84Extent.isNull() )
755 {
756 layerElement.appendChild( QgsXmlUtils::writeRectangle( lWgs84Extent, document, QStringLiteral( "wgs84extent" ) ) );
757 }
758
759 layerElement.setAttribute( QStringLiteral( "autoRefreshTime" ), QString::number( mRefreshTimer->interval() ) );
760 layerElement.setAttribute( QStringLiteral( "autoRefreshMode" ), qgsEnumValueToKey( mAutoRefreshMode ) );
761 layerElement.setAttribute( QStringLiteral( "refreshOnNotifyEnabled" ), mIsRefreshOnNofifyEnabled ? 1 : 0 );
762 layerElement.setAttribute( QStringLiteral( "refreshOnNotifyMessage" ), mRefreshOnNofifyMessage );
763
764 // ID
765 QDomElement layerId = document.createElement( QStringLiteral( "id" ) );
766 const QDomText layerIdText = document.createTextNode( id() );
767 layerId.appendChild( layerIdText );
768
769 layerElement.appendChild( layerId );
770
771 if ( mVerticalCrs.isValid() )
772 {
773 QDomElement verticalSrsNode = document.createElement( QStringLiteral( "verticalCrs" ) );
774 mVerticalCrs.writeXml( verticalSrsNode, document );
775 layerElement.appendChild( verticalSrsNode );
776 }
777
778 // data source
779 QDomElement dataSource = document.createElement( QStringLiteral( "datasource" ) );
780 const QgsDataProvider *provider = dataProvider();
781 const QString providerKey = provider ? provider->name() : QString();
782 const QString srcRaw = encodedSource( source(), context );
783 const QString src = providerKey.isEmpty() ? srcRaw : QgsProviderRegistry::instance()->absoluteToRelativeUri( providerKey, srcRaw, context );
784 const QDomText dataSourceText = document.createTextNode( src );
785 dataSource.appendChild( dataSourceText );
786 layerElement.appendChild( dataSource );
787
788 // layer name
789 QDomElement layerName = document.createElement( QStringLiteral( "layername" ) );
790 const QDomText layerNameText = document.createTextNode( name() );
791 layerName.appendChild( layerNameText );
792 layerElement.appendChild( layerName );
793
794 // layer short name
795
796 // TODO -- ideally this would be in QgsMapLayerServerProperties::writeXml, but that's currently
797 // only called for SOME map layer subclasses!
798 if ( !mServerProperties->shortName().isEmpty() )
799 {
800 QDomElement layerShortName = document.createElement( QStringLiteral( "shortname" ) );
801 const QDomText layerShortNameText = document.createTextNode( mServerProperties->shortName() );
802 layerShortName.appendChild( layerShortNameText );
803 layerElement.appendChild( layerShortName );
804 }
805
806 // layer title
807 if ( !mServerProperties->title().isEmpty() )
808 {
809 QDomElement layerTitle = document.createElement( QStringLiteral( "title" ) );
810 const QDomText layerTitleText = document.createTextNode( mServerProperties->title() );
811 layerTitle.appendChild( layerTitleText );
812
813 if ( mServerProperties->title() != mServerProperties->wfsTitle() )
814 {
815 layerTitle.setAttribute( "wfs", mServerProperties->wfsTitle() );
816 }
817
818 layerElement.appendChild( layerTitle );
819 }
820
821 // layer abstract
822 if ( !mServerProperties->abstract().isEmpty() )
823 {
824 QDomElement layerAbstract = document.createElement( QStringLiteral( "abstract" ) );
825 const QDomText layerAbstractText = document.createTextNode( mServerProperties->abstract() );
826 layerAbstract.appendChild( layerAbstractText );
827 layerElement.appendChild( layerAbstract );
828 }
829
830 // layer keyword list
831 const QStringList keywordStringList = mServerProperties->keywordList().split( ',' );
832 if ( !keywordStringList.isEmpty() )
833 {
834 QDomElement layerKeywordList = document.createElement( QStringLiteral( "keywordList" ) );
835 for ( int i = 0; i < keywordStringList.size(); ++i )
836 {
837 QDomElement layerKeywordValue = document.createElement( QStringLiteral( "value" ) );
838 const QDomText layerKeywordText = document.createTextNode( keywordStringList.at( i ).trimmed() );
839 layerKeywordValue.appendChild( layerKeywordText );
840 layerKeywordList.appendChild( layerKeywordValue );
841 }
842 layerElement.appendChild( layerKeywordList );
843 }
844
845 // layer dataUrl
846 const QString aDataUrl = mServerProperties->dataUrl();
847 if ( !aDataUrl.isEmpty() )
848 {
849 QDomElement layerDataUrl = document.createElement( QStringLiteral( "dataUrl" ) );
850 const QDomText layerDataUrlText = document.createTextNode( aDataUrl );
851 layerDataUrl.appendChild( layerDataUrlText );
852 layerDataUrl.setAttribute( QStringLiteral( "format" ), mServerProperties->dataUrlFormat() );
853 layerElement.appendChild( layerDataUrl );
854 }
855
856 // layer legendUrl
857 const QString aLegendUrl = legendUrl();
858 if ( !aLegendUrl.isEmpty() )
859 {
860 QDomElement layerLegendUrl = document.createElement( QStringLiteral( "legendUrl" ) );
861 const QDomText layerLegendUrlText = document.createTextNode( aLegendUrl );
862 layerLegendUrl.appendChild( layerLegendUrlText );
863 layerLegendUrl.setAttribute( QStringLiteral( "format" ), legendUrlFormat() );
864 layerElement.appendChild( layerLegendUrl );
865 }
866
867 // layer attribution
868 const QString aAttribution = mServerProperties->attribution();
869 if ( !aAttribution.isEmpty() )
870 {
871 QDomElement layerAttribution = document.createElement( QStringLiteral( "attribution" ) );
872 const QDomText layerAttributionText = document.createTextNode( aAttribution );
873 layerAttribution.appendChild( layerAttributionText );
874 layerAttribution.setAttribute( QStringLiteral( "href" ), mServerProperties->attributionUrl() );
875 layerElement.appendChild( layerAttribution );
876 }
877
878 // timestamp if supported
879 if ( timestamp() > QDateTime() )
880 {
881 QDomElement stamp = document.createElement( QStringLiteral( "timestamp" ) );
882 const QDomText stampText = document.createTextNode( timestamp().toString( Qt::ISODate ) );
883 stamp.appendChild( stampText );
884 layerElement.appendChild( stamp );
885 }
886
887 layerElement.appendChild( layerName );
888
889 // zorder
890 // This is no longer stored in the project file. It is superfluous since the layers
891 // are written and read in the proper order.
892
893 // spatial reference system id
894 QDomElement mySrsElement = document.createElement( QStringLiteral( "srs" ) );
895 mCRS.writeXml( mySrsElement, document );
896 layerElement.appendChild( mySrsElement );
897
898 // layer metadata
899 QDomElement myMetadataElem = document.createElement( QStringLiteral( "resourceMetadata" ) );
900 mMetadata.writeMetadataXml( myMetadataElem, document );
901 layerElement.appendChild( myMetadataElem );
902
903 layerElement.setAttribute( QStringLiteral( "legendPlaceholderImage" ), mLegendPlaceholderImage );
904
905 // now append layer node to map layer node
906 return writeXml( layerElement, document, context );
907}
908
909void QgsMapLayer::writeCommonStyle( QDomElement &layerElement, QDomDocument &document,
910 const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories ) const
911{
913
914 // save categories
915 const QMetaEnum metaEnum = QMetaEnum::fromType<QgsMapLayer::StyleCategories>();
916 const QString categoriesKeys( metaEnum.valueToKeys( static_cast<int>( categories ) ) );
917 layerElement.setAttribute( QStringLiteral( "styleCategories" ), categoriesKeys );
918
919 if ( categories.testFlag( Rendering ) )
920 {
921 // use scale dependent visibility flag
922 layerElement.setAttribute( QStringLiteral( "hasScaleBasedVisibilityFlag" ), hasScaleBasedVisibility() ? 1 : 0 );
923 layerElement.setAttribute( QStringLiteral( "maxScale" ), QString::number( maximumScale() ) );
924 layerElement.setAttribute( QStringLiteral( "minScale" ), QString::number( minimumScale() ) );
925 layerElement.setAttribute( QStringLiteral( "autoRefreshMode" ), qgsEnumValueToKey( mAutoRefreshMode ) );
926 layerElement.setAttribute( QStringLiteral( "autoRefreshTime" ), QString::number( autoRefreshInterval() ) );
927 }
928
929 if ( categories.testFlag( Symbology3D ) )
930 {
931 if ( m3DRenderer )
932 {
933 QDomElement renderer3DElem = document.createElement( QStringLiteral( "renderer-3d" ) );
934 renderer3DElem.setAttribute( QStringLiteral( "type" ), m3DRenderer->type() );
935 m3DRenderer->writeXml( renderer3DElem, context );
936 layerElement.appendChild( renderer3DElem );
937 }
938 }
939
940 if ( categories.testFlag( LayerConfiguration ) )
941 {
942 // flags
943 // this code is saving automatically all the flags entries
944 QDomElement layerFlagsElem = document.createElement( QStringLiteral( "flags" ) );
945 const auto enumMap = qgsEnumMap<QgsMapLayer::LayerFlag>();
946 for ( auto it = enumMap.constBegin(); it != enumMap.constEnd(); ++it )
947 {
948 const bool flagValue = mFlags.testFlag( it.key() );
949 QDomElement flagElem = document.createElement( it.value() );
950 flagElem.appendChild( document.createTextNode( QString::number( flagValue ) ) );
951 layerFlagsElem.appendChild( flagElem );
952 }
953 layerElement.appendChild( layerFlagsElem );
954 }
955
956 if ( categories.testFlag( Temporal ) )
957 {
959 properties->writeXml( layerElement, document, context );
960 }
961
962 if ( categories.testFlag( Elevation ) )
963 {
965 properties->writeXml( layerElement, document, context );
966 }
967
968 if ( categories.testFlag( Notes ) && QgsLayerNotesUtils::layerHasNotes( this ) )
969 {
970 QDomElement notesElem = document.createElement( QStringLiteral( "userNotes" ) );
971 notesElem.setAttribute( QStringLiteral( "value" ), QgsLayerNotesUtils::layerNotes( this ) );
972 layerElement.appendChild( notesElem );
973 }
974
975 // custom properties
976 if ( categories.testFlag( CustomProperties ) )
977 {
978 writeCustomProperties( layerElement, document );
979 }
980}
981
982
983bool QgsMapLayer::writeXml( QDomNode &layer_node, QDomDocument &document, const QgsReadWriteContext &context ) const
984{
986
987 Q_UNUSED( layer_node )
988 Q_UNUSED( document )
989 Q_UNUSED( context )
990 // NOP by default; children will over-ride with behavior specific to them
991
992 return true;
993}
994
995QString QgsMapLayer::encodedSource( const QString &source, const QgsReadWriteContext &context ) const
996{
998
999 Q_UNUSED( context )
1000 return source;
1001}
1002
1003QString QgsMapLayer::decodedSource( const QString &source, const QString &dataProvider, const QgsReadWriteContext &context ) const
1004{
1006
1007 Q_UNUSED( context )
1008 Q_UNUSED( dataProvider )
1009 return source;
1010}
1011
1013{
1015
1017 if ( m3DRenderer )
1018 m3DRenderer->resolveReferences( *project );
1019}
1020
1021
1022void QgsMapLayer::readCustomProperties( const QDomNode &layerNode, const QString &keyStartsWith )
1023{
1025
1026 const QgsObjectCustomProperties oldKeys = mCustomProperties;
1027
1028 mCustomProperties.readXml( layerNode, keyStartsWith );
1029
1030 for ( const QString &key : mCustomProperties.keys() )
1031 {
1032 if ( !oldKeys.contains( key ) || mCustomProperties.value( key ) != oldKeys.value( key ) )
1033 {
1034 emit customPropertyChanged( key );
1035 }
1036 }
1037}
1038
1039void QgsMapLayer::writeCustomProperties( QDomNode &layerNode, QDomDocument &doc ) const
1040{
1042
1043 mCustomProperties.writeXml( layerNode, doc );
1044}
1045
1046void QgsMapLayer::readStyleManager( const QDomNode &layerNode )
1047{
1049
1050 const QDomElement styleMgrElem = layerNode.firstChildElement( QStringLiteral( "map-layer-style-manager" ) );
1051 if ( !styleMgrElem.isNull() )
1052 mStyleManager->readXml( styleMgrElem );
1053 else
1054 mStyleManager->reset();
1055}
1056
1057void QgsMapLayer::writeStyleManager( QDomNode &layerNode, QDomDocument &doc ) const
1058{
1060
1061 if ( mStyleManager )
1062 {
1063 QDomElement styleMgrElem = doc.createElement( QStringLiteral( "map-layer-style-manager" ) );
1064 mStyleManager->writeXml( styleMgrElem );
1065 layerNode.appendChild( styleMgrElem );
1066 }
1067}
1068
1070{
1072
1073 return mMapTipTemplate;
1074}
1075
1076void QgsMapLayer::setMapTipTemplate( const QString &mapTip )
1077{
1079
1080 if ( mMapTipTemplate == mapTip )
1081 return;
1082
1083 mMapTipTemplate = mapTip;
1084 emit mapTipTemplateChanged();
1085}
1086
1088{
1090
1091 if ( mMapTipsEnabled == enabled )
1092 return;
1093
1094 mMapTipsEnabled = enabled;
1095 emit mapTipsEnabledChanged();
1096}
1097
1099{
1101
1102 return mMapTipsEnabled;
1103}
1104
1106{
1108 if ( layerReadFlags & QgsMapLayer::FlagTrustLayerMetadata )
1109 {
1111 }
1112 if ( layerReadFlags & QgsMapLayer::FlagForceReadOnly )
1113 {
1115 }
1116
1117 if ( layerReadFlags & QgsMapLayer::FlagReadExtentFromXml )
1118 {
1119 const QDomNode extent3DNode = layerNode.namedItem( QStringLiteral( "extent3D" ) );
1120 if ( extent3DNode.isNull() )
1121 {
1122 const QDomNode extentNode = layerNode.namedItem( QStringLiteral( "extent" ) );
1123 if ( !extentNode.isNull() )
1124 {
1126 }
1127 }
1128 else
1129 {
1131 }
1132 }
1133
1134 return flags;
1135}
1136
1138{
1139 // because QgsVirtualLayerProvider is not anywhere NEAR thread safe:
1141
1142 return mValid;
1143}
1144
1145#if 0
1146void QgsMapLayer::connectNotify( const char *signal )
1147{
1148 Q_UNUSED( signal )
1149 QgsDebugMsgLevel( "QgsMapLayer connected to " + QString( signal ), 3 );
1150} // QgsMapLayer::connectNotify
1151#endif
1152
1153bool QgsMapLayer::isInScaleRange( double scale ) const
1154{
1155 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
1157
1158 // mMinScale (denominator!) is inclusive ( >= --> In range )
1159 // mMaxScale (denominator!) is exclusive ( < --> In range )
1160 return !mScaleBasedVisibility
1161 || ( ( mMinScale == 0 || !QgsScaleUtils::lessThanMaximumScale( scale, mMinScale ) )
1162 && ( mMaxScale == 0 || !QgsScaleUtils::equalToOrGreaterThanMinimumScale( scale, mMaxScale ) ) );
1163}
1164
1166{
1167 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
1169
1170 return mScaleBasedVisibility;
1171}
1172
1174{
1176
1177 return mAutoRefreshMode != Qgis::AutoRefreshMode::Disabled;;
1178}
1179
1181{
1183
1184 return mAutoRefreshMode;
1185}
1186
1188{
1190
1191 return mRefreshTimer->interval();
1192}
1193
1195{
1197
1198 if ( interval <= 0 )
1199 {
1200 mRefreshTimer->stop();
1201 mRefreshTimer->setInterval( 0 );
1203 }
1204 else
1205 {
1206 mRefreshTimer->setInterval( interval );
1207 }
1208 emit autoRefreshIntervalChanged( mRefreshTimer->isActive() ? mRefreshTimer->interval() : 0 );
1209}
1210
1217
1219{
1221
1222 if ( mode == mAutoRefreshMode )
1223 return;
1224
1225 mAutoRefreshMode = mode;
1226 switch ( mAutoRefreshMode )
1227 {
1229 mRefreshTimer->stop();
1230 break;
1231
1234 if ( mRefreshTimer->interval() > 0 )
1235 mRefreshTimer->start();
1236 break;
1237 }
1238
1239 emit autoRefreshIntervalChanged( mRefreshTimer->isActive() ? mRefreshTimer->interval() : 0 );
1240}
1241
1243{
1245
1246 return mMetadata;
1247}
1248
1250{
1252
1253 mMinScale = scale;
1254}
1255
1257{
1259
1260 return mMinScale;
1261}
1262
1264{
1266
1267 mMaxScale = scale;
1268}
1269
1271{
1273
1274 mScaleBasedVisibility = enabled;
1275}
1276
1278{
1280
1281 return mMaxScale;
1282}
1283
1284QStringList QgsMapLayer::subLayers() const
1285{
1287
1288 return QStringList();
1289}
1290
1291void QgsMapLayer::setLayerOrder( const QStringList &layers )
1292{
1294
1295 Q_UNUSED( layers )
1296}
1297
1298void QgsMapLayer::setSubLayerVisibility( const QString &name, bool vis )
1299{
1301
1302 Q_UNUSED( name )
1303 Q_UNUSED( vis )
1304}
1305
1307{
1309
1310 return false;
1311}
1312
1314{
1315 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
1317
1318 return mCRS;
1319}
1320
1322{
1323 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
1325
1326 switch ( mCRS.type() )
1327 {
1328 case Qgis::CrsType::Vertical: // would hope this never happens!
1329 QgsDebugError( QStringLiteral( "Layer has a vertical CRS set as the horizontal CRS!" ) );
1330 return mCRS;
1331
1333 return mCRS.verticalCrs();
1334
1346 break;
1347 }
1348 return mVerticalCrs;
1349}
1350
1352{
1354
1355 return mCrs3D.isValid() ? mCrs3D : mCRS;
1356}
1357
1358void QgsMapLayer::setCrs( const QgsCoordinateReferenceSystem &srs, bool emitSignal )
1359{
1361 if ( mCRS == srs )
1362 return;
1363
1364 const QgsCoordinateReferenceSystem oldVerticalCrs = verticalCrs();
1365 const QgsCoordinateReferenceSystem oldCrs3D = mCrs3D;
1366
1367 mCRS = srs;
1368
1370 {
1371 mCRS.setValidationHint( tr( "Specify CRS for layer %1" ).arg( name() ) );
1372 mCRS.validate();
1373 }
1374
1375 rebuildCrs3D();
1376
1377 if ( emitSignal )
1378 emit crsChanged();
1379
1380 // Did vertical crs also change as a result of this? If so, emit signal
1381 if ( oldVerticalCrs != verticalCrs() )
1382 emit verticalCrsChanged();
1383 if ( oldCrs3D != mCrs3D )
1384 emit crs3DChanged();
1385}
1386
1388{
1390 bool res = true;
1391 if ( crs.isValid() )
1392 {
1393 // validate that passed crs is a vertical crs
1394 switch ( crs.type() )
1395 {
1397 break;
1398
1411 if ( errorMessage )
1412 *errorMessage = QObject::tr( "Specified CRS is a %1 CRS, not a Vertical CRS" ).arg( qgsEnumValueToKey( crs.type() ) );
1413 return false;
1414 }
1415 }
1416
1417 if ( crs != mVerticalCrs )
1418 {
1419 const QgsCoordinateReferenceSystem oldVerticalCrs = verticalCrs();
1420 const QgsCoordinateReferenceSystem oldCrs3D = mCrs3D;
1421
1422 switch ( mCRS.type() )
1423 {
1425 if ( crs != oldVerticalCrs )
1426 {
1427 if ( errorMessage )
1428 *errorMessage = QObject::tr( "Layer CRS is a Compound CRS, specified Vertical CRS will be ignored" );
1429 return false;
1430 }
1431 break;
1432
1434 if ( crs != oldVerticalCrs )
1435 {
1436 if ( errorMessage )
1437 *errorMessage = QObject::tr( "Layer CRS is a Geographic 3D CRS, specified Vertical CRS will be ignored" );
1438 return false;
1439 }
1440 break;
1441
1443 if ( crs != oldVerticalCrs )
1444 {
1445 if ( errorMessage )
1446 *errorMessage = QObject::tr( "Layer CRS is a Geocentric CRS, specified Vertical CRS will be ignored" );
1447 return false;
1448 }
1449 break;
1450
1452 if ( mCRS.hasVerticalAxis() && crs != oldVerticalCrs )
1453 {
1454 if ( errorMessage )
1455 *errorMessage = QObject::tr( "Layer CRS is a Projected 3D CRS, specified Vertical CRS will be ignored" );
1456 return false;
1457 }
1458 break;
1459
1469 break;
1470 }
1471
1472 mVerticalCrs = crs;
1473 res = rebuildCrs3D( errorMessage );
1474
1475 // only emit signal if vertical crs was actually changed, so eg if mCrs is compound
1476 // then we haven't actually changed the vertical crs by this call!
1477 if ( verticalCrs() != oldVerticalCrs )
1478 emit verticalCrsChanged();
1479 if ( mCrs3D != oldCrs3D )
1480 emit crs3DChanged();
1481 }
1482 return res;
1483}
1484
1486{
1488
1489 const QgsDataProvider *lDataProvider = dataProvider();
1490 return lDataProvider ? lDataProvider->transformContext() : QgsCoordinateTransformContext();
1491}
1492
1493QString QgsMapLayer::formatLayerName( const QString &name )
1494{
1495 QString layerName( name );
1496 layerName.replace( '_', ' ' );
1498 return layerName;
1499}
1500
1501QString QgsMapLayer::baseURI( PropertyType type ) const
1502{
1504
1505 QString myURI = publicSource();
1506
1507 // first get base path for delimited text, spatialite and OGR layers,
1508 // as in these cases URI may contain layer name and/or additional
1509 // information. This also strips prefix in case if VSIFILE mechanism
1510 // is used
1511 if ( providerType() == QLatin1String( "ogr" ) || providerType() == QLatin1String( "delimitedtext" )
1512 || providerType() == QLatin1String( "gdal" ) || providerType() == QLatin1String( "spatialite" ) )
1513 {
1514 QVariantMap components = QgsProviderRegistry::instance()->decodeUri( providerType(), myURI );
1515 myURI = components["path"].toString();
1516 }
1517
1518 QFileInfo myFileInfo( myURI );
1519 QString key;
1520
1521 if ( myFileInfo.exists() )
1522 {
1523 // if file is using the /vsizip/ or /vsigzip/ mechanism, cleanup the name
1524 if ( myURI.endsWith( QLatin1String( ".gz" ), Qt::CaseInsensitive ) )
1525 myURI.chop( 3 );
1526 else if ( myURI.endsWith( QLatin1String( ".zip" ), Qt::CaseInsensitive ) )
1527 myURI.chop( 4 );
1528 else if ( myURI.endsWith( QLatin1String( ".tar" ), Qt::CaseInsensitive ) )
1529 myURI.chop( 4 );
1530 else if ( myURI.endsWith( QLatin1String( ".tar.gz" ), Qt::CaseInsensitive ) )
1531 myURI.chop( 7 );
1532 else if ( myURI.endsWith( QLatin1String( ".tgz" ), Qt::CaseInsensitive ) )
1533 myURI.chop( 4 );
1534 myFileInfo.setFile( myURI );
1535 // get the file name for our .qml style file
1536 key = myFileInfo.path() + QDir::separator() + myFileInfo.completeBaseName() + QgsMapLayer::extensionPropertyType( type );
1537 }
1538 else
1539 {
1540 key = publicSource();
1541 }
1542
1543 return key;
1544}
1545
1547{
1549
1550 return baseURI( PropertyType::Metadata );
1551}
1552
1553QString QgsMapLayer::saveDefaultMetadata( bool &resultFlag )
1554{
1556
1558 {
1559 if ( metadata->providerCapabilities() & QgsProviderMetadata::SaveLayerMetadata )
1560 {
1561 try
1562 {
1563 QString errorMessage;
1564 resultFlag = QgsProviderRegistry::instance()->saveLayerMetadata( providerType(), mDataSource, mMetadata, errorMessage );
1565 if ( resultFlag )
1566 return tr( "Successfully saved default layer metadata" );
1567 else
1568 return errorMessage;
1569 }
1570 catch ( QgsNotSupportedException &e )
1571 {
1572 resultFlag = false;
1573 return e.what();
1574 }
1575 }
1576 }
1577
1578 // fallback default metadata saving method, for providers which don't support (or implement) saveLayerMetadata
1579 return saveNamedMetadata( metadataUri(), resultFlag );
1580}
1581
1582QString QgsMapLayer::loadDefaultMetadata( bool &resultFlag )
1583{
1585
1586 return loadNamedMetadata( metadataUri(), resultFlag );
1587}
1588
1590{
1592
1593 return baseURI( PropertyType::Style );
1594}
1595
1602
1603bool QgsMapLayer::loadNamedMetadataFromDatabase( const QString &db, const QString &uri, QString &qmd )
1604{
1606
1607 return loadNamedPropertyFromDatabase( db, uri, qmd, PropertyType::Metadata );
1608}
1609
1610bool QgsMapLayer::loadNamedStyleFromDatabase( const QString &db, const QString &uri, QString &qml )
1611{
1613
1614 return loadNamedPropertyFromDatabase( db, uri, qml, PropertyType::Style );
1615}
1616
1617bool QgsMapLayer::loadNamedPropertyFromDatabase( const QString &db, const QString &uri, QString &xml, QgsMapLayer::PropertyType type )
1618{
1620
1621 QgsDebugMsgLevel( QStringLiteral( "db = %1 uri = %2" ).arg( db, uri ), 4 );
1622
1623 bool resultFlag = false;
1624
1625 // read from database
1628
1629 int myResult;
1630
1631 QgsDebugMsgLevel( QStringLiteral( "Trying to load style or metadata for \"%1\" from \"%2\"" ).arg( uri, db ), 4 );
1632
1633 if ( db.isEmpty() || !QFile( db ).exists() )
1634 return false;
1635
1636 myResult = database.open_v2( db, SQLITE_OPEN_READONLY, nullptr );
1637 if ( myResult != SQLITE_OK )
1638 {
1639 return false;
1640 }
1641
1642 QString mySql;
1643 switch ( type )
1644 {
1645 case Metadata:
1646 mySql = QStringLiteral( "select qmd from tbl_metadata where metadata=?" );
1647 break;
1648
1649 case Style:
1650 mySql = QStringLiteral( "select qml from tbl_styles where style=?" );
1651 break;
1652 }
1653
1654 statement = database.prepare( mySql, myResult );
1655 if ( myResult == SQLITE_OK )
1656 {
1657 QByteArray param = uri.toUtf8();
1658
1659 if ( sqlite3_bind_text( statement.get(), 1, param.data(), param.length(), SQLITE_STATIC ) == SQLITE_OK &&
1660 sqlite3_step( statement.get() ) == SQLITE_ROW )
1661 {
1662 xml = QString::fromUtf8( reinterpret_cast< const char * >( sqlite3_column_text( statement.get(), 0 ) ) );
1663 resultFlag = true;
1664 }
1665 }
1666 return resultFlag;
1667}
1668
1669
1670QString QgsMapLayer::loadNamedStyle( const QString &uri, bool &resultFlag, QgsMapLayer::StyleCategories categories, Qgis::LoadStyleFlags flags )
1671{
1673
1674 return loadNamedStyle( uri, resultFlag, false, categories, flags );
1675}
1676
1677QString QgsMapLayer::loadNamedProperty( const QString &uri, QgsMapLayer::PropertyType type, bool &namedPropertyExists, bool &propertySuccessfullyLoaded, StyleCategories categories, Qgis::LoadStyleFlags flags )
1678{
1680
1681 QgsDebugMsgLevel( QStringLiteral( "uri = %1 myURI = %2" ).arg( uri, publicSource() ), 4 );
1682
1683 namedPropertyExists = false;
1684 propertySuccessfullyLoaded = false;
1685 if ( uri.isEmpty() )
1686 return QString();
1687
1688 QDomDocument myDocument( QStringLiteral( "qgis" ) );
1689
1690 // location of problem associated with errorMsg
1691 int line, column;
1692 QString myErrorMessage;
1693
1694 QFile myFile( uri );
1695 if ( myFile.open( QFile::ReadOnly ) )
1696 {
1697 QgsDebugMsgLevel( QStringLiteral( "file found %1" ).arg( uri ), 2 );
1698 namedPropertyExists = true;
1699
1700 // read file
1701 propertySuccessfullyLoaded = myDocument.setContent( &myFile, &myErrorMessage, &line, &column );
1702 if ( !propertySuccessfullyLoaded )
1703 myErrorMessage = tr( "%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1704 myFile.close();
1705 }
1706 else
1707 {
1708 const QFileInfo project( QgsProject::instance()->fileName() ); // skip-keyword-check
1709 QgsDebugMsgLevel( QStringLiteral( "project fileName: %1" ).arg( project.absoluteFilePath() ), 4 );
1710
1711 QString xml;
1712 switch ( type )
1713 {
1714 case QgsMapLayer::Style:
1715 {
1716 if ( loadNamedStyleFromDatabase( QDir( QgsApplication::qgisSettingsDirPath() ).absoluteFilePath( QStringLiteral( "qgis.qmldb" ) ), uri, xml ) ||
1717 ( project.exists() && loadNamedStyleFromDatabase( project.absoluteDir().absoluteFilePath( project.baseName() + ".qmldb" ), uri, xml ) ) ||
1718 loadNamedStyleFromDatabase( QDir( QgsApplication::pkgDataPath() ).absoluteFilePath( QStringLiteral( "resources/qgis.qmldb" ) ), uri, xml ) )
1719 {
1720 namedPropertyExists = true;
1721 propertySuccessfullyLoaded = myDocument.setContent( xml, &myErrorMessage, &line, &column );
1722 if ( !propertySuccessfullyLoaded )
1723 {
1724 myErrorMessage = tr( "%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1725 }
1726 }
1727 else
1728 {
1730 {
1731 myErrorMessage = tr( "Style not found in database" );
1732 }
1733 }
1734 break;
1735 }
1737 {
1738 if ( loadNamedMetadataFromDatabase( QDir( QgsApplication::qgisSettingsDirPath() ).absoluteFilePath( QStringLiteral( "qgis.qmldb" ) ), uri, xml ) ||
1739 ( project.exists() && loadNamedMetadataFromDatabase( project.absoluteDir().absoluteFilePath( project.baseName() + ".qmldb" ), uri, xml ) ) ||
1740 loadNamedMetadataFromDatabase( QDir( QgsApplication::pkgDataPath() ).absoluteFilePath( QStringLiteral( "resources/qgis.qmldb" ) ), uri, xml ) )
1741 {
1742 namedPropertyExists = true;
1743 propertySuccessfullyLoaded = myDocument.setContent( xml, &myErrorMessage, &line, &column );
1744 if ( !propertySuccessfullyLoaded )
1745 {
1746 myErrorMessage = tr( "%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1747 }
1748 }
1749 else
1750 {
1751 myErrorMessage = tr( "Metadata not found in database" );
1752 }
1753 break;
1754 }
1755 }
1756 }
1757
1758 if ( !propertySuccessfullyLoaded )
1759 {
1760 return myErrorMessage;
1761 }
1762
1763 switch ( type )
1764 {
1765 case QgsMapLayer::Style:
1766 propertySuccessfullyLoaded = importNamedStyle( myDocument, myErrorMessage, categories );
1767 if ( !propertySuccessfullyLoaded )
1768 myErrorMessage = tr( "Loading style file %1 failed because:\n%2" ).arg( uri, myErrorMessage );
1769 break;
1771 propertySuccessfullyLoaded = importNamedMetadata( myDocument, myErrorMessage );
1772 if ( !propertySuccessfullyLoaded )
1773 myErrorMessage = tr( "Loading metadata file %1 failed because:\n%2" ).arg( uri, myErrorMessage );
1774 break;
1775 }
1776 return myErrorMessage;
1777}
1778
1779bool QgsMapLayer::importNamedMetadata( QDomDocument &document, QString &errorMessage )
1780{
1782
1783 const QDomElement myRoot = document.firstChildElement( QStringLiteral( "qgis" ) );
1784 if ( myRoot.isNull() )
1785 {
1786 errorMessage = tr( "Root <qgis> element could not be found" );
1787 return false;
1788 }
1789
1790 return mMetadata.readMetadataXml( myRoot );
1791}
1792
1793bool QgsMapLayer::importNamedStyle( QDomDocument &myDocument, QString &myErrorMessage, QgsMapLayer::StyleCategories categories )
1794{
1796
1797 const QDomElement myRoot = myDocument.firstChildElement( QStringLiteral( "qgis" ) );
1798 if ( myRoot.isNull() )
1799 {
1800 myErrorMessage = tr( "Root <qgis> element could not be found" );
1801 return false;
1802 }
1803
1804 // get style file version string, if any
1805 const QgsProjectVersion fileVersion( myRoot.attribute( QStringLiteral( "version" ) ) );
1806 const QgsProjectVersion thisVersion( Qgis::version() );
1807
1808 if ( thisVersion > fileVersion )
1809 {
1810 QgsProjectFileTransform styleFile( myDocument, fileVersion );
1811 styleFile.updateRevision( thisVersion );
1812 }
1813
1814 // Get source categories
1815 const QgsMapLayer::StyleCategories sourceCategories = QgsXmlUtils::readFlagAttribute( myRoot, QStringLiteral( "styleCategories" ), QgsMapLayer::AllStyleCategories );
1816
1817 //Test for matching geometry type on vector layers when applying, if geometry type is given in the style
1818 if ( ( sourceCategories.testFlag( QgsMapLayer::Symbology ) || sourceCategories.testFlag( QgsMapLayer::Symbology3D ) ) &&
1819 ( categories.testFlag( QgsMapLayer::Symbology ) || categories.testFlag( QgsMapLayer::Symbology3D ) ) )
1820 {
1821 if ( type() == Qgis::LayerType::Vector && !myRoot.firstChildElement( QStringLiteral( "layerGeometryType" ) ).isNull() )
1822 {
1823 QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( this );
1824 const Qgis::GeometryType importLayerGeometryType = static_cast<Qgis::GeometryType>( myRoot.firstChildElement( QStringLiteral( "layerGeometryType" ) ).text().toInt() );
1825 if ( importLayerGeometryType != Qgis::GeometryType::Unknown && vl->geometryType() != importLayerGeometryType )
1826 {
1827 myErrorMessage = tr( "Cannot apply style with symbology to layer with a different geometry type" );
1828 return false;
1829 }
1830 }
1831 }
1832
1834 return readSymbology( myRoot, myErrorMessage, context, categories ); // TODO: support relative paths in QML?
1835}
1836
1837void QgsMapLayer::exportNamedMetadata( QDomDocument &doc, QString &errorMsg ) const
1838{
1840
1841 QDomImplementation DomImplementation;
1842 const QDomDocumentType documentType = DomImplementation.createDocumentType( QStringLiteral( "qgis" ), QStringLiteral( "http://mrcc.com/qgis.dtd" ), QStringLiteral( "SYSTEM" ) );
1843 QDomDocument myDocument( documentType );
1844
1845 QDomElement myRootNode = myDocument.createElement( QStringLiteral( "qgis" ) );
1846 myRootNode.setAttribute( QStringLiteral( "version" ), Qgis::version() );
1847 myDocument.appendChild( myRootNode );
1848
1849 if ( !mMetadata.writeMetadataXml( myRootNode, myDocument ) )
1850 {
1851 errorMsg = QObject::tr( "Could not save metadata" );
1852 return;
1853 }
1854
1855 doc = myDocument;
1856}
1857
1858void QgsMapLayer::exportNamedStyle( QDomDocument &doc, QString &errorMsg, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories ) const
1859{
1861
1862 QDomImplementation DomImplementation;
1863 const QDomDocumentType documentType = DomImplementation.createDocumentType( QStringLiteral( "qgis" ), QStringLiteral( "http://mrcc.com/qgis.dtd" ), QStringLiteral( "SYSTEM" ) );
1864 QDomDocument myDocument( documentType );
1865
1866 QDomElement myRootNode = myDocument.createElement( QStringLiteral( "qgis" ) );
1867 myRootNode.setAttribute( QStringLiteral( "version" ), Qgis::version() );
1868 myDocument.appendChild( myRootNode );
1869
1870 if ( !writeSymbology( myRootNode, myDocument, errorMsg, context, categories ) ) // TODO: support relative paths in QML?
1871 {
1872 errorMsg = QObject::tr( "Could not save symbology because:\n%1" ).arg( errorMsg );
1873 return;
1874 }
1875
1876 /*
1877 * Check to see if the layer is vector - in which case we should also export its geometryType
1878 * to avoid eventually pasting to a layer with a different geometry
1879 */
1880 if ( type() == Qgis::LayerType::Vector )
1881 {
1882 //Getting the selectionLayer geometry
1883 const QgsVectorLayer *vl = qobject_cast<const QgsVectorLayer *>( this );
1884 const QString geoType = QString::number( static_cast<int>( vl->geometryType() ) );
1885
1886 //Adding geometryinformation
1887 QDomElement layerGeometryType = myDocument.createElement( QStringLiteral( "layerGeometryType" ) );
1888 const QDomText type = myDocument.createTextNode( geoType );
1889
1890 layerGeometryType.appendChild( type );
1891 myRootNode.appendChild( layerGeometryType );
1892 }
1893
1894 doc = myDocument;
1895}
1896
1897QString QgsMapLayer::saveDefaultStyle( bool &resultFlag )
1898{
1900
1901 return saveDefaultStyle( resultFlag, AllStyleCategories );
1902}
1903
1904QString QgsMapLayer::saveDefaultStyle( bool &resultFlag, StyleCategories categories )
1905{
1907
1908 return saveNamedStyle( styleURI(), resultFlag, categories );
1909}
1910
1911QString QgsMapLayer::saveNamedMetadata( const QString &uri, bool &resultFlag )
1912{
1914
1915 return saveNamedProperty( uri, QgsMapLayer::Metadata, resultFlag );
1916}
1917
1918QString QgsMapLayer::loadNamedMetadata( const QString &uri, bool &resultFlag )
1919{
1921
1922 bool metadataExists = false;
1923 bool metadataSuccessfullyLoaded = false;
1924 const QString message = loadNamedProperty( uri, QgsMapLayer::Metadata, metadataExists, metadataSuccessfullyLoaded );
1925
1926 // TODO QGIS 4.0 -- fix API for loadNamedMetadata so we can return metadataExists too
1927 ( void )metadataExists;
1928 resultFlag = metadataSuccessfullyLoaded;
1929 return message;
1930}
1931
1932QString QgsMapLayer::saveNamedProperty( const QString &uri, QgsMapLayer::PropertyType type, bool &resultFlag, StyleCategories categories )
1933{
1935
1936 // check if the uri is a file or ends with .qml/.qmd,
1937 // which indicates that it should become one
1938 // everything else goes to the database
1939 QString filename;
1940
1941 QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( this );
1942 if ( vlayer && vlayer->providerType() == QLatin1String( "ogr" ) )
1943 {
1944 QStringList theURIParts = uri.split( '|' );
1945 filename = theURIParts[0];
1946 }
1947 else if ( vlayer && vlayer->providerType() == QLatin1String( "gpx" ) )
1948 {
1949 QStringList theURIParts = uri.split( '?' );
1950 filename = theURIParts[0];
1951 }
1952 else if ( vlayer && vlayer->providerType() == QLatin1String( "delimitedtext" ) )
1953 {
1954 filename = QUrl::fromEncoded( uri.toLatin1() ).toLocalFile();
1955 // toLocalFile() returns an empty string if theURI is a plain Windows-path, e.g. "C:/style.qml"
1956 if ( filename.isEmpty() )
1957 filename = uri;
1958 }
1959 else
1960 {
1961 filename = uri;
1962 }
1963
1964 QString myErrorMessage;
1965 QDomDocument myDocument;
1966 switch ( type )
1967 {
1968 case Metadata:
1969 exportNamedMetadata( myDocument, myErrorMessage );
1970 break;
1971
1972 case Style:
1973 const QgsReadWriteContext context;
1974 exportNamedStyle( myDocument, myErrorMessage, context, categories );
1975 break;
1976 }
1977
1978 const QFileInfo myFileInfo( filename );
1979 if ( myFileInfo.exists() || filename.endsWith( QgsMapLayer::extensionPropertyType( type ), Qt::CaseInsensitive ) )
1980 {
1981 const QFileInfo myDirInfo( myFileInfo.path() ); //excludes file name
1982 if ( !myDirInfo.isWritable() )
1983 {
1984 resultFlag = false;
1985 return tr( "The directory containing your dataset needs to be writable!" );
1986 }
1987
1988 // now construct the file name for our .qml or .qmd file
1989 const QString myFileName = myFileInfo.path() + QDir::separator() + myFileInfo.completeBaseName() + QgsMapLayer::extensionPropertyType( type );
1990
1991 QFile myFile( myFileName );
1992 if ( myFile.open( QFile::WriteOnly | QFile::Truncate ) )
1993 {
1994 QTextStream myFileStream( &myFile );
1995 // save as utf-8 with 2 spaces for indents
1996 myDocument.save( myFileStream, 2 );
1997 myFile.close();
1998 resultFlag = true;
1999 switch ( type )
2000 {
2001 case Metadata:
2002 return tr( "Created default metadata file as %1" ).arg( myFileName );
2003
2004 case Style:
2005 return tr( "Created default style file as %1" ).arg( myFileName );
2006 }
2007
2008 }
2009 else
2010 {
2011 resultFlag = false;
2012 switch ( type )
2013 {
2014 case Metadata:
2015 return tr( "ERROR: Failed to created default metadata file as %1. Check file permissions and retry." ).arg( myFileName );
2016
2017 case Style:
2018 return tr( "ERROR: Failed to created default style file as %1. Check file permissions and retry." ).arg( myFileName );
2019 }
2020 }
2021 }
2022 else
2023 {
2024 const QString qml = myDocument.toString();
2025
2026 // read from database
2029
2030 int myResult = database.open( QDir( QgsApplication::qgisSettingsDirPath() ).absoluteFilePath( QStringLiteral( "qgis.qmldb" ) ) );
2031 if ( myResult != SQLITE_OK )
2032 {
2033 return tr( "User database could not be opened." );
2034 }
2035
2036 QByteArray param0 = uri.toUtf8();
2037 QByteArray param1 = qml.toUtf8();
2038
2039 QString mySql;
2040 switch ( type )
2041 {
2042 case Metadata:
2043 mySql = QStringLiteral( "create table if not exists tbl_metadata(metadata varchar primary key,qmd varchar)" );
2044 break;
2045
2046 case Style:
2047 mySql = QStringLiteral( "create table if not exists tbl_styles(style varchar primary key,qml varchar)" );
2048 break;
2049 }
2050
2051 statement = database.prepare( mySql, myResult );
2052 if ( myResult == SQLITE_OK )
2053 {
2054 if ( sqlite3_step( statement.get() ) != SQLITE_DONE )
2055 {
2056 resultFlag = false;
2057 switch ( type )
2058 {
2059 case Metadata:
2060 return tr( "The metadata table could not be created." );
2061
2062 case Style:
2063 return tr( "The style table could not be created." );
2064 }
2065 }
2066 }
2067
2068 switch ( type )
2069 {
2070 case Metadata:
2071 mySql = QStringLiteral( "insert into tbl_metadata(metadata,qmd) values (?,?)" );
2072 break;
2073
2074 case Style:
2075 mySql = QStringLiteral( "insert into tbl_styles(style,qml) values (?,?)" );
2076 break;
2077 }
2078 statement = database.prepare( mySql, myResult );
2079 if ( myResult == SQLITE_OK )
2080 {
2081 if ( sqlite3_bind_text( statement.get(), 1, param0.data(), param0.length(), SQLITE_STATIC ) == SQLITE_OK &&
2082 sqlite3_bind_text( statement.get(), 2, param1.data(), param1.length(), SQLITE_STATIC ) == SQLITE_OK &&
2083 sqlite3_step( statement.get() ) == SQLITE_DONE )
2084 {
2085 resultFlag = true;
2086 switch ( type )
2087 {
2088 case Metadata:
2089 myErrorMessage = tr( "The metadata %1 was saved to database" ).arg( uri );
2090 break;
2091
2092 case Style:
2093 myErrorMessage = tr( "The style %1 was saved to database" ).arg( uri );
2094 break;
2095 }
2096 }
2097 }
2098
2099 if ( !resultFlag )
2100 {
2101 QString mySql;
2102 switch ( type )
2103 {
2104 case Metadata:
2105 mySql = QStringLiteral( "update tbl_metadata set qmd=? where metadata=?" );
2106 break;
2107
2108 case Style:
2109 mySql = QStringLiteral( "update tbl_styles set qml=? where style=?" );
2110 break;
2111 }
2112 statement = database.prepare( mySql, myResult );
2113 if ( myResult == SQLITE_OK )
2114 {
2115 if ( sqlite3_bind_text( statement.get(), 2, param0.data(), param0.length(), SQLITE_STATIC ) == SQLITE_OK &&
2116 sqlite3_bind_text( statement.get(), 1, param1.data(), param1.length(), SQLITE_STATIC ) == SQLITE_OK &&
2117 sqlite3_step( statement.get() ) == SQLITE_DONE )
2118 {
2119 resultFlag = true;
2120 switch ( type )
2121 {
2122 case Metadata:
2123 myErrorMessage = tr( "The metadata %1 was updated in the database." ).arg( uri );
2124 break;
2125
2126 case Style:
2127 myErrorMessage = tr( "The style %1 was updated in the database." ).arg( uri );
2128 break;
2129 }
2130 }
2131 else
2132 {
2133 resultFlag = false;
2134 switch ( type )
2135 {
2136 case Metadata:
2137 myErrorMessage = tr( "The metadata %1 could not be updated in the database." ).arg( uri );
2138 break;
2139
2140 case Style:
2141 myErrorMessage = tr( "The style %1 could not be updated in the database." ).arg( uri );
2142 break;
2143 }
2144 }
2145 }
2146 else
2147 {
2148 resultFlag = false;
2149 switch ( type )
2150 {
2151 case Metadata:
2152 myErrorMessage = tr( "The metadata %1 could not be inserted into database." ).arg( uri );
2153 break;
2154
2155 case Style:
2156 myErrorMessage = tr( "The style %1 could not be inserted into database." ).arg( uri );
2157 break;
2158 }
2159 }
2160 }
2161 }
2162
2163 return myErrorMessage;
2164}
2165
2166QString QgsMapLayer::saveNamedStyle( const QString &uri, bool &resultFlag, StyleCategories categories )
2167{
2169
2170 return saveNamedProperty( uri, QgsMapLayer::Style, resultFlag, categories );
2171}
2172
2173void QgsMapLayer::exportSldStyle( QDomDocument &doc, QString &errorMsg ) const
2174{
2175
2176 return exportSldStyleV2( doc, errorMsg, QgsSldExportContext() );
2177}
2178
2179void QgsMapLayer::exportSldStyleV2( QDomDocument &doc, QString &errorMsg, const QgsSldExportContext &exportContext ) const
2180{
2182
2183 QDomDocument myDocument = QDomDocument();
2184
2185 const QDomNode header = myDocument.createProcessingInstruction( QStringLiteral( "xml" ), QStringLiteral( "version=\"1.0\" encoding=\"UTF-8\"" ) );
2186 myDocument.appendChild( header );
2187
2188 const QgsVectorLayer *vlayer = qobject_cast<const QgsVectorLayer *>( this );
2189 const QgsRasterLayer *rlayer = qobject_cast<const QgsRasterLayer *>( this );
2190 if ( !vlayer && !rlayer )
2191 {
2192 errorMsg = tr( "Could not save symbology because:\n%1" )
2193 .arg( tr( "Only vector and raster layers are supported" ) );
2194 return;
2195 }
2196
2197 // Create the root element
2198 QDomElement root = myDocument.createElementNS( QStringLiteral( "http://www.opengis.net/sld" ), QStringLiteral( "StyledLayerDescriptor" ) );
2199 QDomElement layerNode;
2200 if ( vlayer )
2201 {
2202 root.setAttribute( QStringLiteral( "version" ), QStringLiteral( "1.1.0" ) );
2203 root.setAttribute( QStringLiteral( "xsi:schemaLocation" ), QStringLiteral( "http://www.opengis.net/sld http://schemas.opengis.net/sld/1.1.0/StyledLayerDescriptor.xsd" ) );
2204 root.setAttribute( QStringLiteral( "xmlns:ogc" ), QStringLiteral( "http://www.opengis.net/ogc" ) );
2205 root.setAttribute( QStringLiteral( "xmlns:se" ), QStringLiteral( "http://www.opengis.net/se" ) );
2206 root.setAttribute( QStringLiteral( "xmlns:xlink" ), QStringLiteral( "http://www.w3.org/1999/xlink" ) );
2207 root.setAttribute( QStringLiteral( "xmlns:xsi" ), QStringLiteral( "http://www.w3.org/2001/XMLSchema-instance" ) );
2208 myDocument.appendChild( root );
2209
2210 // Create the NamedLayer element
2211 layerNode = myDocument.createElement( QStringLiteral( "NamedLayer" ) );
2212 root.appendChild( layerNode );
2213 }
2214
2215 // note: Only SLD 1.0 version is generated because seems none is using SE1.1.0 at least for rasters
2216 if ( rlayer )
2217 {
2218 // Create the root element
2219 root.setAttribute( QStringLiteral( "version" ), QStringLiteral( "1.0.0" ) );
2220 root.setAttribute( QStringLiteral( "xmlns:gml" ), QStringLiteral( "http://www.opengis.net/gml" ) );
2221 root.setAttribute( QStringLiteral( "xmlns:ogc" ), QStringLiteral( "http://www.opengis.net/ogc" ) );
2222 root.setAttribute( QStringLiteral( "xmlns:sld" ), QStringLiteral( "http://www.opengis.net/sld" ) );
2223 myDocument.appendChild( root );
2224
2225 // Create the NamedLayer element
2226 layerNode = myDocument.createElement( QStringLiteral( "UserLayer" ) );
2227 root.appendChild( layerNode );
2228 }
2229
2230 QVariantMap props;
2231
2232 QVariant context;
2233 context.setValue( exportContext );
2234
2235 props[ QStringLiteral( "SldExportContext" ) ] = context;
2236
2238 {
2239 props[ QStringLiteral( "scaleMinDenom" ) ] = QString::number( mMinScale );
2240 props[ QStringLiteral( "scaleMaxDenom" ) ] = QString::number( mMaxScale );
2241 }
2242
2243 if ( vlayer )
2244 {
2245 if ( !vlayer->writeSld( layerNode, myDocument, errorMsg, props ) )
2246 {
2247 errorMsg = tr( "Could not save symbology because:\n%1" ).arg( errorMsg );
2248 return;
2249 }
2250 }
2251
2252 if ( rlayer )
2253 {
2254 if ( !rlayer->writeSld( layerNode, myDocument, errorMsg, props ) )
2255 {
2256 errorMsg = tr( "Could not save symbology because:\n%1" ).arg( errorMsg );
2257 return;
2258 }
2259 }
2260
2261 doc = myDocument;
2262}
2263
2264QString QgsMapLayer::saveSldStyle( const QString &uri, bool &resultFlag ) const
2265{
2266 QgsSldExportContext context;
2267 context.setExportFilePath( uri );
2268 return saveSldStyleV2( resultFlag, context );
2269}
2270
2271QString QgsMapLayer::saveSldStyleV2( bool &resultFlag, const QgsSldExportContext &exportContext ) const
2272{
2274
2275 const QgsMapLayer *mlayer = qobject_cast<const QgsMapLayer *>( this );
2276
2277 const QString uri { exportContext.exportFilePath() };
2278
2279 // check if the uri is a file or ends with .sld,
2280 // which indicates that it should become one
2281 QString filename;
2282 if ( mlayer->providerType() == QLatin1String( "ogr" ) )
2283 {
2284 QStringList theURIParts = uri.split( '|' );
2285 filename = theURIParts[0];
2286 }
2287 else if ( mlayer->providerType() == QLatin1String( "gpx" ) )
2288 {
2289 QStringList theURIParts = uri.split( '?' );
2290 filename = theURIParts[0];
2291 }
2292 else if ( mlayer->providerType() == QLatin1String( "delimitedtext" ) )
2293 {
2294 filename = QUrl::fromEncoded( uri.toLatin1() ).toLocalFile();
2295 // toLocalFile() returns an empty string if theURI is a plain Windows-path, e.g. "C:/style.qml"
2296 if ( filename.isEmpty() )
2297 filename = uri;
2298 }
2299 else
2300 {
2301 filename = uri;
2302 }
2303
2304 const QFileInfo myFileInfo( filename );
2305 if ( myFileInfo.exists() || filename.endsWith( QLatin1String( ".sld" ), Qt::CaseInsensitive ) )
2306 {
2307 const QFileInfo myDirInfo( myFileInfo.path() ); //excludes file name
2308 if ( !myDirInfo.isWritable() )
2309 {
2310 resultFlag = false;
2311 return tr( "The directory containing your dataset needs to be writable!" );
2312 }
2313
2314 // now construct the file name for our .sld style file
2315 const QString myFileName = myFileInfo.path() + QDir::separator() + myFileInfo.completeBaseName() + ".sld";
2316
2317 QString errorMsg;
2318 QDomDocument myDocument;
2319
2320 QgsSldExportContext context { exportContext };
2321 context.setExportFilePath( myFileName );
2322
2323 mlayer->exportSldStyleV2( myDocument, errorMsg, context );
2324
2325 if ( !errorMsg.isNull() )
2326 {
2327 resultFlag = false;
2328 return errorMsg;
2329 }
2330
2331 QFile myFile( myFileName );
2332 if ( myFile.open( QFile::WriteOnly | QFile::Truncate ) )
2333 {
2334 QTextStream myFileStream( &myFile );
2335 // save as utf-8 with 2 spaces for indents
2336 myDocument.save( myFileStream, 2 );
2337 myFile.close();
2338 resultFlag = true;
2339 return tr( "Created default style file as %1" ).arg( myFileName );
2340 }
2341 }
2342
2343 resultFlag = false;
2344 return tr( "ERROR: Failed to created SLD style file as %1. Check file permissions and retry." ).arg( filename );
2345
2346}
2347
2348QString QgsMapLayer::loadSldStyle( const QString &uri, bool &resultFlag )
2349{
2351
2352 resultFlag = false;
2353
2354 QDomDocument myDocument;
2355
2356 // location of problem associated with errorMsg
2357 int line, column;
2358 QString myErrorMessage;
2359
2360 QFile myFile( uri );
2361 if ( myFile.open( QFile::ReadOnly ) )
2362 {
2363 // read file
2364 resultFlag = myDocument.setContent( &myFile, true, &myErrorMessage, &line, &column );
2365 if ( !resultFlag )
2366 myErrorMessage = tr( "%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
2367 myFile.close();
2368 }
2369 else
2370 {
2371 myErrorMessage = tr( "Unable to open file %1" ).arg( uri );
2372 }
2373
2374 if ( !resultFlag )
2375 {
2376 return myErrorMessage;
2377 }
2378
2379 // check for root SLD element
2380 const QDomElement myRoot = myDocument.firstChildElement( QStringLiteral( "StyledLayerDescriptor" ) );
2381 if ( myRoot.isNull() )
2382 {
2383 myErrorMessage = QStringLiteral( "Error: StyledLayerDescriptor element not found in %1" ).arg( uri );
2384 resultFlag = false;
2385 return myErrorMessage;
2386 }
2387
2388 // now get the style node out and pass it over to the layer
2389 // to deserialise...
2390 const QDomElement namedLayerElem = myRoot.firstChildElement( QStringLiteral( "NamedLayer" ) );
2391 if ( namedLayerElem.isNull() )
2392 {
2393 myErrorMessage = QStringLiteral( "Info: NamedLayer element not found." );
2394 resultFlag = false;
2395 return myErrorMessage;
2396 }
2397
2398 QString errorMsg;
2399 resultFlag = readSld( namedLayerElem, errorMsg );
2400 if ( !resultFlag )
2401 {
2402 myErrorMessage = tr( "Loading style file %1 failed because:\n%2" ).arg( uri, errorMsg );
2403 return myErrorMessage;
2404 }
2405
2406 return QString();
2407}
2408
2409bool QgsMapLayer::readStyle( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories )
2410{
2412
2413 Q_UNUSED( node )
2414 Q_UNUSED( errorMessage )
2415 Q_UNUSED( context )
2416 Q_UNUSED( categories )
2417 return false;
2418}
2419
2420bool QgsMapLayer::writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage,
2421 const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories ) const
2422{
2424
2425 Q_UNUSED( node )
2426 Q_UNUSED( doc )
2427 Q_UNUSED( errorMessage )
2428 Q_UNUSED( context )
2429 Q_UNUSED( categories )
2430 return false;
2431}
2432
2433
2434void QgsMapLayer::setDataSource( const QString &dataSource, const QString &baseName, const QString &provider,
2435 bool loadDefaultStyleFlag )
2436{
2438
2440
2442 if ( loadDefaultStyleFlag )
2443 {
2445 }
2446
2448 {
2450 }
2451 setDataSource( dataSource,
2452 baseName.isEmpty() ? mLayerName : baseName,
2453 provider.isEmpty() ? mProviderKey : provider,
2454 options, flags );
2455}
2456
2457void QgsMapLayer::setDataSource( const QString &dataSource, const QString &baseName, const QString &provider,
2458 const QgsDataProvider::ProviderOptions &options, bool loadDefaultStyleFlag )
2459{
2461
2463 if ( loadDefaultStyleFlag )
2464 {
2466 }
2467
2469 {
2471 }
2472 setDataSource( dataSource, baseName, provider, options, flags );
2473}
2474
2475void QgsMapLayer::setDataSource( const QString &dataSource, const QString &baseName, const QString &provider,
2477{
2479
2482 {
2484 }
2485 setDataSourcePrivate( dataSource, baseName, provider, options, flags );
2486 emit dataSourceChanged();
2487 emit dataChanged();
2489}
2490
2491
2492void QgsMapLayer::setDataSourcePrivate( const QString &dataSource, const QString &baseName, const QString &provider,
2494{
2496
2497 Q_UNUSED( dataSource )
2498 Q_UNUSED( baseName )
2499 Q_UNUSED( provider )
2500 Q_UNUSED( options )
2501 Q_UNUSED( flags )
2502}
2503
2504
2506{
2508
2509 return mProviderKey;
2510}
2511
2512void QgsMapLayer::readCommonStyle( const QDomElement &layerElement, const QgsReadWriteContext &context,
2513 QgsMapLayer::StyleCategories categories )
2514{
2516
2517 if ( categories.testFlag( Symbology3D ) )
2518 {
2519 const QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "3D Symbology" ) );
2520
2521 QgsAbstract3DRenderer *r3D = nullptr;
2522 QDomElement renderer3DElem = layerElement.firstChildElement( QStringLiteral( "renderer-3d" ) );
2523 if ( !renderer3DElem.isNull() )
2524 {
2525 const QString type3D = renderer3DElem.attribute( QStringLiteral( "type" ) );
2527 if ( meta3D )
2528 {
2529 r3D = meta3D->createRenderer( renderer3DElem, context );
2530 }
2531 }
2532 setRenderer3D( r3D );
2533 }
2534
2535 if ( categories.testFlag( CustomProperties ) )
2536 {
2537 // read custom properties before passing reading further to a subclass, so that
2538 // the subclass can also read custom properties
2539 readCustomProperties( layerElement );
2540 }
2541
2542 // use scale dependent visibility flag
2543 if ( categories.testFlag( Rendering ) )
2544 {
2545 setScaleBasedVisibility( layerElement.attribute( QStringLiteral( "hasScaleBasedVisibilityFlag" ) ).toInt() == 1 );
2546 if ( layerElement.hasAttribute( QStringLiteral( "minimumScale" ) ) )
2547 {
2548 // older element, when scales were reversed
2549 setMaximumScale( layerElement.attribute( QStringLiteral( "minimumScale" ) ).toDouble() );
2550 setMinimumScale( layerElement.attribute( QStringLiteral( "maximumScale" ) ).toDouble() );
2551 }
2552 else
2553 {
2554 setMaximumScale( layerElement.attribute( QStringLiteral( "maxScale" ) ).toDouble() );
2555 setMinimumScale( layerElement.attribute( QStringLiteral( "minScale" ) ).toDouble() );
2556 }
2557 if ( layerElement.hasAttribute( QStringLiteral( "autoRefreshMode" ) ) )
2558 {
2559 setAutoRefreshMode( qgsEnumKeyToValue( layerElement.attribute( QStringLiteral( "autoRefreshMode" ) ), Qgis::AutoRefreshMode::Disabled ) );
2560 setAutoRefreshInterval( layerElement.attribute( QStringLiteral( "autoRefreshTime" ) ).toInt() );
2561 }
2562 }
2563
2564 if ( categories.testFlag( LayerConfiguration ) )
2565 {
2566 // flags
2567 const QDomElement flagsElem = layerElement.firstChildElement( QStringLiteral( "flags" ) );
2568 LayerFlags flags = mFlags;
2569 const auto enumMap = qgsEnumMap<QgsMapLayer::LayerFlag>();
2570 for ( auto it = enumMap.constBegin(); it != enumMap.constEnd(); ++it )
2571 {
2572 const QDomNode flagNode = flagsElem.namedItem( it.value() );
2573 if ( flagNode.isNull() )
2574 continue;
2575 const bool flagValue = flagNode.toElement().text() == "1" ? true : false;
2576 if ( flags.testFlag( it.key() ) && !flagValue )
2577 flags &= ~it.key();
2578 else if ( !flags.testFlag( it.key() ) && flagValue )
2579 flags |= it.key();
2580 }
2581 setFlags( flags );
2582 }
2583
2584 if ( categories.testFlag( Temporal ) )
2585 {
2586 const QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Temporal" ) );
2587
2589 properties->readXml( layerElement.toElement(), context );
2590 }
2591
2592 if ( categories.testFlag( Elevation ) )
2593 {
2594 const QgsReadWriteContextCategoryPopper p = context.enterCategory( tr( "Elevation" ) );
2595
2597 properties->readXml( layerElement.toElement(), context );
2598 }
2599
2600 if ( categories.testFlag( Notes ) )
2601 {
2602 const QDomElement notesElem = layerElement.firstChildElement( QStringLiteral( "userNotes" ) );
2603 if ( !notesElem.isNull() )
2604 {
2605 const QString notes = notesElem.attribute( QStringLiteral( "value" ) );
2606 QgsLayerNotesUtils::setLayerNotes( this, notes );
2607 }
2608 }
2609}
2610
2612{
2614
2615 return mUndoStack;
2616}
2617
2619{
2621
2622 return mUndoStackStyles;
2623}
2624
2626{
2628
2629 return mCustomProperties.keys();
2630}
2631
2632void QgsMapLayer::setCustomProperty( const QString &key, const QVariant &value )
2633{
2635
2636 if ( !mCustomProperties.contains( key ) || mCustomProperties.value( key ) != value )
2637 {
2638 mCustomProperties.setValue( key, value );
2639 emit customPropertyChanged( key );
2640 }
2641}
2642
2644{
2646
2647 mCustomProperties = properties;
2648 for ( const QString &key : mCustomProperties.keys() )
2649 {
2650 emit customPropertyChanged( key );
2651 }
2652}
2653
2655{
2657
2658 return mCustomProperties;
2659}
2660
2661QVariant QgsMapLayer::customProperty( const QString &value, const QVariant &defaultValue ) const
2662{
2663 // non fatal for now -- the "rasterize" processing algorithm is not thread safe and calls this
2665
2666 return mCustomProperties.value( value, defaultValue );
2667}
2668
2669void QgsMapLayer::removeCustomProperty( const QString &key )
2670{
2672
2673 if ( mCustomProperties.contains( key ) )
2674 {
2675 mCustomProperties.remove( key );
2676 emit customPropertyChanged( key );
2677 }
2678}
2679
2680int QgsMapLayer::listStylesInDatabase( QStringList &ids, QStringList &names, QStringList &descriptions, QString &msgError )
2681{
2683
2684 return QgsProviderRegistry::instance()->listStyles( mProviderKey, mDataSource, ids, names, descriptions, msgError );
2685}
2686
2687QString QgsMapLayer::getStyleFromDatabase( const QString &styleId, QString &msgError )
2688{
2690
2691 return QgsProviderRegistry::instance()->getStyleById( mProviderKey, mDataSource, styleId, msgError );
2692}
2693
2694bool QgsMapLayer::deleteStyleFromDatabase( const QString &styleId, QString &msgError )
2695{
2697
2699}
2700
2701void QgsMapLayer::saveStyleToDatabase( const QString &name, const QString &description,
2702 bool useAsDefault, const QString &uiFileContent, QString &msgError, QgsMapLayer::StyleCategories categories )
2703{
2705
2706 QString sldStyle, qmlStyle;
2707 QDomDocument qmlDocument, sldDocument;
2708 QgsReadWriteContext context;
2709 exportNamedStyle( qmlDocument, msgError, context, categories );
2710 if ( !msgError.isNull() )
2711 {
2712 return;
2713 }
2714 qmlStyle = qmlDocument.toString();
2715
2716 this->exportSldStyle( sldDocument, msgError );
2717 if ( !msgError.isNull() )
2718 {
2719 return;
2720 }
2721 sldStyle = sldDocument.toString();
2722
2724 mDataSource, qmlStyle, sldStyle, name,
2725 description, uiFileContent, useAsDefault, msgError );
2726}
2727
2728QString QgsMapLayer::loadNamedStyle( const QString &theURI, bool &resultFlag, bool loadFromLocalDB, QgsMapLayer::StyleCategories categories, Qgis::LoadStyleFlags flags )
2729{
2731
2732 QString returnMessage;
2733 QString qml, errorMsg;
2734 QString styleName;
2735 if ( !loadFromLocalDB && dataProvider() && dataProvider()->styleStorageCapabilities().testFlag( Qgis::ProviderStyleStorageCapability::LoadFromDatabase ) )
2736 {
2738 }
2739
2740 // Style was successfully loaded from provider storage
2741 if ( !qml.isEmpty() )
2742 {
2743 QDomDocument myDocument( QStringLiteral( "qgis" ) );
2744 myDocument.setContent( qml );
2745 resultFlag = importNamedStyle( myDocument, errorMsg );
2746 returnMessage = QObject::tr( "Loaded from Provider" );
2747 }
2748 else
2749 {
2751
2752 bool styleExists = false;
2753 bool styleSuccessfullyLoaded = false;
2754
2755 returnMessage = loadNamedProperty( theURI, PropertyType::Style, styleExists, styleSuccessfullyLoaded, categories, flags );
2756
2757 // TODO QGIS 4.0 -- fix API for loadNamedStyle so we can return styleExists too
2758 ( void )styleExists;
2759 resultFlag = styleSuccessfullyLoaded;
2760 }
2761
2762 if ( ! styleName.isEmpty() )
2763 {
2764 styleManager()->renameStyle( styleManager()->currentStyle(), styleName );
2765 }
2766
2767 if ( resultFlag )
2768 emit styleLoaded( categories );
2769
2770 return returnMessage;
2771}
2772
2779
2781{
2783
2784 return false;
2785}
2786
2788{
2790
2791 return false;
2792}
2793
2795{
2797
2798 return true;
2799}
2800
2802{
2804
2805 // invalid layers are temporary? -- who knows?!
2806 if ( !isValid() )
2807 return false;
2808
2809 if ( mProviderKey == QLatin1String( "memory" ) )
2810 return true;
2811
2812 const QVariantMap sourceParts = QgsProviderRegistry::instance()->decodeUri( mProviderKey, mDataSource );
2813 const QString path = sourceParts.value( QStringLiteral( "path" ) ).toString();
2814 if ( path.isEmpty() )
2815 return false;
2816
2817 // check if layer path is inside one of the standard temporary file locations for this platform
2818 const QStringList tempPaths = QStandardPaths::standardLocations( QStandardPaths::TempLocation );
2819 for ( const QString &tempPath : tempPaths )
2820 {
2821 if ( path.startsWith( tempPath ) )
2822 return true;
2823 }
2824
2825 return false;
2826}
2827
2828void QgsMapLayer::setValid( bool valid )
2829{
2831
2832 if ( mValid == valid )
2833 return;
2834
2835 mValid = valid;
2836 emit isValidChanged();
2837}
2838
2840{
2842
2843 if ( legend == mLegend )
2844 return;
2845
2846 delete mLegend;
2847 mLegend = legend;
2848
2849 if ( mLegend )
2850 {
2851 mLegend->setParent( this );
2852 connect( mLegend, &QgsMapLayerLegend::itemsChanged, this, &QgsMapLayer::legendChanged, Qt::UniqueConnection );
2853 }
2854
2855 emit legendChanged();
2856}
2857
2859{
2861
2862 return mLegend;
2863}
2864
2866{
2868
2869 return mStyleManager;
2870}
2871
2873{
2875
2876 if ( renderer == m3DRenderer )
2877 return;
2878
2879 delete m3DRenderer;
2880 m3DRenderer = renderer;
2881 emit renderer3DChanged();
2882 emit repaintRequested();
2884}
2885
2887{
2889
2890 return m3DRenderer;
2891}
2892
2893void QgsMapLayer::triggerRepaint( bool deferredUpdate )
2894{
2896
2897 if ( mRepaintRequestedFired )
2898 return;
2899 mRepaintRequestedFired = true;
2900 emit repaintRequested( deferredUpdate );
2901 mRepaintRequestedFired = false;
2902}
2903
2910
2912{
2914
2915 mMetadata = metadata;
2916// mMetadata.saveToLayer( this );
2917 emit metadataChanged();
2918}
2919
2921{
2923
2924 return QString();
2925}
2926
2927QDateTime QgsMapLayer::timestamp() const
2928{
2930
2931 return QDateTime();
2932}
2933
2941
2943{
2944 updateExtent( extent );
2945}
2946
2948{
2950
2951 updateExtent( extent );
2952}
2953
2954bool QgsMapLayer::isReadOnly() const
2955{
2957
2958 return true;
2959}
2960
2962{
2964
2965 return mOriginalXmlProperties;
2966}
2967
2968void QgsMapLayer::setOriginalXmlProperties( const QString &originalXmlProperties )
2969{
2971
2972 mOriginalXmlProperties = originalXmlProperties;
2973}
2974
2975QString QgsMapLayer::generateId( const QString &layerName )
2976{
2977 // Generate the unique ID of this layer
2978 const QString uuid = QUuid::createUuid().toString();
2979 // trim { } from uuid
2980 QString id = layerName + '_' + uuid.mid( 1, uuid.length() - 2 );
2981 // Tidy the ID up to avoid characters that may cause problems
2982 // elsewhere (e.g in some parts of XML). Replaces every non-word
2983 // character (word characters are the alphabet, numbers and
2984 // underscore) with an underscore.
2985 // Note that the first backslash in the regular expression is
2986 // there for the compiler, so the pattern is actually \W
2987 const thread_local QRegularExpression idRx( QStringLiteral( "[\\W]" ) );
2988 id.replace( idRx, QStringLiteral( "_" ) );
2989 return id;
2990}
2991
2993{
2995
2996 return true;
2997}
2998
3000{
3002
3003 return mapTipsEnabled() && !mMapTipTemplate.isEmpty();
3004}
3005
3006void QgsMapLayer::setProviderType( const QString &providerType )
3007{
3009
3011}
3012
3013QSet<QgsMapLayerDependency> QgsMapLayer::dependencies() const
3014{
3016
3017 return mDependencies;
3018}
3019
3020bool QgsMapLayer::setDependencies( const QSet<QgsMapLayerDependency> &oDeps )
3021{
3023
3024 QSet<QgsMapLayerDependency> deps;
3025 const auto constODeps = oDeps;
3026 for ( const QgsMapLayerDependency &dep : constODeps )
3027 {
3028 if ( dep.origin() == QgsMapLayerDependency::FromUser )
3029 deps << dep;
3030 }
3031
3032 mDependencies = deps;
3033 emit dependenciesChanged();
3034 return true;
3035}
3036
3038{
3040
3041 QgsDataProvider *lDataProvider = dataProvider();
3042
3043 if ( !lDataProvider )
3044 return;
3045
3046 if ( enabled && !isRefreshOnNotifyEnabled() )
3047 {
3048 lDataProvider->setListening( enabled );
3049 connect( lDataProvider, &QgsDataProvider::notify, this, &QgsMapLayer::onNotified );
3050 }
3051 else if ( !enabled && isRefreshOnNotifyEnabled() )
3052 {
3053 // we don't want to disable provider listening because someone else could need it (e.g. actions)
3054 disconnect( lDataProvider, &QgsDataProvider::notify, this, &QgsMapLayer::onNotified );
3055 }
3056 mIsRefreshOnNofifyEnabled = enabled;
3057}
3058
3060{
3062
3063 if ( QgsMapLayerStore *store = qobject_cast<QgsMapLayerStore *>( parent() ) )
3064 {
3065 return qobject_cast<QgsProject *>( store->parent() );
3066 }
3067 return nullptr;
3068}
3069
3070void QgsMapLayer::onNotified( const QString &message )
3071{
3073
3074 if ( refreshOnNotifyMessage().isEmpty() || refreshOnNotifyMessage() == message )
3075 {
3077 emit dataChanged();
3078 }
3079}
3080
3081QgsRectangle QgsMapLayer::wgs84Extent( bool forceRecalculate ) const
3082{
3084
3086
3087 if ( ! forceRecalculate && ! mWgs84Extent.isNull() )
3088 {
3089 wgs84Extent = mWgs84Extent;
3090 }
3091 else if ( ! mExtent2D.isNull() || ! mExtent3D.isNull() )
3092 {
3094 transformer.setBallparkTransformsAreAppropriate( true );
3095 try
3096 {
3097 if ( mExtent2D.isNull() )
3098 wgs84Extent = transformer.transformBoundingBox( mExtent3D.toRectangle() );
3099 else
3100 wgs84Extent = transformer.transformBoundingBox( mExtent2D );
3101 }
3102 catch ( const QgsCsException &cse )
3103 {
3104 QgsMessageLog::logMessage( tr( "Error transforming extent: %1" ).arg( cse.what() ) );
3106 }
3107 }
3108 return wgs84Extent;
3109}
3110
3111void QgsMapLayer::updateExtent( const QgsRectangle &extent ) const
3112{
3114
3115 if ( extent == mExtent2D )
3116 return;
3117
3118 mExtent2D = extent;
3119
3120 // do not update the wgs84 extent if we trust layer metadata
3122 return;
3123
3124 mWgs84Extent = wgs84Extent( true );
3125}
3126
3127void QgsMapLayer::updateExtent( const QgsBox3D &extent ) const
3128{
3130
3131 if ( extent == mExtent3D )
3132 return;
3133
3134 if ( extent.isNull() )
3135 {
3136 if ( !extent.toRectangle().isNull() )
3137 {
3138 // bad 3D extent param but valid in 2d --> update 2D extent
3139 updateExtent( extent.toRectangle() );
3140 }
3141 else
3142 {
3143 QgsDebugMsgLevel( QStringLiteral( "Unable to update extent with empty parameter" ), 1 );
3144 }
3145 }
3146 else
3147 {
3148 mExtent3D = extent;
3149
3150 // do not update the wgs84 extent if we trust layer metadata
3152 return;
3153
3154 mWgs84Extent = wgs84Extent( true );
3155 }
3156}
3157
3158bool QgsMapLayer::rebuildCrs3D( QString *error )
3159{
3160 bool res = true;
3161 if ( !mCRS.isValid() )
3162 {
3164 }
3165 else if ( !mVerticalCrs.isValid() )
3166 {
3167 mCrs3D = mCRS;
3168 }
3169 else
3170 {
3171 switch ( mCRS.type() )
3172 {
3176 mCrs3D = mCRS;
3177 break;
3178
3180 {
3181 QString tempError;
3182 mCrs3D = mCRS.hasVerticalAxis() ? mCRS : QgsCoordinateReferenceSystem::createCompoundCrs( mCRS, mVerticalCrs, error ? *error : tempError );
3183 res = mCrs3D.isValid();
3184 break;
3185 }
3186
3188 // nonsense situation
3190 res = false;
3191 break;
3192
3201 {
3202 QString tempError;
3203 mCrs3D = QgsCoordinateReferenceSystem::createCompoundCrs( mCRS, mVerticalCrs, error ? *error : tempError );
3204 res = mCrs3D.isValid();
3205 break;
3206 }
3207 }
3208 }
3209 return res;
3210}
3211
3213{
3215
3216 // do not update the wgs84 extent if we trust layer metadata
3218 return;
3219
3220 mWgs84Extent = QgsRectangle();
3221}
3222
3224{
3226
3227 QString metadata = QStringLiteral( "<h1>" ) + tr( "General" ) + QStringLiteral( "</h1>\n<hr>\n" ) + QStringLiteral( "<table class=\"list-view\">\n" );
3228
3229 // name
3230 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Name" ) + QStringLiteral( "</td><td>" ) + name() + QStringLiteral( "</td></tr>\n" );
3231
3232 QString path;
3233 bool isLocalPath = false;
3234 if ( dataProvider() )
3235 {
3236 // local path
3237 QVariantMap uriComponents = QgsProviderRegistry::instance()->decodeUri( dataProvider()->name(), publicSource() );
3238 if ( uriComponents.contains( QStringLiteral( "path" ) ) )
3239 {
3240 path = uriComponents[QStringLiteral( "path" )].toString();
3241 QFileInfo fi( path );
3242 if ( fi.exists() )
3243 {
3244 isLocalPath = true;
3245 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Path" ) + QStringLiteral( "</td><td>%1" ).arg( QStringLiteral( "<a href=\"%1\">%2</a>" ).arg( QUrl::fromLocalFile( path ).toString(), QDir::toNativeSeparators( path ) ) ) + QStringLiteral( "</td></tr>\n" );
3246
3247 QDateTime lastModified = fi.lastModified();
3248 QString lastModifiedFileName;
3249 QSet<QString> sidecarFiles = QgsFileUtils::sidecarFilesForPath( path );
3250 if ( fi.isFile() )
3251 {
3252 qint64 fileSize = fi.size();
3253 if ( !sidecarFiles.isEmpty() )
3254 {
3255 lastModifiedFileName = fi.fileName();
3256 QStringList sidecarFileNames;
3257 for ( const QString &sidecarFile : sidecarFiles )
3258 {
3259 QFileInfo sidecarFi( sidecarFile );
3260 fileSize += sidecarFi.size();
3261 if ( sidecarFi.lastModified() > lastModified )
3262 {
3263 lastModified = sidecarFi.lastModified();
3264 lastModifiedFileName = sidecarFi.fileName();
3265 }
3266 sidecarFileNames << sidecarFi.fileName();
3267 }
3268 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + ( sidecarFiles.size() > 1 ? tr( "Sidecar files" ) : tr( "Sidecar file" ) ) + QStringLiteral( "</td><td>%1" ).arg( sidecarFileNames.join( QLatin1String( ", " ) ) ) + QStringLiteral( "</td></tr>\n" );
3269 }
3270 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + ( !sidecarFiles.isEmpty() ? tr( "Total size" ) : tr( "Size" ) ) + QStringLiteral( "</td><td>%1" ).arg( QgsFileUtils::representFileSize( fileSize ) ) + QStringLiteral( "</td></tr>\n" );
3271 }
3272 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Last modified" ) + QStringLiteral( "</td><td>%1" ).arg( QLocale().toString( fi.lastModified() ) ) + ( !lastModifiedFileName.isEmpty() ? QStringLiteral( " (%1)" ).arg( lastModifiedFileName ) : QString() ) + QStringLiteral( "</td></tr>\n" );
3273 }
3274 }
3275 if ( uriComponents.contains( QStringLiteral( "url" ) ) )
3276 {
3277 const QString url = uriComponents[QStringLiteral( "url" )].toString();
3278 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "URL" ) + QStringLiteral( "</td><td>%1" ).arg( QStringLiteral( "<a href=\"%1\">%2</a>" ).arg( QUrl( url ).toString(), url ) ) + QStringLiteral( "</td></tr>\n" );
3279 }
3280 }
3281
3282 // data source
3283 if ( publicSource() != path || !isLocalPath )
3284 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Source" ) + QStringLiteral( "</td><td>%1" ).arg( publicSource() != path ? publicSource() : path ) + QStringLiteral( "</td></tr>\n" );
3285
3286 // provider
3287 if ( dataProvider() )
3288 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Provider" ) + QStringLiteral( "</td><td>%1" ).arg( dataProvider()->name() ) + QStringLiteral( "</td></tr>\n" );
3289
3290 metadata += QLatin1String( "</table>\n<br><br>" );
3291
3292 return metadata;
3293}
3294
3296{
3297 QString metadata;
3298 // custom properties
3299 if ( const auto keys = customPropertyKeys(); !keys.isEmpty() )
3300 {
3301 metadata += QStringLiteral( "<h1>" ) + tr( "Custom properties" ) + QStringLiteral( "</h1>\n<hr>\n" );
3302 metadata += QLatin1String( "<table class=\"list-view\">\n<tbody>" );
3303 for ( const QString &key : keys )
3304 {
3305 // keys prefaced with _ are considered private/internal details
3306 if ( key.startsWith( '_' ) )
3307 continue;
3308
3309 const QVariant propValue = customProperty( key );
3310 QString stringValue;
3311 if ( propValue.type() == QVariant::List || propValue.type() == QVariant::StringList )
3312 {
3313 for ( const QString &s : propValue.toStringList() )
3314 {
3315 stringValue += "<p style=\"margin: 0;\">" + s.toHtmlEscaped() + "</p>";
3316 }
3317 }
3318 else
3319 {
3320 stringValue = propValue.toString().toHtmlEscaped();
3321
3322 //if the result string is empty but propValue is not, the conversion has failed
3323 if ( stringValue.isEmpty() && !QgsVariantUtils::isNull( propValue ) )
3324 stringValue = tr( "<i>value cannot be displayed</i>" );
3325 }
3326
3327 metadata += QStringLiteral( "<tr><td class=\"highlight\">%1</td><td>%2</td></tr>" ).arg( key.toHtmlEscaped(), stringValue );
3328 }
3329 metadata += QLatin1String( "</tbody></table>\n" );
3330 metadata += QLatin1String( "<br><br>\n" );
3331 }
3332 return metadata;
3333}
3334
3336{
3338 QString metadata;
3339
3340 auto addCrsInfo = [&metadata]( const QgsCoordinateReferenceSystem & c, bool includeType, bool includeOperation, bool includeCelestialBody )
3341 {
3342 if ( !c.isValid() )
3343 metadata += QStringLiteral( "<tr><td colspan=\"2\" class=\"highlight\">" ) + tr( "Unknown" ) + QStringLiteral( "</td></tr>\n" );
3344 else
3345 {
3346 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Name" ) + QStringLiteral( "</td><td>" ) + c.userFriendlyIdentifier( Qgis::CrsIdentifierType::FullString ) + QStringLiteral( "</td></tr>\n" );
3347
3348 // map units
3349 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Units" ) + QStringLiteral( "</td><td>" )
3350 + ( c.isGeographic() ? tr( "Geographic (uses latitude and longitude for coordinates)" ) : QgsUnitTypes::toString( c.mapUnits() ) )
3351 + QStringLiteral( "</td></tr>\n" );
3352
3353 if ( includeType )
3354 {
3355 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Type" ) + QStringLiteral( "</td><td>" ) + QgsCoordinateReferenceSystemUtils::crsTypeToString( c.type() ) + QStringLiteral( "</td></tr>\n" );
3356 }
3357
3358 if ( includeOperation )
3359 {
3360 // operation
3361 const QgsProjOperation operation = c.operation();
3362 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Method" ) + QStringLiteral( "</td><td>" ) + operation.description() + QStringLiteral( "</td></tr>\n" );
3363 }
3364
3365 if ( includeCelestialBody )
3366 {
3367 // celestial body
3368 try
3369 {
3370 const QString celestialBody = c.celestialBodyName();
3371 if ( !celestialBody.isEmpty() )
3372 {
3373 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Celestial Body" ) + QStringLiteral( "</td><td>" ) + celestialBody + QStringLiteral( "</td></tr>\n" );
3374 }
3375 }
3376 catch ( QgsNotSupportedException & )
3377 {
3378
3379 }
3380 }
3381
3382 QString accuracyString;
3383 // dynamic crs with no epoch?
3384 if ( c.isDynamic() && std::isnan( c.coordinateEpoch() ) )
3385 {
3386 accuracyString = tr( "Based on a dynamic CRS, but no coordinate epoch is set. Coordinates are ambiguous and of limited accuracy." );
3387 }
3388
3389 // based on datum ensemble?
3390 try
3391 {
3392 const QgsDatumEnsemble ensemble = c.datumEnsemble();
3393 if ( ensemble.isValid() )
3394 {
3395 QString id;
3396 if ( !ensemble.code().isEmpty() )
3397 id = QStringLiteral( "<i>%1</i> (%2:%3)" ).arg( ensemble.name(), ensemble.authority(), ensemble.code() );
3398 else
3399 id = QStringLiteral( "<i>%</i>”" ).arg( ensemble.name() );
3400
3401 if ( ensemble.accuracy() > 0 )
3402 {
3403 accuracyString = tr( "Based on %1, which has a limited accuracy of <b>at best %2 meters</b>." ).arg( id ).arg( ensemble.accuracy() );
3404 }
3405 else
3406 {
3407 accuracyString = tr( "Based on %1, which has a limited accuracy." ).arg( id );
3408 }
3409 }
3410 }
3411 catch ( QgsNotSupportedException & )
3412 {
3413
3414 }
3415
3416 if ( !accuracyString.isEmpty() )
3417 {
3418 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Accuracy" ) + QStringLiteral( "</td><td>" ) + accuracyString + QStringLiteral( "</td></tr>\n" );
3419 }
3420
3421 // static/dynamic
3422 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Reference" ) + QStringLiteral( "</td><td>%1</td></tr>\n" ).arg( c.isDynamic() ? tr( "Dynamic (relies on a datum which is not plate-fixed)" ) : tr( "Static (relies on a datum which is plate-fixed)" ) );
3423
3424 // coordinate epoch
3425 if ( !std::isnan( c.coordinateEpoch() ) )
3426 {
3427 metadata += QStringLiteral( "<tr><td class=\"highlight\">" ) + tr( "Coordinate Epoch" ) + QStringLiteral( "</td><td>%1</td></tr>\n" ).arg( qgsDoubleToString( c.coordinateEpoch(), 3 ) );
3428 }
3429 }
3430 };
3431
3432 metadata += QStringLiteral( "<h1>" ) + tr( "Coordinate Reference System (CRS)" ) + QStringLiteral( "</h1>\n<hr>\n" );
3433 metadata += QLatin1String( "<table class=\"list-view\">\n" );
3434 addCrsInfo( crs(), true, true, true );
3435 metadata += QLatin1String( "</table>\n<br><br>\n" );
3436
3437 if ( verticalCrs().isValid() )
3438 {
3439 metadata += QStringLiteral( "<h1>" ) + tr( "Vertical Coordinate Reference System (CRS)" ) + QStringLiteral( "</h1>\n<hr>\n" );
3440 metadata += QLatin1String( "<table class=\"list-view\">\n" );
3441 addCrsInfo( verticalCrs(), false, false, false );
3442 metadata += QLatin1String( "</table>\n<br><br>\n" );
3443 }
3444
3445 return metadata;
3446}
static QString version()
Version string.
Definition qgis.cpp:259
@ FullString
Full definition – possibly a very lengthy string, e.g. with no truncation of custom WKT definitions.
@ Vertical
Vertical CRS.
@ Temporal
Temporal CRS.
@ Compound
Compound (horizontal + vertical) CRS.
@ Projected
Projected CRS.
@ Other
Other type.
@ Bound
Bound CRS.
@ DerivedProjected
Derived projected CRS.
@ Unknown
Unknown type.
@ Engineering
Engineering CRS.
@ Geographic3d
3D geopraphic CRS
@ Geodetic
Geodetic CRS.
@ Geographic2d
2D geographic CRS
@ Geocentric
Geocentric CRS.
@ ForceFirstLetterToCapital
Convert just the first letter of each word to uppercase, leave the rest untouched.
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:337
@ Unknown
Unknown types.
QFlags< DataProviderReadFlag > DataProviderReadFlags
Flags which control data provider construction.
Definition qgis.h:450
LayerType
Types of layers that can be added to a map.
Definition qgis.h:169
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ Vector
Vector layer.
QFlags< MapLayerProperty > MapLayerProperties
Map layer properties.
Definition qgis.h:2118
QFlags< LoadStyleFlag > LoadStyleFlags
Flags for loading layer styles.
Definition qgis.h:225
@ LoadDefaultStyle
Reset the layer's style to the default for the datasource.
@ ForceReadOnly
Open layer in a read-only mode.
@ SkipGetExtent
Skip the extent from provider.
@ TrustDataSource
Trust datasource config (primary key unicity, geometry type and srid, etc). Improves provider load ti...
@ IgnoreMissingStyleErrors
If the style is missing, then don't flag it as an error. This flag can be used when the caller is not...
AutoRefreshMode
Map layer automatic refresh modes.
Definition qgis.h:2128
@ RedrawOnly
Redraw current data only.
@ ReloadData
Reload data (and draw the new data)
@ Disabled
Automatic refreshing is disabled.
Base metadata class for 3D renderers.
virtual QgsAbstract3DRenderer * createRenderer(QDomElement &elem, const QgsReadWriteContext &context)=0
Returns new instance of the renderer given the DOM element.
Qgs3DRendererAbstractMetadata * rendererMetadata(const QString &type) const
Returns metadata for a 3D renderer type (may be used to create a new instance of the type)
Base class for all renderers that may to participate in 3D view.
virtual QString type() const =0
Returns unique identifier of the renderer class (used to identify subclass)
virtual void writeXml(QDomElement &elem, const QgsReadWriteContext &context) const =0
Writes renderer's properties to given XML element.
virtual void resolveReferences(const QgsProject &project)
Resolves references to other objects - second phase of loading - after readXml()
static QString pkgDataPath()
Returns the common root path of all application data directories.
static QString qgisSettingsDirPath()
Returns the path to the settings directory in user's home dir.
static QgsAuthManager * authManager()
Returns the application's authentication manager instance.
static Qgs3DRendererRegistry * renderer3DRegistry()
Returns registry of available 3D renderers.
bool setMasterPassword(bool verify=false)
Main call to initially set or continually check master password is set.
A 3-dimensional box composed of x, y, z coordinates.
Definition qgsbox3d.h:43
QgsRectangle toRectangle() const
Converts the box to a 2D rectangle.
Definition qgsbox3d.h:394
bool isNull() const
Test if the box is null (holding no spatial information).
Definition qgsbox3d.cpp:310
static QString crsTypeToString(Qgis::CrsType type)
Returns a translated string representing a CRS type.
This class represents a coordinate reference system (CRS).
static QgsCoordinateReferenceSystem fromOgcWmsCrs(const QString &ogcCrs)
Creates a CRS from a given OGC WMS-format Coordinate Reference System string.
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
bool hasVerticalAxis() const
Returns true if the CRS has a vertical axis.
void validate()
Perform some validation on this CRS.
static CUSTOM_CRS_VALIDATION customCrsValidation()
Gets custom function.
bool readXml(const QDomNode &node)
Restores state from the given DOM node.
static QgsCoordinateReferenceSystem createCompoundCrs(const QgsCoordinateReferenceSystem &horizontalCrs, const QgsCoordinateReferenceSystem &verticalCrs, QString &error)
Given a horizontal and vertical CRS, attempts to create a compound CRS from them.
static void setCustomCrsValidation(CUSTOM_CRS_VALIDATION f)
Sets custom function to force valid CRS.
void setValidationHint(const QString &html)
Set user hint for validation.
QgsCoordinateReferenceSystem verticalCrs() const
Returns the vertical CRS associated with this CRS object.
bool writeXml(QDomNode &node, QDomDocument &doc) const
Stores state to the given Dom node in the given document.
Qgis::CrsType type() const
Returns the type of the CRS.
Contains information about the context in which a coordinate transform is executed.
Class for doing transforms between two map coordinate systems.
Custom exception class for Coordinate Reference System related exceptions.
virtual bool containsElevationData() const
Returns true if the data provider definitely contains elevation related data.
Abstract base class for spatial data provider implementations.
virtual QString name() const =0
Returns a provider name.
void notify(const QString &msg)
Emitted when the datasource issues a notification.
virtual QgsDataProviderElevationProperties * elevationProperties()
Returns the provider's elevation properties.
static QString removePassword(const QString &aUri, bool hide=false)
Removes the password element from a URI.
Contains information about a datum ensemble.
Definition qgsdatums.h:95
QString code() const
Identification code, e.g.
Definition qgsdatums.h:122
QString authority() const
Authority name, e.g.
Definition qgsdatums.h:117
bool isValid() const
Returns true if the datum ensemble is a valid object, or false if it is a null/invalid object.
Definition qgsdatums.h:102
QString name() const
Display name of datum ensemble.
Definition qgsdatums.h:107
double accuracy() const
Positional accuracy (in meters).
Definition qgsdatums.h:112
A container for error messages.
Definition qgserror.h:81
QString what() const
static QSet< QString > sidecarFilesForPath(const QString &path)
Returns a list of the sidecar files which exist for the dataset a the specified path.
static QString representFileSize(qint64 bytes)
Returns the human size from bytes.
A structured metadata store for a map layer.
bool readMetadataXml(const QDomElement &metadataElement) override
Sets state from DOM document.
bool writeMetadataXml(QDomElement &metadataElement, QDomDocument &document) const override
Stores state in a DOM node.
static void setLayerNotes(QgsMapLayer *layer, const QString &notes)
Sets the notes for the specified layer, where notes is a HTML formatted string.
static bool layerHasNotes(const QgsMapLayer *layer)
Returns true if the specified layer has notes available.
static QString layerNotes(const QgsMapLayer *layer)
Returns the notes for the specified layer.
This class models dependencies with or between map layers.
Base class for storage of map layer elevation properties.
The QgsMapLayerLegend class is abstract interface for implementations of legends for one map layer.
void itemsChanged()
Emitted when existing items/nodes got invalid and should be replaced by new ones.
Manages QGIS Server properties for a map layer.
void readXml(const QDomNode &layer_node)
Reads server properties from project file.
void copyTo(QgsMapLayerServerProperties *properties) const
Copy properties to another instance.
A storage object for map layers, in which the layers are owned by the store and have their lifetime b...
Management of styles for use with one map layer.
bool addStyle(const QString &name, const QgsMapLayerStyle &style)
Add a style with given name and data.
QStringList styles() const
Returns list of all defined style names.
void writeXml(QDomElement &mgrElement) const
Write configuration (for project saving)
void reset()
Reset the style manager to a basic state - with one default style which is set as current.
bool renameStyle(const QString &name, const QString &newName)
Rename a stored style to a different name.
QgsMapLayerStyle style(const QString &name) const
Returns data of a stored style - accessed by its unique name.
void readXml(const QDomElement &mgrElement)
Read configuration (for project loading)
Base class for storage of map layer temporal properties.
Base class for all map layer types.
Definition qgsmaplayer.h:76
void crs3DChanged()
Emitted when the crs3D() of the layer has changed.
Q_DECL_DEPRECATED void setShortName(const QString &shortName)
Sets the short name of the layer used by QGIS Server to identify the layer.
virtual bool deleteStyleFromDatabase(const QString &styleId, QString &msgError)
Deletes a style from the database.
bool importNamedMetadata(QDomDocument &document, QString &errorMessage)
Import the metadata of this layer from a QDomDocument.
QString name
Definition qgsmaplayer.h:80
void readStyleManager(const QDomNode &layerNode)
Read style manager's configuration (if any). To be called by subclasses.
virtual bool writeSymbology(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const =0
Write the style for the layer into the document provided.
QString legendUrlFormat() const
Returns the format for a URL based layer legend.
QgsRectangle wgs84Extent(bool forceRecalculate=false) const
Returns the WGS84 extent (EPSG:4326) of the layer according to ReadFlag::FlagTrustLayerMetadata.
void setRefreshOnNotifyEnabled(bool enabled)
Set whether provider notification is connected to triggerRepaint.
virtual bool isSpatial() const
Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated w...
QgsAbstract3DRenderer * renderer3D() const
Returns 3D renderer associated with the layer.
virtual bool isTemporary() const
Returns true if the layer is considered a temporary layer.
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.
bool setId(const QString &id)
Sets the layer's id.
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the layer.
void dependenciesChanged()
Emitted when dependencies are changed.
virtual bool hasMapTips() const
Returns true if the layer contains map tips.
bool isInScaleRange(double scale) const
Tests whether the layer should be visible at the specified scale.
void legendChanged()
Signal emitted when legend of the layer has 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.
QFlags< ReadFlag > ReadFlags
QFlags< LayerFlag > LayerFlags
virtual bool importNamedStyle(QDomDocument &doc, QString &errorMsg, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories)
Import the properties of this layer from a QDomDocument.
Q_DECL_DEPRECATED void setAbstract(const QString &abstract)
Sets the abstract of the layer used by QGIS Server in GetCapabilities request.
void metadataChanged()
Emitted when the layer's metadata is changed.
virtual QgsRectangle extent() const
Returns the extent of the layer.
virtual QString saveSldStyle(const QString &uri, bool &resultFlag) const
Saves the properties of this layer to an SLD format file.
QString source() const
Returns the source for the layer.
void setLegendUrl(const QString &legendUrl)
Sets the URL for the layer's legend.
virtual bool setDependencies(const QSet< QgsMapLayerDependency > &layers)
Sets the list of dependencies.
void request3DUpdate()
Signal emitted when a layer requires an update in any 3D maps.
Q_INVOKABLE QVariant customProperty(const QString &value, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer.
QgsError mError
Error.
int mBlockStyleChangedSignal
If non-zero, the styleChanged signal should not be emitted.
QString providerType() const
Returns the provider type (provider key) for this layer.
virtual void setExtent3D(const QgsBox3D &box)
Sets the extent.
void removeCustomProperty(const QString &key)
Remove a custom property from layer.
Qgis::AutoRefreshMode autoRefreshMode() const
Returns the layer's automatic refresh mode.
void setBlendMode(QPainter::CompositionMode blendMode)
Set the blending mode used for rendering a layer.
void configChanged()
Emitted whenever the configuration is changed.
void trigger3DUpdate()
Will advise any 3D maps that this layer requires to be updated in the scene.
void autoRefreshIntervalChanged(int interval)
Emitted when the auto refresh interval changes.
void setMinimumScale(double scale)
Sets the minimum map scale (i.e.
virtual QSet< QgsMapLayerDependency > dependencies() const
Gets the list of dependencies.
void setCustomProperties(const QgsObjectCustomProperties &properties)
Set custom properties for layer.
static Qgis::DataProviderReadFlags providerReadFlags(const QDomNode &layerNode, QgsMapLayer::ReadFlags layerReadFlags)
Returns provider read flag deduced from layer read flags layerReadFlags and a dom node layerNode that...
virtual QString loadNamedStyle(const QString &theURI, bool &resultFlag, bool loadFromLocalDb, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories, Qgis::LoadStyleFlags flags=Qgis::LoadStyleFlags())
Loads a named style from file/local db/datasource db.
virtual QString encodedSource(const QString &source, const QgsReadWriteContext &context) const
Called by writeLayerXML(), used by derived classes to encode provider's specific data source to proje...
QgsMapLayer::LayerFlags flags() const
Returns the flags for this layer.
QgsCoordinateReferenceSystem crs3D
Definition qgsmaplayer.h:85
virtual void setSubLayerVisibility(const QString &name, bool visible)
Set the visibility of the given sublayer name.
void isValidChanged()
Emitted when the validity of this layer changed.
QgsCoordinateReferenceSystem crs
Definition qgsmaplayer.h:83
bool loadNamedMetadataFromDatabase(const QString &db, const QString &uri, QString &qmd)
Retrieve a named metadata for this layer from a sqlite database.
virtual bool readXml(const QDomNode &layer_node, QgsReadWriteContext &context)
Called by readLayerXML(), used by children to read state specific to them from project files.
QgsMapLayerServerProperties * serverProperties()
Returns QGIS Server Properties for the map layer.
Q_DECL_DEPRECATED QString attribution() const
Returns the attribution of the layer used by QGIS Server in GetCapabilities request.
void setOriginalXmlProperties(const QString &originalXmlProperties)
Sets the original XML properties for the layer to originalXmlProperties.
void writeCustomProperties(QDomNode &layerNode, QDomDocument &doc) const
Write custom properties to project file.
QString mRefreshOnNofifyMessage
QString mLegendUrl
WMS legend.
virtual int listStylesInDatabase(QStringList &ids, QStringList &names, QStringList &descriptions, QString &msgError)
Lists all the style in db split into related to the layer and not related to.
virtual QString loadDefaultStyle(bool &resultFlag)
Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record...
void setDataSource(const QString &dataSource, const QString &baseName=QString(), const QString &provider=QString(), bool loadDefaultStyleFlag=false)
Updates the data source of the layer.
QString mLayerName
Name of the layer - used for display.
virtual QString loadNamedMetadata(const QString &uri, bool &resultFlag)
Retrieve a named metadata for this layer if one exists (either as a .qmd file on disk or as a record ...
virtual bool writeXml(QDomNode &layer_node, QDomDocument &document, const QgsReadWriteContext &context) const
Called by writeLayerXML(), used by children to write state specific to them to project files.
Q_DECL_DEPRECATED bool hasAutoRefreshEnabled() const
Returns true if auto refresh is enabled for the layer.
QString id
Definition qgsmaplayer.h:79
void mapTipTemplateChanged()
Emitted when the map tip template changes.
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.
Q_DECL_DEPRECATED void setAttributionUrl(const QString &attribUrl)
Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request.
Q_DECL_DEPRECATED void setAutoRefreshEnabled(bool enabled)
Sets whether auto refresh is enabled for the layer.
void setMaximumScale(double scale)
Sets the maximum map scale (i.e.
QgsLayerMetadata metadata
Definition qgsmaplayer.h:82
static QString formatLayerName(const QString &name)
A convenience function to capitalize and format a layer name.
void renderer3DChanged()
Signal emitted when 3D renderer associated with the layer has changed.
Q_DECL_DEPRECATED QString abstract() const
Returns the abstract of the layer used by QGIS Server in GetCapabilities request.
QgsMapLayer(Qgis::LayerType type=Qgis::LayerType::Vector, const QString &name=QString(), const QString &source=QString())
Constructor for QgsMapLayer.
QString originalXmlProperties() const
Returns the XML properties of the original layer as they were when the layer was first read from the ...
Qgis::LayerType type
Definition qgsmaplayer.h:86
Q_DECL_DEPRECATED QString dataUrlFormat() const
Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
QPainter::CompositionMode blendMode() const
Returns the current blending mode for a layer.
Q_DECL_DEPRECATED void setDataUrl(const QString &dataUrl)
Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request.
virtual void setOpacity(double opacity)
Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1....
Q_DECL_DEPRECATED void setKeywordList(const QString &keywords)
Sets the keyword list of the layerused by QGIS Server in GetCapabilities request.
Q_DECL_DEPRECATED void setAttribution(const QString &attrib)
Sets the attribution of the layerused by QGIS Server in GetCapabilities request.
void setFlags(QgsMapLayer::LayerFlags flags)
Returns the flags for this layer.
bool isRefreshOnNotifyEnabled() const
Returns true if the refresh on provider nofification is enabled.
QString publicSource(bool hidePassword=false) const
Gets a version of the internal layer definition that has sensitive bits removed (for example,...
Q_DECL_DEPRECATED QString shortName() const
Returns the short name of the layer used by QGIS Server to identify the 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 Qgis::MapLayerProperties properties() const
Returns the map layer properties of this layer.
virtual QString loadSldStyle(const QString &uri, bool &resultFlag)
Attempts to style the layer using the formatting from an SLD type file.
virtual void setMetadata(const QgsLayerMetadata &metadata)
Sets the layer's metadata store.
virtual bool readStyle(const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories)
Read the style for the current layer from the DOM node supplied.
virtual QString saveDefaultMetadata(bool &resultFlag)
Save the current metadata of this layer as the default metadata (either as a .qmd file on disk or as ...
virtual bool supportsEditing() const
Returns whether the layer supports editing or not.
Q_DECL_DEPRECATED void setDataUrlFormat(const QString &dataUrlFormat)
Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
QString mLegendUrlFormat
QFlags< StyleCategory > StyleCategories
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.
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.
virtual bool isEditable() const
Returns true if the layer can be edited.
QUndoStack * undoStack()
Returns pointer to layer's undo stack.
std::unique_ptr< QgsDataProvider > mPreloadedProvider
Optionally used when loading a project, it is released when the layer is effectively created.
Q_DECL_DEPRECATED QString title() const
Returns the title of the layer used by QGIS Server in GetCapabilities request.
void crsChanged()
Emitted when the crs() of the layer has changed.
virtual QgsError error() const
Gets current status error.
bool writeLayerXml(QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context) const
Stores state in DOM node.
virtual QString styleURI() const
Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users styl...
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.
void idChanged(const QString &id)
Emitted when the layer's ID has been changed.
Q_DECL_DEPRECATED QString dataUrl() const
Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request.
bool hasScaleBasedVisibility() const
Returns whether scale based visibility is enabled for the layer.
Q_DECL_DEPRECATED QString metadataUrlFormat() const
Returns the metadata format of the layer used by QGIS Server in GetCapabilities request.
void setRefreshOnNofifyMessage(const QString &message)
Set the notification message that triggers repaint If refresh on notification is enabled,...
static QString generateId(const QString &layerName)
Generates an unique identifier for this layer, the generate ID is prefixed by layerName.
QgsProviderMetadata * providerMetadata() const
Returns the layer data provider's metadata, it may be nullptr.
void opacityChanged(double opacity)
Emitted when the layer's opacity is changed, where opacity is a value between 0 (transparent) and 1 (...
virtual bool isModified() const
Returns true if the layer has been modified since last commit/save.
void styleLoaded(QgsMapLayer::StyleCategories categories)
Emitted when a style has been loaded.
virtual QString getStyleFromDatabase(const QString &styleId, QString &msgError)
Returns the named style corresponding to style id provided.
void emitStyleChanged()
Triggers an emission of the styleChanged() signal.
virtual QgsMapLayerTemporalProperties * temporalProperties()
Returns the layer's temporal properties.
QUndoStack * undoStackStyles()
Returns pointer to layer's style undo stack.
void dataChanged()
Data of layer changed.
virtual QStringList subLayers() const
Returns the sublayers of this layer.
virtual QString htmlMetadata() const
Obtain a formatted HTML string containing assorted metadata for this layer.
Q_DECL_DEPRECATED void setMetadataUrlFormat(const QString &metaUrlFormat)
Sets the metadata format of the layer used by QGIS Server in GetCapabilities request.
virtual bool loadNamedStyleFromDatabase(const QString &db, const QString &uri, QString &qml)
Retrieve a named style for this layer from a sqlite database.
void verticalCrsChanged()
Emitted when the verticalCrs() of the layer has changed.
virtual QgsBox3D extent3D() const
Returns the 3D extent of the layer.
static QString extensionPropertyType(PropertyType type)
Returns the extension of a Property.
virtual QgsMapLayer * clone() const =0
Returns a new instance equivalent to this one except for the id which is still unique.
void blendModeChanged(QPainter::CompositionMode blendMode)
Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode()
virtual QString saveSldStyleV2(bool &resultFlag, const QgsSldExportContext &exportContext) const
Saves the properties of this layer to an SLD format file.
void setName(const QString &name)
Set the display name of the layer.
void setAutoRefreshInterval(int interval)
Sets the auto refresh interval (in milliseconds) for the layer.
virtual bool readSymbology(const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories)=0
Read the symbology for the current layer from the DOM node supplied.
Q_DECL_DEPRECATED QString metadataUrl() const
Returns the metadata URL of the layer used by QGIS Server in GetCapabilities request.
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 saveNamedMetadata(const QString &uri, bool &resultFlag)
Save the current metadata of this layer as a named metadata (either as a .qmd file on disk or as a re...
QString mDataSource
Data source description string, varies by layer type.
void setAutoRefreshMode(Qgis::AutoRefreshMode mode)
Sets the automatic refresh mode for the layer.
QString refreshOnNotifyMessage() const
Returns the message that should be notified by the provider to triggerRepaint.
virtual bool readSld(const QDomNode &node, QString &errorMessage)
void setMapTipsEnabled(bool enabled)
Enable or disable map tips for this layer.
virtual QString loadDefaultMetadata(bool &resultFlag)
Retrieve the default metadata for this layer if one exists (either as a .qmd file on disk or as a rec...
@ 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.
void setValid(bool valid)
Sets whether layer is valid or not.
Q_DECL_DEPRECATED QString attributionUrl() const
Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request.
void readCommonStyle(const QDomElement &layerElement, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories)
Read style data common to all layer types.
void customPropertyChanged(const QString &key)
Emitted when a custom property of the layer has been changed or removed.
QgsMapLayer::ReadFlags mReadFlags
Read flags. It's up to the subclass to respect these when restoring state from XML.
double minimumScale() const
Returns the minimum map scale (i.e.
QgsMapLayerStyleManager * styleManager() const
Gets access to the layer's style manager.
QString legendUrl() const
Returns the URL for the layer's legend.
void flagsChanged()
Emitted when layer's flags have been modified.
void repaintRequested(bool deferredUpdate=false)
By emitting this signal the layer tells that either appearance or content have been changed and any v...
void setLegendUrlFormat(const QString &legendUrlFormat)
Sets the format for a URL based layer legend.
void exportNamedMetadata(QDomDocument &doc, QString &errorMsg) const
Export the current metadata of this layer as named metadata in a QDomDocument.
virtual QString saveNamedStyle(const QString &uri, bool &resultFlag, StyleCategories categories=AllStyleCategories)
Save the properties of this layer as a named style (either as a .qml file on disk or as a record in t...
virtual void exportSldStyle(QDomDocument &doc, QString &errorMsg) const
Export the properties of this layer as SLD style in a QDomDocument.
void beforeResolveReferences(QgsProject *project)
Emitted when all layers are loaded and references can be resolved, just before the references of this...
void setMapTipTemplate(const QString &mapTipTemplate)
The mapTip is a pretty, html representation for feature information.
Q_DECL_DEPRECATED void setMetadataUrl(const QString &metaUrl)
Sets the metadata URL of the layer used by QGIS Server in GetCapabilities request.
virtual QgsMapLayerElevationProperties * elevationProperties()
Returns the layer's elevation properties.
bool setVerticalCrs(const QgsCoordinateReferenceSystem &crs, QString *errorMessage=nullptr)
Sets the layer's vertical coordinate reference system.
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.
Q_DECL_DEPRECATED void setMetadataUrlType(const QString &metaUrlType)
Set the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType ind...
bool mapTipsEnabled
Definition qgsmaplayer.h:90
bool readLayerXml(const QDomElement &layerElement, QgsReadWriteContext &context, QgsMapLayer::ReadFlags flags=QgsMapLayer::ReadFlags(), QgsDataProvider *preloadedProvider=nullptr)
Sets state from DOM document.
void setLegend(QgsMapLayerLegend *legend)
Assign a legend controller to the map layer.
double opacity
Definition qgsmaplayer.h:88
virtual QString decodedSource(const QString &source, const QString &dataProvider, const QgsReadWriteContext &context) const
Called by readLayerXML(), used by derived classes to decode provider's specific data source from proj...
void nameChanged()
Emitted when the name has been changed.
virtual QString metadataUri() const
Retrieve the metadata URI for this layer (either as a .qmd file on disk or as a record in the users s...
int autoRefreshInterval
Definition qgsmaplayer.h:81
QgsCoordinateReferenceSystem verticalCrs
Definition qgsmaplayer.h:84
virtual bool writeStyle(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const
Write just the symbology information for the layer into the document.
bool mIsRefreshOnNofifyEnabled
virtual Q_INVOKABLE QgsDataProvider * dataProvider()
Returns the layer's data provider, it may be nullptr.
double mLayerOpacity
Layer opacity.
bool mValid
Indicates if the layer is valid and can be drawn.
@ LayerConfiguration
General configuration: identifiable, removable, searchable, display expression, read-only.
@ Symbology
Symbology.
@ Notes
Layer user notes.
@ Temporal
Temporal properties.
@ Rendering
Rendering: scale visibility, simplify method, opacity.
@ Elevation
Elevation settings.
@ Symbology3D
3D symbology
@ CustomProperties
Custom properties (by plugins for instance)
virtual Q_INVOKABLE void reload()
Synchronises with changes in the datasource.
virtual QDateTime timestamp() const
Time stamp of data source in the moment when data/metadata were loaded by provider.
void setProviderType(const QString &providerType)
Sets the providerType (provider key)
void mapTipsEnabledChanged()
Emitted when map tips are enabled or disabled for the layer.
virtual QString saveDefaultStyle(bool &resultFlag, StyleCategories categories)
Save the properties of this layer as the default style (either as a .qml file on disk or as a record ...
void setRenderer3D(QgsAbstract3DRenderer *renderer)
Sets 3D renderer for the layer.
~QgsMapLayer() override
QString customPropertyHtmlMetadata() const
Returns an HTML fragment containing custom property information, for use in the htmlMetadata() method...
const QgsObjectCustomProperties & customProperties() const
Read all custom properties from layer.
virtual void exportSldStyleV2(QDomDocument &doc, QString &errorMsg, const QgsSldExportContext &exportContext) const
Export the properties of this layer as SLD style in a QDomDocument.
QString generalHtmlMetadata() const
Returns an HTML fragment containing general metadata information, for use in the htmlMetadata() metho...
Q_DECL_DEPRECATED QString metadataUrlType() const
Returns the metadata type of the layer used by QGIS Server in GetCapabilities request.
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.
Q_DECL_DEPRECATED QString keywordList() const
Returns the keyword list of the layer used by QGIS Server in GetCapabilities request.
virtual void setLayerOrder(const QStringList &layers)
Reorders the previously selected sublayers of this layer from bottom to top.
void invalidateWgs84Extent()
Invalidates the WGS84 extent.
QString mapTipTemplate
Definition qgsmaplayer.h:89
Q_DECL_DEPRECATED void setTitle(const QString &title)
Sets the title of the layer used by QGIS Server in GetCapabilities request.
PropertyType
Maplayer has a style and a metadata property.
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).
Custom exception class which is raised when an operation is not supported.
Simple key-value store (keys = strings, values = variants) that supports loading/saving to/from XML i...
void setValue(const QString &key, const QVariant &value)
Add an entry to the store with the specified key.
QStringList keys() const
Returns a list of all stored keys.
void writeXml(QDomNode &parentNode, QDomDocument &doc) const
Writes the store contents to an XML node.
void remove(const QString &key)
Removes a key (entry) from the store.
QVariant value(const QString &key, const QVariant &defaultValue=QVariant()) const
Returns the value for the given key.
void readXml(const QDomNode &parentNode, const QString &keyStartsWith=QString())
Read store contents from an XML node.
bool contains(const QString &key) const
Returns true if the properties contains a key with the specified name.
Contains information about a PROJ operation.
QString description() const
Description.
Class to convert from older project file versions to newer.
bool updateRevision(const QgsProjectVersion &version)
virtual QString translate(const QString &context, const QString &sourceText, const char *disambiguation=nullptr, int n=-1) const =0
Translates a string using the Qt QTranslator mechanism.
A class to describe the version of a project.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:107
bool removeAttachedFile(const QString &path)
Removes the attached file.
static QgsProject * instance()
Returns the QgsProject singleton instance.
QString baseName() const
Returns the base name of the project file without the path and without extension - derived from fileN...
QString absoluteFilePath() const
Returns full absolute path to the project file if the project is stored in a file system - derived fr...
Holds data provider key, description, and associated shared library file or function pointer informat...
@ SaveLayerMetadata
Indicates that the provider supports saving native layer metadata.
QString absoluteToRelativeUri(const QString &providerKey, const QString &uri, const QgsReadWriteContext &context) const
Converts absolute path(s) to relative path(s) in the given provider-specific URI.
QString getStyleById(const QString &providerKey, const QString &uri, const QString &styleId, QString &errCause)
Gets a layer style defined by styleId.
QVariantMap decodeUri(const QString &providerKey, const QString &uri)
Breaks a provider data source URI into its component paths (e.g.
static QgsProviderRegistry * instance(const QString &pluginPath=QString())
Means of accessing canonical single instance.
bool saveLayerMetadata(const QString &providerKey, const QString &uri, const QgsLayerMetadata &metadata, QString &errorMessage)
Saves metadata to the layer corresponding to the specified uri.
bool deleteStyleById(const QString &providerKey, const QString &uri, const QString &styleId, QString &errCause)
Deletes a layer style defined by styleId.
QString loadStoredStyle(const QString &providerKey, const QString &uri, QString &styleName, QString &errCause)
Loads a layer style from the provider storage, reporting its name.
QString relativeToAbsoluteUri(const QString &providerKey, const QString &uri, const QgsReadWriteContext &context) const
Converts relative path(s) to absolute path(s) in the given provider-specific URI.
QgsProviderMetadata * providerMetadata(const QString &providerKey) const
Returns metadata of the provider or nullptr if not found.
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.
Represents a raster layer.
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.0.0 format.
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.
A rectangle specified with double values.
bool isNull() const
Test if the rectangle is null (holding no spatial information).
static bool equalToOrGreaterThanMinimumScale(const double scale, const double minScale)
Returns whether the scale is equal to or greater than the minScale, taking non-round numbers into acc...
static bool lessThanMaximumScale(const double scale, const double maxScale)
Returns whether the scale is less than the maxScale, taking non-round numbers into account.
void setMetadataUrls(const QList< QgsServerMetadataUrlProperties::MetadataUrl > &metaUrls)
Sets a the list of metadata URL for the layer.
QList< QgsServerMetadataUrlProperties::MetadataUrl > metadataUrls() const
Returns a list of metadataUrl resources associated for the layer.
The QgsSldExportContext class holds SLD export options and other information related to SLD export of...
QString exportFilePath() const
Returns the export file path for the SLD.
void setExportFilePath(const QString &exportFilePath)
Sets the export file path for the SLD to exportFilePath.
static QString capitalize(const QString &string, Qgis::Capitalization capitalization)
Converts a string by applying capitalization rules to the string.
An interface for classes which can visit style entity (e.g.
static Q_INVOKABLE QString toString(Qgis::DistanceUnit unit)
Returns a translated string representing a distance unit.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
Represents a vector layer which manages a vector based data sets.
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.
Q_INVOKABLE Qgis::GeometryType geometryType() const
Returns point, line or polygon.
static T readFlagAttribute(const QDomElement &element, const QString &attributeName, T defaultValue)
Read a flag value from an attribute of the element.
static QDomElement writeBox3D(const QgsBox3D &box, QDomDocument &doc, const QString &elementName=QStringLiteral("extent3D"))
Encodes a 3D box to a DOM element.
static QgsBox3D readBox3D(const QDomElement &element)
Decodes a DOM element to a 3D box.
static QDomElement writeRectangle(const QgsRectangle &rect, QDomDocument &doc, const QString &elementName=QStringLiteral("extent"))
Encodes a rectangle to a DOM element.
static QgsRectangle readRectangle(const QDomElement &element)
Unique pointer for sqlite3 databases, which automatically closes the database when the pointer goes o...
sqlite3_statement_unique_ptr prepare(const QString &sql, int &resultCode) const
Prepares a sql statement, returning the result.
int open(const QString &path)
Opens the database at the specified file path.
int open_v2(const QString &path, int flags, const char *zVfs)
Opens the database at the specified file path.
Unique pointer for sqlite3 prepared statements, which automatically finalizes the statement when the ...
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
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:6127
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
Definition qgis.h:5834
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
Definition qgis.h:6108
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Definition qgis.h:5917
CONSTLATIN1STRING geoEpsgCrsAuthId()
Geographic coord sys from EPSG authority.
Definition qgis.h:6406
void(* CUSTOM_CRS_VALIDATION)(QgsCoordinateReferenceSystem &)
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:39
#define QgsDebugError(str)
Definition qgslogger.h:38
#define QGIS_PROTECT_QOBJECT_THREAD_ACCESS_NON_FATAL
#define QGIS_PROTECT_QOBJECT_THREAD_ACCESS
const QgsCoordinateReferenceSystem & crs
Setting options for creating vector data providers.
QString format
Format specification of online resource.