QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Types | Signals | Public Member Functions | Static Public Member Functions | List of all members
QgsProviderMetadata Class Reference

Holds data provider key, description, and associated shared library file or function pointer information. More...

#include <qgsprovidermetadata.h>

Inheritance diagram for QgsProviderMetadata:
Inheritance graph
[legend]

Public Types

typedef std::function< QgsDataProvider *(const QString &, const QgsDataProvider::ProviderOptions &, QgsDataProvider::ReadFlags &) > CreateDataProviderFunction
 Typedef for data provider creation function. More...
 
enum class  FilterType {
  FilterVector = 1 , FilterRaster , FilterMesh , FilterMeshDataset ,
  FilterPointCloud
}
 Type of file filters. More...
 
enum  ProviderCapability { FileBasedUris = 1 << 0 , SaveLayerMetadata = 1 << 1 }
 Provider capabilities. More...
 
enum  ProviderMetadataCapability { PriorityForUri = 1 << 0 , LayerTypesForUri = 1 << 1 , QuerySublayers = 1 << 2 }
 Indicates capabilities of the provider metadata implementation. More...
 

Signals

void connectionChanged (const QString &name)
 Emitted when the connection with the specified name is changed, e.g. More...
 
void connectionCreated (const QString &name)
 Emitted when a connection with the specified name is created. More...
 
void connectionDeleted (const QString &name)
 Emitted when the connection with the specified name was deleted. More...
 

Public Member Functions

Q_DECL_DEPRECATED QgsProviderMetadata (const QString &key, const QString &description, const QgsProviderMetadata::CreateDataProviderFunction &createFunc)
 Metadata for provider with direct provider creation function pointer, where no library is involved. More...
 
 QgsProviderMetadata (const QString &key, const QString &description, const QString &library=QString())
 Constructor for provider metadata. More...
 
virtual ~QgsProviderMetadata ()
 dtor More...
 
virtual QgsProviderMetadata::ProviderMetadataCapabilities capabilities () const
 Returns the provider metadata capabilities. More...
 
virtual void cleanupProvider ()
 Cleanup the provider. More...
 
template<typename T >
QMap< QString, T * > connections (bool cached=true)
 Returns a dictionary of provider connections of the specified type T, the dictionary key is the connection identifier. More...
 
virtual QMap< QString, QgsAbstractProviderConnection * > connections (bool cached=true) SIP_THROW(QgsProviderConnectionException)
 Returns a dictionary of stored provider connections, the dictionary key is the connection identifier. More...
 
virtual QgsAbstractProviderConnectioncreateConnection (const QString &name) SIP_THROW(QgsProviderConnectionException)
 Creates a new connection by loading the connection with the given name from the settings. More...
 
virtual QgsAbstractProviderConnectioncreateConnection (const QString &uri, const QVariantMap &configuration) SIP_THROW(QgsProviderConnectionException)
 Creates a new connection from uri and configuration, the newly created connection is not automatically stored in the settings, call saveConnection() to save it. More...
 
virtual bool createDb (const QString &dbPath, QString &errCause)
 Creates database by the provider on the path. More...
 
virtual Qgis::VectorExportResult createEmptyLayer (const QString &uri, const QgsFields &fields, QgsWkbTypes::Type wkbType, const QgsCoordinateReferenceSystem &srs, bool overwrite, QMap< int, int > &oldToNewAttrIdxMap, QString &errorMessage, const QMap< QString, QVariant > *options)
 Creates new empty vector layer. More...
 
Q_DECL_DEPRECATED CreateDataProviderFunction createFunction () const
 Returns a pointer to the direct provider creation function, if supported by the provider. More...
 
virtual bool createMeshData (const QgsMesh &mesh, const QString &fileName, const QString &driverName, const QgsCoordinateReferenceSystem &crs) const
 Creates mesh data source from a file name fileName and a driver driverName, that is the mesh frame stored in file, memory or with other way (depending of the provider) More...
 
