Class: QgsProjectStorageGuiProvider

Abstract interface for project storage GUI - to be implemented by various backends and registered in QgsProjectStorageGuiRegistry.

Added in version 3.10.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: type()

Abstract Methods

type	Unique identifier of the project storage type.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsProjectStorageGuiProvider. See the FAQ for more details.

showLoadGui	Opens GUI to allow user to select a project to be loaded (GUI specific to this storage type).
showSaveGui	Opens GUI to allow user to select where a project should be saved (GUI specific to this storage type).
visibleName	Returns human-readable name of the storage.

class qgis.gui.QgsProjectStorageGuiProvider

Bases: object

virtual showLoadGui(self) → str

Opens GUI to allow user to select a project to be loaded (GUI specific to this storage type). Returns project URI if user has picked a project or empty string if the GUI was canceled.

Return type:

str

virtual showSaveGui(self) → str

Opens GUI to allow user to select where a project should be saved (GUI specific to this storage type). Returns project URI if user has picked a destination or empty string if the GUI was canceled.

Return type:

str

abstract type(self) → str

Unique identifier of the project storage type. If type() returns “memory”, all project file names starting with “memory:” will have read/write redirected through that storage implementation.

Return type:

str

virtual visibleName(self) → str

Returns human-readable name of the storage. Used as the menu item text in QGIS. Empty name indicates that the storage does not implement GUI support (showLoadGui() and showSaveGui()). The name may be translatable and ideally unique as well.

Return type:

str