QGIS API Documentation  3.4.3-Madeira (2f64a3c)
Public Member Functions | List of all members
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 null pointer otherwise (it is a normal file) More...
 
QgsProjectStorageprojectStorageFromUri (const QString &uri)
 Returns storage implementation if the URI matches one. Returns null pointer otherwise (it is a normal file) More...
 
QList< QgsProjectStorage * > projectStorages () const
 Returns a list of registered project storage implementations. More...
 
void registerProjectStorage (QgsProjectStorage *storage)
 Registers a storage backend and takes ownership of it. More...
 
void unregisterProjectStorage (QgsProjectStorage *storage)
 Unregisters a storage backend and destroys its instance. More...
 

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 33 of file qgsprojectstorageregistry.h.

Constructor & Destructor Documentation

◆ ~QgsProjectStorageRegistry()

QgsProjectStorageRegistry::~QgsProjectStorageRegistry ( )

Definition at line 21 of file qgsprojectstorageregistry.cpp.

Member Function Documentation

◆ projectStorageFromType()

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

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

Definition at line 26 of file qgsprojectstorageregistry.cpp.

◆ projectStorageFromUri()

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

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

Definition at line 31 of file qgsprojectstorageregistry.cpp.

◆ projectStorages()

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

Returns a list of registered project storage implementations.

Definition at line 43 of file qgsprojectstorageregistry.cpp.

◆ registerProjectStorage()

void QgsProjectStorageRegistry::registerProjectStorage ( QgsProjectStorage storage)

Registers a storage backend and takes ownership of it.

Definition at line 48 of file qgsprojectstorageregistry.cpp.

◆ unregisterProjectStorage()

void QgsProjectStorageRegistry::unregisterProjectStorage ( QgsProjectStorage storage)

Unregisters a storage backend and destroys its instance.

Definition at line 53 of file qgsprojectstorageregistry.cpp.


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