QGIS API Documentation  3.13.0-Master (7f54853aae)
Public Member Functions | List of all members
QgsProjectStorageGuiProvider Class Referenceabstract

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

#include <qgsprojectstorageguiprovider.h>

Public Member Functions

virtual ~QgsProjectStorageGuiProvider ()=default
 
virtual QString showLoadGui ()
 Opens GUI to allow user to select a project to be loaded (GUI specific to this storage type). More...
 
virtual QString showSaveGui ()
 Opens GUI to allow user to select where a project should be saved (GUI specific to this storage type). More...
 
virtual QString type ()=0
 Unique identifier of the project storage type. More...
 
virtual QString visibleName ()
 Returns human-readable name of the storage. More...
 

Detailed Description

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

Since
QGIS 3.10

Definition at line 31 of file qgsprojectstorageguiprovider.h.

Constructor & Destructor Documentation

◆ ~QgsProjectStorageGuiProvider()

virtual QgsProjectStorageGuiProvider::~QgsProjectStorageGuiProvider ( )
virtualdefault

Member Function Documentation

◆ showLoadGui()

virtual QString QgsProjectStorageGuiProvider::showLoadGui ( )
inlinevirtual

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.

Definition at line 53 of file qgsprojectstorageguiprovider.h.

◆ showSaveGui()

virtual QString QgsProjectStorageGuiProvider::showSaveGui ( )
inlinevirtual

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.

Definition at line 59 of file qgsprojectstorageguiprovider.h.

◆ type()

virtual QString QgsProjectStorageGuiProvider::type ( )
pure virtual

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

virtual QString QgsProjectStorageGuiProvider::visibleName ( )
inlinevirtual

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.

Definition at line 47 of file qgsprojectstorageguiprovider.h.


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