QGIS API Documentation  3.9.0-Master (224899f119)
Public Member Functions | List of all members
QgsProjectStorageGuiRegistry Class Reference

A registry / canonical manager of GUI parts of project storage backends. More...

#include <qgsprojectstorageguiregistry.h>

Public Member Functions

 QgsProjectStorageGuiRegistry ()
 
 QgsProjectStorageGuiRegistry (const QgsProjectStorageGuiRegistry &rh)=delete
 QgsProjectStorageGuiRegistry cannot be copied. More...
 
 ~QgsProjectStorageGuiRegistry ()
 
void initializeFromProviderGuiRegistry (QgsProviderGuiRegistry *providerGuiRegistry)
 Initializes the registry. More...
 
QgsProjectStorageGuiRegistryoperator= (const QgsProjectStorageGuiRegistry &rh)=delete
 QgsProjectStorageGuiRegistry cannot be copied. More...
 
QgsProjectStorageGuiProviderprojectStorageFromType (const QString &type)
 Returns storage implementation if the storage type matches one. Returns nullptr otherwise (it is a normal file) More...
 
QgsProjectStorageGuiProviderprojectStorageFromUri (const QString &uri)
 Returns storage implementation if the URI matches one. Returns nullptr otherwise (it is a normal file) More...
 
QList< QgsProjectStorageGuiProvider * > projectStorages () const
 Returns a list of registered project storage implementations. More...
 
void registerProjectStorage (QgsProjectStorageGuiProvider *storage)
 Registers a storage backend and takes ownership of it. More...
 
void unregisterProjectStorage (QgsProjectStorageGuiProvider *storage)
 Unregisters a storage backend and destroys its instance. More...
 

Detailed Description

A registry / canonical manager of GUI parts of project storage backends.

QgsProjectStorageGuiRegistry is not usually directly created, but rather accessed through QgsGui::projectStorageGuiRegistry().

See also
QgsProjectStorageRegistry
Since
QGIS 3.10

Definition at line 44 of file qgsprojectstorageguiregistry.h.

Constructor & Destructor Documentation

◆ QgsProjectStorageGuiRegistry() [1/2]

QgsProjectStorageGuiRegistry::QgsProjectStorageGuiRegistry ( )
default

◆ ~QgsProjectStorageGuiRegistry()

QgsProjectStorageGuiRegistry::~QgsProjectStorageGuiRegistry ( )

Definition at line 24 of file qgsprojectstorageguiregistry.cpp.

◆ QgsProjectStorageGuiRegistry() [2/2]

QgsProjectStorageGuiRegistry::QgsProjectStorageGuiRegistry ( const QgsProjectStorageGuiRegistry rh)
delete

QgsProjectStorageGuiRegistry cannot be copied.

Member Function Documentation

◆ initializeFromProviderGuiRegistry()

void QgsProjectStorageGuiRegistry::initializeFromProviderGuiRegistry ( QgsProviderGuiRegistry providerGuiRegistry)

Initializes the registry.

The registry needs to be passed explicitly (instead of using singleton) because this gets called from QgsGui constructor.

Definition at line 61 of file qgsprojectstorageguiregistry.cpp.

◆ operator=()

QgsProjectStorageGuiRegistry& QgsProjectStorageGuiRegistry::operator= ( const QgsProjectStorageGuiRegistry rh)
delete

QgsProjectStorageGuiRegistry cannot be copied.

◆ projectStorageFromType()

QgsProjectStorageGuiProvider * QgsProjectStorageGuiRegistry::projectStorageFromType ( const QString &  type)

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

Definition at line 29 of file qgsprojectstorageguiregistry.cpp.

◆ projectStorageFromUri()

QgsProjectStorageGuiProvider * QgsProjectStorageGuiRegistry::projectStorageFromUri ( const QString &  uri)

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

Definition at line 34 of file qgsprojectstorageguiregistry.cpp.

◆ projectStorages()

QList< QgsProjectStorageGuiProvider * > QgsProjectStorageGuiRegistry::projectStorages ( ) const

Returns a list of registered project storage implementations.

Definition at line 46 of file qgsprojectstorageguiregistry.cpp.

◆ registerProjectStorage()

void QgsProjectStorageGuiRegistry::registerProjectStorage ( QgsProjectStorageGuiProvider storage)

Registers a storage backend and takes ownership of it.

Definition at line 51 of file qgsprojectstorageguiregistry.cpp.

◆ unregisterProjectStorage()

void QgsProjectStorageGuiRegistry::unregisterProjectStorage ( QgsProjectStorageGuiProvider storage)

Unregisters a storage backend and destroys its instance.

Definition at line 56 of file qgsprojectstorageguiregistry.cpp.


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