30#include "moc_qgsmaplayer.cpp"
56#include <QDomDocument>
58#include <QDomImplementation>
66#include <QStandardPaths>
68#include <QRegularExpression>
77 return QStringLiteral(
".qmd" );
80 return QStringLiteral(
".qml" );
86 const QString &lyrname,
87 const QString &source )
88 : mDataSource( source )
89 , mLayerName( lyrname )
92 , mUndoStack( new QUndoStack( this ) )
93 , mUndoStackStyles( new QUndoStack( this ) )
95 , mRefreshTimer( new QTimer( this ) )
100 connect( mRefreshTimer, &QTimer::timeout,
this, [
this]
103 switch ( mAutoRefreshMode )
137 for (
const QString &s : constStyles )
147 layer->mExtent3D = mExtent3D;
149 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();
378 mServerProperties->setLegendUrl(
legendUrl );
385 return mServerProperties->legendUrl();
399 return mServerProperties->legendUrlFormat();
407 if ( urls.isEmpty() )
410 urls.prepend( newItem );
416 urls.prepend( newItem );
425 if ( mServerProperties->metadataUrls().isEmpty() )
427 return QLatin1String();
431 return mServerProperties->metadataUrls().first().url;
439 QList<QgsMapLayerServerProperties::MetadataUrl> urls = mServerProperties->metadataUrls();
440 if ( urls.isEmpty() )
443 urls.prepend( newItem );
449 urls.prepend( newItem );
451 mServerProperties->setMetadataUrls( urls );
458 if ( mServerProperties->metadataUrls().isEmpty() )
460 return QLatin1String();
464 return mServerProperties->metadataUrls().first().type;
472 QList<QgsMapLayerServerProperties::MetadataUrl> urls = mServerProperties->metadataUrls();
473 if ( urls.isEmpty() )
476 urls.prepend( newItem );
482 urls.prepend( newItem );
484 mServerProperties->setMetadataUrls( urls );
491 if ( mServerProperties->metadataUrls().isEmpty() )
497 return mServerProperties->metadataUrls().first().format;
591 mnl = layerElement.namedItem( QStringLiteral(
"provider" ) );
592 mne = mnl.toElement();
593 provider = mne.text();
596 mnl = layerElement.namedItem( QStringLiteral(
"datasource" ) );
597 mne = mnl.toElement();
598 const QString dataSourceRaw = mne.text();
601 const thread_local QRegularExpression rx(
"authcfg=([a-z]|[A-Z]|[0-9]){7}" );
602 if ( rx.match( dataSourceRaw ).hasMatch()
614 mnl = layerElement.namedItem( QStringLiteral(
"layername" ) );
615 mne = mnl.toElement();
620 const QDomNode srsNode = layerElement.namedItem( QStringLiteral(
"srs" ) );
639 mnl = layerElement.namedItem( QStringLiteral(
"id" ) );
640 if ( ! mnl.isNull() )
642 mne = mnl.toElement();
643 if ( ! mne.isNull() && mne.text().length() > 10 )
645 const QString newId = mne.text();
655 mnl = layerElement.namedItem( QStringLiteral(
"layername" ) );
656 mne = mnl.toElement();
659 setName( context.
projectTranslator()->
translate( QStringLiteral(
"project:layers:%1" ).arg( layerElement.namedItem( QStringLiteral(
"id" ) ).toElement().text() ), mne.text() ) );
662 layerError = !
readXml( layerElement, context );
676 const QDomNode verticalCrsNode = layerElement.firstChildElement( QStringLiteral(
"verticalCrs" ) );
677 if ( !verticalCrsNode.isNull() )
688 const QDomElement metadataElem = layerElement.firstChildElement( QStringLiteral(
"resourceMetadata" ) );
691 setAutoRefreshInterval( layerElement.attribute( QStringLiteral(
"autoRefreshTime" ), QStringLiteral(
"0" ) ).toInt() );
692 if ( layerElement.hasAttribute( QStringLiteral(
"autoRefreshMode" ) ) )
701 setRefreshOnNotifyEnabled( layerElement.attribute( QStringLiteral(
"refreshOnNotifyEnabled" ), QStringLiteral(
"0" ) ).toInt() );
706 const QDomNode wgs84ExtentNode = layerElement.namedItem( QStringLiteral(
"wgs84extent" ) );
707 if ( !wgs84ExtentNode.isNull() )
711 mLegendPlaceholderImage = layerElement.attribute( QStringLiteral(
"legendPlaceholderImage" ) );
715 if ( mCrs3D != oldCrs3D )
726 Q_UNUSED( layer_node )
733 const QDomNode extent3DNode = layer_node.namedItem( QStringLiteral(
"extent3D" ) );
734 if ( extent3DNode.isNull() )
736 const QDomNode extentNode = layer_node.namedItem( QStringLiteral(
"extent" ) );
737 if ( !extentNode.isNull() )
762 if ( !extent2D.isNull() )
773 layerElement.setAttribute( QStringLiteral(
"autoRefreshTime" ), QString::number( mRefreshTimer->interval() ) );
774 layerElement.setAttribute( QStringLiteral(
"autoRefreshMode" ),
qgsEnumValueToKey( mAutoRefreshMode ) );
779 QDomElement layerId = document.createElement( QStringLiteral(
"id" ) );
780 const QDomText layerIdText = document.createTextNode(
id() );
781 layerId.appendChild( layerIdText );
783 layerElement.appendChild( layerId );
787 QDomElement verticalSrsNode = document.createElement( QStringLiteral(
"verticalCrs" ) );
788 mVerticalCrs.
writeXml( verticalSrsNode, document );
789 layerElement.appendChild( verticalSrsNode );
793 QDomElement dataSource = document.createElement( QStringLiteral(
"datasource" ) );
795 const QDomText dataSourceText = document.createTextNode( src );
796 dataSource.appendChild( dataSourceText );
797 layerElement.appendChild( dataSource );
800 QDomElement layerName = document.createElement( QStringLiteral(
"layername" ) );
801 const QDomText layerNameText = document.createTextNode(
name() );
802 layerName.appendChild( layerNameText );
803 layerElement.appendChild( layerName );
808 QDomElement stamp = document.createElement( QStringLiteral(
"timestamp" ) );
809 const QDomText stampText = document.createTextNode(
timestamp().toString( Qt::ISODate ) );
810 stamp.appendChild( stampText );
811 layerElement.appendChild( stamp );
814 layerElement.appendChild( layerName );
821 QDomElement mySrsElement = document.createElement( QStringLiteral(
"srs" ) );
822 mCRS.
writeXml( mySrsElement, document );
823 layerElement.appendChild( mySrsElement );
826 QDomElement myMetadataElem = document.createElement( QStringLiteral(
"resourceMetadata" ) );
828 layerElement.appendChild( myMetadataElem );
830 layerElement.setAttribute( QStringLiteral(
"legendPlaceholderImage" ), mLegendPlaceholderImage );
835 return writeXml( layerElement, document, context );
844 const QMetaEnum metaEnum = QMetaEnum::fromType<QgsMapLayer::StyleCategories>();
845 const QString categoriesKeys( metaEnum.valueToKeys(
static_cast<int>( categories ) ) );
846 layerElement.setAttribute( QStringLiteral(
"styleCategories" ), categoriesKeys );
851 layerElement.setAttribute( QStringLiteral(
"hasScaleBasedVisibilityFlag" ),
hasScaleBasedVisibility() ? 1 : 0 );
852 layerElement.setAttribute( QStringLiteral(
"maxScale" ), QString::number(
maximumScale() ) );
853 layerElement.setAttribute( QStringLiteral(
"minScale" ), QString::number(
minimumScale() ) );
854 layerElement.setAttribute( QStringLiteral(
"autoRefreshMode" ),
qgsEnumValueToKey( mAutoRefreshMode ) );
855 layerElement.setAttribute( QStringLiteral(
"autoRefreshTime" ), QString::number(
autoRefreshInterval() ) );
862 QDomElement renderer3DElem = document.createElement( QStringLiteral(
"renderer-3d" ) );
863 renderer3DElem.setAttribute( QStringLiteral(
"type" ), m3DRenderer->
type() );
864 m3DRenderer->
writeXml( renderer3DElem, context );
865 layerElement.appendChild( renderer3DElem );
873 QDomElement layerFlagsElem = document.createElement( QStringLiteral(
"flags" ) );
874 const auto enumMap = qgsEnumMap<QgsMapLayer::LayerFlag>();
875 for (
auto it = enumMap.constBegin(); it != enumMap.constEnd(); ++it )
877 const bool flagValue = mFlags.testFlag( it.key() );
878 QDomElement flagElem = document.createElement( it.value() );
879 flagElem.appendChild( document.createTextNode( QString::number( flagValue ) ) );
880 layerFlagsElem.appendChild( flagElem );
882 layerElement.appendChild( layerFlagsElem );
885 if ( categories.testFlag(
Temporal ) )
888 properties->writeXml( layerElement, document, context );
894 properties->writeXml( layerElement, document, context );
899 QDomElement notesElem = document.createElement( QStringLiteral(
"userNotes" ) );
901 layerElement.appendChild( notesElem );
916 Q_UNUSED( layer_node )
957 mCustomProperties.
readXml( layerNode, keyStartsWith );
959 for (
const QString &key : mCustomProperties.
keys() )
961 if ( !oldKeys.contains( key ) || mCustomProperties.
value( key ) != oldKeys.value( key ) )
972 mCustomProperties.
writeXml( layerNode, doc );
979 const QDomElement styleMgrElem = layerNode.firstChildElement( QStringLiteral(
"map-layer-style-manager" ) );
980 if ( !styleMgrElem.isNull() )
981 mStyleManager->readXml( styleMgrElem );
983 mStyleManager->reset();
992 QDomElement styleMgrElem = doc.createElement( QStringLiteral(
"map-layer-style-manager" ) );
993 mStyleManager->writeXml( styleMgrElem );
994 layerNode.appendChild( styleMgrElem );
1002 return mMapTipTemplate;
1009 if ( mMapTipTemplate == mapTip )
1012 mMapTipTemplate = mapTip;
1020 if ( mMapTipsEnabled == enabled )
1023 mMapTipsEnabled = enabled;
1031 return mMapTipsEnabled;
1048 const QDomNode extent3DNode = layerNode.namedItem( QStringLiteral(
"extent3D" ) );
1049 if ( extent3DNode.isNull() )
1051 const QDomNode extentNode = layerNode.namedItem( QStringLiteral(
"extent" ) );
1052 if ( !extentNode.isNull() )
1075void QgsMapLayer::connectNotify(
const char *signal )
1089 return !mScaleBasedVisibility
1099 return mScaleBasedVisibility;
1113 return mAutoRefreshMode;
1120 return mRefreshTimer->interval();
1127 if ( interval <= 0 )
1129 mRefreshTimer->stop();
1130 mRefreshTimer->setInterval( 0 );
1135 mRefreshTimer->setInterval( interval );
1151 if ( mode == mAutoRefreshMode )
1154 mAutoRefreshMode = mode;
1155 switch ( mAutoRefreshMode )
1158 mRefreshTimer->stop();
1163 if ( mRefreshTimer->interval() > 0 )
1164 mRefreshTimer->start();
1203 mScaleBasedVisibility = enabled;
1217 return QStringList();
1255 switch ( mCRS.
type() )
1258 QgsDebugError( QStringLiteral(
"Layer has a vertical CRS set as the horizontal CRS!" ) );
1277 return mVerticalCrs;
1284 return mCrs3D.
isValid() ? mCrs3D : mCRS;
1292 if ( mCRS == srs && !needToValidateCrs )
1301 if ( needToValidateCrs )
1309 if ( emitSignal && mCRS != oldCrs )
1315 if ( oldCrs3D != mCrs3D )
1344 *errorMessage = QObject::tr(
"Specified CRS is a %1 CRS, not a Vertical CRS" ).arg(
qgsEnumValueToKey(
crs.
type() ) );
1349 if (
crs != mVerticalCrs )
1354 switch ( mCRS.
type() )
1357 if (
crs != oldVerticalCrs )
1360 *errorMessage = QObject::tr(
"Layer CRS is a Compound CRS, specified Vertical CRS will be ignored" );
1366 if (
crs != oldVerticalCrs )
1369 *errorMessage = QObject::tr(
"Layer CRS is a Geographic 3D CRS, specified Vertical CRS will be ignored" );
1375 if (
crs != oldVerticalCrs )
1378 *errorMessage = QObject::tr(
"Layer CRS is a Geocentric CRS, specified Vertical CRS will be ignored" );
1387 *errorMessage = QObject::tr(
"Layer CRS is a Projected 3D CRS, specified Vertical CRS will be ignored" );
1405 res = rebuildCrs3D( errorMessage );
1411 if ( mCrs3D != oldCrs3D )
1427 QString layerName(
name );
1428 layerName.replace(
'_',
' ' );
1433QString QgsMapLayer::baseURI( PropertyType type )
const
1447 myURI = components[
"path"].toString();
1450 QFileInfo myFileInfo( myURI );
1453 if ( myFileInfo.exists() )
1456 if ( myURI.endsWith( QLatin1String(
".gz" ), Qt::CaseInsensitive ) )
1458 else if ( myURI.endsWith( QLatin1String(
".zip" ), Qt::CaseInsensitive ) )
1460 else if ( myURI.endsWith( QLatin1String(
".tar" ), Qt::CaseInsensitive ) )
1462 else if ( myURI.endsWith( QLatin1String(
".tar.gz" ), Qt::CaseInsensitive ) )
1464 else if ( myURI.endsWith( QLatin1String(
".tgz" ), Qt::CaseInsensitive ) )
1466 myFileInfo.setFile( myURI );
1495 QString errorMessage;
1498 return tr(
"Successfully saved default layer metadata" );
1500 return errorMessage;
1549bool QgsMapLayer::loadNamedPropertyFromDatabase(
const QString &db,
const QString &uri, QString &xml,
QgsMapLayer::PropertyType type )
1553 QgsDebugMsgLevel( QStringLiteral(
"db = %1 uri = %2" ).arg( db, uri ), 4 );
1555 bool resultFlag =
false;
1563 QgsDebugMsgLevel( QStringLiteral(
"Trying to load style or metadata for \"%1\" from \"%2\"" ).arg( uri, db ), 4 );
1565 if ( db.isEmpty() || !QFile( db ).exists() )
1568 myResult = database.
open_v2( db, SQLITE_OPEN_READONLY,
nullptr );
1569 if ( myResult != SQLITE_OK )
1578 mySql = QStringLiteral(
"select qmd from tbl_metadata where metadata=?" );
1582 mySql = QStringLiteral(
"select qml from tbl_styles where style=?" );
1586 statement = database.
prepare( mySql, myResult );
1587 if ( myResult == SQLITE_OK )
1589 QByteArray param = uri.toUtf8();
1591 if ( sqlite3_bind_text( statement.get(), 1, param.data(), param.length(), SQLITE_STATIC ) == SQLITE_OK &&
1592 sqlite3_step( statement.get() ) == SQLITE_ROW )
1594 xml = QString::fromUtf8(
reinterpret_cast< const char *
>( sqlite3_column_text( statement.get(), 0 ) ) );
1615 namedPropertyExists =
false;
1616 propertySuccessfullyLoaded =
false;
1617 if ( uri.isEmpty() )
1620 QDomDocument myDocument( QStringLiteral(
"qgis" ) );
1624 QString myErrorMessage;
1626 QFile myFile( uri );
1627 if ( myFile.open( QFile::ReadOnly ) )
1630 namedPropertyExists =
true;
1633 propertySuccessfullyLoaded = myDocument.setContent( &myFile, &myErrorMessage, &line, &column );
1634 if ( !propertySuccessfullyLoaded )
1635 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1652 namedPropertyExists =
true;
1653 propertySuccessfullyLoaded = myDocument.setContent( xml, &myErrorMessage, &line, &column );
1654 if ( !propertySuccessfullyLoaded )
1656 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1663 myErrorMessage = tr(
"Style not found in database" );
1674 namedPropertyExists =
true;
1675 propertySuccessfullyLoaded = myDocument.setContent( xml, &myErrorMessage, &line, &column );
1676 if ( !propertySuccessfullyLoaded )
1678 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1683 myErrorMessage = tr(
"Metadata not found in database" );
1690 if ( !propertySuccessfullyLoaded )
1692 return myErrorMessage;
1698 propertySuccessfullyLoaded =
importNamedStyle( myDocument, myErrorMessage, categories );
1699 if ( !propertySuccessfullyLoaded )
1700 myErrorMessage = tr(
"Loading style file %1 failed because:\n%2" ).arg( uri, myErrorMessage );
1704 if ( !propertySuccessfullyLoaded )
1705 myErrorMessage = tr(
"Loading metadata file %1 failed because:\n%2" ).arg( uri, myErrorMessage );
1708 return myErrorMessage;
1715 const QDomElement myRoot = document.firstChildElement( QStringLiteral(
"qgis" ) );
1716 if ( myRoot.isNull() )
1718 errorMessage = tr(
"Root <qgis> element could not be found" );
1729 const QDomElement myRoot = myDocument.firstChildElement( QStringLiteral(
"qgis" ) );
1730 if ( myRoot.isNull() )
1732 myErrorMessage = tr(
"Root <qgis> element could not be found" );
1737 const QgsProjectVersion fileVersion( myRoot.attribute( QStringLiteral(
"version" ) ) );
1740 if ( thisVersion > fileVersion )
1759 myErrorMessage = tr(
"Cannot apply style with symbology to layer with a different geometry type" );
1766 return readSymbology( myRoot, myErrorMessage, context, categories );
1773 QDomImplementation DomImplementation;
1774 const QDomDocumentType documentType = DomImplementation.createDocumentType( QStringLiteral(
"qgis" ), QStringLiteral(
"http://mrcc.com/qgis.dtd" ), QStringLiteral(
"SYSTEM" ) );
1775 QDomDocument myDocument( documentType );
1777 QDomElement myRootNode = myDocument.createElement( QStringLiteral(
"qgis" ) );
1778 myRootNode.setAttribute( QStringLiteral(
"version" ),
Qgis::version() );
1779 myDocument.appendChild( myRootNode );
1783 errorMsg = QObject::tr(
"Could not save metadata" );
1794 QDomImplementation DomImplementation;
1795 const QDomDocumentType documentType = DomImplementation.createDocumentType( QStringLiteral(
"qgis" ), QStringLiteral(
"http://mrcc.com/qgis.dtd" ), QStringLiteral(
"SYSTEM" ) );
1796 QDomDocument myDocument( documentType );
1798 QDomElement myRootNode = myDocument.createElement( QStringLiteral(
"qgis" ) );
1799 myRootNode.setAttribute( QStringLiteral(
"version" ),
Qgis::version() );
1800 myDocument.appendChild( myRootNode );
1802 if ( !
writeSymbology( myRootNode, myDocument, errorMsg, context, categories ) )
1804 errorMsg = QObject::tr(
"Could not save symbology because:\n%1" ).arg( errorMsg );
1815 const QgsVectorLayer *vl = qobject_cast<const QgsVectorLayer *>(
this );
1816 const QString geoType = QString::number(
static_cast<int>( vl->
geometryType() ) );
1819 QDomElement layerGeometryType = myDocument.createElement( QStringLiteral(
"layerGeometryType" ) );
1820 const QDomText
type = myDocument.createTextNode( geoType );
1822 layerGeometryType.appendChild(
type );
1823 myRootNode.appendChild( layerGeometryType );
1854 bool metadataExists =
false;
1855 bool metadataSuccessfullyLoaded =
false;
1856 const QString message = loadNamedProperty( uri,
QgsMapLayer::Metadata, metadataExists, metadataSuccessfullyLoaded );
1859 ( void )metadataExists;
1860 resultFlag = metadataSuccessfullyLoaded;
1864QString QgsMapLayer::saveNamedProperty(
const QString &uri,
QgsMapLayer::PropertyType type,
bool &resultFlag, StyleCategories categories )
1874 if ( vlayer && vlayer->
providerType() == QLatin1String(
"ogr" ) )
1876 QStringList theURIParts = uri.split(
'|' );
1877 filename = theURIParts[0];
1879 else if ( vlayer && vlayer->
providerType() == QLatin1String(
"gpx" ) )
1881 QStringList theURIParts = uri.split(
'?' );
1882 filename = theURIParts[0];
1884 else if ( vlayer && vlayer->
providerType() == QLatin1String(
"delimitedtext" ) )
1886 filename = QUrl::fromEncoded( uri.toLatin1() ).toLocalFile();
1888 if ( filename.isEmpty() )
1896 QString myErrorMessage;
1897 QDomDocument myDocument;
1910 const QFileInfo myFileInfo( filename );
1913 const QFileInfo myDirInfo( myFileInfo.path() );
1914 if ( !myDirInfo.isWritable() )
1917 return tr(
"The directory containing your dataset needs to be writable!" );
1923 QFile myFile( myFileName );
1924 if ( myFile.open( QFile::WriteOnly | QFile::Truncate ) )
1926 QTextStream myFileStream( &myFile );
1928 myDocument.save( myFileStream, 2 );
1934 return tr(
"Created default metadata file as %1" ).arg( myFileName );
1937 return tr(
"Created default style file as %1" ).arg( myFileName );
1947 return tr(
"ERROR: Failed to created default metadata file as %1. Check file permissions and retry." ).arg( myFileName );
1950 return tr(
"ERROR: Failed to created default style file as %1. Check file permissions and retry." ).arg( myFileName );
1956 const QString qml = myDocument.toString();
1963 if ( myResult != SQLITE_OK )
1965 return tr(
"User database could not be opened." );
1968 QByteArray param0 = uri.toUtf8();
1969 QByteArray param1 = qml.toUtf8();
1975 mySql = QStringLiteral(
"create table if not exists tbl_metadata(metadata varchar primary key,qmd varchar)" );
1979 mySql = QStringLiteral(
"create table if not exists tbl_styles(style varchar primary key,qml varchar)" );
1983 statement = database.
prepare( mySql, myResult );
1984 if ( myResult == SQLITE_OK )
1986 if ( sqlite3_step( statement.get() ) != SQLITE_DONE )
1992 return tr(
"The metadata table could not be created." );
1995 return tr(
"The style table could not be created." );
2003 mySql = QStringLiteral(
"insert into tbl_metadata(metadata,qmd) values (?,?)" );
2007 mySql = QStringLiteral(
"insert into tbl_styles(style,qml) values (?,?)" );
2010 statement = database.
prepare( mySql, myResult );
2011 if ( myResult == SQLITE_OK )
2013 if ( sqlite3_bind_text( statement.get(), 1, param0.data(), param0.length(), SQLITE_STATIC ) == SQLITE_OK &&
2014 sqlite3_bind_text( statement.get(), 2, param1.data(), param1.length(), SQLITE_STATIC ) == SQLITE_OK &&
2015 sqlite3_step( statement.get() ) == SQLITE_DONE )
2021 myErrorMessage = tr(
"The metadata %1 was saved to database" ).arg( uri );
2025 myErrorMessage = tr(
"The style %1 was saved to database" ).arg( uri );
2037 mySql = QStringLiteral(
"update tbl_metadata set qmd=? where metadata=?" );
2041 mySql = QStringLiteral(
"update tbl_styles set qml=? where style=?" );
2044 statement = database.
prepare( mySql, myResult );
2045 if ( myResult == SQLITE_OK )
2047 if ( sqlite3_bind_text( statement.get(), 2, param0.data(), param0.length(), SQLITE_STATIC ) == SQLITE_OK &&
2048 sqlite3_bind_text( statement.get(), 1, param1.data(), param1.length(), SQLITE_STATIC ) == SQLITE_OK &&
2049 sqlite3_step( statement.get() ) == SQLITE_DONE )
2055 myErrorMessage = tr(
"The metadata %1 was updated in the database." ).arg( uri );
2059 myErrorMessage = tr(
"The style %1 was updated in the database." ).arg( uri );
2069 myErrorMessage = tr(
"The metadata %1 could not be updated in the database." ).arg( uri );
2073 myErrorMessage = tr(
"The style %1 could not be updated in the database." ).arg( uri );
2084 myErrorMessage = tr(
"The metadata %1 could not be inserted into database." ).arg( uri );
2088 myErrorMessage = tr(
"The style %1 could not be inserted into database." ).arg( uri );
2095 return myErrorMessage;
2109 if ( !exportContext.
errors().empty() )
2110 errorMsg = exportContext.
errors().join(
"\n" );
2117 if ( !exportContext.
errors().empty() )
2118 errorMsg = exportContext.
errors().join(
"\n" );
2125 QDomDocument myDocument = QDomDocument();
2127 const QDomNode header = myDocument.createProcessingInstruction( QStringLiteral(
"xml" ), QStringLiteral(
"version=\"1.0\" encoding=\"UTF-8\"" ) );
2128 myDocument.appendChild( header );
2130 const QgsVectorLayer *vlayer = qobject_cast<const QgsVectorLayer *>(
this );
2131 const QgsRasterLayer *rlayer = qobject_cast<const QgsRasterLayer *>(
this );
2132 if ( !vlayer && !rlayer )
2134 exportContext.
pushError( tr(
"Could not save symbology because:\n%1" )
2135 .arg( tr(
"Only vector and raster layers are supported" ) ) );
2140 QDomElement root = myDocument.createElementNS( QStringLiteral(
"http://www.opengis.net/sld" ), QStringLiteral(
"StyledLayerDescriptor" ) );
2141 QDomElement layerNode;
2144 root.setAttribute( QStringLiteral(
"version" ), QStringLiteral(
"1.1.0" ) );
2145 root.setAttribute( QStringLiteral(
"xsi:schemaLocation" ), QStringLiteral(
"http://www.opengis.net/sld http://schemas.opengis.net/sld/1.1.0/StyledLayerDescriptor.xsd" ) );
2146 root.setAttribute( QStringLiteral(
"xmlns:ogc" ), QStringLiteral(
"http://www.opengis.net/ogc" ) );
2147 root.setAttribute( QStringLiteral(
"xmlns:se" ), QStringLiteral(
"http://www.opengis.net/se" ) );
2148 root.setAttribute( QStringLiteral(
"xmlns:xlink" ), QStringLiteral(
"http://www.w3.org/1999/xlink" ) );
2149 root.setAttribute( QStringLiteral(
"xmlns:xsi" ), QStringLiteral(
"http://www.w3.org/2001/XMLSchema-instance" ) );
2150 myDocument.appendChild( root );
2153 layerNode = myDocument.createElement( QStringLiteral(
"NamedLayer" ) );
2154 root.appendChild( layerNode );
2161 root.setAttribute( QStringLiteral(
"version" ), QStringLiteral(
"1.0.0" ) );
2162 root.setAttribute( QStringLiteral(
"xmlns:gml" ), QStringLiteral(
"http://www.opengis.net/gml" ) );
2163 root.setAttribute( QStringLiteral(
"xmlns:ogc" ), QStringLiteral(
"http://www.opengis.net/ogc" ) );
2164 root.setAttribute( QStringLiteral(
"xmlns:sld" ), QStringLiteral(
"http://www.opengis.net/sld" ) );
2165 myDocument.appendChild( root );
2168 layerNode = myDocument.createElement( QStringLiteral(
"UserLayer" ) );
2169 root.appendChild( layerNode );
2175 context.setValue( exportContext );
2178 props[ QStringLiteral(
"SldExportContext" ) ] = context;
2182 props[ QStringLiteral(
"scaleMinDenom" ) ] = QString::number( mMinScale );
2183 props[ QStringLiteral(
"scaleMaxDenom" ) ] = QString::number( mMaxScale );
2189 if ( !vlayer->
writeSld( layerNode, myDocument, exportContext ) )
2196 if ( !rlayer->
writeSld( layerNode, myDocument, exportContext ) )
2216 const QgsMapLayer *mlayer = qobject_cast<const QgsMapLayer *>(
this );
2223 if ( mlayer->providerType() == QLatin1String(
"ogr" ) )
2225 QStringList theURIParts = uri.split(
'|' );
2226 filename = theURIParts[0];
2228 else if ( mlayer->providerType() == QLatin1String(
"gpx" ) )
2230 QStringList theURIParts = uri.split(
'?' );
2231 filename = theURIParts[0];
2233 else if ( mlayer->providerType() == QLatin1String(
"delimitedtext" ) )
2235 filename = QUrl::fromEncoded( uri.toLatin1() ).toLocalFile();
2237 if ( filename.isEmpty() )
2245 const QFileInfo myFileInfo( filename );
2246 if ( myFileInfo.exists() || filename.endsWith( QLatin1String(
".sld" ), Qt::CaseInsensitive ) )
2248 const QFileInfo myDirInfo( myFileInfo.path() );
2249 if ( !myDirInfo.isWritable() )
2252 return tr(
"The directory containing your dataset needs to be writable!" );
2256 const QString myFileName = myFileInfo.path() + QDir::separator() + myFileInfo.completeBaseName() +
".sld";
2261 QDomDocument myDocument = mlayer->exportSldStyleV3( context );
2263 if ( !context.errors().empty() )
2266 return context.errors().join(
'\n' );
2269 QFile myFile( myFileName );
2270 if ( myFile.open( QFile::WriteOnly | QFile::Truncate ) )
2272 QTextStream myFileStream( &myFile );
2274 myDocument.save( myFileStream, 2 );
2277 return tr(
"Created default style file as %1" ).arg( myFileName );
2282 return tr(
"ERROR: Failed to created SLD style file as %1. Check file permissions and retry." ).arg( filename );
2292 QDomDocument myDocument;
2296 QString myErrorMessage;
2298 QFile myFile( uri );
2299 if ( myFile.open( QFile::ReadOnly ) )
2302 resultFlag = myDocument.setContent( &myFile,
true, &myErrorMessage, &line, &column );
2304 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
2309 myErrorMessage = tr(
"Unable to open file %1" ).arg( uri );
2314 return myErrorMessage;
2318 const QDomElement myRoot = myDocument.firstChildElement( QStringLiteral(
"StyledLayerDescriptor" ) );
2319 if ( myRoot.isNull() )
2321 myErrorMessage = QStringLiteral(
"Error: StyledLayerDescriptor element not found in %1" ).arg( uri );
2323 return myErrorMessage;
2328 const QDomElement namedLayerElem = myRoot.firstChildElement( QStringLiteral(
"NamedLayer" ) );
2329 if ( namedLayerElem.isNull() )
2331 myErrorMessage = QStringLiteral(
"Info: NamedLayer element not found." );
2333 return myErrorMessage;
2337 resultFlag =
readSld( namedLayerElem, errorMsg );
2340 myErrorMessage = tr(
"Loading style file %1 failed because:\n%2" ).arg( uri, errorMsg );
2341 return myErrorMessage;
2352 Q_UNUSED( errorMessage )
2354 Q_UNUSED( categories )
2365 Q_UNUSED( errorMessage )
2367 Q_UNUSED( categories )
2373 bool loadDefaultStyleFlag )
2380 if ( loadDefaultStyleFlag )
2401 if ( loadDefaultStyleFlag )
2423 setDataSourcePrivate( dataSource, baseName, provider, options,
flags );
2430void QgsMapLayer::setDataSourcePrivate(
const QString &dataSource,
const QString &baseName,
const QString &provider,
2435 Q_UNUSED( dataSource )
2436 Q_UNUSED( baseName )
2437 Q_UNUSED( provider )
2460 QDomElement renderer3DElem = layerElement.firstChildElement( QStringLiteral(
"renderer-3d" ) );
2461 if ( !renderer3DElem.isNull() )
2463 const QString type3D = renderer3DElem.attribute( QStringLiteral(
"type" ) );
2483 setScaleBasedVisibility( layerElement.attribute( QStringLiteral(
"hasScaleBasedVisibilityFlag" ) ).toInt() == 1 );
2484 if ( layerElement.hasAttribute( QStringLiteral(
"minimumScale" ) ) )
2487 setMaximumScale( layerElement.attribute( QStringLiteral(
"minimumScale" ) ).toDouble() );
2488 setMinimumScale( layerElement.attribute( QStringLiteral(
"maximumScale" ) ).toDouble() );
2492 setMaximumScale( layerElement.attribute( QStringLiteral(
"maxScale" ) ).toDouble() );
2493 setMinimumScale( layerElement.attribute( QStringLiteral(
"minScale" ) ).toDouble() );
2495 if ( layerElement.hasAttribute( QStringLiteral(
"autoRefreshMode" ) ) )
2505 const QDomElement flagsElem = layerElement.firstChildElement( QStringLiteral(
"flags" ) );
2507 const auto enumMap = qgsEnumMap<QgsMapLayer::LayerFlag>();
2508 for (
auto it = enumMap.constBegin(); it != enumMap.constEnd(); ++it )
2510 const QDomNode flagNode = flagsElem.namedItem( it.value() );
2511 if ( flagNode.isNull() )
2513 const bool flagValue = flagNode.toElement().text() ==
"1" ? true :
false;
2514 if (
flags.testFlag( it.key() ) && !flagValue )
2516 else if ( !
flags.testFlag( it.key() ) && flagValue )
2522 if ( categories.testFlag(
Temporal ) )
2527 properties->readXml( layerElement.toElement(), context );
2535 properties->readXml( layerElement.toElement(), context );
2538 if ( categories.testFlag(
Notes ) )
2540 const QDomElement notesElem = layerElement.firstChildElement( QStringLiteral(
"userNotes" ) );
2541 if ( !notesElem.isNull() )
2543 const QString notes = notesElem.attribute( QStringLiteral(
"value" ) );
2560 return mUndoStackStyles;
2567 return mCustomProperties.
keys();
2574 if ( !mCustomProperties.
contains( key ) || mCustomProperties.
value( key ) != value )
2576 mCustomProperties.
setValue( key, value );
2586 for (
const QString &key : mCustomProperties.keys() )
2596 return mCustomProperties;
2604 return mCustomProperties.
value( value, defaultValue );
2611 if ( mCustomProperties.
contains( key ) )
2613 mCustomProperties.
remove( key );
2644 QString sldStyle, qmlStyle;
2645 QDomDocument qmlDocument;
2648 if ( !msgError.isNull() )
2652 qmlStyle = qmlDocument.toString();
2656 if ( !sldContext.
errors().empty() )
2660 sldStyle = sldDocument.toString();
2664 description, uiFileContent, useAsDefault, msgError );
2671 QString returnMessage;
2672 QString qml, errorMsg;
2680 if ( !qml.isEmpty() )
2682 QDomDocument myDocument( QStringLiteral(
"qgis" ) );
2683 myDocument.setContent( qml );
2685 returnMessage = QObject::tr(
"Loaded from Provider" );
2691 bool styleExists =
false;
2692 bool styleSuccessfullyLoaded =
false;
2694 returnMessage = loadNamedProperty( theURI,
PropertyType::Style, styleExists, styleSuccessfullyLoaded, categories,
flags );
2697 ( void )styleExists;
2698 resultFlag = styleSuccessfullyLoaded;
2701 if ( ! styleName.isEmpty() )
2709 return returnMessage;
2752 const QString path = sourceParts.value( QStringLiteral(
"path" ) ).toString();
2753 if ( path.isEmpty() )
2757 const QStringList tempPaths = QStandardPaths::standardLocations( QStandardPaths::TempLocation );
2758 for (
const QString &tempPath : tempPaths )
2760 if ( path.startsWith( tempPath ) )
2790 mLegend->setParent(
this );
2808 return mStyleManager.get();
2815 if ( renderer == m3DRenderer )
2819 m3DRenderer = renderer;
2836 if ( mRepaintRequestedFired )
2838 mRepaintRequestedFired =
true;
2840 mRepaintRequestedFired =
false;
2893bool QgsMapLayer::isReadOnly()
const
2904 return mOriginalXmlProperties;
2917 const QString uuid = QUuid::createUuid().toString();
2919 QString
id = layerName +
'_' + uuid.mid( 1, uuid.length() - 2 );
2926 const thread_local QRegularExpression idRx( QStringLiteral(
"[\\W]" ) );
2927 id.replace( idRx, QStringLiteral(
"_" ) );
2963 QSet<QgsMapLayerDependency> deps;
2964 const auto constODeps = oDeps;
2982 if ( !lDataProvider )
2987 lDataProvider->setListening( enabled );
3002 if (
QgsMapLayerStore *store = qobject_cast<QgsMapLayerStore *>( parent() ) )
3004 return qobject_cast<QgsProject *>( store->parent() );
3009void QgsMapLayer::onNotified(
const QString &message )
3026 if ( ! forceRecalculate && ! mWgs84Extent.
isNull() )
3030 else if ( ! mExtent2D.
isNull() || ! mExtent3D.
isNull() )
3033 transformer.setBallparkTransformsAreAppropriate(
true );
3036 if ( mExtent2D.
isNull() )
3039 wgs84Extent = transformer.transformBoundingBox( mExtent2D );
3050void QgsMapLayer::updateExtent(
const QgsRectangle &extent )
const
3054 if (
extent == mExtent2D )
3066void QgsMapLayer::updateExtent(
const QgsBox3D &extent )
const
3070 if (
extent == mExtent3D )
3078 updateExtent(
extent.toRectangle() );
3082 QgsDebugMsgLevel( QStringLiteral(
"Unable to update extent with empty parameter" ), 1 );
3097bool QgsMapLayer::rebuildCrs3D( QString *error )
3104 else if ( !mVerticalCrs.
isValid() )
3110 switch ( mCRS.
type() )
3166 QString
metadata = QStringLiteral(
"<h1>" ) + tr(
"General" ) + QStringLiteral(
"</h1>\n<hr>\n" ) + QStringLiteral(
"<table class=\"list-view\">\n" );
3169 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Name" ) + QStringLiteral(
"</td><td>" ) +
name() + QStringLiteral(
"</td></tr>\n" );
3174 bool isLocalPath =
false;
3179 if ( uriComponents.contains( QStringLiteral(
"path" ) ) )
3181 path = uriComponents[QStringLiteral(
"path" )].toString();
3182 QFileInfo fi( path );
3186 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" );
3188 QDateTime lastModified = fi.lastModified();
3189 QString lastModifiedFileName;
3193 qint64 fileSize = fi.size();
3194 if ( !sidecarFiles.isEmpty() )
3196 lastModifiedFileName = fi.fileName();
3197 QStringList sidecarFileNames;
3198 for (
const QString &sidecarFile : sidecarFiles )
3200 QFileInfo sidecarFi( sidecarFile );
3201 fileSize += sidecarFi.size();
3202 if ( sidecarFi.lastModified() > lastModified )
3204 lastModified = sidecarFi.lastModified();
3205 lastModifiedFileName = sidecarFi.fileName();
3207 sidecarFileNames << sidecarFi.fileName();
3209 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" );
3211 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" );
3213 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" );
3216 if ( uriComponents.contains( QStringLiteral(
"url" ) ) )
3218 const QString url = uriComponents[QStringLiteral(
"url" )].toString();
3219 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" );
3224 if ( lPublicSource != path || !isLocalPath )
3225 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Source" ) + QStringLiteral(
"</td><td>%1" ).arg( lPublicSource != path ? lPublicSource : path ) + QStringLiteral(
"</td></tr>\n" );
3229 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Provider" ) + QStringLiteral(
"</td><td>%1" ).arg(
dataProvider()->
name() ) + QStringLiteral(
"</td></tr>\n" );
3232 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Layer ID" ) + QStringLiteral(
"</td><td>%1" ).arg(
id() ) + QStringLiteral(
"</td></tr>\n" );
3234 metadata += QLatin1String(
"</table>\n<br><br>" );
3245 metadata += QStringLiteral(
"<h1>" ) + tr(
"Custom properties" ) + QStringLiteral(
"</h1>\n<hr>\n" );
3246 metadata += QLatin1String(
"<table class=\"list-view\">\n<tbody>" );
3247 for (
const QString &key : keys )
3250 if ( key.startsWith(
'_' ) )
3254 QString stringValue;
3255 if ( propValue.type() == QVariant::List || propValue.type() == QVariant::StringList )
3257 for (
const QString &s : propValue.toStringList() )
3259 stringValue +=
"<p style=\"margin: 0;\">" + s.toHtmlEscaped() +
"</p>";
3264 stringValue = propValue.toString().toHtmlEscaped();
3268 stringValue = tr(
"<i>value cannot be displayed</i>" );
3271 metadata += QStringLiteral(
"<tr><td class=\"highlight\">%1</td><td>%2</td></tr>" ).arg( key.toHtmlEscaped(), stringValue );
3273 metadata += QLatin1String(
"</tbody></table>\n" );
3274 metadata += QLatin1String(
"<br><br>\n" );
3287 metadata += QStringLiteral(
"<tr><td colspan=\"2\" class=\"highlight\">" ) + tr(
"Unknown" ) + QStringLiteral(
"</td></tr>\n" );
3293 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Units" ) + QStringLiteral(
"</td><td>" )
3294 + (
c.isGeographic() ? tr(
"Geographic (uses latitude and longitude for coordinates)" ) :
QgsUnitTypes::toString(
c.mapUnits() ) )
3295 + QStringLiteral(
"</td></tr>\n" );
3302 if ( includeOperation )
3306 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Method" ) + QStringLiteral(
"</td><td>" ) + operation.
description() + QStringLiteral(
"</td></tr>\n" );
3309 if ( includeCelestialBody )
3314 const QString celestialBody =
c.celestialBodyName();
3315 if ( !celestialBody.isEmpty() )
3317 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Celestial Body" ) + QStringLiteral(
"</td><td>" ) + celestialBody + QStringLiteral(
"</td></tr>\n" );
3326 QString accuracyString;
3328 if (
c.isDynamic() && std::isnan(
c.coordinateEpoch() ) )
3330 accuracyString = tr(
"Based on a dynamic CRS, but no coordinate epoch is set. Coordinates are ambiguous and of limited accuracy." );
3340 if ( !ensemble.
code().isEmpty() )
3341 id = QStringLiteral(
"<i>%1</i> (%2:%3)" ).arg( ensemble.
name(), ensemble.
authority(), ensemble.
code() );
3343 id = QStringLiteral(
"<i>%1</i>”" ).arg( ensemble.
name() );
3347 accuracyString = tr(
"Based on %1, which has a limited accuracy of <b>at best %2 meters</b>." ).arg(
id ).arg( ensemble.
accuracy() );
3351 accuracyString = tr(
"Based on %1, which has a limited accuracy." ).arg(
id );
3360 if ( !accuracyString.isEmpty() )
3362 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Accuracy" ) + QStringLiteral(
"</td><td>" ) + accuracyString + QStringLiteral(
"</td></tr>\n" );
3366 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)" ) );
3369 if ( !std::isnan(
c.coordinateEpoch() ) )
3371 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Coordinate Epoch" ) + QStringLiteral(
"</td><td>%1</td></tr>\n" ).arg(
qgsDoubleToString(
c.coordinateEpoch(), 3 ) );
3376 metadata += QStringLiteral(
"<h1>" ) + tr(
"Coordinate Reference System (CRS)" ) + QStringLiteral(
"</h1>\n<hr>\n" );
3377 metadata += QLatin1String(
"<table class=\"list-view\">\n" );
3378 addCrsInfo(
crs().horizontalCrs(),
true,
true,
true );
3379 metadata += QLatin1String(
"</table>\n<br><br>\n" );
3383 metadata += QStringLiteral(
"<h1>" ) + tr(
"Vertical Coordinate Reference System (CRS)" ) + QStringLiteral(
"</h1>\n<hr>\n" );
3384 metadata += QLatin1String(
"<table class=\"list-view\">\n" );
3386 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.
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.
Represents a coordinate reference system (CRS).
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.
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.
QgsMapLayerStyle style(const QString &name) const
Returns data of a stored style - accessed by its unique name.
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.
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.
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
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.
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()
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 ...
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 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.
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 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 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.
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.
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.
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.
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.
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
const QgsCoordinateReferenceSystem & crs
Setting options for creating vector data providers.