QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | Public Attributes | List of all members
QgsProviderRegistry::UnusableUriDetails Class Reference

Contains information about unusable URIs which aren't handled by any registered providers. More...

#include <qgsproviderregistry.h>

Public Member Functions

 UnusableUriDetails (const QString &uri=QString(), const QString &warning=QString(), const QList< QgsMapLayerType > &layerTypes=QList< QgsMapLayerType >())
 Constructor for UnusableUriDetails for the given uri, with the specified user-friendly, translated warning. More...
 

Public Attributes

QString detailedWarning
 Contains a longer, user-friendly, translated message advising why the URI is not usable. More...
 
QList< QgsMapLayerTypelayerTypes
 Contains a list of map layer types which are usually valid options for opening the target URI. More...
 
QString uri
 URI which could not be handled. More...
 
QString warning
 Contains a short, user-friendly, translated message advising why the URI is not usable. More...
 

Detailed Description

Contains information about unusable URIs which aren't handled by any registered providers.

For example, if a QGIS install is built without the PDAL library then las/laz files are unusable. This class can then be used to construct friendly warnings to users advising them why the las/laz files cannot be used on their QGIS build.

Since
QGIS 3.18.1

Definition at line 400 of file qgsproviderregistry.h.

Constructor & Destructor Documentation

◆ UnusableUriDetails()

QgsProviderRegistry::UnusableUriDetails::UnusableUriDetails ( const QString &  uri = QString(),
const QString &  warning = QString(),
const QList< QgsMapLayerType > &  layerTypes = QList< QgsMapLayerType >() 
)
inline

Constructor for UnusableUriDetails for the given uri, with the specified user-friendly, translated warning.

The optional layerTypes argument can be used to specify layer types which are usually valid options for opening the URI.

Definition at line 410 of file qgsproviderregistry.h.

Member Data Documentation

◆ detailedWarning

QString QgsProviderRegistry::UnusableUriDetails::detailedWarning

Contains a longer, user-friendly, translated message advising why the URI is not usable.

Definition at line 429 of file qgsproviderregistry.h.

◆ layerTypes

QList<QgsMapLayerType> QgsProviderRegistry::UnusableUriDetails::layerTypes

Contains a list of map layer types which are usually valid options for opening the target URI.

Definition at line 435 of file qgsproviderregistry.h.

◆ uri

QString QgsProviderRegistry::UnusableUriDetails::uri

URI which could not be handled.

Definition at line 419 of file qgsproviderregistry.h.

◆ warning

QString QgsProviderRegistry::UnusableUriDetails::warning

Contains a short, user-friendly, translated message advising why the URI is not usable.

Definition at line 424 of file qgsproviderregistry.h.


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