Class: QgsProjectFileTransform

class qgis.core.QgsProjectFileTransform

Bases: sip.wrapper

Class to 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

QgsProjectFileTransform(domDocument: QDomDocument, version: QgsProjectVersion) Create an instance from a Dom and a supplied version

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

  • version – Version number

QgsProjectFileTransform(QgsProjectFileTransform)

Methods

convertRasterProperties

param doc:

currentVersion

The current project version

dom

The current dom document

dump

Prints the contents via :py:class:`QgsDebugMsgLevel`()

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.

updateRevision

param version:

convertRasterProperties(doc: QDomDocument, parentNode: QDomNode, rasterPropertiesElem: QDomElement, rlayer: QgsRasterLayer)
Parameters:
  • doc (QDomDocument) –

  • parentNode (QDomNode) –

  • rasterPropertiesElem (QDomElement) –

  • rlayer (QgsRasterLayer) –

currentVersion(self) QgsProjectVersion

The current project version

New in version 3.12.

Return type:

QgsProjectVersion

dom(self) QDomDocument

The current dom document

New in version 3.12.

Return type:

QDomDocument

dump(self)

Prints the contents via :py:class:`QgsDebugMsgLevel`()

fixOldSymbolLayerReferences(mapLayers: object)

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.

New in version 3.30.

Deprecated since version QGIS: 3.30

Parameters:

mapLayers (object) –

updateRevision(self, version: QgsProjectVersion) bool
Parameters:

version (QgsProjectVersion) –

Return type:

bool