QGIS API Documentation  3.22.4-Białowieża (ce8e65e95e)
Public Member Functions | Static Public Member Functions | List of all members
QgsProjectFileTransform Class Reference

Class to convert from older project file versions to newer. More...

#include <qgsprojectfiletransform.h>

Public Member Functions

 QgsProjectFileTransform (QDomDocument &domDocument, const QgsProjectVersion &version)
 Create an instance from a Dom and a supplied version. More...
 
QgsProjectVersion currentVersion () const
 The current project version. More...
 
QDomDocument & dom ()
 The current dom document. More...
 
void dump ()
 Prints the contents via QgsDebugMsg() More...
 
bool updateRevision (const QgsProjectVersion &version)
 

Static Public Member Functions

static void convertRasterProperties (QDomDocument &doc, QDomNode &parentNode, QDomElement &rasterPropertiesElem, QgsRasterLayer *rlayer)
 

Detailed Description

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

Definition at line 37 of file qgsprojectfiletransform.h.

Constructor & Destructor Documentation

◆ QgsProjectFileTransform()

QgsProjectFileTransform::QgsProjectFileTransform ( QDomDocument &  domDocument,
const QgsProjectVersion version 
)
inline

Create an instance from a Dom and a supplied version.

Parameters
domDocumentThe Dom document to use as content
versionVersion number

Definition at line 48 of file qgsprojectfiletransform.h.

Member Function Documentation

◆ convertRasterProperties()

void QgsProjectFileTransform::convertRasterProperties ( QDomDocument &  doc,
QDomNode &  parentNode,
QDomElement &  rasterPropertiesElem,
QgsRasterLayer rlayer 
)
static

Definition at line 889 of file qgsprojectfiletransform.cpp.

◆ currentVersion()

QgsProjectVersion QgsProjectFileTransform::currentVersion ( ) const

The current project version.

Since
QGIS 3.12

Definition at line 1109 of file qgsprojectfiletransform.cpp.

◆ dom()

QDomDocument & QgsProjectFileTransform::dom ( )

The current dom document.

Since
QGIS 3.12

Definition at line 1104 of file qgsprojectfiletransform.cpp.

◆ dump()

void QgsProjectFileTransform::dump ( )

Prints the contents via QgsDebugMsg()

Definition at line 123 of file qgsprojectfiletransform.cpp.

◆ updateRevision()

bool QgsProjectFileTransform::updateRevision ( const QgsProjectVersion version)

Definition at line 71 of file qgsprojectfiletransform.cpp.


The documentation for this class was generated from the following files: