QgsProjectDirtyBlocker Class Reference

Temporarily blocks QgsProject "dirtying" for the lifetime of the object. More...

#include <qgsproject.h>

Public Member Functions
	QgsProjectDirtyBlocker (QgsProject *project)
	Constructor for QgsProjectDirtyBlocker. More...
	QgsProjectDirtyBlocker (const QgsProjectDirtyBlocker &other)=delete
	QgsProjectDirtyBlocker cannot be copied. More...
	~QgsProjectDirtyBlocker ()
QgsProjectDirtyBlocker &	operator= (const QgsProjectDirtyBlocker &other)=delete
	QgsProjectDirtyBlocker cannot be copied. More...

Detailed Description

Temporarily blocks QgsProject "dirtying" for the lifetime of the object.

QgsProjectDirtyBlocker supports "stacked" blocking, so two QgsProjectDirtyBlockers created for the same project will both need to be destroyed before the project can be dirtied again.

Note that QgsProjectDirtyBlocker only blocks calls which set the project as dirty - calls which set the project as clean are not blocked.

Python scripts should not use QgsProjectDirtyBlocker directly. Instead, use QgsProject.blockDirtying()

project = QgsProject.instance()
with QgsProject.blockDirtying(project):
  # do something

See also

QgsProject::setDirty()

Since

QGIS 3.2

Definition at line 1489 of file qgsproject.h.

Constructor & Destructor Documentation

QgsProjectDirtyBlocker::QgsProjectDirtyBlocker ( QgsProject *  project )

inline

Constructor for QgsProjectDirtyBlocker.

This will block dirtying the specified project for the lifetime of this object.

Definition at line 1498 of file qgsproject.h.

QgsProjectDirtyBlocker::QgsProjectDirtyBlocker ( const QgsProjectDirtyBlocker &  other )

delete

QgsProjectDirtyBlocker cannot be copied.

QgsProjectDirtyBlocker::~QgsProjectDirtyBlocker ( )

inline

Definition at line 1510 of file qgsproject.h.

Member Function Documentation

QgsProjectDirtyBlocker& QgsProjectDirtyBlocker::operator= ( const QgsProjectDirtyBlocker &  other )

delete

QgsProjectDirtyBlocker cannot be copied.

---

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

• /build/qgis-3.4.15+24xenial/src/core/qgsproject.h