59#include <QDomDocument>
61#include <QDomImplementation>
66#include <QRegularExpression>
67#include <QStandardPaths>
72#include <QXmlStreamReader>
74#include "moc_qgsmaplayer.cpp"
81 return QStringLiteral(
".qmd" );
84 return QStringLiteral(
".qml" );
90 const QString &lyrname,
96 , mUndoStack( new QUndoStack( this ) )
97 , mUndoStackStyles( new QUndoStack( this ) )
99 , mRefreshTimer( new QTimer( this ) )
104 connect( mRefreshTimer, &QTimer::timeout,
this, [
this]
107 switch ( mAutoRefreshMode )
141 for (
const QString &s : constStyles )
151 layer->mExtent3D = mExtent3D;
153 layer->mExtent2D = mExtent2D;
187 if (
flags == mFlags )
212 if ( qobject_cast< QgsMapLayerStore * >( parent() ) )
270 mServerProperties->setShortName(
shortName );
277 return mServerProperties->shortName();
284 mServerProperties->setTitle(
title );
291 return mServerProperties->title();
298 mServerProperties->setAbstract(
abstract );
305 return mServerProperties->abstract();
312 mServerProperties->setKeywordList( keywords );
319 return mServerProperties->keywordList();
326 mServerProperties->setDataUrl(
dataUrl );
333 return mServerProperties->dataUrl();
347 return mServerProperties->dataUrlFormat();
354 mServerProperties->setAttribution( attrib );
361 return mServerProperties->attribution();
368 mServerProperties->setAttributionUrl( attribUrl );
375 return mServerProperties->attributionUrl();
382 mServerProperties->setLegendUrl(
legendUrl );
389 return mServerProperties->legendUrl();
403 return mServerProperties->legendUrlFormat();
411 if ( urls.isEmpty() )
414 urls.prepend( newItem );
420 urls.prepend( newItem );
429 if ( mServerProperties->metadataUrls().isEmpty() )
431 return QLatin1String();
435 return mServerProperties->metadataUrls().first().url;
443 QList<QgsMapLayerServerProperties::MetadataUrl> urls = mServerProperties->metadataUrls();
444 if ( urls.isEmpty() )
447 urls.prepend( newItem );
453 urls.prepend( newItem );
455 mServerProperties->setMetadataUrls( urls );
462 if ( mServerProperties->metadataUrls().isEmpty() )
464 return QLatin1String();
468 return mServerProperties->metadataUrls().first().type;
476 QList<QgsMapLayerServerProperties::MetadataUrl> urls = mServerProperties->metadataUrls();
477 if ( urls.isEmpty() )
480 urls.prepend( newItem );
486 urls.prepend( newItem );
488 mServerProperties->setMetadataUrls( urls );
495 if ( mServerProperties->metadataUrls().isEmpty() )
501 return mServerProperties->metadataUrls().first().format;
532 return mExtent2D.isNull() ? mExtent3D.toRectangle() : mExtent2D;
595 mnl = layerElement.namedItem( QStringLiteral(
"provider" ) );
596 mne = mnl.toElement();
597 provider = mne.text();
600 mnl = layerElement.namedItem( QStringLiteral(
"datasource" ) );
601 mne = mnl.toElement();
602 const QString dataSourceRaw = mne.text();
605 const thread_local QRegularExpression rx(
"authcfg=([a-z]|[A-Z]|[0-9]){7}" );
606 if ( rx.match( dataSourceRaw ).hasMatch()
618 mnl = layerElement.namedItem( QStringLiteral(
"layername" ) );
619 mne = mnl.toElement();
624 const QDomNode srsNode = layerElement.namedItem( QStringLiteral(
"srs" ) );
625 mCRS.readXml( srsNode );
626 mCRS.setValidationHint( tr(
"Specify CRS for layer %1" ).arg( mne.text() ) );
643 mnl = layerElement.namedItem( QStringLiteral(
"id" ) );
644 if ( ! mnl.isNull() )
646 mne = mnl.toElement();
647 if ( ! mne.isNull() && mne.text().length() > 10 )
649 const QString newId = mne.text();
659 mnl = layerElement.namedItem( QStringLiteral(
"layername" ) );
660 mne = mnl.toElement();
663 setName( context.
projectTranslator()->
translate( QStringLiteral(
"project:layers:%1" ).arg( layerElement.namedItem( QStringLiteral(
"id" ) ).toElement().text() ), mne.text() ) );
666 layerError = !
readXml( layerElement, context );
680 const QDomNode verticalCrsNode = layerElement.firstChildElement( QStringLiteral(
"verticalCrs" ) );
681 if ( !verticalCrsNode.isNull() )
692 const QDomElement metadataElem = layerElement.firstChildElement( QStringLiteral(
"resourceMetadata" ) );
693 mMetadata.readMetadataXml( metadataElem, context );
695 setAutoRefreshInterval( layerElement.attribute( QStringLiteral(
"autoRefreshTime" ), QStringLiteral(
"0" ) ).toInt() );
696 if ( layerElement.hasAttribute( QStringLiteral(
"autoRefreshMode" ) ) )
705 setRefreshOnNotifyEnabled( layerElement.attribute( QStringLiteral(
"refreshOnNotifyEnabled" ), QStringLiteral(
"0" ) ).toInt() );
710 const QDomNode wgs84ExtentNode = layerElement.namedItem( QStringLiteral(
"wgs84extent" ) );
711 if ( !wgs84ExtentNode.isNull() )
715 mLegendPlaceholderImage = layerElement.attribute( QStringLiteral(
"legendPlaceholderImage" ) );
719 if ( mCrs3D != oldCrs3D )
730 Q_UNUSED( layer_node )
737 const QDomNode extent3DNode = layer_node.namedItem( QStringLiteral(
"extent3D" ) );
738 if ( extent3DNode.isNull() )
740 const QDomNode extentNode = layer_node.namedItem( QStringLiteral(
"extent" ) );
741 if ( !extentNode.isNull() )
777 layerElement.setAttribute( QStringLiteral(
"autoRefreshTime" ), QString::number( mRefreshTimer->interval() ) );
778 layerElement.setAttribute( QStringLiteral(
"autoRefreshMode" ),
qgsEnumValueToKey( mAutoRefreshMode ) );
783 QDomElement layerId = document.createElement( QStringLiteral(
"id" ) );
784 const QDomText layerIdText = document.createTextNode(
id() );
785 layerId.appendChild( layerIdText );
787 layerElement.appendChild( layerId );
789 if ( mVerticalCrs.isValid() )
791 QDomElement verticalSrsNode = document.createElement( QStringLiteral(
"verticalCrs" ) );
792 mVerticalCrs.writeXml( verticalSrsNode, document );
793 layerElement.appendChild( verticalSrsNode );
797 QDomElement dataSource = document.createElement( QStringLiteral(
"datasource" ) );
799 const QDomText dataSourceText = document.createTextNode( src );
800 dataSource.appendChild( dataSourceText );
801 layerElement.appendChild( dataSource );
804 QDomElement layerName = document.createElement( QStringLiteral(
"layername" ) );
805 const QDomText layerNameText = document.createTextNode(
name() );
806 layerName.appendChild( layerNameText );
807 layerElement.appendChild( layerName );
812 QDomElement stamp = document.createElement( QStringLiteral(
"timestamp" ) );
813 const QDomText stampText = document.createTextNode(
timestamp().toString( Qt::ISODate ) );
814 stamp.appendChild( stampText );
815 layerElement.appendChild( stamp );
818 layerElement.appendChild( layerName );
825 QDomElement mySrsElement = document.createElement( QStringLiteral(
"srs" ) );
826 mCRS.writeXml( mySrsElement, document );
827 layerElement.appendChild( mySrsElement );
830 QDomElement myMetadataElem = document.createElement( QStringLiteral(
"resourceMetadata" ) );
831 mMetadata.writeMetadataXml( myMetadataElem, document );
832 layerElement.appendChild( myMetadataElem );
834 layerElement.setAttribute( QStringLiteral(
"legendPlaceholderImage" ), mLegendPlaceholderImage );
839 return writeXml( layerElement, document, context );
848 const QMetaEnum metaEnum = QMetaEnum::fromType<QgsMapLayer::StyleCategories>();
849 const QString categoriesKeys( metaEnum.valueToKeys(
static_cast<int>( categories ) ) );
850 layerElement.setAttribute( QStringLiteral(
"styleCategories" ), categoriesKeys );
858 layerElement.setAttribute( QStringLiteral(
"hasScaleBasedVisibilityFlag" ),
hasScaleBasedVisibility() ? 1 : 0 );
859 layerElement.setAttribute( QStringLiteral(
"maxScale" ), QString::number(
maximumScale() ) );
860 layerElement.setAttribute( QStringLiteral(
"minScale" ), QString::number(
minimumScale() ) );
861 layerElement.setAttribute( QStringLiteral(
"autoRefreshMode" ),
qgsEnumValueToKey( mAutoRefreshMode ) );
862 layerElement.setAttribute( QStringLiteral(
"autoRefreshTime" ), QString::number(
autoRefreshInterval() ) );
869 QDomElement renderer3DElem = document.createElement( QStringLiteral(
"renderer-3d" ) );
870 renderer3DElem.setAttribute( QStringLiteral(
"type" ), m3DRenderer->type() );
871 m3DRenderer->writeXml( renderer3DElem, context );
872 layerElement.appendChild( renderer3DElem );
880 QDomElement layerFlagsElem = document.createElement( QStringLiteral(
"flags" ) );
882 for (
auto it = enumMap.constBegin(); it != enumMap.constEnd(); ++it )
884 const bool flagValue = mFlags.testFlag( it.key() );
885 QDomElement flagElem = document.createElement( it.value() );
886 flagElem.appendChild( document.createTextNode( QString::number( flagValue ) ) );
887 layerFlagsElem.appendChild( flagElem );
889 layerElement.appendChild( layerFlagsElem );
892 if ( categories.testFlag(
Temporal ) )
895 properties->writeXml( layerElement, document, context );
901 properties->writeXml( layerElement, document, context );
906 QDomElement notesElem = document.createElement( QStringLiteral(
"userNotes" ) );
908 layerElement.appendChild( notesElem );
923 Q_UNUSED( layer_node )
954 m3DRenderer->resolveReferences( *
project );
964 mCustomProperties.
readXml( layerNode, keyStartsWith );
966 for (
const QString &key : mCustomProperties.keys() )
968 if ( !oldKeys.contains( key ) || mCustomProperties.value( key ) != oldKeys.value( key ) )
979 mCustomProperties.writeXml( layerNode, doc );
986 const QDomElement styleMgrElem = layerNode.firstChildElement( QStringLiteral(
"map-layer-style-manager" ) );
987 if ( !styleMgrElem.isNull() )
988 mStyleManager->readXml( styleMgrElem );
990 mStyleManager->reset();
999 QDomElement styleMgrElem = doc.createElement( QStringLiteral(
"map-layer-style-manager" ) );
1000 mStyleManager->writeXml( styleMgrElem );
1001 layerNode.appendChild( styleMgrElem );
1009 return mMapTipTemplate;
1016 if ( mMapTipTemplate == mapTip )
1019 mMapTipTemplate = mapTip;
1027 if ( mMapTipsEnabled == enabled )
1030 mMapTipsEnabled = enabled;
1038 return mMapTipsEnabled;
1055 const QDomNode extent3DNode = layerNode.namedItem( QStringLiteral(
"extent3D" ) );
1056 if ( extent3DNode.isNull() )
1058 const QDomNode extentNode = layerNode.namedItem( QStringLiteral(
"extent" ) );
1059 if ( !extentNode.isNull() )
1082void QgsMapLayer::connectNotify(
const char *signal )
1096 return !mScaleBasedVisibility
1106 return mScaleBasedVisibility;
1120 return mAutoRefreshMode;
1127 return mRefreshTimer->interval();
1134 if ( interval <= 0 )
1136 mRefreshTimer->stop();
1137 mRefreshTimer->setInterval( 0 );
1142 mRefreshTimer->setInterval( interval );
1158 if ( mode == mAutoRefreshMode )
1161 mAutoRefreshMode = mode;
1162 switch ( mAutoRefreshMode )
1165 mRefreshTimer->stop();
1170 if ( mRefreshTimer->interval() > 0 )
1171 mRefreshTimer->start();
1210 mScaleBasedVisibility = enabled;
1224 return QStringList();
1262 switch ( mCRS.type() )
1265 QgsDebugError( QStringLiteral(
"Layer has a vertical CRS set as the horizontal CRS!" ) );
1269 return mCRS.verticalCrs();
1284 return mVerticalCrs;
1291 return mCrs3D.isValid() ? mCrs3D : mCRS;
1299 if ( mCRS == srs && !needToValidateCrs )
1308 if ( needToValidateCrs )
1310 mCRS.setValidationHint( tr(
"Specify CRS for layer %1" ).arg(
name() ) );
1316 if ( emitSignal && mCRS != oldCrs )
1322 if ( oldCrs3D != mCrs3D )
1330 if (
crs.isValid() )
1333 switch (
crs.type() )
1351 *errorMessage = QObject::tr(
"Specified CRS is a %1 CRS, not a Vertical CRS" ).arg(
qgsEnumValueToKey(
crs.type() ) );
1356 if (
crs != mVerticalCrs )
1361 switch ( mCRS.type() )
1364 if (
crs != oldVerticalCrs )
1367 *errorMessage = QObject::tr(
"Layer CRS is a Compound CRS, specified Vertical CRS will be ignored" );
1373 if (
crs != oldVerticalCrs )
1376 *errorMessage = QObject::tr(
"Layer CRS is a Geographic 3D CRS, specified Vertical CRS will be ignored" );
1382 if (
crs != oldVerticalCrs )
1385 *errorMessage = QObject::tr(
"Layer CRS is a Geocentric CRS, specified Vertical CRS will be ignored" );
1391 if ( mCRS.hasVerticalAxis() &&
crs != oldVerticalCrs )
1394 *errorMessage = QObject::tr(
"Layer CRS is a Projected 3D CRS, specified Vertical CRS will be ignored" );
1412 res = rebuildCrs3D( errorMessage );
1418 if ( mCrs3D != oldCrs3D )
1434 QString layerName(
name );
1435 layerName.replace(
'_',
' ' );
1440QString QgsMapLayer::baseURI( PropertyType type )
const
1454 myURI = components[
"path"].toString();
1457 QFileInfo myFileInfo( myURI );
1460 if ( myFileInfo.exists() )
1463 if ( myURI.endsWith( QLatin1String(
".gz" ), Qt::CaseInsensitive ) )
1465 else if ( myURI.endsWith( QLatin1String(
".zip" ), Qt::CaseInsensitive ) )
1467 else if ( myURI.endsWith( QLatin1String(
".tar" ), Qt::CaseInsensitive ) )
1469 else if ( myURI.endsWith( QLatin1String(
".tar.gz" ), Qt::CaseInsensitive ) )
1471 else if ( myURI.endsWith( QLatin1String(
".tgz" ), Qt::CaseInsensitive ) )
1473 myFileInfo.setFile( myURI );
1502 QString errorMessage;
1505 return tr(
"Successfully saved default layer metadata" );
1507 return errorMessage;
1556bool QgsMapLayer::loadNamedPropertyFromDatabase(
const QString &db,
const QString &uri, QString &xml,
QgsMapLayer::PropertyType type )
1560 QgsDebugMsgLevel( QStringLiteral(
"db = %1 uri = %2" ).arg( db, uri ), 4 );
1562 bool resultFlag =
false;
1570 QgsDebugMsgLevel( QStringLiteral(
"Trying to load style or metadata for \"%1\" from \"%2\"" ).arg( uri, db ), 4 );
1572 if ( db.isEmpty() || !QFile( db ).exists() )
1575 myResult = database.
open_v2( db, SQLITE_OPEN_READONLY,
nullptr );
1576 if ( myResult != SQLITE_OK )
1585 mySql = QStringLiteral(
"select qmd from tbl_metadata where metadata=?" );
1589 mySql = QStringLiteral(
"select qml from tbl_styles where style=?" );
1593 statement = database.
prepare( mySql, myResult );
1594 if ( myResult == SQLITE_OK )
1596 QByteArray param = uri.toUtf8();
1598 if ( sqlite3_bind_text( statement.get(), 1, param.data(), param.length(), SQLITE_STATIC ) == SQLITE_OK &&
1599 sqlite3_step( statement.get() ) == SQLITE_ROW )
1601 xml = QString::fromUtf8(
reinterpret_cast< const char *
>( sqlite3_column_text( statement.get(), 0 ) ) );
1622 namedPropertyExists =
false;
1623 propertySuccessfullyLoaded =
false;
1624 if ( uri.isEmpty() )
1627 QDomDocument myDocument( QStringLiteral(
"qgis" ) );
1631 QString myErrorMessage;
1633 QFile myFile( uri );
1634 if ( myFile.open( QFile::ReadOnly ) )
1637 namedPropertyExists =
true;
1640 propertySuccessfullyLoaded = myDocument.setContent( &myFile, &myErrorMessage, &line, &column );
1641 if ( !propertySuccessfullyLoaded )
1642 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1659 namedPropertyExists =
true;
1660 propertySuccessfullyLoaded = myDocument.setContent( xml, &myErrorMessage, &line, &column );
1661 if ( !propertySuccessfullyLoaded )
1663 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1670 myErrorMessage = tr(
"Style not found in database" );
1681 namedPropertyExists =
true;
1682 propertySuccessfullyLoaded = myDocument.setContent( xml, &myErrorMessage, &line, &column );
1683 if ( !propertySuccessfullyLoaded )
1685 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1690 myErrorMessage = tr(
"Metadata not found in database" );
1697 if ( !propertySuccessfullyLoaded )
1699 return myErrorMessage;
1705 propertySuccessfullyLoaded =
importNamedStyle( myDocument, myErrorMessage, categories );
1706 if ( !propertySuccessfullyLoaded )
1707 myErrorMessage = tr(
"Loading style file %1 failed because:\n%2" ).arg( uri, myErrorMessage );
1711 if ( !propertySuccessfullyLoaded )
1712 myErrorMessage = tr(
"Loading metadata file %1 failed because:\n%2" ).arg( uri, myErrorMessage );
1715 return myErrorMessage;
1722 const QDomElement myRoot = document.firstChildElement( QStringLiteral(
"qgis" ) );
1723 if ( myRoot.isNull() )
1725 errorMessage = tr(
"Root <qgis> element could not be found" );
1729 return mMetadata.readMetadataXml( myRoot );
1736 const QDomElement myRoot = myDocument.firstChildElement( QStringLiteral(
"qgis" ) );
1737 if ( myRoot.isNull() )
1739 myErrorMessage = tr(
"Root <qgis> element could not be found" );
1744 const QgsProjectVersion fileVersion( myRoot.attribute( QStringLiteral(
"version" ) ) );
1747 if ( thisVersion > fileVersion )
1766 myErrorMessage = tr(
"Cannot apply style with symbology to layer with a different geometry type" );
1774 return readSymbology( myRoot, myErrorMessage, context, categories & sourceCategories );
1781 QDomImplementation DomImplementation;
1782 const QDomDocumentType documentType = DomImplementation.createDocumentType( QStringLiteral(
"qgis" ), QStringLiteral(
"http://mrcc.com/qgis.dtd" ), QStringLiteral(
"SYSTEM" ) );
1783 QDomDocument myDocument( documentType );
1785 QDomElement myRootNode = myDocument.createElement( QStringLiteral(
"qgis" ) );
1786 myRootNode.setAttribute( QStringLiteral(
"version" ),
Qgis::version() );
1787 myDocument.appendChild( myRootNode );
1789 if ( !mMetadata.writeMetadataXml( myRootNode, myDocument ) )
1791 errorMsg = QObject::tr(
"Could not save metadata" );
1802 QDomImplementation DomImplementation;
1803 const QDomDocumentType documentType = DomImplementation.createDocumentType( QStringLiteral(
"qgis" ), QStringLiteral(
"http://mrcc.com/qgis.dtd" ), QStringLiteral(
"SYSTEM" ) );
1804 QDomDocument myDocument( documentType );
1806 QDomElement myRootNode = myDocument.createElement( QStringLiteral(
"qgis" ) );
1807 myRootNode.setAttribute( QStringLiteral(
"version" ),
Qgis::version() );
1808 myDocument.appendChild( myRootNode );
1810 if ( !
writeSymbology( myRootNode, myDocument, errorMsg, context, categories ) )
1812 errorMsg = QObject::tr(
"Could not save symbology because:\n%1" ).arg( errorMsg );
1823 const QgsVectorLayer *vl = qobject_cast<const QgsVectorLayer *>(
this );
1824 const QString geoType = QString::number(
static_cast<int>( vl->
geometryType() ) );
1827 QDomElement layerGeometryType = myDocument.createElement( QStringLiteral(
"layerGeometryType" ) );
1828 const QDomText
type = myDocument.createTextNode( geoType );
1830 layerGeometryType.appendChild(
type );
1831 myRootNode.appendChild( layerGeometryType );
1862 bool metadataExists =
false;
1863 bool metadataSuccessfullyLoaded =
false;
1864 const QString message = loadNamedProperty( uri,
QgsMapLayer::Metadata, metadataExists, metadataSuccessfullyLoaded );
1867 ( void )metadataExists;
1868 resultFlag = metadataSuccessfullyLoaded;
1872QString QgsMapLayer::saveNamedProperty(
const QString &uri,
QgsMapLayer::PropertyType type,
bool &resultFlag, StyleCategories categories )
1882 if ( vlayer && vlayer->
providerType() == QLatin1String(
"ogr" ) )
1884 QStringList theURIParts = uri.split(
'|' );
1885 filename = theURIParts[0];
1887 else if ( vlayer && vlayer->
providerType() == QLatin1String(
"gpx" ) )
1889 QStringList theURIParts = uri.split(
'?' );
1890 filename = theURIParts[0];
1892 else if ( vlayer && vlayer->
providerType() == QLatin1String(
"delimitedtext" ) )
1894 filename = QUrl::fromEncoded( uri.toLatin1() ).toLocalFile();
1896 if ( filename.isEmpty() )
1904 QString myErrorMessage;
1905 QDomDocument myDocument;
1913 const QgsReadWriteContext context;
1918 const QFileInfo myFileInfo( filename );
1921 const QFileInfo myDirInfo( myFileInfo.path() );
1922 if ( !myDirInfo.isWritable() )
1925 return tr(
"The directory containing your dataset needs to be writable!" );
1931 QFile myFile( myFileName );
1932 if ( myFile.open( QFile::WriteOnly | QFile::Truncate ) )
1934 QTextStream myFileStream( &myFile );
1936 myDocument.save( myFileStream, 2 );
1942 return tr(
"Created default metadata file as %1" ).arg( myFileName );
1945 return tr(
"Created default style file as %1" ).arg( myFileName );
1955 return tr(
"ERROR: Failed to created default metadata file as %1. Check file permissions and retry." ).arg( myFileName );
1958 return tr(
"ERROR: Failed to created default style file as %1. Check file permissions and retry." ).arg( myFileName );
1964 const QString qml = myDocument.toString();
1967 sqlite3_database_unique_ptr database;
1968 sqlite3_statement_unique_ptr statement;
1971 if ( myResult != SQLITE_OK )
1973 return tr(
"User database could not be opened." );
1976 QByteArray param0 = uri.toUtf8();
1977 QByteArray param1 = qml.toUtf8();
1983 mySql = QStringLiteral(
"create table if not exists tbl_metadata(metadata varchar primary key,qmd varchar)" );
1987 mySql = QStringLiteral(
"create table if not exists tbl_styles(style varchar primary key,qml varchar)" );
1991 statement = database.
prepare( mySql, myResult );
1992 if ( myResult == SQLITE_OK )
1994 if ( sqlite3_step( statement.get() ) != SQLITE_DONE )
2000 return tr(
"The metadata table could not be created." );
2003 return tr(
"The style table could not be created." );
2011 mySql = QStringLiteral(
"insert into tbl_metadata(metadata,qmd) values (?,?)" );
2015 mySql = QStringLiteral(
"insert into tbl_styles(style,qml) values (?,?)" );
2018 statement = database.
prepare( mySql, myResult );
2019 if ( myResult == SQLITE_OK )
2021 if ( sqlite3_bind_text( statement.get(), 1, param0.data(), param0.length(), SQLITE_STATIC ) == SQLITE_OK &&
2022 sqlite3_bind_text( statement.get(), 2, param1.data(), param1.length(), SQLITE_STATIC ) == SQLITE_OK &&
2023 sqlite3_step( statement.get() ) == SQLITE_DONE )
2029 myErrorMessage = tr(
"The metadata %1 was saved to database" ).arg( uri );
2033 myErrorMessage = tr(
"The style %1 was saved to database" ).arg( uri );
2045 mySql = QStringLiteral(
"update tbl_metadata set qmd=? where metadata=?" );
2049 mySql = QStringLiteral(
"update tbl_styles set qml=? where style=?" );
2052 statement = database.
prepare( mySql, myResult );
2053 if ( myResult == SQLITE_OK )
2055 if ( sqlite3_bind_text( statement.get(), 2, param0.data(), param0.length(), SQLITE_STATIC ) == SQLITE_OK &&
2056 sqlite3_bind_text( statement.get(), 1, param1.data(), param1.length(), SQLITE_STATIC ) == SQLITE_OK &&
2057 sqlite3_step( statement.get() ) == SQLITE_DONE )
2063 myErrorMessage = tr(
"The metadata %1 was updated in the database." ).arg( uri );
2067 myErrorMessage = tr(
"The style %1 was updated in the database." ).arg( uri );
2077 myErrorMessage = tr(
"The metadata %1 could not be updated in the database." ).arg( uri );
2081 myErrorMessage = tr(
"The style %1 could not be updated in the database." ).arg( uri );
2092 myErrorMessage = tr(
"The metadata %1 could not be inserted into database." ).arg( uri );
2096 myErrorMessage = tr(
"The style %1 could not be inserted into database." ).arg( uri );
2103 return myErrorMessage;
2117 if ( !exportContext.
errors().empty() )
2118 errorMsg = exportContext.
errors().join(
"\n" );
2125 if ( !exportContext.
errors().empty() )
2126 errorMsg = exportContext.
errors().join(
"\n" );
2133 QDomDocument myDocument = QDomDocument();
2135 const QDomNode header = myDocument.createProcessingInstruction( QStringLiteral(
"xml" ), QStringLiteral(
"version=\"1.0\" encoding=\"UTF-8\"" ) );
2136 myDocument.appendChild( header );
2138 const QgsVectorLayer *vlayer = qobject_cast<const QgsVectorLayer *>(
this );
2139 const QgsRasterLayer *rlayer = qobject_cast<const QgsRasterLayer *>(
this );
2140 if ( !vlayer && !rlayer )
2142 exportContext.
pushError( tr(
"Could not save symbology because:\n%1" )
2143 .arg( tr(
"Only vector and raster layers are supported" ) ) );
2148 QDomElement root = myDocument.createElementNS( QStringLiteral(
"http://www.opengis.net/sld" ), QStringLiteral(
"StyledLayerDescriptor" ) );
2149 QDomElement layerNode;
2152 root.setAttribute( QStringLiteral(
"version" ), QStringLiteral(
"1.1.0" ) );
2153 root.setAttribute( QStringLiteral(
"xsi:schemaLocation" ), QStringLiteral(
"http://www.opengis.net/sld http://schemas.opengis.net/sld/1.1.0/StyledLayerDescriptor.xsd" ) );
2154 root.setAttribute( QStringLiteral(
"xmlns:ogc" ), QStringLiteral(
"http://www.opengis.net/ogc" ) );
2155 root.setAttribute( QStringLiteral(
"xmlns:se" ), QStringLiteral(
"http://www.opengis.net/se" ) );
2156 root.setAttribute( QStringLiteral(
"xmlns:xlink" ), QStringLiteral(
"http://www.w3.org/1999/xlink" ) );
2157 root.setAttribute( QStringLiteral(
"xmlns:xsi" ), QStringLiteral(
"http://www.w3.org/2001/XMLSchema-instance" ) );
2158 myDocument.appendChild( root );
2161 layerNode = myDocument.createElement( QStringLiteral(
"NamedLayer" ) );
2162 root.appendChild( layerNode );
2169 root.setAttribute( QStringLiteral(
"version" ), QStringLiteral(
"1.0.0" ) );
2170 root.setAttribute( QStringLiteral(
"xmlns:gml" ), QStringLiteral(
"http://www.opengis.net/gml" ) );
2171 root.setAttribute( QStringLiteral(
"xmlns:ogc" ), QStringLiteral(
"http://www.opengis.net/ogc" ) );
2172 root.setAttribute( QStringLiteral(
"xmlns:sld" ), QStringLiteral(
"http://www.opengis.net/sld" ) );
2173 myDocument.appendChild( root );
2176 layerNode = myDocument.createElement( QStringLiteral(
"UserLayer" ) );
2177 root.appendChild( layerNode );
2183 context.setValue( exportContext );
2186 props[ QStringLiteral(
"SldExportContext" ) ] = context;
2190 props[ QStringLiteral(
"scaleMinDenom" ) ] = QString::number( mMinScale );
2191 props[ QStringLiteral(
"scaleMaxDenom" ) ] = QString::number( mMaxScale );
2197 if ( !vlayer->
writeSld( layerNode, myDocument, exportContext ) )
2204 if ( !rlayer->
writeSld( layerNode, myDocument, exportContext ) )
2224 const QgsMapLayer *mlayer = qobject_cast<const QgsMapLayer *>(
this );
2231 if ( mlayer->providerType() == QLatin1String(
"ogr" ) )
2233 QStringList theURIParts = uri.split(
'|' );
2234 filename = theURIParts[0];
2236 else if ( mlayer->providerType() == QLatin1String(
"gpx" ) )
2238 QStringList theURIParts = uri.split(
'?' );
2239 filename = theURIParts[0];
2241 else if ( mlayer->providerType() == QLatin1String(
"delimitedtext" ) )
2243 filename = QUrl::fromEncoded( uri.toLatin1() ).toLocalFile();
2245 if ( filename.isEmpty() )
2253 const QFileInfo myFileInfo( filename );
2254 if ( myFileInfo.exists() || filename.endsWith( QLatin1String(
".sld" ), Qt::CaseInsensitive ) )
2256 const QFileInfo myDirInfo( myFileInfo.path() );
2257 if ( !myDirInfo.isWritable() )
2260 return tr(
"The directory containing your dataset needs to be writable!" );
2264 const QString myFileName = myFileInfo.path() + QDir::separator() + myFileInfo.completeBaseName() +
".sld";
2269 QDomDocument myDocument = mlayer->exportSldStyleV3( context );
2271 if ( !context.
errors().empty() )
2274 return context.
errors().join(
'\n' );
2277 QFile myFile( myFileName );
2278 if ( myFile.open( QFile::WriteOnly | QFile::Truncate ) )
2280 QTextStream myFileStream( &myFile );
2282 myDocument.save( myFileStream, 2 );
2285 return tr(
"Created default style file as %1" ).arg( myFileName );
2290 return tr(
"ERROR: Failed to created SLD style file as %1. Check file permissions and retry." ).arg( filename );
2300 QDomDocument myDocument;
2303 int line = 0, column = 0;
2304 QString myErrorMessage;
2306 QFile myFile( uri );
2307 if ( myFile.open( QFile::ReadOnly ) )
2310#if QT_VERSION >= QT_VERSION_CHECK( 6, 5, 0 )
2311 QXmlStreamReader xmlReader( &myFile );
2312 xmlReader.addExtraNamespaceDeclaration( QXmlStreamNamespaceDeclaration( QStringLiteral(
"sld" ), QStringLiteral(
"http://www.opengis.net/sld" ) ) );
2313 xmlReader.addExtraNamespaceDeclaration( QXmlStreamNamespaceDeclaration( QStringLiteral(
"fes" ), QStringLiteral(
"http://www.opengis.net/fes/2.0" ) ) );
2314 xmlReader.addExtraNamespaceDeclaration( QXmlStreamNamespaceDeclaration( QStringLiteral(
"ogc" ), QStringLiteral(
"http://www.opengis.net/ogc" ) ) );
2315 const QDomDocument::ParseResult result = myDocument.setContent( &xmlReader, QDomDocument::ParseOption::UseNamespaceProcessing );
2322 myErrorMessage = result.errorMessage;
2323 line = result.errorLine;
2324 column = result.errorColumn;
2327 resultFlag = myDocument.setContent( &myFile,
true, &myErrorMessage, &line, &column );
2330 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
2335 myErrorMessage = tr(
"Unable to open file %1" ).arg( uri );
2340 return myErrorMessage;
2344 const QDomElement myRoot = myDocument.firstChildElement( QStringLiteral(
"StyledLayerDescriptor" ) );
2345 if ( myRoot.isNull() )
2347 myErrorMessage = QStringLiteral(
"Error: StyledLayerDescriptor element not found in %1" ).arg( uri );
2349 return myErrorMessage;
2354 const QDomElement namedLayerElem = myRoot.firstChildElement( QStringLiteral(
"NamedLayer" ) );
2355 if ( namedLayerElem.isNull() )
2357 myErrorMessage = QStringLiteral(
"Info: NamedLayer element not found." );
2359 return myErrorMessage;
2363 resultFlag =
readSld( namedLayerElem, errorMsg );
2366 myErrorMessage = tr(
"Loading style file %1 failed because:\n%2" ).arg( uri, errorMsg );
2367 return myErrorMessage;
2378 Q_UNUSED( errorMessage )
2380 Q_UNUSED( categories )
2391 Q_UNUSED( errorMessage )
2393 Q_UNUSED( categories )
2399 bool loadDefaultStyleFlag )
2406 if ( loadDefaultStyleFlag )
2427 if ( loadDefaultStyleFlag )
2449 setDataSourcePrivate( dataSource, baseName, provider, options,
flags );
2456void QgsMapLayer::setDataSourcePrivate(
const QString &dataSource,
const QString &baseName,
const QString &provider,
2461 Q_UNUSED( dataSource )
2462 Q_UNUSED( baseName )
2463 Q_UNUSED( provider )
2486 QDomElement renderer3DElem = layerElement.firstChildElement( QStringLiteral(
"renderer-3d" ) );
2487 if ( !renderer3DElem.isNull() )
2489 const QString type3D = renderer3DElem.attribute( QStringLiteral(
"type" ) );
2509 setScaleBasedVisibility( layerElement.attribute( QStringLiteral(
"hasScaleBasedVisibilityFlag" ) ).toInt() == 1 );
2510 if ( layerElement.hasAttribute( QStringLiteral(
"minimumScale" ) ) )
2513 setMaximumScale( layerElement.attribute( QStringLiteral(
"minimumScale" ) ).toDouble() );
2514 setMinimumScale( layerElement.attribute( QStringLiteral(
"maximumScale" ) ).toDouble() );
2518 setMaximumScale( layerElement.attribute( QStringLiteral(
"maxScale" ) ).toDouble() );
2519 setMinimumScale( layerElement.attribute( QStringLiteral(
"minScale" ) ).toDouble() );
2521 if ( layerElement.hasAttribute( QStringLiteral(
"autoRefreshMode" ) ) )
2531 const QDomElement flagsElem = layerElement.firstChildElement( QStringLiteral(
"flags" ) );
2534 for (
auto it = enumMap.constBegin(); it != enumMap.constEnd(); ++it )
2536 const QDomNode flagNode = flagsElem.namedItem( it.value() );
2537 if ( flagNode.isNull() )
2539 const bool flagValue = flagNode.toElement().text() ==
"1" ? true :
false;
2540 if (
flags.testFlag( it.key() ) && !flagValue )
2542 else if ( !
flags.testFlag( it.key() ) && flagValue )
2548 if ( categories.testFlag(
Temporal ) )
2553 properties->readXml( layerElement.toElement(), context );
2561 properties->readXml( layerElement.toElement(), context );
2564 if ( categories.testFlag(
Notes ) )
2566 const QDomElement notesElem = layerElement.firstChildElement( QStringLiteral(
"userNotes" ) );
2567 if ( !notesElem.isNull() )
2569 const QString notes = notesElem.attribute( QStringLiteral(
"value" ) );
2586 return mUndoStackStyles;
2593 return mCustomProperties.keys();
2600 if ( !mCustomProperties.contains( key ) || mCustomProperties.value( key ) != value )
2602 mCustomProperties.setValue( key, value );
2612 for (
const QString &key : mCustomProperties.keys() )
2622 return mCustomProperties;
2630 return mCustomProperties.value( value, defaultValue );
2637 if ( mCustomProperties.contains( key ) )
2639 mCustomProperties.remove( key );
2677 QString sldStyle, qmlStyle;
2678 QDomDocument qmlDocument;
2681 if ( !msgError.isEmpty() )
2687 qmlStyle = qmlDocument.toString();
2692 if ( !sldContext.
errors().empty() )
2698 sldStyle = sldDocument.toString();
2702 mDataSource, qmlStyle, sldStyle,
name, description, uiFileContent, useAsDefault, msgError ) )
2713 QString returnMessage;
2714 QString qml, errorMsg;
2722 if ( !qml.isEmpty() )
2724 QDomDocument myDocument( QStringLiteral(
"qgis" ) );
2725 myDocument.setContent( qml );
2727 returnMessage = QObject::tr(
"Loaded from Provider" );
2733 bool styleExists =
false;
2734 bool styleSuccessfullyLoaded =
false;
2736 returnMessage = loadNamedProperty( theURI,
PropertyType::Style, styleExists, styleSuccessfullyLoaded, categories,
flags );
2739 ( void )styleExists;
2740 resultFlag = styleSuccessfullyLoaded;
2743 if ( ! styleName.isEmpty() )
2751 return returnMessage;
2794 const QString path = sourceParts.value( QStringLiteral(
"path" ) ).toString();
2795 if ( path.isEmpty() )
2799 const QStringList tempPaths = QStandardPaths::standardLocations( QStandardPaths::TempLocation );
2800 for (
const QString &tempPath : tempPaths )
2802 if ( path.startsWith( tempPath ) )
2824 if (
legend == mLegend.get() )
2832 mLegend->setParent(
this );
2843 return mLegend.get();
2850 return mStyleManager.get();
2857 if ( renderer == m3DRenderer.get() )
2860 m3DRenderer.reset( renderer );
2871 return m3DRenderer.get();
2878 if ( mRepaintRequestedFired )
2880 mRepaintRequestedFired =
true;
2882 mRepaintRequestedFired =
false;
2935bool QgsMapLayer::isReadOnly()
const
2946 return mOriginalXmlProperties;
2959 const QString uuid = QUuid::createUuid().toString();
2961 QString
id = layerName +
'_' + uuid.mid( 1, uuid.length() - 2 );
2968 const thread_local QRegularExpression idRx( QStringLiteral(
"[\\W]" ) );
2969 id.replace( idRx, QStringLiteral(
"_" ) );
3012 QSet<QgsMapLayerDependency> deps;
3013 const auto constODeps = oDeps;
3031 if ( !lDataProvider )
3036 lDataProvider->setListening( enabled );
3051 if (
QgsMapLayerStore *store = qobject_cast<QgsMapLayerStore *>( parent() ) )
3053 return qobject_cast<QgsProject *>( store->parent() );
3058void QgsMapLayer::onNotified(
const QString &message )
3075 if ( ! forceRecalculate && ! mWgs84Extent.isNull() )
3079 else if ( ! mExtent2D.isNull() || ! mExtent3D.isNull() )
3085 if ( mExtent2D.isNull() )
3099void QgsMapLayer::updateExtent(
const QgsRectangle &extent )
const
3103 if (
extent == mExtent2D )
3115void QgsMapLayer::updateExtent(
const QgsBox3D &extent )
const
3119 if (
extent == mExtent3D )
3124 if ( !
extent.toRectangle().isNull() )
3127 updateExtent(
extent.toRectangle() );
3131 QgsDebugMsgLevel( QStringLiteral(
"Unable to update extent with empty parameter" ), 1 );
3146bool QgsMapLayer::rebuildCrs3D( QString *error )
3149 if ( !mCRS.isValid() )
3151 mCrs3D = QgsCoordinateReferenceSystem();
3153 else if ( !mVerticalCrs.isValid() )
3159 switch ( mCRS.type() )
3171 res = mCrs3D.isValid();
3177 mCrs3D = QgsCoordinateReferenceSystem();
3192 res = mCrs3D.isValid();
3215 QString
metadata = QStringLiteral(
"<h1>" ) + tr(
"General" ) + QStringLiteral(
"</h1>\n<hr>\n" ) + QStringLiteral(
"<table class=\"list-view\">\n" );
3218 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Name" ) + QStringLiteral(
"</td><td>" ) +
name() + QStringLiteral(
"</td></tr>\n" );
3223 bool isLocalPath =
false;
3228 if ( uriComponents.contains( QStringLiteral(
"path" ) ) )
3230 path = uriComponents[QStringLiteral(
"path" )].toString();
3231 QFileInfo fi( path );
3235 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" );
3237 QDateTime lastModified = fi.lastModified();
3238 QString lastModifiedFileName;
3242 qint64 fileSize = fi.size();
3243 if ( !sidecarFiles.isEmpty() )
3245 lastModifiedFileName = fi.fileName();
3246 QStringList sidecarFileNames;
3247 for (
const QString &sidecarFile : sidecarFiles )
3249 QFileInfo sidecarFi( sidecarFile );
3250 fileSize += sidecarFi.size();
3251 if ( sidecarFi.lastModified() > lastModified )
3253 lastModified = sidecarFi.lastModified();
3254 lastModifiedFileName = sidecarFi.fileName();
3256 sidecarFileNames << sidecarFi.fileName();
3258 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" );
3260 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" );
3262 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" );
3265 if ( uriComponents.contains( QStringLiteral(
"url" ) ) )
3267 QUrl decodedUri = QUrl::fromPercentEncoding( uriComponents[QStringLiteral(
"url" )].toString().toLocal8Bit() );
3268 const QString url = decodedUri.toString();
3269 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"URL" ) + QStringLiteral(
"</td><td>%1" ).arg( QStringLiteral(
"<a href=\"%1\">%2</a>" ).arg( url, url ) ) + QStringLiteral(
"</td></tr>\n" );
3274 if ( lPublicSource != path || !isLocalPath )
3275 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Source" ) + QStringLiteral(
"</td><td>%1" ).arg( lPublicSource != path ? lPublicSource : path ) + QStringLiteral(
"</td></tr>\n" );
3279 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Provider" ) + QStringLiteral(
"</td><td>%1" ).arg(
dataProvider()->
name() ) + QStringLiteral(
"</td></tr>\n" );
3282 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Layer ID" ) + QStringLiteral(
"</td><td>%1" ).arg(
id() ) + QStringLiteral(
"</td></tr>\n" );
3284 metadata += QLatin1String(
"</table>\n<br><br>" );
3295 metadata += QStringLiteral(
"<h1>" ) + tr(
"Custom properties" ) + QStringLiteral(
"</h1>\n<hr>\n" );
3296 metadata += QLatin1String(
"<table class=\"list-view\">\n<tbody>" );
3297 for (
const QString &key : keys )
3300 if ( key.startsWith(
'_' ) )
3304 QString stringValue;
3305 if ( propValue.type() == QVariant::List || propValue.type() == QVariant::StringList )
3307 for (
const QString &s : propValue.toStringList() )
3309 stringValue +=
"<p style=\"margin: 0;\">" + s.toHtmlEscaped() +
"</p>";
3314 stringValue = propValue.toString().toHtmlEscaped();
3318 stringValue = tr(
"<i>value cannot be displayed</i>" );
3321 metadata += QStringLiteral(
"<tr><td class=\"highlight\">%1</td><td>%2</td></tr>" ).arg( key.toHtmlEscaped(), stringValue );
3323 metadata += QLatin1String(
"</tbody></table>\n" );
3324 metadata += QLatin1String(
"<br><br>\n" );
3337 metadata += QStringLiteral(
"<tr><td colspan=\"2\" class=\"highlight\">" ) + tr(
"Unknown" ) + QStringLiteral(
"</td></tr>\n" );
3343 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Units" ) + QStringLiteral(
"</td><td>" )
3344 + (
c.isGeographic() ? tr(
"Geographic (uses latitude and longitude for coordinates)" ) :
QgsUnitTypes::toString(
c.mapUnits() ) )
3345 + QStringLiteral(
"</td></tr>\n" );
3352 if ( includeOperation )
3356 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Method" ) + QStringLiteral(
"</td><td>" ) + operation.
description() + QStringLiteral(
"</td></tr>\n" );
3359 if ( includeCelestialBody )
3364 const QString celestialBody =
c.celestialBodyName();
3365 if ( !celestialBody.isEmpty() )
3367 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Celestial Body" ) + QStringLiteral(
"</td><td>" ) + celestialBody + QStringLiteral(
"</td></tr>\n" );
3376 QString accuracyString;
3378 if (
c.isDynamic() && std::isnan(
c.coordinateEpoch() ) )
3380 accuracyString = tr(
"Based on a dynamic CRS, but no coordinate epoch is set. Coordinates are ambiguous and of limited accuracy." );
3390 if ( !ensemble.
code().isEmpty() )
3391 id = QStringLiteral(
"<i>%1</i> (%2:%3)" ).arg( ensemble.
name(), ensemble.
authority(), ensemble.
code() );
3393 id = QStringLiteral(
"<i>%1</i>”" ).arg( ensemble.
name() );
3397 accuracyString = tr(
"Based on %1, which has a limited accuracy of <b>at best %2 meters</b>." ).arg(
id ).arg( ensemble.
accuracy() );
3401 accuracyString = tr(
"Based on %1, which has a limited accuracy." ).arg(
id );
3410 if ( !accuracyString.isEmpty() )
3412 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Accuracy" ) + QStringLiteral(
"</td><td>" ) + accuracyString + QStringLiteral(
"</td></tr>\n" );
3416 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)" ) );
3419 if ( !std::isnan(
c.coordinateEpoch() ) )
3421 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Coordinate Epoch" ) + QStringLiteral(
"</td><td>%1</td></tr>\n" ).arg(
qgsDoubleToString(
c.coordinateEpoch(), 3 ) );
3426 metadata += QStringLiteral(
"<h1>" ) + tr(
"Coordinate Reference System (CRS)" ) + QStringLiteral(
"</h1>\n<hr>\n" );
3427 metadata += QLatin1String(
"<table class=\"list-view\">\n" );
3428 addCrsInfo(
crs().horizontalCrs(),
true,
true,
true );
3429 metadata += QLatin1String(
"</table>\n<br><br>\n" );
3433 metadata += QStringLiteral(
"<h1>" ) + tr(
"Vertical Coordinate Reference System (CRS)" ) + QStringLiteral(
"</h1>\n<hr>\n" );
3434 metadata += QLatin1String(
"<table class=\"list-view\">\n" );
3436 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.
@ 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.
@ RemoveCredentials
Completely remove credentials (eg passwords) from the URI. This flag is not compatible with the Redac...
@ RedactCredentials
Replace the value of credentials (eg passwords) with 'xxxxxxxx'. This flag is not compatible with the...
@ 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 participate in 3D views.
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.
A 3-dimensional box composed of x, y, z coordinates.
static QString crsTypeToString(Qgis::CrsType type)
Returns a translated string representing a CRS type.
Represents a coordinate reference system (CRS).
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
static CUSTOM_CRS_VALIDATION customCrsValidation()
Gets custom function.
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.
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.
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.
Models dependencies with or between map layers.
Base class for storage of map layer elevation properties.
An 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.
void writeXml(QDomNode &layer_node, QDomDocument &document) const
Saves server properties to xml under the layer node.
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.
bool renameStyle(const QString &name, const QString &newName)
Rename a stored style to a different name.
Base class for storage of map layer temporal properties.
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.
Q_DECL_DEPRECATED 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 Q_DECL_DEPRECATED void exportSldStyleV2(QDomDocument &doc, QString &errorMsg, QgsSldExportContext &exportContext) const
Export the properties of this layer as SLD style in a QDomDocument.
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.
Q_DECL_DEPRECATED 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.
@ SldGenerationFailed
Generation of the SLD failed, and was not written to the database.
@ DatabaseWriteFailed
An error occurred when attempting to write to the database.
@ QmlGenerationFailed
Generation of the QML failed, and was not written to the database.
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...
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.
friend class QgsVectorLayer
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
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.
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.
QgsMapLayer::SaveStyleResults saveStyleToDatabaseV2(const QString &name, const QString &description, bool useAsDefault, const QString &uiFileContent, QString &msgError, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories)
Saves QML and SLD representations of the layer's style to a table in the database.
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 Q_DECL_DEPRECATED void saveStyleToDatabase(const QString &name, const QString &description, bool useAsDefault, const QString &uiFileContent, QString &msgError, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories)
Saves QML and SLD representations of the layer's style to a table in the database.
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.
QgsMapLayer::LayerFlags flags
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().
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...
virtual QString saveSldStyleV2(bool &resultFlag, QgsSldExportContext &exportContext) const
Saves the properties of this layer to an SLD format file.
@ 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.
virtual QDomDocument exportSldStyleV3(QgsSldExportContext &exportContext) const
Export the properties of this layer as SLD style in a QDomDocument.
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.
Q_DECL_DEPRECATED 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...
Q_DECL_DEPRECATED 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 Q_DECL_DEPRECATED 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 ...
QFlags< SaveStyleResult > SaveStyleResults
Results of saving styles to database.
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.
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, const char *file=__builtin_FILE(), const char *function=__builtin_FUNCTION(), int line=__builtin_LINE())
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 readXml(const QDomNode &parentNode, const QString &keyStartsWith=QString())
Read store contents from an XML node.
An interface for classes which can visit various object entity (e.g.
A QgsObjectEntityVisitorInterface context object.
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.
Describes 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 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.
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.
Represents a raster layer.
Q_DECL_DEPRECATED bool writeSld(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QVariantMap &props=QVariantMap()) const
Writes the symbology of the layer into the document provided in SLD 1.0.0 format.
Allows entering a context category and takes care of leaving this category on deletion of the class.
A container for the context for various read/write operations on objects.
QgsReadWriteContextCategoryPopper enterCategory(const QString &category, const QString &details=QString()) const
Push a category to the stack.
const QgsProjectTranslator * projectTranslator() const
Returns the project translator.
A rectangle specified with double values.
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.
Holds SLD export options and other information related to SLD export of a QGIS layer style.
QString exportFilePath() const
Returns the export file path for the SLD.
QStringList errors() const
Returns a list of errors which occurred during the conversion.
void setExtraProperties(const QVariantMap &properties)
Sets the open ended set of properties that can drive/inform the SLD encoding.
void setExportFilePath(const QString &exportFilePath)
Sets the export file path for the SLD to exportFilePath.
QVariantMap extraProperties() const
Returns the open ended set of properties that can drive/inform the SLD encoding.
void pushError(const QString &error)
Pushes a error message generated during the conversion.
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 dataset.
Q_DECL_DEPRECATED bool writeSld(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QVariantMap &props=QVariantMap()) const
Writes the symbology of the layer into the document provided in SLD 1.1 format.
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.
const QMap< T, QString > qgsEnumMap()
Returns a map of all enum entries.
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference).
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
Setting options for creating vector data providers.