Class: QgsProjectStorageGuiProvider

class qgis.gui.QgsProjectStorageGuiProvider

Bases: sip.wrapper

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

Methods

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).

type

Unique identifier of the project storage type.

visibleName

Returns human-readable name of the storage.

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.

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.

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.

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.