virtual bool createMeshData (const QgsMesh &mesh, const QString &uri, const QgsCoordinateReferenceSystem &crs) const
 Creates mesh data source from an uri, that is the mesh frame stored in file, memory or with other way (depending of the provider) More...
 
virtual QgsDataProvidercreateProvider (const QString &uri, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags=QgsDataProvider::ReadFlags())
 Class factory to return a pointer to a newly created QgsDataProvider object. More...
 
virtual QgsRasterDataProvidercreateRasterDataProvider (const QString &uri, const QString &format, int nBands, Qgis::DataType type, int width, int height, double *geoTransform, const QgsCoordinateReferenceSystem &crs, const QStringList &createOptions=QStringList())
 Creates a new instance of the raster data provider. More...
 
virtual QgsTransactioncreateTransaction (const QString &connString)
 Returns new instance of transaction. More...
 
virtual QList< QgsDataItemProvider * > dataItemProviders () const
 Returns data item providers. More...
 
QMap< QString, QgsAbstractDatabaseProviderConnection * > dbConnections (bool cached=true) SIP_THROW(QgsProviderConnectionException)
 Returns a dictionary of database provider connections, the dictionary key is the connection identifier. More...
 
virtual QVariantMap decodeUri (const QString &uri) const
 Breaks a provider data source URI into its component paths (e.g. More...
 
virtual void deleteConnection (const QString &name) SIP_THROW(QgsProviderConnectionException)
 Removes the connection with the given name from the settings. More...
 
virtual bool deleteStyleById (const QString &uri, QString styleId, QString &errCause)
 Deletes a layer style defined by styleId. More...
 
QString description () const
 This returns descriptive text for the provider. More...
 
virtual QString encodeUri (const QVariantMap &parts) const
 Reassembles a provider data source URI from its component paths (e.g. More...
 
virtual QString filters (FilterType type)
 Builds the list of file filter strings (supported formats) More...
 
QgsAbstractProviderConnectionfindConnection (const QString &name, bool cached=true) SIP_THROW(QgsProviderConnectionException)
 Searches and returns a (possibly NULL) connection from the stored provider connections. More...
 
virtual QString getStyleById (const QString &uri, QString styleId, QString &errCause)
 Gets a layer style defined by uri. More...
 
virtual void initProvider ()
 Initialize the provider. More...
 
QString key () const
 This returns the unique key associated with the provider. More...
 
Q_DECL_DEPRECATED QString library () const
 This returns the library file name. More...
 
virtual int listStyles (const QString &uri, QStringList &ids, QStringList &names, QStringList &descriptions, QString &errCause)
 Lists stored layer styles in the provider defined by uri. More...
 
virtual QString loadStyle (const QString &uri, QString &errCause)
 Loads a layer style defined by uri. More...
 
virtual QList< QgsMeshDriverMetadatameshDriversMetadata ()
 Builds the list of available mesh drivers metadata. More...
 
virtual int priorityForUri (const QString &uri) const
 Returns an integer representing the priority which this provider should have when opening a dataset with the specified uri. More...
 
virtual QgsProviderMetadata::ProviderCapabilities providerCapabilities () const
 Returns the provider's capabilities. More...
 
virtual QList< QPair< QString, QString > > pyramidResamplingMethods ()
 Returns pyramid resampling methods available for provider. More...
 
virtual QList< QgsProviderSublayerDetailsquerySublayers (const QString &uri, Qgis::SublayerQueryFlags flags=Qgis::SublayerQueryFlags(), QgsFeedback *feedback=nullptr) const
 Queries the specified uri and returns a list of any valid sublayers found in the dataset which can be handled by this provider. More...
 
virtual void saveConnection (const QgsAbstractProviderConnection *connection, const QString &name) SIP_THROW(QgsProviderConnectionException)
 Stores the connection in the settings. More...
 
virtual bool saveLayerMetadata (const QString &uri, const QgsLayerMetadata &metadata, QString &errorMessage) SIP_THROW(QgsNotSupportedException)
 Saves metadata to the layer corresponding to the specified uri. More...
 
virtual bool saveStyle (const QString &uri, const QString &qmlStyle, const QString &sldStyle, const QString &styleName, const QString &styleDescription, const QString &uiFileContent, bool useAsDefault, QString &errCause)
 Saves a layer style to provider. More...
 
virtual QStringList sidecarFilesForUri (const QString &uri) const
 Given a uri, returns any sidecar files which are associated with the URI and this provider. More...
 
virtual bool uriIsBlocklisted (const QString &uri) const
 Returns true if the specified uri is known by this provider to be something which should be blocklisted from the QGIS interface, e.g. More...
 
virtual QList< QgsMapLayerTypevalidLayerTypesForUri (const QString &uri) const
 Returns a list of valid layer types which the provider can be used with when opening the specified uri. More...
 

Static Public Member Functions

static bool boolParameter (const QVariantMap &uri, const QString &parameter, bool defaultValue=false)
 Returns the parameter value in the uri as a bool. More...
 
static void setBoolParameter (QVariantMap &uri, const QString &parameter, const QVariant &value)
 Sets the value into the uri parameter as a bool. More...
 

Detailed Description

Holds data provider key, description, and associated shared library file or function pointer information.

Provider metadata refers either to providers which are loaded via libraries or which are native providers that are included in the core QGIS installation and accessed through function pointers.

For library based providers, the metadata class is used in a lazy load implementation in QgsProviderRegistry. To save memory, data providers are only actually loaded via QLibrary calls if they're to be used. (Though they're all iteratively loaded once to get their metadata information, and then unloaded when the QgsProviderRegistry is created.) QgsProviderMetadata supplies enough information to be able to later load the associated shared library object.

Definition at line 177 of file qgsprovidermetadata.h.

Member Typedef Documentation

◆ CreateDataProviderFunction

typedef std::function< QgsDataProvider*( const QString &, const QgsDataProvider::ProviderOptions &, QgsDataProvider::ReadFlags & ) > QgsProviderMetadata::CreateDataProviderFunction

Typedef for data provider creation function.

Since
QGIS 3.0

Definition at line 212 of file qgsprovidermetadata.h.

Member Enumeration Documentation

◆ FilterType

Type of file filters.

Since
QGIS 3.10
Enumerator
FilterVector 

Vector layers.

FilterRaster 

Raster layers.

FilterMesh 

Mesh layers.

FilterMeshDataset 

Mesh datasets.

FilterPointCloud 

Point clouds (since QGIS 3.18)

Definition at line 295 of file qgsprovidermetadata.h.

◆ ProviderCapability

Provider capabilities.

Since
QGIS 3.18.1
Enumerator
FileBasedUris 

Indicates that the provider can utilize URIs which are based on paths to files (as opposed to database or internet paths)

SaveLayerMetadata 

Indicates that the provider supports saving native layer metadata (since QGIS 3.20)

Definition at line 201 of file qgsprovidermetadata.h.

◆ ProviderMetadataCapability

Indicates capabilities of the provider metadata implementation.

Since
QGIS 3.18
Enumerator
PriorityForUri 

Indicates that the metadata can calculate a priority for a URI.

LayerTypesForUri 

Indicates that the metadata can determine valid layer types for a URI.

QuerySublayers 

Indicates that the metadata can query sublayers for a URI (since QGIS 3.22)

Definition at line 188 of file qgsprovidermetadata.h.

Constructor & Destructor Documentation

◆ QgsProviderMetadata() [1/2]

QgsProviderMetadata::QgsProviderMetadata ( const QString &  key,
const QString &  description,
const QString &  library = QString() 
)

Constructor for provider metadata.

Parameters
keyprovider key
descriptionprovider description
libraryplugin library file name (empty if the provider is not loaded from a library)

Definition at line 26 of file qgsprovidermetadata.cpp.

◆ QgsProviderMetadata() [2/2]

QgsProviderMetadata::QgsProviderMetadata ( const QString &  key,
const QString &  description,
const QgsProviderMetadata::CreateDataProviderFunction createFunc 
)

Metadata for provider with direct provider creation function pointer, where no library is involved.

Since
QGIS 3.0
Deprecated:
QGIS 3.10

Definition at line 34 of file qgsprovidermetadata.cpp.

◆ ~QgsProviderMetadata()

QgsProviderMetadata::~QgsProviderMetadata ( )
virtual

dtor

Definition at line 40 of file qgsprovidermetadata.cpp.

Member Function Documentation

◆ boolParameter()

bool QgsProviderMetadata::boolParameter ( const QVariantMap &  uri,
const QString &  parameter,
bool  defaultValue = false 
)
static

Returns the parameter value in the uri as a bool.

eg. "yes" value will be returned as true, 0 will be returned as false

Since
QGIS 3.14

Definition at line 147 of file qgsprovidermetadata.cpp.

◆ capabilities()

QgsProviderMetadata::ProviderMetadataCapabilities QgsProviderMetadata::capabilities ( ) const
virtual

Returns the provider metadata capabilities.

Since
QGIS 3.18

Definition at line 55 of file qgsprovidermetadata.cpp.

◆ cleanupProvider()

void QgsProviderMetadata::cleanupProvider ( )
virtual

Cleanup the provider.

Since
QGIS 3.10

Definition at line 80 of file qgsprovidermetadata.cpp.

◆ connectionChanged

void QgsProviderMetadata::connectionChanged ( const QString &  name)
signal

Emitted when the connection with the specified name is changed, e.g.

the settings relating to the connection have been updated.

Note
Only providers which implement the connection handling API will emit this signal.
Since
QGIS 3.14

◆ connectionCreated

void QgsProviderMetadata::connectionCreated ( const QString &  name)
signal

Emitted when a connection with the specified name is created.

Note
Only providers which implement the connection handling API will emit this signal.
Since
QGIS 3.14

◆ connectionDeleted

void QgsProviderMetadata::connectionDeleted ( const QString &  name)
signal

Emitted when the connection with the specified name was deleted.

Note
Only providers which implement the connection handling API will emit this signal.
Since
QGIS 3.14

◆ connections() [1/2]

template<typename T >
QMap< QString, T * > QgsProviderMetadata::connections ( bool  cached = true)

Returns a dictionary of provider connections of the specified type T, the dictionary key is the connection identifier.

Parameters
cachedif false connections will be re-read from the settings
Note
not available in Python bindings
Since
QGIS 3.10

Definition at line 335 of file qgsprovidermetadata.cpp.

◆ connections() [2/2]

QMap< QString, QgsAbstractProviderConnection * > QgsProviderMetadata::connections ( bool  cached = true)
virtual

Returns a dictionary of stored provider connections, the dictionary key is the connection identifier.

Ownership is not transferred. Raises a QgsProviderConnectionException if any errors are encountered.

Parameters
cachedif false connections will be re-read from the settings
Exceptions
QgsProviderConnectionException
Since
QGIS 3.10

Definition at line 268 of file qgsprovidermetadata.cpp.

◆ createConnection() [1/2]

QgsAbstractProviderConnection * QgsProviderMetadata::createConnection ( const QString &  name)
virtual

Creates a new connection by loading the connection with the given name from the settings.

Ownership is transferred to the caller.

Exceptions
QgsProviderConnectionException
See also
findConnection()

Definition at line 293 of file qgsprovidermetadata.cpp.

◆ createConnection() [2/2]

QgsAbstractProviderConnection * QgsProviderMetadata::createConnection ( const QString &  uri,
const QVariantMap &  configuration 
)
virtual

Creates a new connection from uri and configuration, the newly created connection is not automatically stored in the settings, call saveConnection() to save it.

Ownership is transferred to the caller.

Exceptions
QgsProviderConnectionException
See also
saveConnection()
Since
QGIS 3.10

Definition at line 300 of file qgsprovidermetadata.cpp.

◆ createDb()

bool QgsProviderMetadata::createDb ( const QString &  dbPath,
QString &  errCause 
)
virtual

Creates database by the provider on the path.

Since
QGIS 3.10

Definition at line 257 of file qgsprovidermetadata.cpp.

◆ createEmptyLayer()

Qgis::VectorExportResult QgsProviderMetadata::createEmptyLayer ( const QString &  uri,
const QgsFields fields,
QgsWkbTypes::Type  wkbType,
const QgsCoordinateReferenceSystem srs,
bool  overwrite,
QMap< int, int > &  oldToNewAttrIdxMap,
QString &  errorMessage,
const QMap< QString, QVariant > *  options 
)
virtual

Creates new empty vector layer.

Note
not available in Python bindings
Since
QGIS 3.10

Definition at line 175 of file qgsprovidermetadata.cpp.

◆ createFunction()

QgsProviderMetadata::CreateDataProviderFunction QgsProviderMetadata::createFunction ( ) const

Returns a pointer to the direct provider creation function, if supported by the provider.

Note
not available in Python bindings
Since
QGIS 3.0
Deprecated:
QGIS 3.10

Definition at line 70 of file qgsprovidermetadata.cpp.

◆ createMeshData() [1/2]

bool QgsProviderMetadata::createMeshData ( const QgsMesh mesh,
const QString &  fileName,
const QString &  driverName,
const QgsCoordinateReferenceSystem crs 
) const
virtual

Creates mesh data source from a file name fileName and a driver driverName, that is the mesh frame stored in file, memory or with other way (depending of the provider)

Since
QGIS 3.16

Definition at line 195 of file qgsprovidermetadata.cpp.

◆ createMeshData() [2/2]

bool QgsProviderMetadata::createMeshData ( const QgsMesh mesh,
const QString &  uri,
const QgsCoordinateReferenceSystem crs 
) const
virtual

Creates mesh data source from an uri, that is the mesh frame stored in file, memory or with other way (depending of the provider)

Since
QGIS 3.22

Definition at line 203 of file qgsprovidermetadata.cpp.

◆ createProvider()

QgsDataProvider * QgsProviderMetadata::createProvider ( const QString &  uri,
const QgsDataProvider::ProviderOptions options,
QgsDataProvider::ReadFlags  flags = QgsDataProvider::ReadFlags() 
)
virtual

Class factory to return a pointer to a newly created QgsDataProvider object.

Parameters
urithe datasource uri
optionscreation options
flagscreation flags, sing QGIS 3.16
Since
QGIS 3.10

Definition at line 120 of file qgsprovidermetadata.cpp.

◆ createRasterDataProvider()

QgsRasterDataProvider * QgsProviderMetadata::createRasterDataProvider ( const QString &  uri,
const QString &  format,
int  nBands,
Qgis::DataType  type,
int  width,
int  height,
double *  geoTransform,
const QgsCoordinateReferenceSystem crs,
const QStringList &  createOptions = QStringList() 
)
virtual

Creates a new instance of the raster data provider.

Since
QGIS 3.10

Definition at line 185 of file qgsprovidermetadata.cpp.

◆ createTransaction()

QgsTransaction * QgsProviderMetadata::createTransaction ( const QString &  connString)
virtual

Returns new instance of transaction.

Ownership is transferred to the caller

Since
QGIS 3.10

Definition at line 263 of file qgsprovidermetadata.cpp.

◆ dataItemProviders()

QList< QgsDataItemProvider * > QgsProviderMetadata::dataItemProviders ( ) const
virtual

Returns data item providers.

Caller is responsible for ownership of the item providers

See also
QgsProviderGuiMetadata::dataItemGuiProviders()
Note
Ownership of created data item providers is passed to the caller.
Since
QGIS 3.10

Definition at line 215 of file qgsprovidermetadata.cpp.

◆ dbConnections()

QMap< QString, QgsAbstractDatabaseProviderConnection * > QgsProviderMetadata::dbConnections ( bool  cached = true)

Returns a dictionary of database provider connections, the dictionary key is the connection identifier.

Ownership is not transferred. Raises a QgsProviderConnectionException if any errors are encountered.

Parameters
cachedif false connections will be re-read from the settings
Exceptions
QgsProviderConnectionException
Since
QGIS 3.10

Definition at line 274 of file qgsprovidermetadata.cpp.

◆ decodeUri()

QVariantMap QgsProviderMetadata::decodeUri ( const QString &  uri) const
virtual

Breaks a provider data source URI into its component paths (e.g.

file path, layer name).

Parameters
uriuri string
Returns
map containing components. Standard components may include:
  • "path": file path
  • "layerName"
  • "url": base URL, for online services
  • "referer": referrer string, for HTTP requests
  • "host": hostname, for database services
  • "bounds": hardcoded layer bounds (as a QgsRectangle)
  • "crs": CRS definition
  • "authcfg": authentication configuration ID
Note
this function may not be supported by all providers, an empty map will be returned in such case
Since
QGIS 3.10

Definition at line 165 of file qgsprovidermetadata.cpp.

◆ deleteConnection()

void QgsProviderMetadata::deleteConnection ( const QString &  name)
virtual

Removes the connection with the given name from the settings.

Raises a QgsProviderConnectionException if any errors are encountered.

Exceptions
QgsProviderConnectionException
Since
QGIS 3.10

Definition at line 307 of file qgsprovidermetadata.cpp.

◆ deleteStyleById()

bool QgsProviderMetadata::deleteStyleById ( const QString &  uri,
QString  styleId,
QString &  errCause 
)
virtual

Deletes a layer style defined by styleId.

Since
QGIS 3.10

Definition at line 233 of file qgsprovidermetadata.cpp.

◆ description()

QString QgsProviderMetadata::description ( ) const

This returns descriptive text for the provider.

This is used to provide a descriptive list of available data providers.

Definition at line 50 of file qgsprovidermetadata.cpp.

◆ encodeUri()

QString QgsProviderMetadata::encodeUri ( const QVariantMap &  parts) const
virtual

Reassembles a provider data source URI from its component paths (e.g.

file path, layer name).

Parameters
partsparts as returned by decodeUri
Returns
datasource uri string
Note
this function may not be supported by all providers, an empty string will be returned in such case
See also
decodeUri()
Since
QGIS 3.12

Definition at line 170 of file qgsprovidermetadata.cpp.

◆ filters()

QString QgsProviderMetadata::filters ( FilterType  type)
virtual

Builds the list of file filter strings (supported formats)

Suitable for use in a QFileDialog::getOpenFileNames() call.

Since
QGIS 3.10

Definition at line 85 of file qgsprovidermetadata.cpp.

◆ findConnection()

QgsAbstractProviderConnection * QgsProviderMetadata::findConnection ( const QString &  name,
bool  cached = true 
)

Searches and returns a (possibly NULL) connection from the stored provider connections.

Ownership is not transferred. Raises a QgsProviderConnectionException if any errors are encountered.

Parameters
namethe connection name
cachedif false connections will be re-read from the settings
Exceptions
QgsProviderConnectionException
Since
QGIS 3.10

Definition at line 279 of file qgsprovidermetadata.cpp.

◆ getStyleById()

QString QgsProviderMetadata::getStyleById ( const QString &  uri,
QString  styleId,
QString &  errCause 
)
virtual

Gets a layer style defined by uri.

Since
QGIS 3.10

Definition at line 227 of file qgsprovidermetadata.cpp.

◆ initProvider()

void QgsProviderMetadata::initProvider ( )
virtual

Initialize the provider.

Since
QGIS 3.10

Definition at line 75 of file qgsprovidermetadata.cpp.

◆ key()

QString QgsProviderMetadata::key ( ) const

This returns the unique key associated with the provider.

This key string is used for the associative container in QgsProviderRegistry

Definition at line 45 of file qgsprovidermetadata.cpp.

◆ library()

QString QgsProviderMetadata::library ( ) const

This returns the library file name.

This is used to QLibrary calls to load the data provider (only for dynamically loaded libraries)

Deprecated:
QGIS 3.10 - providers may not need to be loaded from a library (empty string returned)

Definition at line 65 of file qgsprovidermetadata.cpp.

◆ listStyles()

int QgsProviderMetadata::listStyles ( const QString &  uri,
QStringList &  ids,
QStringList &  names,
QStringList &  descriptions,
QString &  errCause 
)
virtual

Lists stored layer styles in the provider defined by uri.

Returns
-1 if not implemented by provider, otherwise number of styles stored
Since
QGIS 3.10

Definition at line 220 of file qgsprovidermetadata.cpp.

◆ loadStyle()

QString QgsProviderMetadata::loadStyle ( const QString &  uri,
QString &  errCause 
)
virtual

Loads a layer style defined by uri.

Since
QGIS 3.10

Definition at line 246 of file qgsprovidermetadata.cpp.

◆ meshDriversMetadata()

QList< QgsMeshDriverMetadata > QgsProviderMetadata::meshDriversMetadata ( )
virtual

Builds the list of available mesh drivers metadata.

Since
QGIS 3.12

Definition at line 90 of file qgsprovidermetadata.cpp.

◆ priorityForUri()

int QgsProviderMetadata::priorityForUri ( const QString &  uri) const
virtual

Returns an integer representing the priority which this provider should have when opening a dataset with the specified uri.

A larger priority means that the provider should be selected over others with a lower priority for the same URI.

The default implementation returns 0 for all URIs.

Warning
Not all providers implement this functionality. Check whether capabilities() returns the ProviderMetadataCapability::PriorityForUri to determine whether a specific provider metadata object supports this method.
Since
QGIS 3.18

Definition at line 95 of file qgsprovidermetadata.cpp.

◆ providerCapabilities()

QgsProviderMetadata::ProviderCapabilities QgsProviderMetadata::providerCapabilities ( ) const
virtual

Returns the provider's capabilities.

Since
QGIS 3.18.1

Definition at line 60 of file qgsprovidermetadata.cpp.

◆ pyramidResamplingMethods()

QList< QPair< QString, QString > > QgsProviderMetadata::pyramidResamplingMethods ( )
virtual

Returns pyramid resampling methods available for provider.

Since
QGIS 3.10

Definition at line 210 of file qgsprovidermetadata.cpp.

◆ querySublayers()

QList< QgsProviderSublayerDetails > QgsProviderMetadata::querySublayers ( const QString &  uri,
Qgis::SublayerQueryFlags  flags = Qgis::SublayerQueryFlags(),
QgsFeedback feedback = nullptr 
) const
virtual

Queries the specified uri and returns a list of any valid sublayers found in the dataset which can be handled by this provider.

The optional flags argument can be used to control the behavior of the query.

The optional feedback argument can be used to provide cancellation support for long-running queries.

Note
Providers which implement this method should always return a list of sublayer details for any valid, even if the uri only relates to a single layer. Returning a non-empty list indicates that the provider is able to load at least one layer using the uri, and is used to collate a combined layer of all providers which support the URI (e.g. in the case that a URI may be readable by multiple different providers).
Since
QGIS 3.22

Definition at line 115 of file qgsprovidermetadata.cpp.

◆ saveConnection()

void QgsProviderMetadata::saveConnection ( const QgsAbstractProviderConnection connection,
const QString &  name 
)
virtual

Stores the connection in the settings.

Parameters
connectionthe connection to be stored in the settings
namethe name under which the connection will be stored
Exceptions
QgsProviderConnectionException
Since
QGIS 3.10

Definition at line 313 of file qgsprovidermetadata.cpp.

◆ saveLayerMetadata()

bool QgsProviderMetadata::saveLayerMetadata ( const QString &  uri,
const QgsLayerMetadata metadata,
QString &  errorMessage 
)
virtual

Saves metadata to the layer corresponding to the specified uri.

Parameters
uriuri of layer to store metadata for
metadatalayer metadata
errorMessagedescriptive string of error if encountered
Returns
true if the metadata was successfully saved.
Exceptions
QgsNotSupportedExceptionif the provider does not support saving layer metadata for the specified uri.
Since
QGIS 3.20

Definition at line 252 of file qgsprovidermetadata.cpp.

◆ saveStyle()

bool QgsProviderMetadata::saveStyle ( const QString &  uri,
const QString &  qmlStyle,
const QString &  sldStyle,
const QString &  styleName,
const QString &  styleDescription,
const QString &  uiFileContent,
bool  useAsDefault,
QString &  errCause 
)
virtual

Saves a layer style to provider.

Since
QGIS 3.10

Definition at line 239 of file qgsprovidermetadata.cpp.

◆ setBoolParameter()

void QgsProviderMetadata::setBoolParameter ( QVariantMap &  uri,
const QString &  parameter,
const QVariant &  value 
)
static

Sets the value into the uri parameter as a bool.

eg. "yes" value will be saved as true, 0 will be saved as false

Since
QGIS 3.14

Definition at line 131 of file qgsprovidermetadata.cpp.

◆ sidecarFilesForUri()

QStringList QgsProviderMetadata::sidecarFilesForUri ( const QString &  uri) const
virtual

Given a uri, returns any sidecar files which are associated with the URI and this provider.

In this context a sidecar file is defined as a file which shares the same base filename as a dataset, but which differs in file extension. It defines the list of additional files which must be renamed or deleted alongside the main file associated with the dataset in order to completely rename/delete the dataset.

For instance, the OGR provider would return the corresponding .dbf, .idx, etc files for a uri pointing at a .shp file.

Implementations should files any files which MAY exist for the URI, and it is up to the caller to filter these to only existing files if required.

Note
Some file formats consist of a set of static file names, such as ESRI aigrid datasets which consist of a folder with files with the names "hdr.adf", "prj.adf", etc. These statically named files are NOT considered as sidecar files.
Since
QGIS 3.22

Definition at line 110 of file qgsprovidermetadata.cpp.

◆ uriIsBlocklisted()

bool QgsProviderMetadata::uriIsBlocklisted ( const QString &  uri) const
virtual

Returns true if the specified uri is known by this provider to be something which should be blocklisted from the QGIS interface, e.g.

an internal detail only.

Specifically, this method can be utilized by the browser panel to hide noisy internal details by returning true for URIs which are known to be sidecar files only, such as ".aux.xml" files or ".shp.xml" files, or the "ept-build.json" files which sit alongside Entwine "ept.json" point cloud sources.

The default method returns false for all URIs.

Warning
Returning true from an implementation of this method indicates that ALL providers should ignore the specified uri, not just the provider associated with this metadata!
Since
QGIS 3.18

Definition at line 105 of file qgsprovidermetadata.cpp.

◆ validLayerTypesForUri()

QList< QgsMapLayerType > QgsProviderMetadata::validLayerTypesForUri ( const QString &  uri) const
virtual

Returns a list of valid layer types which the provider can be used with when opening the specified uri.

Warning
Not all providers implement this functionality. Check whether capabilities() returns the ProviderMetadataCapability::LayerTypesForUri to determine whether a specific provider metadata object supports this method.
Since
QGIS 3.18

Definition at line 100 of file qgsprovidermetadata.cpp.


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