QGIS/python/gui/auto_generated/qgsprojectstorageguiprovider.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

67 lines
2.5 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsprojectstorageguiprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProjectStorageGuiProvider
{
%Docstring(signature="appended")
Abstract interface for project storage GUI - to be implemented by
various backends and registered in
:py:class:`QgsProjectStorageGuiRegistry`.
.. versionadded:: 3.10
%End
%TypeHeaderCode
#include "qgsprojectstorageguiprovider.h"
%End
public:
virtual ~QgsProjectStorageGuiProvider();
virtual QString type() = 0;
%Docstring
Unique identifier of the project storage type. If
:py:func:`~QgsProjectStorageGuiProvider.type` returns "memory", all
project file names starting with "memory:" will have read/write
redirected through that storage implementation.
%End
virtual QString visibleName();
%Docstring
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 (:py:func:`~QgsProjectStorageGuiProvider.showLoadGui` and
:py:func:`~QgsProjectStorageGuiProvider.showSaveGui`). The name may be
translatable and ideally unique as well.
%End
virtual QString showLoadGui();
%Docstring
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.
%End
virtual QString showSaveGui();
%Docstring
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.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsprojectstorageguiprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/