QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
QgsProjectStorageRegistry Class Reference

Registry of storage backends that QgsProject may use. More...

#include <qgsprojectstorageregistry.h>

Public Member Functions

 ~QgsProjectStorageRegistry ()
QgsProjectStorageprojectStorageFromType (const QString &type)
 Returns storage implementation if the storage type matches one. Returns nullptr otherwise (it is a normal file).
QgsProjectStorageprojectStorageFromUri (const QString &uri)
 Returns storage implementation if the URI matches one. Returns nullptr otherwise (it is a normal file).
QList< QgsProjectStorage * > projectStorages () const
 Returns a list of registered project storage implementations.
void registerProjectStorage (QgsProjectStorage *storage)
 Registers a storage backend and takes ownership of it.
void unregisterProjectStorage (QgsProjectStorage *storage)
 Unregisters a storage backend and destroys its instance.

Detailed Description

Registry of storage backends that QgsProject may use.

This is a singleton that should be accessed through QgsApplication::projectStorageRegistry().

Since
QGIS 3.2

Definition at line 34 of file qgsprojectstorageregistry.h.

Constructor & Destructor Documentation

◆ ~QgsProjectStorageRegistry()

QgsProjectStorageRegistry::~QgsProjectStorageRegistry ( )

Definition at line 20 of file qgsprojectstorageregistry.cpp.

Member Function Documentation

◆ projectStorageFromType()

QgsProjectStorage * QgsProjectStorageRegistry::projectStorageFromType ( const QString & type)

Returns storage implementation if the storage type matches one. Returns nullptr otherwise (it is a normal file).

Definition at line 25 of file qgsprojectstorageregistry.cpp.

◆ projectStorageFromUri()

QgsProjectStorage * QgsProjectStorageRegistry::projectStorageFromUri ( const QString & uri)

Returns storage implementation if the URI matches one. Returns nullptr otherwise (it is a normal file).

Definition at line 30 of file qgsprojectstorageregistry.cpp.

◆ projectStorages()

QList< QgsProjectStorage * > QgsProjectStorageRegistry::projectStorages ( ) const

Returns a list of registered project storage implementations.

Definition at line 49 of file qgsprojectstorageregistry.cpp.

◆ registerProjectStorage()

void QgsProjectStorageRegistry::registerProjectStorage ( QgsProjectStorage * storage)

Registers a storage backend and takes ownership of it.

Definition at line 54 of file qgsprojectstorageregistry.cpp.

◆ unregisterProjectStorage()

void QgsProjectStorageRegistry::unregisterProjectStorage ( QgsProjectStorage * storage)

Unregisters a storage backend and destroys its instance.

Definition at line 59 of file qgsprojectstorageregistry.cpp.


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