QGIS API Documentation 3.99.0-Master (26c88405ac0)
Loading...
Searching...
No Matches
QgsProjectStoredObjectManagerBase Class Reference

Manages storage of a set of objects attached to a QgsProject. More...

#include <qgsprojectstoredobjectmanager.h>

Inheritance diagram for QgsProjectStoredObjectManagerBase:

Signals

void objectAboutToBeAdded (const QString &name)
 Emitted when an object is about to be added to the manager.
void objectAboutToBeRemoved (const QString &name)
 Emitted when an object is about to be removed from the manager.
void objectAdded (const QString &name)
 Emitted when an object has been added to the manager.
void objectRemoved (const QString &name)
 Emitted when an object was removed from the manager.

Public Member Functions

 QgsProjectStoredObjectManagerBase (QgsProject *project=nullptr)
 Constructor for QgsProjectStoredObjectManagerBase, for objects attached to the specified project.

Protected Member Functions

void markProjectDirty ()
 Marks the project as dirty.

Protected Attributes

QgsProjectmProject = nullptr
 Associated project.

Detailed Description

Manages storage of a set of objects attached to a QgsProject.

QgsProjectStoredObjectManagerBase handles the storage, serializing and deserializing of attached objects.

QgsProjectStoredObjectManagerBase retains ownership of all the objects contained in the manager.

Since
QGIS 4.0

Definition at line 40 of file qgsprojectstoredobjectmanager.h.

Constructor & Destructor Documentation

◆ QgsProjectStoredObjectManagerBase()

QgsProjectStoredObjectManagerBase::QgsProjectStoredObjectManagerBase ( QgsProject * project = nullptr)
explicit

Constructor for QgsProjectStoredObjectManagerBase, for objects attached to the specified project.

Definition at line 26 of file qgsprojectstoredobjectmanager.cpp.

Member Function Documentation

◆ markProjectDirty()

void QgsProjectStoredObjectManagerBase::markProjectDirty ( )
protected

Marks the project as dirty.

Definition at line 33 of file qgsprojectstoredobjectmanager.cpp.

◆ objectAboutToBeAdded

void QgsProjectStoredObjectManagerBase::objectAboutToBeAdded ( const QString & name)
signal

Emitted when an object is about to be added to the manager.

◆ objectAboutToBeRemoved

void QgsProjectStoredObjectManagerBase::objectAboutToBeRemoved ( const QString & name)
signal

Emitted when an object is about to be removed from the manager.

◆ objectAdded

void QgsProjectStoredObjectManagerBase::objectAdded ( const QString & name)
signal

Emitted when an object has been added to the manager.

◆ objectRemoved

void QgsProjectStoredObjectManagerBase::objectRemoved ( const QString & name)
signal

Emitted when an object was removed from the manager.

Member Data Documentation

◆ mProject

QgsProject* QgsProjectStoredObjectManagerBase::mProject = nullptr
protected

Associated project.

Definition at line 68 of file qgsprojectstoredobjectmanager.h.


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