20 #include <QDomDocument>
21 #include <QDomElement>
22 #include <QDomImplementation>
26 #include <QTextStream>
29 #include <QStandardPaths>
72 return QStringLiteral(
".qmd" );
75 return QStringLiteral(
".qml" );
81 const QString &lyrname,
82 const QString &source )
83 : mDataSource( source )
84 , mLayerName( lyrname )
86 , mUndoStack( new QUndoStack( this ) )
87 , mUndoStackStyles( new QUndoStack( this ) )
89 , mRefreshTimer( new QTimer( this ) )
94 connect( mRefreshTimer, &QTimer::timeout,
this, [ = ] {
triggerRepaint(
true ); } );
101 delete mStyleManager;
109 for (
const QString &s : constStyles )
152 if (
flags == mFlags )
252 mnl = layerElement.namedItem( QStringLiteral(
"provider" ) );
253 mne = mnl.toElement();
254 provider = mne.text();
257 mnl = layerElement.namedItem( QStringLiteral(
"datasource" ) );
258 mne = mnl.toElement();
262 QRegExp rx(
"authcfg=([a-z]|[A-Z]|[0-9]){7}" );
275 mnl = layerElement.namedItem( QStringLiteral(
"layername" ) );
276 mne = mnl.toElement();
281 QDomNode srsNode = layerElement.namedItem( QStringLiteral(
"srs" ) );
300 mnl = layerElement.namedItem( QStringLiteral(
"id" ) );
301 if ( ! mnl.isNull() )
303 mne = mnl.toElement();
304 if ( ! mne.isNull() && mne.text().length() > 10 )
311 mnl = layerElement.namedItem( QStringLiteral(
"layername" ) );
312 mne = mnl.toElement();
315 setName( context.
projectTranslator()->
translate( QStringLiteral(
"project:layers:%1" ).arg( layerElement.namedItem( QStringLiteral(
"id" ) ).toElement().text() ), mne.text() ) );
318 layerError = !
readXml( layerElement, context );
327 QDomElement shortNameElem = layerElement.firstChildElement( QStringLiteral(
"shortname" ) );
328 if ( !shortNameElem.isNull() )
334 QDomElement titleElem = layerElement.firstChildElement( QStringLiteral(
"title" ) );
335 if ( !titleElem.isNull() )
337 mTitle = titleElem.text();
341 QDomElement abstractElem = layerElement.firstChildElement( QStringLiteral(
"abstract" ) );
342 if ( !abstractElem.isNull() )
348 QDomElement keywordListElem = layerElement.firstChildElement( QStringLiteral(
"keywordList" ) );
349 if ( !keywordListElem.isNull() )
352 for ( QDomNode n = keywordListElem.firstChild(); !n.isNull(); n = n.nextSibling() )
354 kwdList << n.toElement().text();
360 QDomElement dataUrlElem = layerElement.firstChildElement( QStringLiteral(
"dataUrl" ) );
361 if ( !dataUrlElem.isNull() )
364 mDataUrlFormat = dataUrlElem.attribute( QStringLiteral(
"format" ), QString() );
368 QDomElement legendUrlElem = layerElement.firstChildElement( QStringLiteral(
"legendUrl" ) );
369 if ( !legendUrlElem.isNull() )
372 mLegendUrlFormat = legendUrlElem.attribute( QStringLiteral(
"format" ), QString() );
376 QDomElement attribElem = layerElement.firstChildElement( QStringLiteral(
"attribution" ) );
377 if ( !attribElem.isNull() )
380 mAttributionUrl = attribElem.attribute( QStringLiteral(
"href" ), QString() );
384 QDomElement metaUrlElem = layerElement.firstChildElement( QStringLiteral(
"metadataUrl" ) );
385 if ( !metaUrlElem.isNull() )
388 mMetadataUrlType = metaUrlElem.attribute( QStringLiteral(
"type" ), QString() );
393 QDomElement metadataElem = layerElement.firstChildElement( QStringLiteral(
"resourceMetadata" ) );
396 setAutoRefreshInterval( layerElement.attribute( QStringLiteral(
"autoRefreshTime" ), QStringLiteral(
"0" ) ).toInt() );
397 setAutoRefreshEnabled( layerElement.attribute( QStringLiteral(
"autoRefreshEnabled" ), QStringLiteral(
"0" ) ).toInt() );
399 setRefreshOnNotifyEnabled( layerElement.attribute( QStringLiteral(
"refreshOnNotifyEnabled" ), QStringLiteral(
"0" ) ).toInt() );
402 if (
mReadFlags & QgsMapLayer::ReadFlag::FlagTrustLayerMetadata )
404 const QDomNode wgs84ExtentNode = layerElement.namedItem( QStringLiteral(
"wgs84extent" ) );
405 if ( !wgs84ExtentNode.isNull() )
415 Q_UNUSED( layer_node )
422 const QDomNode extentNode = layer_node.namedItem( QStringLiteral(
"extent" ) );
423 if ( !extentNode.isNull() )
441 layerElement.setAttribute( QStringLiteral(
"autoRefreshTime" ), QString::number( mRefreshTimer->interval() ) );
442 layerElement.setAttribute( QStringLiteral(
"autoRefreshEnabled" ), mRefreshTimer->isActive() ? 1 : 0 );
448 QDomElement layerId = document.createElement( QStringLiteral(
"id" ) );
449 QDomText layerIdText = document.createTextNode(
id() );
450 layerId.appendChild( layerIdText );
452 layerElement.appendChild( layerId );
455 QDomElement dataSource = document.createElement( QStringLiteral(
"datasource" ) );
457 QDomText dataSourceText = document.createTextNode( src );
458 dataSource.appendChild( dataSourceText );
459 layerElement.appendChild( dataSource );
462 QDomElement layerName = document.createElement( QStringLiteral(
"layername" ) );
463 QDomText layerNameText = document.createTextNode(
name() );
464 layerName.appendChild( layerNameText );
465 layerElement.appendChild( layerName );
470 QDomElement layerShortName = document.createElement( QStringLiteral(
"shortname" ) );
471 QDomText layerShortNameText = document.createTextNode(
mShortName );
472 layerShortName.appendChild( layerShortNameText );
473 layerElement.appendChild( layerShortName );
479 QDomElement layerTitle = document.createElement( QStringLiteral(
"title" ) );
480 QDomText layerTitleText = document.createTextNode(
mTitle );
481 layerTitle.appendChild( layerTitleText );
482 layerElement.appendChild( layerTitle );
488 QDomElement layerAbstract = document.createElement( QStringLiteral(
"abstract" ) );
489 QDomText layerAbstractText = document.createTextNode(
mAbstract );
490 layerAbstract.appendChild( layerAbstractText );
491 layerElement.appendChild( layerAbstract );
495 QStringList keywordStringList =
keywordList().split(
',' );
496 if ( !keywordStringList.isEmpty() )
498 QDomElement layerKeywordList = document.createElement( QStringLiteral(
"keywordList" ) );
499 for (
int i = 0; i < keywordStringList.size(); ++i )
501 QDomElement layerKeywordValue = document.createElement( QStringLiteral(
"value" ) );
502 QDomText layerKeywordText = document.createTextNode( keywordStringList.at( i ).trimmed() );
503 layerKeywordValue.appendChild( layerKeywordText );
504 layerKeywordList.appendChild( layerKeywordValue );
506 layerElement.appendChild( layerKeywordList );
511 if ( !aDataUrl.isEmpty() )
513 QDomElement layerDataUrl = document.createElement( QStringLiteral(
"dataUrl" ) );
514 QDomText layerDataUrlText = document.createTextNode( aDataUrl );
515 layerDataUrl.appendChild( layerDataUrlText );
516 layerDataUrl.setAttribute( QStringLiteral(
"format" ),
dataUrlFormat() );
517 layerElement.appendChild( layerDataUrl );
522 if ( !aLegendUrl.isEmpty() )
524 QDomElement layerLegendUrl = document.createElement( QStringLiteral(
"legendUrl" ) );
525 QDomText layerLegendUrlText = document.createTextNode( aLegendUrl );
526 layerLegendUrl.appendChild( layerLegendUrlText );
527 layerLegendUrl.setAttribute( QStringLiteral(
"format" ),
legendUrlFormat() );
528 layerElement.appendChild( layerLegendUrl );
533 if ( !aAttribution.isEmpty() )
535 QDomElement layerAttribution = document.createElement( QStringLiteral(
"attribution" ) );
536 QDomText layerAttributionText = document.createTextNode( aAttribution );
537 layerAttribution.appendChild( layerAttributionText );
538 layerAttribution.setAttribute( QStringLiteral(
"href" ),
attributionUrl() );
539 layerElement.appendChild( layerAttribution );
544 if ( !aMetadataUrl.isEmpty() )
546 QDomElement layerMetadataUrl = document.createElement( QStringLiteral(
"metadataUrl" ) );
547 QDomText layerMetadataUrlText = document.createTextNode( aMetadataUrl );
548 layerMetadataUrl.appendChild( layerMetadataUrlText );
549 layerMetadataUrl.setAttribute( QStringLiteral(
"type" ),
metadataUrlType() );
550 layerMetadataUrl.setAttribute( QStringLiteral(
"format" ),
metadataUrlFormat() );
551 layerElement.appendChild( layerMetadataUrl );
557 QDomElement stamp = document.createElement( QStringLiteral(
"timestamp" ) );
558 QDomText stampText = document.createTextNode(
timestamp().toString( Qt::ISODate ) );
559 stamp.appendChild( stampText );
560 layerElement.appendChild( stamp );
563 layerElement.appendChild( layerName );
570 QDomElement mySrsElement = document.createElement( QStringLiteral(
"srs" ) );
571 mCRS.
writeXml( mySrsElement, document );
572 layerElement.appendChild( mySrsElement );
575 QDomElement myMetadataElem = document.createElement( QStringLiteral(
"resourceMetadata" ) );
577 layerElement.appendChild( myMetadataElem );
580 return writeXml( layerElement, document, context );
587 QMetaEnum metaEnum = QMetaEnum::fromType<QgsMapLayer::StyleCategories>();
588 QString categoriesKeys( metaEnum.valueToKeys(
static_cast<int>( categories ) ) );
589 layerElement.setAttribute( QStringLiteral(
"styleCategories" ), categoriesKeys );
594 layerElement.setAttribute( QStringLiteral(
"hasScaleBasedVisibilityFlag" ),
hasScaleBasedVisibility() ? 1 : 0 );
595 layerElement.setAttribute( QStringLiteral(
"maxScale" ), QString::number(
maximumScale() ) );
596 layerElement.setAttribute( QStringLiteral(
"minScale" ), QString::number(
minimumScale() ) );
603 QDomElement renderer3DElem = document.createElement( QStringLiteral(
"renderer-3d" ) );
604 renderer3DElem.setAttribute( QStringLiteral(
"type" ), m3DRenderer->
type() );
605 m3DRenderer->
writeXml( renderer3DElem, context );
606 layerElement.appendChild( renderer3DElem );
614 QDomElement layerFlagsElem = document.createElement( QStringLiteral(
"flags" ) );
615 auto enumMap = qgsEnumMap<QgsMapLayer::LayerFlag>();
616 for (
auto it = enumMap.constBegin(); it != enumMap.constEnd(); ++it )
618 bool flagValue = mFlags.testFlag( it.key() );
619 QDomElement flagElem = document.createElement( it.value() );
620 flagElem.appendChild( document.createTextNode( QString::number( flagValue ) ) );
621 layerFlagsElem.appendChild( flagElem );
623 layerElement.appendChild( layerFlagsElem );
626 if ( categories.testFlag(
Temporal ) )
629 properties->writeXml( layerElement, document, context );
635 properties->writeXml( layerElement, document, context );
640 QDomElement notesElem = document.createElement( QStringLiteral(
"userNotes" ) );
642 layerElement.appendChild( notesElem );
655 Q_UNUSED( layer_node )
686 mCustomProperties.
readXml( layerNode, keyStartsWith );
691 mCustomProperties.
writeXml( layerNode, doc );
696 QDomElement styleMgrElem = layerNode.firstChildElement( QStringLiteral(
"map-layer-style-manager" ) );
697 if ( !styleMgrElem.isNull() )
698 mStyleManager->
readXml( styleMgrElem );
700 mStyleManager->
reset();
707 QDomElement styleMgrElem = doc.createElement( QStringLiteral(
"map-layer-style-manager" ) );
708 mStyleManager->
writeXml( styleMgrElem );
709 layerNode.appendChild( styleMgrElem );
719 void QgsMapLayer::connectNotify(
const char *signal )
728 return !mScaleBasedVisibility ||
730 && ( mMaxScale == 0 || scale < mMaxScale ) );
735 return mScaleBasedVisibility;
740 return mRefreshTimer->isActive();
745 return mRefreshTimer->interval();
752 mRefreshTimer->stop();
753 mRefreshTimer->setInterval( 0 );
757 mRefreshTimer->setInterval( interval );
765 mRefreshTimer->stop();
766 else if ( mRefreshTimer->interval() > 0 )
767 mRefreshTimer->start();
795 mScaleBasedVisibility = enabled;
805 return QStringList();
848 QString layerName(
name );
849 layerName.replace(
'_',
' ' );
854 QString QgsMapLayer::baseURI( PropertyType type )
const
866 myURI = components[
"path"].toString();
869 QFileInfo myFileInfo( myURI );
872 if ( myFileInfo.exists() )
875 if ( myURI.endsWith( QLatin1String(
".gz" ), Qt::CaseInsensitive ) )
877 else if ( myURI.endsWith( QLatin1String(
".zip" ), Qt::CaseInsensitive ) )
879 else if ( myURI.endsWith( QLatin1String(
".tar" ), Qt::CaseInsensitive ) )
881 else if ( myURI.endsWith( QLatin1String(
".tar.gz" ), Qt::CaseInsensitive ) )
883 else if ( myURI.endsWith( QLatin1String(
".tgz" ), Qt::CaseInsensitive ) )
885 myFileInfo.setFile( myURI );
899 return baseURI( PropertyType::Metadata );
910 QString errorMessage;
913 return tr(
"Successfully saved default layer metadata" );
936 return baseURI( PropertyType::Style );
946 return loadNamedPropertyFromDatabase( db, uri, qmd, PropertyType::Metadata );
951 return loadNamedPropertyFromDatabase( db, uri, qml, PropertyType::Style );
954 bool QgsMapLayer::loadNamedPropertyFromDatabase(
const QString &db,
const QString &uri, QString &xml,
QgsMapLayer::PropertyType type )
958 bool resultFlag =
false;
966 QgsDebugMsgLevel( QStringLiteral(
"Trying to load style or metadata for \"%1\" from \"%2\"" ).arg( uri, db ), 4 );
968 if ( db.isEmpty() || !QFile( db ).exists() )
971 myResult = database.
open_v2( db, SQLITE_OPEN_READONLY,
nullptr );
972 if ( myResult != SQLITE_OK )
981 mySql = QStringLiteral(
"select qmd from tbl_metadata where metadata=?" );
985 mySql = QStringLiteral(
"select qml from tbl_styles where style=?" );
989 statement = database.
prepare( mySql, myResult );
990 if ( myResult == SQLITE_OK )
992 QByteArray param = uri.toUtf8();
994 if ( sqlite3_bind_text( statement.get(), 1, param.data(), param.length(), SQLITE_STATIC ) == SQLITE_OK &&
995 sqlite3_step( statement.get() ) == SQLITE_ROW )
997 xml = QString::fromUtf8(
reinterpret_cast< const char *
>( sqlite3_column_text( statement.get(), 0 ) ) );
1007 return loadNamedProperty( uri, PropertyType::Style, resultFlag, categories );
1010 QString QgsMapLayer::loadNamedProperty(
const QString &uri,
QgsMapLayer::PropertyType type,
bool &resultFlag, StyleCategories categories )
1016 QDomDocument myDocument( QStringLiteral(
"qgis" ) );
1020 QString myErrorMessage;
1022 QFile myFile( uri );
1023 if ( myFile.open( QFile::ReadOnly ) )
1027 resultFlag = myDocument.setContent( &myFile, &myErrorMessage, &line, &column );
1029 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1046 resultFlag = myDocument.setContent( xml, &myErrorMessage, &line, &column );
1049 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1054 myErrorMessage = tr(
"Style not found in database" );
1065 resultFlag = myDocument.setContent( xml, &myErrorMessage, &line, &column );
1068 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1073 myErrorMessage = tr(
"Metadata not found in database" );
1083 return myErrorMessage;
1091 myErrorMessage = tr(
"Loading style file %1 failed because:\n%2" ).arg( uri, myErrorMessage );
1096 myErrorMessage = tr(
"Loading metadata file %1 failed because:\n%2" ).arg( uri, myErrorMessage );
1099 return myErrorMessage;
1104 QDomElement myRoot = document.firstChildElement( QStringLiteral(
"qgis" ) );
1105 if ( myRoot.isNull() )
1107 errorMessage = tr(
"Root <qgis> element could not be found" );
1116 QDomElement myRoot = myDocument.firstChildElement( QStringLiteral(
"qgis" ) );
1117 if ( myRoot.isNull() )
1119 myErrorMessage = tr(
"Root <qgis> element could not be found" );
1124 QgsProjectVersion fileVersion( myRoot.attribute( QStringLiteral(
"version" ) ) );
1127 if ( thisVersion > fileVersion )
1144 if ( importLayerGeometryType != QgsWkbTypes::GeometryType::UnknownGeometry && vl->
geometryType() != importLayerGeometryType )
1146 myErrorMessage = tr(
"Cannot apply style with symbology to layer with a different geometry type" );
1153 return readSymbology( myRoot, myErrorMessage, context, categories );
1158 QDomImplementation DomImplementation;
1159 QDomDocumentType documentType = DomImplementation.createDocumentType( QStringLiteral(
"qgis" ), QStringLiteral(
"http://mrcc.com/qgis.dtd" ), QStringLiteral(
"SYSTEM" ) );
1160 QDomDocument myDocument( documentType );
1162 QDomElement myRootNode = myDocument.createElement( QStringLiteral(
"qgis" ) );
1163 myRootNode.setAttribute( QStringLiteral(
"version" ),
Qgis::version() );
1164 myDocument.appendChild( myRootNode );
1168 errorMsg = QObject::tr(
"Could not save metadata" );
1177 QDomImplementation DomImplementation;
1178 QDomDocumentType documentType = DomImplementation.createDocumentType( QStringLiteral(
"qgis" ), QStringLiteral(
"http://mrcc.com/qgis.dtd" ), QStringLiteral(
"SYSTEM" ) );
1179 QDomDocument myDocument( documentType );
1181 QDomElement myRootNode = myDocument.createElement( QStringLiteral(
"qgis" ) );
1182 myRootNode.setAttribute( QStringLiteral(
"version" ),
Qgis::version() );
1183 myDocument.appendChild( myRootNode );
1185 if ( !
writeSymbology( myRootNode, myDocument, errorMsg, context, categories ) )
1187 errorMsg = QObject::tr(
"Could not save symbology because:\n%1" ).arg( errorMsg );
1198 const QgsVectorLayer *vl = qobject_cast<const QgsVectorLayer *>(
this );
1199 QString geoType = QString::number( vl->
geometryType() );
1202 QDomElement layerGeometryType = myDocument.createElement( QStringLiteral(
"layerGeometryType" ) );
1203 QDomText
type = myDocument.createTextNode( geoType );
1205 layerGeometryType.appendChild(
type );
1206 myRootNode.appendChild( layerGeometryType );
1227 QString QgsMapLayer::saveNamedProperty(
const QString &uri,
QgsMapLayer::PropertyType type,
bool &resultFlag, StyleCategories categories )
1235 if ( vlayer && vlayer->
providerType() == QLatin1String(
"ogr" ) )
1237 QStringList theURIParts = uri.split(
'|' );
1238 filename = theURIParts[0];
1240 else if ( vlayer && vlayer->
providerType() == QLatin1String(
"gpx" ) )
1242 QStringList theURIParts = uri.split(
'?' );
1243 filename = theURIParts[0];
1245 else if ( vlayer && vlayer->
providerType() == QLatin1String(
"delimitedtext" ) )
1247 filename = QUrl::fromEncoded( uri.toLatin1() ).toLocalFile();
1249 if ( filename.isEmpty() )
1257 QString myErrorMessage;
1258 QDomDocument myDocument;
1271 QFileInfo myFileInfo( filename );
1274 QFileInfo myDirInfo( myFileInfo.path() );
1275 if ( !myDirInfo.isWritable() )
1277 return tr(
"The directory containing your dataset needs to be writable!" );
1283 QFile myFile( myFileName );
1284 if ( myFile.open( QFile::WriteOnly | QFile::Truncate ) )
1286 QTextStream myFileStream( &myFile );
1288 myDocument.save( myFileStream, 2 );
1294 return tr(
"Created default metadata file as %1" ).arg( myFileName );
1297 return tr(
"Created default style file as %1" ).arg( myFileName );
1307 return tr(
"ERROR: Failed to created default metadata file as %1. Check file permissions and retry." ).arg( myFileName );
1310 return tr(
"ERROR: Failed to created default style file as %1. Check file permissions and retry." ).arg( myFileName );
1316 QString qml = myDocument.toString();
1323 if ( myResult != SQLITE_OK )
1325 return tr(
"User database could not be opened." );
1328 QByteArray param0 = uri.toUtf8();
1329 QByteArray param1 = qml.toUtf8();
1335 mySql = QStringLiteral(
"create table if not exists tbl_metadata(metadata varchar primary key,qmd varchar)" );
1339 mySql = QStringLiteral(
"create table if not exists tbl_styles(style varchar primary key,qml varchar)" );
1343 statement = database.
prepare( mySql, myResult );
1344 if ( myResult == SQLITE_OK )
1346 if ( sqlite3_step( statement.get() ) != SQLITE_DONE )
1352 return tr(
"The metadata table could not be created." );
1355 return tr(
"The style table could not be created." );
1363 mySql = QStringLiteral(
"insert into tbl_metadata(metadata,qmd) values (?,?)" );
1367 mySql = QStringLiteral(
"insert into tbl_styles(style,qml) values (?,?)" );
1370 statement = database.
prepare( mySql, myResult );
1371 if ( myResult == SQLITE_OK )
1373 if ( sqlite3_bind_text( statement.get(), 1, param0.data(), param0.length(), SQLITE_STATIC ) == SQLITE_OK &&
1374 sqlite3_bind_text( statement.get(), 2, param1.data(), param1.length(), SQLITE_STATIC ) == SQLITE_OK &&
1375 sqlite3_step( statement.get() ) == SQLITE_DONE )
1381 myErrorMessage = tr(
"The metadata %1 was saved to database" ).arg( uri );
1385 myErrorMessage = tr(
"The style %1 was saved to database" ).arg( uri );
1397 mySql = QStringLiteral(
"update tbl_metadata set qmd=? where metadata=?" );
1401 mySql = QStringLiteral(
"update tbl_styles set qml=? where style=?" );
1404 statement = database.
prepare( mySql, myResult );
1405 if ( myResult == SQLITE_OK )
1407 if ( sqlite3_bind_text( statement.get(), 2, param0.data(), param0.length(), SQLITE_STATIC ) == SQLITE_OK &&
1408 sqlite3_bind_text( statement.get(), 1, param1.data(), param1.length(), SQLITE_STATIC ) == SQLITE_OK &&
1409 sqlite3_step( statement.get() ) == SQLITE_DONE )
1415 myErrorMessage = tr(
"The metadata %1 was updated in the database." ).arg( uri );
1419 myErrorMessage = tr(
"The style %1 was updated in the database." ).arg( uri );
1429 myErrorMessage = tr(
"The metadata %1 could not be updated in the database." ).arg( uri );
1433 myErrorMessage = tr(
"The style %1 could not be updated in the database." ).arg( uri );
1444 myErrorMessage = tr(
"The metadata %1 could not be inserted into database." ).arg( uri );
1448 myErrorMessage = tr(
"The style %1 could not be inserted into database." ).arg( uri );
1455 return myErrorMessage;
1465 QDomDocument myDocument = QDomDocument();
1467 QDomNode header = myDocument.createProcessingInstruction( QStringLiteral(
"xml" ), QStringLiteral(
"version=\"1.0\" encoding=\"UTF-8\"" ) );
1468 myDocument.appendChild( header );
1470 const QgsVectorLayer *vlayer = qobject_cast<const QgsVectorLayer *>(
this );
1471 const QgsRasterLayer *rlayer = qobject_cast<const QgsRasterLayer *>(
this );
1472 if ( !vlayer && !rlayer )
1474 errorMsg = tr(
"Could not save symbology because:\n%1" )
1475 .arg( tr(
"Only vector and raster layers are supported" ) );
1480 QDomElement root = myDocument.createElementNS( QStringLiteral(
"http://www.opengis.net/sld" ), QStringLiteral(
"StyledLayerDescriptor" ) );
1481 QDomElement layerNode;
1484 root.setAttribute( QStringLiteral(
"version" ), QStringLiteral(
"1.1.0" ) );
1485 root.setAttribute( QStringLiteral(
"xsi:schemaLocation" ), QStringLiteral(
"http://www.opengis.net/sld http://schemas.opengis.net/sld/1.1.0/StyledLayerDescriptor.xsd" ) );
1486 root.setAttribute( QStringLiteral(
"xmlns:ogc" ), QStringLiteral(
"http://www.opengis.net/ogc" ) );
1487 root.setAttribute( QStringLiteral(
"xmlns:se" ), QStringLiteral(
"http://www.opengis.net/se" ) );
1488 root.setAttribute( QStringLiteral(
"xmlns:xlink" ), QStringLiteral(
"http://www.w3.org/1999/xlink" ) );
1489 root.setAttribute( QStringLiteral(
"xmlns:xsi" ), QStringLiteral(
"http://www.w3.org/2001/XMLSchema-instance" ) );
1490 myDocument.appendChild( root );
1493 layerNode = myDocument.createElement( QStringLiteral(
"NamedLayer" ) );
1494 root.appendChild( layerNode );
1501 root.setAttribute( QStringLiteral(
"version" ), QStringLiteral(
"1.0.0" ) );
1502 root.setAttribute( QStringLiteral(
"xmlns:gml" ), QStringLiteral(
"http://www.opengis.net/gml" ) );
1503 root.setAttribute( QStringLiteral(
"xmlns:ogc" ), QStringLiteral(
"http://www.opengis.net/ogc" ) );
1504 root.setAttribute( QStringLiteral(
"xmlns:sld" ), QStringLiteral(
"http://www.opengis.net/sld" ) );
1505 myDocument.appendChild( root );
1508 layerNode = myDocument.createElement( QStringLiteral(
"UserLayer" ) );
1509 root.appendChild( layerNode );
1515 props[ QStringLiteral(
"scaleMinDenom" ) ] = QString::number( mMinScale );
1516 props[ QStringLiteral(
"scaleMaxDenom" ) ] = QString::number( mMaxScale );
1521 if ( !vlayer->
writeSld( layerNode, myDocument, errorMsg, props ) )
1523 errorMsg = tr(
"Could not save symbology because:\n%1" ).arg( errorMsg );
1530 if ( !rlayer->
writeSld( layerNode, myDocument, errorMsg, props ) )
1532 errorMsg = tr(
"Could not save symbology because:\n%1" ).arg( errorMsg );
1542 const QgsMapLayer *mlayer = qobject_cast<const QgsMapLayer *>(
this );
1545 QDomDocument myDocument;
1547 if ( !errorMsg.isNull() )
1555 if ( mlayer->
providerType() == QLatin1String(
"ogr" ) )
1557 QStringList theURIParts = uri.split(
'|' );
1558 filename = theURIParts[0];
1560 else if ( mlayer->
providerType() == QLatin1String(
"gpx" ) )
1562 QStringList theURIParts = uri.split(
'?' );
1563 filename = theURIParts[0];
1565 else if ( mlayer->
providerType() == QLatin1String(
"delimitedtext" ) )
1567 filename = QUrl::fromEncoded( uri.toLatin1() ).toLocalFile();
1569 if ( filename.isEmpty() )
1577 QFileInfo myFileInfo( filename );
1578 if ( myFileInfo.exists() || filename.endsWith( QLatin1String(
".sld" ), Qt::CaseInsensitive ) )
1580 QFileInfo myDirInfo( myFileInfo.path() );
1581 if ( !myDirInfo.isWritable() )
1583 return tr(
"The directory containing your dataset needs to be writable!" );
1587 QString myFileName = myFileInfo.path() + QDir::separator() + myFileInfo.completeBaseName() +
".sld";
1589 QFile myFile( myFileName );
1590 if ( myFile.open( QFile::WriteOnly | QFile::Truncate ) )
1592 QTextStream myFileStream( &myFile );
1594 myDocument.save( myFileStream, 2 );
1597 return tr(
"Created default style file as %1" ).arg( myFileName );
1602 return tr(
"ERROR: Failed to created SLD style file as %1. Check file permissions and retry." ).arg( filename );
1609 QDomDocument myDocument;
1613 QString myErrorMessage;
1615 QFile myFile( uri );
1616 if ( myFile.open( QFile::ReadOnly ) )
1619 resultFlag = myDocument.setContent( &myFile,
true, &myErrorMessage, &line, &column );
1621 myErrorMessage = tr(
"%1 at line %2 column %3" ).arg( myErrorMessage ).arg( line ).arg( column );
1626 myErrorMessage = tr(
"Unable to open file %1" ).arg( uri );
1631 return myErrorMessage;
1635 QDomElement myRoot = myDocument.firstChildElement( QStringLiteral(
"StyledLayerDescriptor" ) );
1636 if ( myRoot.isNull() )
1638 myErrorMessage = QStringLiteral(
"Error: StyledLayerDescriptor element not found in %1" ).arg( uri );
1640 return myErrorMessage;
1645 QDomElement namedLayerElem = myRoot.firstChildElement( QStringLiteral(
"NamedLayer" ) );
1646 if ( namedLayerElem.isNull() )
1648 myErrorMessage = QStringLiteral(
"Info: NamedLayer element not found." );
1650 return myErrorMessage;
1654 resultFlag =
readSld( namedLayerElem, errorMsg );
1657 myErrorMessage = tr(
"Loading style file %1 failed because:\n%2" ).arg( uri, errorMsg );
1658 return myErrorMessage;
1667 Q_UNUSED( errorMessage )
1669 Q_UNUSED( categories )
1678 Q_UNUSED( errorMessage )
1680 Q_UNUSED( categories )
1686 bool loadDefaultStyleFlag )
1690 QgsDataProvider::ReadFlags
flags = QgsDataProvider::ReadFlags();
1691 if ( loadDefaultStyleFlag )
1706 QgsDataProvider::ReadFlags
flags = QgsDataProvider::ReadFlags();
1707 if ( loadDefaultStyleFlag )
1728 setDataSourcePrivate( dataSource, baseName, provider, options,
flags );
1735 void QgsMapLayer::setDataSourcePrivate(
const QString &dataSource,
const QString &baseName,
const QString &provider,
1738 Q_UNUSED( dataSource )
1739 Q_UNUSED( baseName )
1740 Q_UNUSED( provider )
1752 QgsMapLayer::StyleCategories categories )
1759 QDomElement renderer3DElem = layerElement.firstChildElement( QStringLiteral(
"renderer-3d" ) );
1760 if ( !renderer3DElem.isNull() )
1762 QString type3D = renderer3DElem.attribute( QStringLiteral(
"type" ) );
1782 setScaleBasedVisibility( layerElement.attribute( QStringLiteral(
"hasScaleBasedVisibilityFlag" ) ).toInt() == 1 );
1783 if ( layerElement.hasAttribute( QStringLiteral(
"minimumScale" ) ) )
1786 setMaximumScale( layerElement.attribute( QStringLiteral(
"minimumScale" ) ).toDouble() );
1787 setMinimumScale( layerElement.attribute( QStringLiteral(
"maximumScale" ) ).toDouble() );
1791 setMaximumScale( layerElement.attribute( QStringLiteral(
"maxScale" ) ).toDouble() );
1792 setMinimumScale( layerElement.attribute( QStringLiteral(
"minScale" ) ).toDouble() );
1799 QDomElement flagsElem = layerElement.firstChildElement( QStringLiteral(
"flags" ) );
1800 LayerFlags
flags = mFlags;
1801 auto enumMap = qgsEnumMap<QgsMapLayer::LayerFlag>();
1802 for (
auto it = enumMap.constBegin(); it != enumMap.constEnd(); ++it )
1804 QDomNode flagNode = flagsElem.namedItem( it.value() );
1805 if ( flagNode.isNull() )
1807 bool flagValue = flagNode.toElement().text() ==
"1" ? true :
false;
1808 if (
flags.testFlag( it.key() ) && !flagValue )
1810 else if ( !
flags.testFlag( it.key() ) && flagValue )
1816 if ( categories.testFlag(
Temporal ) )
1821 properties->readXml( layerElement.toElement(), context );
1829 properties->readXml( layerElement.toElement(), context );
1832 if ( categories.testFlag(
Notes ) )
1834 const QDomElement notesElem = layerElement.firstChildElement( QStringLiteral(
"userNotes" ) );
1835 if ( !notesElem.isNull() )
1837 const QString notes = notesElem.attribute( QStringLiteral(
"value" ) );
1850 return mUndoStackStyles;
1855 return mCustomProperties.
keys();
1860 if ( !mCustomProperties.
contains( key ) || mCustomProperties.
value( key ) != value )
1862 mCustomProperties.
setValue( key, value );
1869 mCustomProperties = properties;
1874 return mCustomProperties;
1879 return mCustomProperties.
value( value, defaultValue );
1885 if ( mCustomProperties.
contains( key ) )
1887 mCustomProperties.
remove( key );
1919 const QString path = sourceParts.value( QStringLiteral(
"path" ) ).toString();
1920 if ( path.isEmpty() )
1924 const QStringList tempPaths = QStandardPaths::standardLocations( QStandardPaths::TempLocation );
1925 for (
const QString &tempPath : tempPaths )
1927 if ( path.startsWith( tempPath ) )
1953 mLegend->setParent(
this );
1967 return mStyleManager;
1972 if ( renderer == m3DRenderer )
1976 m3DRenderer = renderer;
1988 if ( mRepaintRequestedFired )
1991 mRepaintRequestedFired =
true;
1993 mRepaintRequestedFired =
false;
2029 bool QgsMapLayer::isReadOnly()
const
2036 return mOriginalXmlProperties;
2047 QString uuid = QUuid::createUuid().toString();
2049 QString
id = layerName +
'_' + uuid.mid( 1, uuid.length() - 2 );
2056 id.replace( QRegExp(
"[\\W]" ), QStringLiteral(
"_" ) );
2077 QSet<QgsMapLayerDependency> deps;
2078 const auto constODeps = oDeps;
2094 if ( !lDataProvider )
2112 if (
QgsMapLayerStore *store = qobject_cast<QgsMapLayerStore *>( parent() ) )
2114 return qobject_cast<QgsProject *>( store->parent() );
2119 void QgsMapLayer::onNotified(
const QString &message )
2132 if ( ! forceRecalculate && ! mWgs84Extent.
isNull() )
2136 else if ( ! mExtent.
isNull() )
2141 wgs84Extent = transformer.transformBoundingBox( mExtent );
2152 void QgsMapLayer::updateExtent(
const QgsRectangle &extent )
const
2160 if (
mReadFlags & QgsMapLayer::ReadFlag::FlagTrustLayerMetadata )
2169 if (
mReadFlags & QgsMapLayer::ReadFlag::FlagTrustLayerMetadata )
2177 QString
metadata = QStringLiteral(
"<h1>" ) + tr(
"Coordinate Reference System (CRS)" ) + QStringLiteral(
"</h1>\n<hr>\n" );
2178 metadata += QLatin1String(
"<table class=\"list-view\">\n" );
2183 metadata += QStringLiteral(
"<tr><td colspan=\"2\" class=\"highlight\">" ) + tr(
"Unknown" ) + QStringLiteral(
"</td></tr>\n" );
2189 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Units" ) + QStringLiteral(
"</td><td>" )
2190 + (
c.isGeographic() ? tr(
"Geographic (uses latitude and longitude for coordinates)" ) :
QgsUnitTypes::toString(
c.mapUnits() ) )
2191 + QStringLiteral(
"</td></tr>\n" );
2196 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Method" ) + QStringLiteral(
"</td><td>" ) + operation.
description() + QStringLiteral(
"</td></tr>\n" );
2201 const QString celestialBody =
c.celestialBodyName();
2202 if ( !celestialBody.isEmpty() )
2204 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Celestial body" ) + QStringLiteral(
"</td><td>" ) + celestialBody + QStringLiteral(
"</td></tr>\n" );
2212 QString accuracyString;
2214 if (
c.isDynamic() && std::isnan(
c.coordinateEpoch() ) )
2216 accuracyString = tr(
"Based on a dynamic CRS, but no coordinate epoch is set. Coordinates are ambiguous and of limited accuracy." );
2226 if ( !ensemble.
code().isEmpty() )
2227 id = QStringLiteral(
"<i>%1</i> (%2:%3)" ).arg( ensemble.
name(), ensemble.
authority(), ensemble.
code() );
2229 id = QStringLiteral(
"<i>%</i>”" ).arg( ensemble.
name() );
2233 accuracyString = tr(
"Based on %1, which has a limited accuracy of <b>at best %2 meters</b>." ).arg(
id ).arg( ensemble.
accuracy() );
2237 accuracyString = tr(
"Based on %1, which has a limited accuracy." ).arg(
id );
2246 if ( !accuracyString.isEmpty() )
2248 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Accuracy" ) + QStringLiteral(
"</td><td>" ) + accuracyString + QStringLiteral(
"</td></tr>\n" );
2252 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)" ) );
2255 if ( !std::isnan(
c.coordinateEpoch() ) )
2257 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Coordinate epoch" ) + QStringLiteral(
"</td><td>%1</td></tr>\n" ).arg(
c.coordinateEpoch() );
2261 metadata += QLatin1String(
"</table>\n<br><br>\n" );
static QString version()
Version string.
static const double SCALE_PRECISION
Fudge factor used to compare two scales.
Qgs3DRendererAbstractMetadata * rendererMetadata(const QString &type) const
Returns metadata for a 3D renderer type (may be used to create a new instance of the type)
Base class for all renderers that may to participate in 3D view.
virtual QString type() const =0
Returns unique identifier of the renderer class (used to identify subclass)
virtual void writeXml(QDomElement &elem, const QgsReadWriteContext &context) const =0
Writes renderer's properties to given XML element.
virtual void resolveReferences(const QgsProject &project)
Resolves references to other objects - second phase of loading - after readXml()
static QString pkgDataPath()
Returns the common root path of all application data directories.
static QString qgisSettingsDirPath()
Returns the path to the settings directory in user's home dir.
static QgsAuthManager * authManager()
Returns the application's authentication manager instance.
static Qgs3DRendererRegistry * renderer3DRegistry()
Returns registry of available 3D renderers.
bool setMasterPassword(bool verify=false)
Main call to initially set or continually check master password is set.
This class represents a coordinate reference system (CRS).
static QgsCoordinateReferenceSystem fromOgcWmsCrs(const QString &ogcCrs)
Creates a CRS from a given OGC WMS-format Coordinate Reference System string.
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
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 void setCustomCrsValidation(CUSTOM_CRS_VALIDATION f)
Sets custom function to force valid CRS.
void setValidationHint(const QString &html)
Set user hint for validation.
@ FullString
Full definition – possibly a very lengthy string, e.g. with no truncation of custom WKT definitions.
bool writeXml(QDomNode &node, QDomDocument &doc) const
Stores state to the given Dom node in the given document.
Contains information about the context in which a coordinate transform is executed.
Custom exception class for Coordinate Reference System related exceptions.
Abstract base class for spatial data provider implementations.
@ FlagLoadDefaultStyle
Reset the layer's style to the default for the datasource.
@ FlagTrustDataSource
Trust datasource config (primary key unicity, geometry type and srid, etc). Improves provider load ti...
QgsCoordinateTransformContext transformContext() const
Returns data provider coordinate transform context.
virtual void setListening(bool isListening)
Set whether the provider will listen to datasource notifications If set, the provider will issue noti...
void notify(const QString &msg)
Emitted when the datasource issues a notification.
static QString removePassword(const QString &aUri)
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).
QgsError is container for error messages (report).
static void setLayerNotes(QgsMapLayer *layer, const QString ¬es)
Sets the notes for the specified layer, where notes is a HTML formatted string.
static bool layerHasNotes(const QgsMapLayer *layer)
Returns true if the specified layer has notes available.
static QString layerNotes(const QgsMapLayer *layer)
Returns the notes for the specified layer.
This class models dependencies with or between map layers.
Base class for storage of map layer elevation properties.
The QgsMapLayerLegend class is abstract interface for implementations of legends for one map layer.
void itemsChanged()
Emitted when existing items/nodes got invalid and should be replaced by new ones.
A storage object for map layers, in which the layers are owned by the store and have their lifetime b...
Management of styles for use with one map layer.
bool addStyle(const QString &name, const QgsMapLayerStyle &style)
Add a style with given name and data.
QStringList styles() const
Returns list of all defined style names.
void writeXml(QDomElement &mgrElement) const
Write configuration (for project saving)
void reset()
Reset the style manager to a basic state - with one default style which is set as current.
void readXml(const QDomElement &mgrElement)
Read configuration (for project loading)
Base class for storage of map layer temporal properties.
Base class for all map layer types.
void setShortName(const QString &shortName)
Sets the short name of the layer used by QGIS Server to identify the layer.
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 docment provided.
QString legendUrlFormat() const
Returns the format for a URL based layer legend.
QgsRectangle wgs84Extent(bool forceRecalculate=false) const
Returns the WGS84 extent (EPSG:4326) of the layer according to ReadFlag::FlagTrustLayerMetadata.
void setRefreshOnNotifyEnabled(bool enabled)
Set whether provider notification is connected to triggerRepaint.
virtual bool isSpatial() const
Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated w...
QgsAbstract3DRenderer * renderer3D() const
Returns 3D renderer associated with the layer.
virtual bool isTemporary() const
Returns true if the layer is considered a temporary layer.
virtual void exportNamedStyle(QDomDocument &doc, QString &errorMsg, const QgsReadWriteContext &context=QgsReadWriteContext(), QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const
Export the properties of this layer as named style in a QDomDocument.
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.
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.
virtual bool importNamedStyle(QDomDocument &doc, QString &errorMsg, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories)
Import the properties of this layer from a QDomDocument.
void setAbstract(const QString &abstract)
Sets the abstract of the layer used by QGIS Server in GetCapabilities request.
void metadataChanged()
Emitted when the layer's metadata is changed.
virtual QgsRectangle extent() const
Returns the extent of the layer.
virtual QString saveSldStyle(const QString &uri, bool &resultFlag) const
Saves the properties of this layer to an SLD format file.
QString source() const
Returns the source for the layer.
void setLegendUrl(const QString &legendUrl)
Sets the URL for the layer's legend.
virtual bool setDependencies(const QSet< QgsMapLayerDependency > &layers)
Sets the list of dependencies.
void request3DUpdate()
Signal emitted when a layer requires an update in any 3D maps.
Q_INVOKABLE QVariant customProperty(const QString &value, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer.
int mBlockStyleChangedSignal
If non-zero, the styleChanged signal should not be emitted.
QString providerType() const
Returns the provider type (provider key) for this layer.
void removeCustomProperty(const QString &key)
Remove a custom property from layer.
void setBlendMode(QPainter::CompositionMode blendMode)
Set the blending mode used for rendering a layer.
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.
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(QgsMapLayerType type=QgsMapLayerType::VectorLayer, const QString &name=QString(), const QString &source=QString())
Constructor for QgsMapLayer.
QString publicSource() const
Gets a version of the internal layer definition that has sensitive bits removed (for example,...
QgsMapLayer::LayerFlags flags() const
Returns the flags for this layer.
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.
QString attribution() const
Returns the attribution of the layer used by QGIS Server in GetCapabilities request.
void setOriginalXmlProperties(const QString &originalXmlProperties)
Sets the original XML properties for the layer to originalXmlProperties.
void writeCustomProperties(QDomNode &layerNode, QDomDocument &doc) const
Write custom properties to project file.
QString mRefreshOnNofifyMessage
QString mLegendUrl
WMS legend.
QString id() const
Returns the layer's unique ID, which is used to access this layer from QgsProject.
virtual QString loadDefaultStyle(bool &resultFlag)
Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record...
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.
bool hasAutoRefreshEnabled() const
Returns true if auto refresh is enabled for the layer.
void triggerRepaint(bool deferredUpdate=false)
Will advise the map canvas (and any other interested party) that this layer requires to be repainted.
QString crsHtmlMetadata() const
Returns a HTML fragment containing the layer's CRS metadata, for use in the htmlMetadata() method.
void setAttributionUrl(const QString &attribUrl)
Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request.
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.
QString originalXmlProperties() const
Returns the XML properties of the original layer as they were when the layer was first read from the ...
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.
void setDataUrl(const QString &dataUrl)
Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request.
virtual QString saveDefaultStyle(bool &resultFlag)
Save the properties of this layer as the default style (either as a .qml file on disk or as a record ...
virtual void setOpacity(double opacity)
Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1....
void setKeywordList(const QString &keywords)
Sets the keyword list of the layer used by QGIS Server in GetCapabilities request.
void setAttribution(const QString &attrib)
Sets the attribution of the layer used 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 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 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 ...
void setDataUrlFormat(const QString &dataUrlFormat)
Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
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.
QString title() const
Returns the title of the layer used by QGIS Server in GetCapabilities request.
void crsChanged()
Emit a signal that layer's CRS has been reset.
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.
QString dataUrl() const
Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request.
bool readLayerXml(const QDomElement &layerElement, QgsReadWriteContext &context, QgsMapLayer::ReadFlags flags=QgsMapLayer::ReadFlags())
Sets state from DOM document.
bool hasScaleBasedVisibility() const
Returns whether scale based visibility is enabled for the layer.
virtual QString loadNamedStyle(const QString &uri, bool &resultFlag, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories)
Retrieve a named style for this layer if one exists (either as a .qml file on disk or as a record in ...
virtual QgsMapLayer * clone() const =0
Returns a new instance equivalent to this one except for the id which is still unique.
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.
void opacityChanged(double opacity)
Emitted when the layer's opacity is changed, where opacity is a value between 0 (transparent) and 1 (...
void emitStyleChanged()
Triggers an emission of the styleChanged() signal.
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.
QString mMetadataUrlFormat
virtual QString htmlMetadata() const
Obtain a formatted HTML string containing assorted metadata for this layer.
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.
static QString extensionPropertyType(PropertyType type)
Returns the extension of a Property.
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.
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 mMetadataUrl
MetadataUrl of the layer.
QString mDataSource
Data source description string, varies by layer type.
QString refreshOnNotifyMessage() const
Returns the message that should be notified by the provider to triggerRepaint.
virtual bool readSld(const QDomNode &node, QString &errorMessage)
virtual QString loadDefaultMetadata(bool &resultFlag)
Retrieve the default metadata for this layer if one exists (either as a .qmd file on disk or as a rec...
@ FlagReadExtentFromXml
Read extent from xml and skip get extent from provider.
@ FlagTrustLayerMetadata
Trust layer metadata. Improves layer load time by skipping expensive checks like primary key unicity,...
void setValid(bool valid)
Sets whether layer is valid or not.
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.
QString mAbstract
Description of the layer.
void customPropertyChanged(const QString &key)
Emitted when a custom property of the layer has been changed or removed.
QgsMapLayer::ReadFlags mReadFlags
Read flags. It's up to the subclass to respect these when restoring state from XML.
void setDataSource(const QString &dataSource, const QString &baseName, const QString &provider, bool loadDefaultStyleFlag=false)
Updates the data source of the layer.
double minimumScale() const
Returns the minimum map scale (i.e.
QgsMapLayerStyleManager * styleManager() const
Gets access to the layer's style manager.
QString legendUrl() const
Returns the URL for the layer's legend.
void flagsChanged()
Emitted when layer's flags have been modified.
void repaintRequested(bool deferredUpdate=false)
By emitting this signal the layer tells that either appearance or content have been changed and any v...
void setLegendUrlFormat(const QString &legendUrlFormat)
Sets the format for a URL based layer legend.
void exportNamedMetadata(QDomDocument &doc, QString &errorMsg) const
Export the current metadata of this layer as named metadata in a QDomDocument.
virtual QString saveNamedStyle(const QString &uri, bool &resultFlag, StyleCategories categories=AllStyleCategories)
Save the properties of this layer as a named style (either as a .qml file on disk or as a record in t...
virtual void exportSldStyle(QDomDocument &doc, QString &errorMsg) const
Export the properties of this layer as SLD style in a QDomDocument.
void beforeResolveReferences(QgsProject *project)
Emitted when all layers are loaded and references can be resolved, just before the references of this...
void setMetadataUrl(const QString &metaUrl)
Sets the metadata URL of the layer used by QGIS Server in GetCapabilities request.
Q_INVOKABLE QStringList customPropertyKeys() const
Returns list of all keys within custom properties.
QgsProject * project() const
Returns the parent project if this map layer is added to a project.
void setMetadataUrlType(const QString &metaUrlType)
Set the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType ind...
void setLegend(QgsMapLayerLegend *legend)
Assign a legend controller to the map layer.
virtual QgsMapLayerElevationProperties * elevationProperties()
Returns the layer's elevation properties.
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...
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
QString mDataUrl
DataUrl of the layer.
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.
@ Notes
Layer user notes (since QGIS 3.20)
@ Temporal
Temporal properties (since QGIS 3.14)
@ Rendering
Rendering: scale visibility, simplify method, opacity.
@ Elevation
Elevation settings (since QGIS 3.18)
@ Symbology3D
3D symbology
@ CustomProperties
Custom properties (by plugins for instance)
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)
virtual QgsMapLayerTemporalProperties * temporalProperties()
Returns the layer's temporal properties.
void setRenderer3D(QgsAbstract3DRenderer *renderer)
Sets 3D renderer for the layer.
QString mAttribution
Attribution of the layer.
const QgsObjectCustomProperties & customProperties() const
Read all custom properties from layer.
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.
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.
void setTitle(const QString &title)
Sets the title of the layer used by QGIS Server in GetCapabilities request.
PropertyType
Maplayer has a style and a metadata property.
bool mShouldValidateCrs
true if the layer's CRS should be validated and invalid CRSes are not permitted.
void setCrs(const QgsCoordinateReferenceSystem &srs, bool emitSignal=true)
Sets layer's spatial reference system.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
Custom exception class which is raised when an operation is not supported.
Simple key-value store (keys = strings, values = variants) that supports loading/saving to/from XML i...
void setValue(const QString &key, const QVariant &value)
Add an entry to the store with the specified key.
QStringList keys() const
Returns a list of all stored keys.
void writeXml(QDomNode &parentNode, QDomDocument &doc) const
Writes the store contents to an XML node.
void remove(const QString &key)
Removes a key (entry) from the store.
QVariant value(const QString &key, const QVariant &defaultValue=QVariant()) const
Returns the value for the given key.
void readXml(const QDomNode &parentNode, const QString &keyStartsWith=QString())
Read store contents from an XML node.
bool contains(const QString &key) const
Returns true if the properties contains a key with the specified name.
Contains information about a PROJ operation.
QString description() const
Description.
virtual QString translate(const QString &context, const QString &sourceText, const char *disambiguation=nullptr, int n=-1) const =0
The derived translate() translates with QTranslator and qm file the sourceText.
A class to describe the version of a project.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
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...
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) SIP_THROW(QgsNotSupportedException)
Saves metadata to the layer corresponding to the specified uri.
Represents a raster layer.
bool writeSld(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QVariantMap &props=QVariantMap()) const
Writes the symbology of the layer into the document provided in SLD 1.0.0 format.
Allows entering a context category and takes care of leaving this category on deletion of the class.
The class is used as a container of context for various read/write operations on other objects.
MAYBE_UNUSED NODISCARD QgsReadWriteContextCategoryPopper enterCategory(const QString &category, const QString &details=QString()) const
Push a category to the stack.
const QgsProjectTranslator * projectTranslator() const
Returns the project translator.
A rectangle specified with double values.
bool isNull() const
Test if the rectangle is null (all coordinates zero or after call to setMinimal()).
static QString capitalize(const QString &string, Capitalization capitalization)
Converts a string by applying capitalization rules to the string.
@ ForceFirstLetterToCapital
Convert just the first letter of each word to uppercase, leave the rest untouched.
An interface for classes which can visit style entity (e.g.
static Q_INVOKABLE QString toString(QgsUnitTypes::DistanceUnit unit)
Returns a translated string representing a distance unit.
Represents a vector layer which manages a vector based data sets.
Q_INVOKABLE QgsWkbTypes::GeometryType geometryType() const
Returns point, line or polygon.
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.
GeometryType
The geometry types are used to group QgsWkbTypes::Type in a coarse way.
static T readFlagAttribute(const QDomElement &element, const QString &attributeName, T defaultValue)
Read a flag value from an attribute of the element.
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 ...
QgsMapLayerType
Types of layers that can be added to a map.
@ AnnotationLayer
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
CONSTLATIN1STRING geoEpsgCrsAuthId()
Geographic coord sys from EPSG authority.
void(* CUSTOM_CRS_VALIDATION)(QgsCoordinateReferenceSystem &)
#define QgsDebugMsgLevel(str, level)
Setting options for creating vector data providers.