Class: QgsProjectStorage¶
-
class
qgis.core.
QgsProjectStorage
¶ Bases:
sip.wrapper
Abstract interface for project storage - to be implemented by various backends and registered in QgsProjectStorageRegistry.
New in version 3.2: Enums
Methods
Returns list of all projects for given URI (specific to each storage backend)
Reads project file content stored in the backend at the specified URI to the given device (could be e.g.
Reads project metadata (e.g.
Removes an existing project at the given URI.
Rename an existing project at the given URI to a different URI.
Opens GUI to allow user to select a project to be loaded (GUI specific to this storage type).
Opens GUI to allow user to select where a project should be saved (GUI specific to this storage type).
Unique identifier of the project storage type.
Returns human-readable name of the storage.
Writes project file content stored in given device (could be e.g.
Signals
Attributes
-
class
Metadata
¶ Bases:
sip.wrapper
Metadata associated with a project
New in version 3.2.
-
lastModified
¶
-
name
¶
-
-
listProjects
(self, uri: str) → List[str]¶ Returns list of all projects for given URI (specific to each storage backend)
-
readProject
(self, uri: str, device: QIODevice, context: QgsReadWriteContext) → bool¶ Reads project file content stored in the backend at the specified URI to the given device (could be e.g. a temporary file or a memory buffer). The device is expected to be empty when passed to readProject() so that the method can write all data to it and then rewind it using seek(0) to make it ready for reading in
QgsProject
.
-
readProjectStorageMetadata
(self, uri: str) → Tuple[bool, QgsProjectStorage.Metadata]¶ Reads project metadata (e.g. last modified time) if this is supported by the storage implementation. Returns true if the metadata were read with success.
-
removeProject
(self, uri: str) → bool¶ Removes an existing project at the given URI. Returns true if the removal was successful.
-
renameProject
(self, uri: str, uriNew: str) → bool¶ Rename an existing project at the given URI to a different URI. Returns true if renaming was successful.
-
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.
-
writeProject
(self, uri: str, device: QIODevice, context: QgsReadWriteContext) → bool¶ Writes project file content stored in given device (could be e.g. a temporary file or a memory buffer) using the backend to the specified URI. The device is expected to contain all project file data and having position at the start of the content when passed to writeProject() so that the method can read all data from it until it reaches its end.
-
class