Class: QgsProjectFileTransform

Convert from older project file versions to newer.

This class provides possibility to store a project file as a QDomDocument, and provides the ability to specify version of the project file, and perform upgrades to a more recent version

Methods

currentVersion

The current project version

dom

The current dom document

dump

Prints the contents to the console.

updateRevision

Static Methods

convertRasterProperties

fixOldSymbolLayerReferences

QgsSymbolLayerReference uses QgsSymbolLayer unique uuid identifier since QGIS 3.30, instead of the symbol key (rule for QgsRuleBasedRenderer for instance) and index path, so this method migrates mapLayers old references to new ones.

class qgis.core.QgsProjectFileTransform[source]

Bases: object

__init__(domDocument: QDomDocument, version: QgsProjectVersion)

Create an instance from a Dom and a supplied version

Parameters:
  • domDocument (QDomDocument) – The Dom document to use as content

  • version (QgsProjectVersion) – Version number

__init__(a0: QgsProjectFileTransform)
Parameters:

a0 (QgsProjectFileTransform)

static convertRasterProperties(doc: QDomDocument, parentNode: QDomNode, rasterPropertiesElem: QDomElement, rlayer: QgsRasterLayer | None)[source]
Parameters:
  • doc (QDomDocument)

  • parentNode (QDomNode)

  • rasterPropertiesElem (QDomElement)

  • rlayer (Optional[QgsRasterLayer])

currentVersion(self) QgsProjectVersion[source]

The current project version

Added in version 3.12.

Return type:

QgsProjectVersion

dom(self) QDomDocument

The current dom document

Added in version 3.12.

Return type:

QDomDocument

dump(self)[source]

Prints the contents to the console.

static fixOldSymbolLayerReferences(mapLayers: Any)[source]

QgsSymbolLayerReference uses QgsSymbolLayer unique uuid identifier since QGIS 3.30, instead of the symbol key (rule for QgsRuleBasedRenderer for instance) and index path, so this method migrates mapLayers old references to new ones.

Added in version 3.30.

Deprecated since version 3.30.

Parameters:

mapLayers (Any)

updateRevision(self, version: QgsProjectVersion) bool[source]
Parameters:

version (QgsProjectVersion)

Return type:

bool