54#include <QDomDocument>
56#include <QDomImplementation>
64#include <QStandardPaths>
66#include <QRegularExpression>
75 return QStringLiteral(
".qmd" );
78 return QStringLiteral(
".qml" );
84 const QString &lyrname,
85 const QString &source )
86 : mDataSource( source )
87 , mLayerName( lyrname )
90 , mUndoStack( new QUndoStack( this ) )
91 , mUndoStackStyles( new QUndoStack( this ) )
93 , mRefreshTimer( new QTimer( this ) )
98 connect( mRefreshTimer, &QTimer::timeout,
this, [
this]
101 switch ( mAutoRefreshMode )
124 delete mStyleManager;
135 for (
const QString &s : constStyles )
145 layer->mExtent3D = mExtent3D;
147 layer->mExtent2D = mExtent2D;
183 if (
flags == mFlags )
208 if ( qobject_cast< QgsMapLayerStore * >( parent() ) )
266 mServerProperties->setShortName(
shortName );
273 return mServerProperties->shortName();
280 mServerProperties->setTitle(
title );
287 return mServerProperties->title();
294 mServerProperties->setAbstract(
abstract );
301 return mServerProperties->abstract();
308 mServerProperties->setKeywordList( keywords );
315 return mServerProperties->keywordList();
322 mServerProperties->setDataUrl(
dataUrl );
329 return mServerProperties->dataUrl();
343 return mServerProperties->dataUrlFormat();
350 mServerProperties->setAttribution( attrib );
357 return mServerProperties->attribution();
364 mServerProperties->setAttributionUrl( attribUrl );
371 return mServerProperties->attributionUrl();
380 if ( urls.isEmpty() )
383 urls.prepend( newItem );
389 urls.prepend( newItem );
398 if ( mServerProperties->metadataUrls().isEmpty() )
400 return QLatin1String();
404 return mServerProperties->metadataUrls().first().url;
412 QList<QgsMapLayerServerProperties::MetadataUrl> urls = mServerProperties->metadataUrls();
413 if ( urls.isEmpty() )
416 urls.prepend( newItem );
422 urls.prepend( newItem );
424 mServerProperties->setMetadataUrls( urls );
431 if ( mServerProperties->metadataUrls().isEmpty() )
433 return QLatin1String();
437 return mServerProperties->metadataUrls().first().type;
445 QList<QgsMapLayerServerProperties::MetadataUrl> urls = mServerProperties->metadataUrls();
446 if ( urls.isEmpty() )
449 urls.prepend( newItem );
455 urls.prepend( newItem );
457 mServerProperties->setMetadataUrls( urls );
464 if ( mServerProperties->metadataUrls().isEmpty() )
470 return mServerProperties->metadataUrls().first().format;
558 mnl = layerElement.namedItem( QStringLiteral(
"provider" ) );
559 mne = mnl.toElement();
560 provider = mne.text();
563 mnl = layerElement.namedItem( QStringLiteral(
"datasource" ) );
564 mne = mnl.toElement();
565 const QString dataSourceRaw = mne.text();
569 const thread_local QRegularExpression rx(
"authcfg=([a-z]|[A-Z]|[0-9]){7}" );
582 mnl = layerElement.namedItem( QStringLiteral(
"layername" ) );
583 mne = mnl.toElement();
588 const QDomNode srsNode = layerElement.namedItem( QStringLiteral(
"srs" ) );
607 mnl = layerElement.namedItem( QStringLiteral(
"id" ) );
608 if ( ! mnl.isNull() )
610 mne = mnl.toElement();
611 if ( ! mne.isNull() && mne.text().length() > 10 )
613 const QString newId = mne.text();
623 mnl = layerElement.namedItem( QStringLiteral(
"layername" ) );
624 mne = mnl.toElement();
627 setName( context.
projectTranslator()->
translate( QStringLiteral(
"project:layers:%1" ).arg( layerElement.namedItem( QStringLiteral(
"id" ) ).toElement().text() ), mne.text() ) );
630 layerError = !
readXml( layerElement, context );
644 const QDomNode verticalCrsNode = layerElement.firstChildElement( QStringLiteral(
"verticalCrs" ) );
645 if ( !verticalCrsNode.isNull() )
654 const QDomElement legendUrlElem = layerElement.firstChildElement( QStringLiteral(
"legendUrl" ) );
655 if ( !legendUrlElem.isNull() )
658 mLegendUrlFormat = legendUrlElem.attribute( QStringLiteral(
"format" ), QString() );
667 const QDomElement metaUrlElem = layerElement.firstChildElement( QStringLiteral(
"metadataUrl" ) );
668 if ( !metaUrlElem.isNull() )
670 const QString url = metaUrlElem.text();
671 const QString
type = metaUrlElem.attribute( QStringLiteral(
"type" ), QString() );
672 const QString format = metaUrlElem.attribute( QStringLiteral(
"format" ), QString() );
674 mServerProperties->setMetadataUrls( QList<QgsMapLayerServerProperties::MetadataUrl>() << newItem );
679 const QDomElement metadataElem = layerElement.firstChildElement( QStringLiteral(
"resourceMetadata" ) );
682 setAutoRefreshInterval( layerElement.attribute( QStringLiteral(
"autoRefreshTime" ), QStringLiteral(
"0" ) ).toInt() );
683 if ( layerElement.hasAttribute( QStringLiteral(
"autoRefreshMode" ) ) )
692 setRefreshOnNotifyEnabled( layerElement.attribute( QStringLiteral(
"refreshOnNotifyEnabled" ), QStringLiteral(
"0" ) ).toInt() );
697 const QDomNode wgs84ExtentNode = layerElement.namedItem( QStringLiteral(
"wgs84extent" ) );
698 if ( !wgs84ExtentNode.isNull() )
702 mLegendPlaceholderImage = layerElement.attribute( QStringLiteral(
"legendPlaceholderImage" ) );
706 if ( mCrs3D != oldCrs3D )
717 Q_UNUSED( layer_node )
724 const QDomNode extent3DNode = layer_node.namedItem( QStringLiteral(
"extent3D" ) );
725 if ( extent3DNode.isNull() )
727 const QDomNode extentNode = layer_node.namedItem( QStringLiteral(
"extent" ) );
728 if ( !extentNode.isNull() )
749 else if ( !mExtent2D.
isNull() )
757 layerElement.setAttribute( QStringLiteral(
"autoRefreshTime" ), QString::number( mRefreshTimer->interval() ) );
758 layerElement.setAttribute( QStringLiteral(
"autoRefreshMode" ),
qgsEnumValueToKey( mAutoRefreshMode ) );
763 QDomElement layerId = document.createElement( QStringLiteral(
"id" ) );
764 const QDomText layerIdText = document.createTextNode(
id() );
765 layerId.appendChild( layerIdText );
767 layerElement.appendChild( layerId );
771 QDomElement verticalSrsNode = document.createElement( QStringLiteral(
"verticalCrs" ) );
772 mVerticalCrs.
writeXml( verticalSrsNode, document );
773 layerElement.appendChild( verticalSrsNode );
777 QDomElement dataSource = document.createElement( QStringLiteral(
"datasource" ) );
779 const QString providerKey = provider ? provider->
name() : QString();
782 const QDomText dataSourceText = document.createTextNode( src );
783 dataSource.appendChild( dataSourceText );
784 layerElement.appendChild( dataSource );
787 QDomElement layerName = document.createElement( QStringLiteral(
"layername" ) );
788 const QDomText layerNameText = document.createTextNode(
name() );
789 layerName.appendChild( layerNameText );
790 layerElement.appendChild( layerName );
796 if ( !mServerProperties->shortName().isEmpty() )
798 QDomElement layerShortName = document.createElement( QStringLiteral(
"shortname" ) );
799 const QDomText layerShortNameText = document.createTextNode( mServerProperties->shortName() );
800 layerShortName.appendChild( layerShortNameText );
801 layerElement.appendChild( layerShortName );
805 if ( !mServerProperties->title().isEmpty() )
807 QDomElement layerTitle = document.createElement( QStringLiteral(
"title" ) );
808 const QDomText layerTitleText = document.createTextNode( mServerProperties->title() );
809 layerTitle.appendChild( layerTitleText );
811 if ( mServerProperties->title() != mServerProperties->wfsTitle() )
813 layerTitle.setAttribute(
"wfs", mServerProperties->wfsTitle() );
816 layerElement.appendChild( layerTitle );
820 if ( !mServerProperties->abstract().isEmpty() )
822 QDomElement layerAbstract = document.createElement( QStringLiteral(
"abstract" ) );
823 const QDomText layerAbstractText = document.createTextNode( mServerProperties->abstract() );
824 layerAbstract.appendChild( layerAbstractText );
825 layerElement.appendChild( layerAbstract );
829 const QStringList keywordStringList = mServerProperties->keywordList().split(
',' );
830 if ( !keywordStringList.isEmpty() )
832 QDomElement layerKeywordList = document.createElement( QStringLiteral(
"keywordList" ) );
833 for (
int i = 0; i < keywordStringList.size(); ++i )
835 QDomElement layerKeywordValue = document.createElement( QStringLiteral(
"value" ) );
836 const QDomText layerKeywordText = document.createTextNode( keywordStringList.at( i ).trimmed() );
837 layerKeywordValue.appendChild( layerKeywordText );
838 layerKeywordList.appendChild( layerKeywordValue );
840 layerElement.appendChild( layerKeywordList );
844 const QString aDataUrl = mServerProperties->dataUrl();
845 if ( !aDataUrl.isEmpty() )
847 QDomElement layerDataUrl = document.createElement( QStringLiteral(
"dataUrl" ) );
848 const QDomText layerDataUrlText = document.createTextNode( aDataUrl );
849 layerDataUrl.appendChild( layerDataUrlText );
850 layerDataUrl.setAttribute( QStringLiteral(
"format" ), mServerProperties->dataUrlFormat() );
851 layerElement.appendChild( layerDataUrl );
856 if ( !aLegendUrl.isEmpty() )
858 QDomElement layerLegendUrl = document.createElement( QStringLiteral(
"legendUrl" ) );
859 const QDomText layerLegendUrlText = document.createTextNode( aLegendUrl );
860 layerLegendUrl.appendChild( layerLegendUrlText );
861 layerLegendUrl.setAttribute( QStringLiteral(
"format" ),
legendUrlFormat() );
862 layerElement.appendChild( layerLegendUrl );
866 const QString aAttribution = mServerProperties->attribution();
867 if ( !aAttribution.isEmpty() )
869 QDomElement layerAttribution = document.createElement( QStringLiteral(
"attribution" ) );
870 const QDomText layerAttributionText = document.createTextNode( aAttribution );
871 layerAttribution.appendChild( layerAttributionText );
872 layerAttribution.setAttribute( QStringLiteral(
"href" ), mServerProperties->attributionUrl() );
873 layerElement.appendChild( layerAttribution );
879 QDomElement stamp = document.createElement( QStringLiteral(
"timestamp" ) );
880 const QDomText stampText = document.createTextNode(
timestamp().toString( Qt::ISODate ) );
881 stamp.appendChild( stampText );
882 layerElement.appendChild( stamp );
885 layerElement.appendChild( layerName );
892 QDomElement mySrsElement = document.createElement( QStringLiteral(
"srs" ) );
893 mCRS.
writeXml( mySrsElement, document );
894 layerElement.appendChild( mySrsElement );
897 QDomElement myMetadataElem = document.createElement( QStringLiteral(
"resourceMetadata" ) );
899 layerElement.appendChild( myMetadataElem );
901 layerElement.setAttribute( QStringLiteral(
"legendPlaceholderImage" ), mLegendPlaceholderImage );
904 return writeXml( layerElement, document, context );
913 const QMetaEnum metaEnum = QMetaEnum::fromType<QgsMapLayer::StyleCategories>();
914 const QString categoriesKeys( metaEnum.valueToKeys(
static_cast<int>( categories ) ) );
915 layerElement.setAttribute( QStringLiteral(
"styleCategories" ), categoriesKeys );
920 layerElement.setAttribute( QStringLiteral(
"hasScaleBasedVisibilityFlag" ),
hasScaleBasedVisibility() ? 1 : 0 );
921 layerElement.setAttribute( QStringLiteral(
"maxScale" ), QString::number(
maximumScale() ) );
922 layerElement.setAttribute( QStringLiteral(
"minScale" ), QString::number(
minimumScale() ) );
923 layerElement.setAttribute( QStringLiteral(
"autoRefreshMode" ),
qgsEnumValueToKey( mAutoRefreshMode ) );
924 layerElement.setAttribute( QStringLiteral(
"autoRefreshInterval" ), QString::number(
autoRefreshInterval() ) );
931 QDomElement renderer3DElem = document.createElement( QStringLiteral(
"renderer-3d" ) );
932 renderer3DElem.setAttribute( QStringLiteral(
"type" ), m3DRenderer->
type() );
933 m3DRenderer->
writeXml( renderer3DElem, context );
934 layerElement.appendChild( renderer3DElem );
942 QDomElement layerFlagsElem = document.createElement( QStringLiteral(
"flags" ) );
943 const auto enumMap = qgsEnumMap<QgsMapLayer::LayerFlag>();
944 for (
auto it = enumMap.constBegin(); it != enumMap.constEnd(); ++it )
946 const bool flagValue = mFlags.testFlag( it.key() );
947 QDomElement flagElem = document.createElement( it.value() );
948 flagElem.appendChild( document.createTextNode( QString::number( flagValue ) ) );
949 layerFlagsElem.appendChild( flagElem );
951 layerElement.appendChild( layerFlagsElem );
954 if ( categories.testFlag(
Temporal ) )
957 properties->writeXml( layerElement, document, context );
963 properties->writeXml( layerElement, document, context );
968 QDomElement notesElem = document.createElement( QStringLiteral(
"userNotes" ) );
970 layerElement.appendChild( notesElem );
985 Q_UNUSED( layer_node )
1026 mCustomProperties.
readXml( layerNode, keyStartsWith );
1028 for (
const QString &key : mCustomProperties.
keys() )
1030 if ( !oldKeys.contains( key ) || mCustomProperties.
value( key ) != oldKeys.value( key ) )
1041 mCustomProperties.
writeXml( layerNode, doc );
1048 const QDomElement styleMgrElem = layerNode.firstChildElement( QStringLiteral(
"map-layer-style-manager" ) );
1049 if ( !styleMgrElem.isNull() )
1050 mStyleManager->
readXml( styleMgrElem );
1052 mStyleManager->
reset();
1059 if ( mStyleManager )
1061 QDomElement styleMgrElem = doc.createElement( QStringLiteral(
"map-layer-style-manager" ) );
1062 mStyleManager->
writeXml( styleMgrElem );
1063 layerNode.appendChild( styleMgrElem );
1071 return mMapTipTemplate;
1078 if ( mMapTipTemplate == mapTip )
1081 mMapTipTemplate = mapTip;
1089 if ( mMapTipsEnabled == enabled )
1092 mMapTipsEnabled = enabled;
1100 return mMapTipsEnabled;
1117 const QDomNode extent3DNode = layerNode.namedItem( QStringLiteral(
"extent3D" ) );
1118 if ( extent3DNode.isNull() )
1120 const QDomNode extentNode = layerNode.namedItem( QStringLiteral(
"extent" ) );
1121 if ( !extentNode.isNull() )
1144void QgsMapLayer::connectNotify(
const char *signal )
1156 return !mScaleBasedVisibility ||
1158 && ( mMaxScale == 0 || scale < mMaxScale ) );
1166 return mScaleBasedVisibility;
1180 return mAutoRefreshMode;
1187 return mRefreshTimer->interval();
1194 if ( interval <= 0 )
1196 mRefreshTimer->stop();
1197 mRefreshTimer->setInterval( 0 );
1202 mRefreshTimer->setInterval( interval );
1218 if ( mode == mAutoRefreshMode )
1221 mAutoRefreshMode = mode;
1222 switch ( mAutoRefreshMode )
1225 mRefreshTimer->stop();
1230 if ( mRefreshTimer->interval() > 0 )
1231 mRefreshTimer->start();
1270 mScaleBasedVisibility = enabled;
1284 return QStringList();
1322 switch ( mCRS.
type() )
1325 QgsDebugError( QStringLiteral(
"Layer has a vertical CRS set as the horizontal CRS!" ) );
1344 return mVerticalCrs;
1351 return mCrs3D.
isValid() ? mCrs3D : mCRS;
1379 if ( oldCrs3D != mCrs3D )
1408 *errorMessage = QObject::tr(
"Specified CRS is a %1 CRS, not a Vertical CRS" ).arg(
qgsEnumValueToKey(
crs.
type() ) );
1413 if (
crs != mVerticalCrs )
1418 switch ( mCRS.
type() )
1421 if (
crs != oldVerticalCrs )
1424 *errorMessage = QObject::tr(
"Layer CRS is a Compound CRS, specified Vertical CRS will be ignored" );
1430 if (
crs != oldVerticalCrs )
1433 *errorMessage = QObject::tr(
"Layer CRS is a Geographic 3D CRS, specified Vertical CRS will be ignored" );
1439 if (
crs != oldVerticalCrs )
1442 *errorMessage = QObject::tr(
"Layer CRS is a Geocentric CRS, specified Vertical CRS will be ignored" );
1451 *errorMessage = QObject::tr(
"Layer CRS is a Projected 3D CRS, specified Vertical CRS will be ignored" );
1469 res = rebuildCrs3D( errorMessage );
1475 if ( mCrs3D != oldCrs3D )
1491 QString layerName(
name );
1492 layerName.replace(
'_',
' ' );
1497QString QgsMapLayer::baseURI( PropertyType type )
const
1511 myURI = components[
"path"].toString();
1514 QFileInfo myFileInfo( myURI );
1517 if ( myFileInfo.exists() )
1520 if ( myURI.endsWith( QLatin1String(
".gz" ), Qt::CaseInsensitive ) )
1522 else if ( myURI.endsWith( QLatin1String(
".zip" ), Qt::CaseInsensitive ) )
1524 else if ( myURI.endsWith( QLatin1String(
".tar" ), Qt::CaseInsensitive ) )
1526 else if ( myURI.endsWith( QLatin1String(
".tar.gz" ), Qt::CaseInsensitive ) )
1528 else if ( myURI.endsWith( QLatin1String(
".tgz" ), Qt::CaseInsensitive ) )
1530 myFileInfo.setFile( myURI );
1559 QString errorMessage;
1562 return tr(
"Successfully saved default layer metadata" );
1564 return errorMessage;
1613bool QgsMapLayer::loadNamedPropertyFromDatabase(
const QString &db,
const QString &uri, QString &xml,
QgsMapLayer::PropertyType type )
1617 QgsDebugMsgLevel( QStringLiteral(
"db = %1 uri = %2" ).arg( db, uri ), 4 );
1619 bool resultFlag =
false;
1627 QgsDebugMsgLevel( QStringLiteral(
"Trying to load style or metadata for \"%1\" from \"%2\"" ).arg( uri, db ), 4 );
1629 if ( db.isEmpty() || !QFile( db ).exists() )
1632 myResult = database.
open_v2( db, SQLITE_OPEN_READONLY,
nullptr );
1633 if ( myResult != SQLITE_OK )
1642 mySql = QStringLiteral(
"select qmd from tbl_metadata where metadata=?" );
1646 mySql = QStringLiteral(
"select qml from tbl_styles where style=?" );
1650 statement = database.
prepare( mySql, myResult );
1651 if ( myResult == SQLITE_OK )
1653 QByteArray param = uri.toUtf8();
1655 if ( sqlite3_bind_text( statement.get(), 1, param.data(), param.length(), SQLITE_STATIC ) == SQLITE_OK &&
1656 sqlite3_step( statement.get() ) == SQLITE_ROW )
1658 xml = QString::fromUtf8(
reinterpret_cast< const char *
>( sqlite3_column_text( statement.get(), 0 ) ) );
1679 namedPropertyExists =
false;
1680 propertySuccessfullyLoaded =
false;
1681 if ( uri.isEmpty() )
1684 QDomDocument myDocument( QStringLiteral(
"qgis" ) );
1688 QString myErrorMessage;
1690 QFile myFile( uri );
1691 if ( myFile.open( QFile::ReadOnly ) )
1694 namedPropertyExists =
true;
1697 propertySuccessfullyLoaded = myDocument.setContent( &myFile, &myErrorMessage, &line, &column );
1698 if ( !propertySuccessfullyLoaded )
1699 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1716 namedPropertyExists =
true;
1717 propertySuccessfullyLoaded = myDocument.setContent( xml, &myErrorMessage, &line, &column );
1718 if ( !propertySuccessfullyLoaded )
1720 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1727 myErrorMessage = tr(
"Style not found in database" );
1738 namedPropertyExists =
true;
1739 propertySuccessfullyLoaded = myDocument.setContent( xml, &myErrorMessage, &line, &column );
1740 if ( !propertySuccessfullyLoaded )
1742 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1747 myErrorMessage = tr(
"Metadata not found in database" );
1754 if ( !propertySuccessfullyLoaded )
1756 return myErrorMessage;
1762 propertySuccessfullyLoaded =
importNamedStyle( myDocument, myErrorMessage, categories );
1763 if ( !propertySuccessfullyLoaded )
1764 myErrorMessage = tr(
"Loading style file %1 failed because:\n%2" ).arg( uri, myErrorMessage );
1768 if ( !propertySuccessfullyLoaded )
1769 myErrorMessage = tr(
"Loading metadata file %1 failed because:\n%2" ).arg( uri, myErrorMessage );
1772 return myErrorMessage;
1779 const QDomElement myRoot = document.firstChildElement( QStringLiteral(
"qgis" ) );
1780 if ( myRoot.isNull() )
1782 errorMessage = tr(
"Root <qgis> element could not be found" );
1793 const QDomElement myRoot = myDocument.firstChildElement( QStringLiteral(
"qgis" ) );
1794 if ( myRoot.isNull() )
1796 myErrorMessage = tr(
"Root <qgis> element could not be found" );
1801 const QgsProjectVersion fileVersion( myRoot.attribute( QStringLiteral(
"version" ) ) );
1804 if ( thisVersion > fileVersion )
1823 myErrorMessage = tr(
"Cannot apply style with symbology to layer with a different geometry type" );
1830 return readSymbology( myRoot, myErrorMessage, context, categories );
1837 QDomImplementation DomImplementation;
1838 const QDomDocumentType documentType = DomImplementation.createDocumentType( QStringLiteral(
"qgis" ), QStringLiteral(
"http://mrcc.com/qgis.dtd" ), QStringLiteral(
"SYSTEM" ) );
1839 QDomDocument myDocument( documentType );
1841 QDomElement myRootNode = myDocument.createElement( QStringLiteral(
"qgis" ) );
1842 myRootNode.setAttribute( QStringLiteral(
"version" ),
Qgis::version() );
1843 myDocument.appendChild( myRootNode );
1847 errorMsg = QObject::tr(
"Could not save metadata" );
1858 QDomImplementation DomImplementation;
1859 const QDomDocumentType documentType = DomImplementation.createDocumentType( QStringLiteral(
"qgis" ), QStringLiteral(
"http://mrcc.com/qgis.dtd" ), QStringLiteral(
"SYSTEM" ) );
1860 QDomDocument myDocument( documentType );
1862 QDomElement myRootNode = myDocument.createElement( QStringLiteral(
"qgis" ) );
1863 myRootNode.setAttribute( QStringLiteral(
"version" ),
Qgis::version() );
1864 myDocument.appendChild( myRootNode );
1866 if ( !
writeSymbology( myRootNode, myDocument, errorMsg, context, categories ) )
1868 errorMsg = QObject::tr(
"Could not save symbology because:\n%1" ).arg( errorMsg );
1879 const QgsVectorLayer *vl = qobject_cast<const QgsVectorLayer *>(
this );
1880 const QString geoType = QString::number(
static_cast<int>( vl->
geometryType() ) );
1883 QDomElement layerGeometryType = myDocument.createElement( QStringLiteral(
"layerGeometryType" ) );
1884 const QDomText
type = myDocument.createTextNode( geoType );
1886 layerGeometryType.appendChild(
type );
1887 myRootNode.appendChild( layerGeometryType );
1918 bool metadataExists =
false;
1919 bool metadataSuccessfullyLoaded =
false;
1920 const QString message = loadNamedProperty( uri,
QgsMapLayer::Metadata, metadataExists, metadataSuccessfullyLoaded );
1923 ( void )metadataExists;
1924 resultFlag = metadataSuccessfullyLoaded;
1928QString QgsMapLayer::saveNamedProperty(
const QString &uri,
QgsMapLayer::PropertyType type,
bool &resultFlag, StyleCategories categories )
1938 if ( vlayer && vlayer->
providerType() == QLatin1String(
"ogr" ) )
1940 QStringList theURIParts = uri.split(
'|' );
1941 filename = theURIParts[0];
1943 else if ( vlayer && vlayer->
providerType() == QLatin1String(
"gpx" ) )
1945 QStringList theURIParts = uri.split(
'?' );
1946 filename = theURIParts[0];
1948 else if ( vlayer && vlayer->
providerType() == QLatin1String(
"delimitedtext" ) )
1950 filename = QUrl::fromEncoded( uri.toLatin1() ).toLocalFile();
1952 if ( filename.isEmpty() )
1960 QString myErrorMessage;
1961 QDomDocument myDocument;
1974 const QFileInfo myFileInfo( filename );
1977 const QFileInfo myDirInfo( myFileInfo.path() );
1978 if ( !myDirInfo.isWritable() )
1981 return tr(
"The directory containing your dataset needs to be writable!" );
1987 QFile myFile( myFileName );
1988 if ( myFile.open( QFile::WriteOnly | QFile::Truncate ) )
1990 QTextStream myFileStream( &myFile );
1992 myDocument.save( myFileStream, 2 );
1998 return tr(
"Created default metadata file as %1" ).arg( myFileName );
2001 return tr(
"Created default style file as %1" ).arg( myFileName );
2011 return tr(
"ERROR: Failed to created default metadata file as %1. Check file permissions and retry." ).arg( myFileName );
2014 return tr(
"ERROR: Failed to created default style file as %1. Check file permissions and retry." ).arg( myFileName );
2020 const QString qml = myDocument.toString();
2027 if ( myResult != SQLITE_OK )
2029 return tr(
"User database could not be opened." );
2032 QByteArray param0 = uri.toUtf8();
2033 QByteArray param1 = qml.toUtf8();
2039 mySql = QStringLiteral(
"create table if not exists tbl_metadata(metadata varchar primary key,qmd varchar)" );
2043 mySql = QStringLiteral(
"create table if not exists tbl_styles(style varchar primary key,qml varchar)" );
2047 statement = database.
prepare( mySql, myResult );
2048 if ( myResult == SQLITE_OK )
2050 if ( sqlite3_step( statement.get() ) != SQLITE_DONE )
2056 return tr(
"The metadata table could not be created." );
2059 return tr(
"The style table could not be created." );
2067 mySql = QStringLiteral(
"insert into tbl_metadata(metadata,qmd) values (?,?)" );
2071 mySql = QStringLiteral(
"insert into tbl_styles(style,qml) values (?,?)" );
2074 statement = database.
prepare( mySql, myResult );
2075 if ( myResult == SQLITE_OK )
2077 if ( sqlite3_bind_text( statement.get(), 1, param0.data(), param0.length(), SQLITE_STATIC ) == SQLITE_OK &&
2078 sqlite3_bind_text( statement.get(), 2, param1.data(), param1.length(), SQLITE_STATIC ) == SQLITE_OK &&
2079 sqlite3_step( statement.get() ) == SQLITE_DONE )
2085 myErrorMessage = tr(
"The metadata %1 was saved to database" ).arg( uri );
2089 myErrorMessage = tr(
"The style %1 was saved to database" ).arg( uri );
2101 mySql = QStringLiteral(
"update tbl_metadata set qmd=? where metadata=?" );
2105 mySql = QStringLiteral(
"update tbl_styles set qml=? where style=?" );
2108 statement = database.
prepare( mySql, myResult );
2109 if ( myResult == SQLITE_OK )
2111 if ( sqlite3_bind_text( statement.get(), 2, param0.data(), param0.length(), SQLITE_STATIC ) == SQLITE_OK &&
2112 sqlite3_bind_text( statement.get(), 1, param1.data(), param1.length(), SQLITE_STATIC ) == SQLITE_OK &&
2113 sqlite3_step( statement.get() ) == SQLITE_DONE )
2119 myErrorMessage = tr(
"The metadata %1 was updated in the database." ).arg( uri );
2123 myErrorMessage = tr(
"The style %1 was updated in the database." ).arg( uri );
2133 myErrorMessage = tr(
"The metadata %1 could not be updated in the database." ).arg( uri );
2137 myErrorMessage = tr(
"The style %1 could not be updated in the database." ).arg( uri );
2148 myErrorMessage = tr(
"The metadata %1 could not be inserted into database." ).arg( uri );
2152 myErrorMessage = tr(
"The style %1 could not be inserted into database." ).arg( uri );
2159 return myErrorMessage;
2179 QDomDocument myDocument = QDomDocument();
2181 const QDomNode header = myDocument.createProcessingInstruction( QStringLiteral(
"xml" ), QStringLiteral(
"version=\"1.0\" encoding=\"UTF-8\"" ) );
2182 myDocument.appendChild( header );
2184 const QgsVectorLayer *vlayer = qobject_cast<const QgsVectorLayer *>(
this );
2185 const QgsRasterLayer *rlayer = qobject_cast<const QgsRasterLayer *>(
this );
2186 if ( !vlayer && !rlayer )
2188 errorMsg = tr(
"Could not save symbology because:\n%1" )
2189 .arg( tr(
"Only vector and raster layers are supported" ) );
2194 QDomElement root = myDocument.createElementNS( QStringLiteral(
"http://www.opengis.net/sld" ), QStringLiteral(
"StyledLayerDescriptor" ) );
2195 QDomElement layerNode;
2198 root.setAttribute( QStringLiteral(
"version" ), QStringLiteral(
"1.1.0" ) );
2199 root.setAttribute( QStringLiteral(
"xsi:schemaLocation" ), QStringLiteral(
"http://www.opengis.net/sld http://schemas.opengis.net/sld/1.1.0/StyledLayerDescriptor.xsd" ) );
2200 root.setAttribute( QStringLiteral(
"xmlns:ogc" ), QStringLiteral(
"http://www.opengis.net/ogc" ) );
2201 root.setAttribute( QStringLiteral(
"xmlns:se" ), QStringLiteral(
"http://www.opengis.net/se" ) );
2202 root.setAttribute( QStringLiteral(
"xmlns:xlink" ), QStringLiteral(
"http://www.w3.org/1999/xlink" ) );
2203 root.setAttribute( QStringLiteral(
"xmlns:xsi" ), QStringLiteral(
"http://www.w3.org/2001/XMLSchema-instance" ) );
2204 myDocument.appendChild( root );
2207 layerNode = myDocument.createElement( QStringLiteral(
"NamedLayer" ) );
2208 root.appendChild( layerNode );
2215 root.setAttribute( QStringLiteral(
"version" ), QStringLiteral(
"1.0.0" ) );
2216 root.setAttribute( QStringLiteral(
"xmlns:gml" ), QStringLiteral(
"http://www.opengis.net/gml" ) );
2217 root.setAttribute( QStringLiteral(
"xmlns:ogc" ), QStringLiteral(
"http://www.opengis.net/ogc" ) );
2218 root.setAttribute( QStringLiteral(
"xmlns:sld" ), QStringLiteral(
"http://www.opengis.net/sld" ) );
2219 myDocument.appendChild( root );
2222 layerNode = myDocument.createElement( QStringLiteral(
"UserLayer" ) );
2223 root.appendChild( layerNode );
2229 context.setValue( exportContext );
2231 props[ QStringLiteral(
"SldExportContext" ) ] = context;
2235 props[ QStringLiteral(
"scaleMinDenom" ) ] = QString::number( mMinScale );
2236 props[ QStringLiteral(
"scaleMaxDenom" ) ] = QString::number( mMaxScale );
2241 if ( !vlayer->
writeSld( layerNode, myDocument, errorMsg, props ) )
2243 errorMsg = tr(
"Could not save symbology because:\n%1" ).arg( errorMsg );
2250 if ( !rlayer->
writeSld( layerNode, myDocument, errorMsg, props ) )
2252 errorMsg = tr(
"Could not save symbology because:\n%1" ).arg( errorMsg );
2271 const QgsMapLayer *mlayer = qobject_cast<const QgsMapLayer *>(
this );
2278 if ( mlayer->providerType() == QLatin1String(
"ogr" ) )
2280 QStringList theURIParts = uri.split(
'|' );
2281 filename = theURIParts[0];
2283 else if ( mlayer->providerType() == QLatin1String(
"gpx" ) )
2285 QStringList theURIParts = uri.split(
'?' );
2286 filename = theURIParts[0];
2288 else if ( mlayer->providerType() == QLatin1String(
"delimitedtext" ) )
2290 filename = QUrl::fromEncoded( uri.toLatin1() ).toLocalFile();
2292 if ( filename.isEmpty() )
2300 const QFileInfo myFileInfo( filename );
2301 if ( myFileInfo.exists() || filename.endsWith( QLatin1String(
".sld" ), Qt::CaseInsensitive ) )
2303 const QFileInfo myDirInfo( myFileInfo.path() );
2304 if ( !myDirInfo.isWritable() )
2307 return tr(
"The directory containing your dataset needs to be writable!" );
2311 const QString myFileName = myFileInfo.path() + QDir::separator() + myFileInfo.completeBaseName() +
".sld";
2314 QDomDocument myDocument;
2319 mlayer->exportSldStyleV2( myDocument, errorMsg, context );
2321 if ( !errorMsg.isNull() )
2327 QFile myFile( myFileName );
2328 if ( myFile.open( QFile::WriteOnly | QFile::Truncate ) )
2330 QTextStream myFileStream( &myFile );
2332 myDocument.save( myFileStream, 2 );
2335 return tr(
"Created default style file as %1" ).arg( myFileName );
2340 return tr(
"ERROR: Failed to created SLD style file as %1. Check file permissions and retry." ).arg( filename );
2350 QDomDocument myDocument;
2354 QString myErrorMessage;
2356 QFile myFile( uri );
2357 if ( myFile.open( QFile::ReadOnly ) )
2360 resultFlag = myDocument.setContent( &myFile,
true, &myErrorMessage, &line, &column );
2362 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
2367 myErrorMessage = tr(
"Unable to open file %1" ).arg( uri );
2372 return myErrorMessage;
2376 const QDomElement myRoot = myDocument.firstChildElement( QStringLiteral(
"StyledLayerDescriptor" ) );
2377 if ( myRoot.isNull() )
2379 myErrorMessage = QStringLiteral(
"Error: StyledLayerDescriptor element not found in %1" ).arg( uri );
2381 return myErrorMessage;
2386 const QDomElement namedLayerElem = myRoot.firstChildElement( QStringLiteral(
"NamedLayer" ) );
2387 if ( namedLayerElem.isNull() )
2389 myErrorMessage = QStringLiteral(
"Info: NamedLayer element not found." );
2391 return myErrorMessage;
2395 resultFlag =
readSld( namedLayerElem, errorMsg );
2398 myErrorMessage = tr(
"Loading style file %1 failed because:\n%2" ).arg( uri, errorMsg );
2399 return myErrorMessage;
2410 Q_UNUSED( errorMessage )
2412 Q_UNUSED( categories )
2423 Q_UNUSED( errorMessage )
2425 Q_UNUSED( categories )
2431 bool loadDefaultStyleFlag )
2438 if ( loadDefaultStyleFlag )
2456 if ( loadDefaultStyleFlag )
2478 setDataSourcePrivate( dataSource, baseName, provider, options,
flags );
2485void QgsMapLayer::setDataSourcePrivate(
const QString &dataSource,
const QString &baseName,
const QString &provider,
2490 Q_UNUSED( dataSource )
2491 Q_UNUSED( baseName )
2492 Q_UNUSED( provider )
2515 QDomElement renderer3DElem = layerElement.firstChildElement( QStringLiteral(
"renderer-3d" ) );
2516 if ( !renderer3DElem.isNull() )
2518 const QString type3D = renderer3DElem.attribute( QStringLiteral(
"type" ) );
2538 setScaleBasedVisibility( layerElement.attribute( QStringLiteral(
"hasScaleBasedVisibilityFlag" ) ).toInt() == 1 );
2539 if ( layerElement.hasAttribute( QStringLiteral(
"minimumScale" ) ) )
2542 setMaximumScale( layerElement.attribute( QStringLiteral(
"minimumScale" ) ).toDouble() );
2543 setMinimumScale( layerElement.attribute( QStringLiteral(
"maximumScale" ) ).toDouble() );
2547 setMaximumScale( layerElement.attribute( QStringLiteral(
"maxScale" ) ).toDouble() );
2548 setMinimumScale( layerElement.attribute( QStringLiteral(
"minScale" ) ).toDouble() );
2550 if ( layerElement.hasAttribute( QStringLiteral(
"autoRefreshMode" ) ) )
2560 const QDomElement flagsElem = layerElement.firstChildElement( QStringLiteral(
"flags" ) );
2562 const auto enumMap = qgsEnumMap<QgsMapLayer::LayerFlag>();
2563 for (
auto it = enumMap.constBegin(); it != enumMap.constEnd(); ++it )
2565 const QDomNode flagNode = flagsElem.namedItem( it.value() );
2566 if ( flagNode.isNull() )
2568 const bool flagValue = flagNode.toElement().text() ==
"1" ? true :
false;
2569 if (
flags.testFlag( it.key() ) && !flagValue )
2571 else if ( !
flags.testFlag( it.key() ) && flagValue )
2577 if ( categories.testFlag(
Temporal ) )
2582 properties->readXml( layerElement.toElement(), context );
2590 properties->readXml( layerElement.toElement(), context );
2593 if ( categories.testFlag(
Notes ) )
2595 const QDomElement notesElem = layerElement.firstChildElement( QStringLiteral(
"userNotes" ) );
2596 if ( !notesElem.isNull() )
2598 const QString notes = notesElem.attribute( QStringLiteral(
"value" ) );
2615 return mUndoStackStyles;
2622 return mCustomProperties.
keys();
2629 if ( !mCustomProperties.
contains( key ) || mCustomProperties.
value( key ) != value )
2631 mCustomProperties.
setValue( key, value );
2641 for (
const QString &key : mCustomProperties.keys() )
2651 return mCustomProperties;
2659 return mCustomProperties.
value( value, defaultValue );
2666 if ( mCustomProperties.
contains( key ) )
2668 mCustomProperties.
remove( key );
2699 QString sldStyle, qmlStyle;
2700 QDomDocument qmlDocument, sldDocument;
2703 if ( !msgError.isNull() )
2707 qmlStyle = qmlDocument.toString();
2710 if ( !msgError.isNull() )
2714 sldStyle = sldDocument.toString();
2718 description, uiFileContent, useAsDefault, msgError );
2725 QString returnMessage;
2726 QString qml, errorMsg;
2734 if ( !qml.isEmpty() )
2736 QDomDocument myDocument( QStringLiteral(
"qgis" ) );
2737 myDocument.setContent( qml );
2739 returnMessage = QObject::tr(
"Loaded from Provider" );
2745 bool styleExists =
false;
2746 bool styleSuccessfullyLoaded =
false;
2748 returnMessage = loadNamedProperty( theURI,
PropertyType::Style, styleExists, styleSuccessfullyLoaded, categories,
flags );
2751 ( void )styleExists;
2752 resultFlag = styleSuccessfullyLoaded;
2755 if ( ! styleName.isEmpty() )
2763 return returnMessage;
2806 const QString path = sourceParts.value( QStringLiteral(
"path" ) ).toString();
2807 if ( path.isEmpty() )
2811 const QStringList tempPaths = QStandardPaths::standardLocations( QStandardPaths::TempLocation );
2812 for (
const QString &tempPath : tempPaths )
2814 if ( path.startsWith( tempPath ) )
2844 mLegend->setParent(
this );
2862 return mStyleManager;
2869 if ( renderer == m3DRenderer )
2873 m3DRenderer = renderer;
2890 if ( mRepaintRequestedFired )
2892 mRepaintRequestedFired =
true;
2894 mRepaintRequestedFired =
false;
2947bool QgsMapLayer::isReadOnly()
const
2958 return mOriginalXmlProperties;
2971 const QString uuid = QUuid::createUuid().toString();
2973 QString
id = layerName +
'_' + uuid.mid( 1, uuid.length() - 2 );
2980 const thread_local QRegularExpression idRx( QStringLiteral(
"[\\W]" ) );
2981 id.replace( idRx, QStringLiteral(
"_" ) );
3017 QSet<QgsMapLayerDependency> deps;
3018 const auto constODeps = oDeps;
3036 if ( !lDataProvider )
3041 lDataProvider->setListening( enabled );
3056 if (
QgsMapLayerStore *store = qobject_cast<QgsMapLayerStore *>( parent() ) )
3058 return qobject_cast<QgsProject *>( store->parent() );
3063void QgsMapLayer::onNotified(
const QString &message )
3080 if ( ! forceRecalculate && ! mWgs84Extent.
isNull() )
3084 else if ( ! mExtent2D.
isNull() || ! mExtent3D.
isNull() )
3087 transformer.setBallparkTransformsAreAppropriate(
true );
3090 if ( mExtent2D.
isNull() )
3093 wgs84Extent = transformer.transformBoundingBox( mExtent2D );
3104void QgsMapLayer::updateExtent(
const QgsRectangle &extent )
const
3108 if (
extent == mExtent2D )
3120void QgsMapLayer::updateExtent(
const QgsBox3D &extent )
const
3124 if (
extent == mExtent3D )
3132 updateExtent(
extent.toRectangle() );
3136 QgsDebugMsgLevel( QStringLiteral(
"Unable to update extent with empty parameter" ), 1 );
3151bool QgsMapLayer::rebuildCrs3D( QString *error )
3158 else if ( !mVerticalCrs.
isValid() )
3164 switch ( mCRS.
type() )
3220 QString
metadata = QStringLiteral(
"<h1>" ) + tr(
"General" ) + QStringLiteral(
"</h1>\n<hr>\n" ) + QStringLiteral(
"<table class=\"list-view\">\n" );
3223 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Name" ) + QStringLiteral(
"</td><td>" ) +
name() + QStringLiteral(
"</td></tr>\n" );
3226 bool isLocalPath =
false;
3231 if ( uriComponents.contains( QStringLiteral(
"path" ) ) )
3233 path = uriComponents[QStringLiteral(
"path" )].toString();
3234 QFileInfo fi( path );
3238 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" );
3240 QDateTime lastModified = fi.lastModified();
3241 QString lastModifiedFileName;
3245 qint64 fileSize = fi.size();
3246 if ( !sidecarFiles.isEmpty() )
3248 lastModifiedFileName = fi.fileName();
3249 QStringList sidecarFileNames;
3250 for (
const QString &sidecarFile : sidecarFiles )
3252 QFileInfo sidecarFi( sidecarFile );
3253 fileSize += sidecarFi.size();
3254 if ( sidecarFi.lastModified() > lastModified )
3256 lastModified = sidecarFi.lastModified();
3257 lastModifiedFileName = sidecarFi.fileName();
3259 sidecarFileNames << sidecarFi.fileName();
3261 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" );
3263 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" );
3265 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" );
3268 if ( uriComponents.contains( QStringLiteral(
"url" ) ) )
3270 const QString url = uriComponents[QStringLiteral(
"url" )].toString();
3271 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" );
3277 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Source" ) + QStringLiteral(
"</td><td>%1" ).arg(
publicSource() != path ?
publicSource() : path ) + QStringLiteral(
"</td></tr>\n" );
3281 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Provider" ) + QStringLiteral(
"</td><td>%1" ).arg(
dataProvider()->
name() ) + QStringLiteral(
"</td></tr>\n" );
3283 metadata += QLatin1String(
"</table>\n<br><br>" );
3294 metadata += QStringLiteral(
"<h1>" ) + tr(
"Custom properties" ) + QStringLiteral(
"</h1>\n<hr>\n" );
3295 metadata += QLatin1String(
"<table class=\"list-view\">\n<tbody>" );
3296 for (
const QString &key : keys )
3299 if ( key.startsWith(
'_' ) )
3303 QString stringValue;
3304 if ( propValue.type() == QVariant::List || propValue.type() == QVariant::StringList )
3306 for (
const QString &s : propValue.toStringList() )
3308 stringValue +=
"<p style=\"margin: 0;\">" + s.toHtmlEscaped() +
"</p>";
3313 stringValue = propValue.toString().toHtmlEscaped();
3317 stringValue = tr(
"<i>value cannot be displayed</i>" );
3320 metadata += QStringLiteral(
"<tr><td class=\"highlight\">%1</td><td>%2</td></tr>" ).arg( key.toHtmlEscaped(), stringValue );
3322 metadata += QLatin1String(
"</tbody></table>\n" );
3323 metadata += QLatin1String(
"<br><br>\n" );
3336 metadata += QStringLiteral(
"<tr><td colspan=\"2\" class=\"highlight\">" ) + tr(
"Unknown" ) + QStringLiteral(
"</td></tr>\n" );
3342 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Units" ) + QStringLiteral(
"</td><td>" )
3343 + (
c.isGeographic() ? tr(
"Geographic (uses latitude and longitude for coordinates)" ) :
QgsUnitTypes::toString(
c.mapUnits() ) )
3344 + QStringLiteral(
"</td></tr>\n" );
3351 if ( includeOperation )
3355 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Method" ) + QStringLiteral(
"</td><td>" ) + operation.
description() + QStringLiteral(
"</td></tr>\n" );
3358 if ( includeCelestialBody )
3363 const QString celestialBody =
c.celestialBodyName();
3364 if ( !celestialBody.isEmpty() )
3366 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Celestial Body" ) + QStringLiteral(
"</td><td>" ) + celestialBody + QStringLiteral(
"</td></tr>\n" );
3375 QString accuracyString;
3377 if (
c.isDynamic() && std::isnan(
c.coordinateEpoch() ) )
3379 accuracyString = tr(
"Based on a dynamic CRS, but no coordinate epoch is set. Coordinates are ambiguous and of limited accuracy." );
3389 if ( !ensemble.
code().isEmpty() )
3390 id = QStringLiteral(
"<i>%1</i> (%2:%3)" ).arg( ensemble.
name(), ensemble.
authority(), ensemble.
code() );
3392 id = QStringLiteral(
"<i>%</i>”" ).arg( ensemble.
name() );
3396 accuracyString = tr(
"Based on %1, which has a limited accuracy of <b>at best %2 meters</b>." ).arg(
id ).arg( ensemble.
accuracy() );
3400 accuracyString = tr(
"Based on %1, which has a limited accuracy." ).arg(
id );
3409 if ( !accuracyString.isEmpty() )
3411 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Accuracy" ) + QStringLiteral(
"</td><td>" ) + accuracyString + QStringLiteral(
"</td></tr>\n" );
3415 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)" ) );
3418 if ( !std::isnan(
c.coordinateEpoch() ) )
3420 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Coordinate Epoch" ) + QStringLiteral(
"</td><td>%1</td></tr>\n" ).arg(
qgsDoubleToString(
c.coordinateEpoch(), 3 ) );
3425 metadata += QStringLiteral(
"<h1>" ) + tr(
"Coordinate Reference System (CRS)" ) + QStringLiteral(
"</h1>\n<hr>\n" );
3426 metadata += QLatin1String(
"<table class=\"list-view\">\n" );
3427 addCrsInfo(
crs(),
true,
true,
true );
3428 metadata += QLatin1String(
"</table>\n<br><br>\n" );
3432 metadata += QStringLiteral(
"<h1>" ) + tr(
"Vertical Coordinate Reference System (CRS)" ) + QStringLiteral(
"</h1>\n<hr>\n" );
3433 metadata += QLatin1String(
"<table class=\"list-view\">\n" );
3435 metadata += QLatin1String(
"</table>\n<br><br>\n" );
static QString version()
Version string.
@ FullString
Full definition – possibly a very lengthy string, e.g. with no truncation of custom WKT definitions.
static const double SCALE_PRECISION
Fudge factor used to compare two scales.
@ Compound
Compound (horizontal + vertical) CRS.
@ Projected
Projected CRS.
@ DerivedProjected
Derived projected CRS.
@ Engineering
Engineering CRS.
@ Geographic3d
3D geopraphic 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.
QFlags< DataProviderReadFlag > DataProviderReadFlags
Flags which control data provider construction.
LayerType
Types of layers that can be added to a map.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
QFlags< MapLayerProperty > MapLayerProperties
Map layer properties.
QFlags< LoadStyleFlag > LoadStyleFlags
Flags for loading layer styles.
@ 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.
@ RedrawOnly
Redraw current data only.
@ ReloadData
Reload data (and draw the new data)
@ Disabled
Automatic refreshing is disabled.
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.
QgsRectangle toRectangle() const
Converts the box to a 2D rectangle.
bool isNull() const
Test if the box is null (holding no spatial information).
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.
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.
QString code() const
Identification code, e.g.
QString authority() const
Authority name, e.g.
bool isValid() const
Returns true if the datum ensemble is a valid object, or false if it is a null/invalid object.
QString name() const
Display name of datum ensemble.
double accuracy() const
Positional accuracy (in meters).
A container for error messages.
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.
static void setLayerNotes(QgsMapLayer *layer, const QString ¬es)
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.
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.
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.
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
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
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...
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.
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
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 ...
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.
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.
void setDataSource(const QString &dataSource, const QString &baseName, const QString &provider, bool loadDefaultStyleFlag=false)
Updates the data source of the layer.
double minimumScale() const
Returns the minimum map scale (i.e.
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 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.
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...
QgsCoordinateReferenceSystem verticalCrs
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.
@ 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.
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.
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.
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,...
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...
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).
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.
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
CONSTLATIN1STRING geoEpsgCrsAuthId()
Geographic coord sys from EPSG authority.
void(* CUSTOM_CRS_VALIDATION)(QgsCoordinateReferenceSystem &)
#define QgsDebugMsgLevel(str, level)
#define QgsDebugError(str)
#define QGIS_PROTECT_QOBJECT_THREAD_ACCESS_NON_FATAL
#define QGIS_PROTECT_QOBJECT_THREAD_ACCESS
const QgsCoordinateReferenceSystem & crs
Setting options for creating vector data providers.