19 #ifndef QGSPROVIDERREGISTRY_H
20 #define QGSPROVIDERREGISTRY_H
29 #include "qgis_core.h"
107 Q_DECL_DEPRECATED QString library(
const QString &providerKey )
const SIP_DEPRECATED;
110 QString pluginList(
bool asHtml =
false )
const;
115 QDir libraryDirectory()
const;
118 void setLibraryDirectory(
const QDir &path );
148 const QString &dataSource,
150 QgsDataProvider::ReadFlags flags = QgsDataProvider::ReadFlags() )
SIP_TRANSFERBACK;
158 Q_DECL_DEPRECATED
int providerCapabilities( const QString &providerKey ) const
SIP_DEPRECATED;
165 SIP_SKIP Qgis::VectorExportResult createEmptyLayer( const QString &providerKey, 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 );
174 const QString &providerKey,
176 const QString &format,
179 int width,
int height,
180 double *geoTransform,
182 const QStringList &createOptions = QStringList() )
SIP_FACTORY;
189 QList<QPair<QString, QString> > pyramidResamplingMethods( const QString &providerKey );
199 QVariantMap decodeUri( const QString &providerKey, const QString &uri );
210 QString encodeUri( const QString &providerKey, const QVariantMap &parts );
232 int listStyles( const QString &providerKey,
236 QStringList &descriptions,
244 QString getStyleById( const QString &providerKey, const QString &uri, QString styleId, QString &errCause );
250 bool deleteStyleById( const QString &providerKey, const QString &uri, QString styleId, QString &errCause );
257 bool saveStyle( const QString &providerKey, const QString &uri, const QString &qmlStyle, const QString &sldStyle,
258 const QString &styleName, const QString &styleDescription,
259 const QString &uiFileContent,
bool useAsDefault, QString &errCause );
265 QString loadStyle( const QString &providerKey, const QString &uri, QString &errCause );
288 bool createDb( const QString &providerKey, const QString &dbPath, QString &errCause );
306 Q_DECL_DEPRECATED QFunctionPointer function( const QString &providerKey, const QString &functionName )
SIP_DEPRECATED;
320 QStringList providerList() const;
341 : mMetadata( metadata )
342 , mLayerTypes( layerTypes )
354 QList<QgsMapLayerType>
layerTypes()
const {
return mLayerTypes; }
357 SIP_PYOBJECT __repr__();
359 QString
str = QStringLiteral(
"<QgsProviderRegistry.ProviderCandidateDetails: %1>" ).arg( sipCpp->metadata()->key() );
360 sipRes = PyUnicode_FromString(
str.toUtf8().constData() );
367 QList< QgsMapLayerType > mLayerTypes;
387 QList< QgsProviderRegistry::ProviderCandidateDetails > preferredProvidersForUri(
const QString &uri )
const;
410 UnusableUriDetails(
const QString &uri = QString(),
const QString &warning = QString(),
const QList< QgsMapLayerType > &layerTypes = QList< QgsMapLayerType >() )
413 , layerTypes( layerTypes )
438 SIP_PYOBJECT __repr__();
440 QString
str = QStringLiteral(
"<QgsProviderRegistry.UnusableUriDetails: %1>" ).arg( sipCpp->warning );
441 sipRes = PyUnicode_FromString(
str.toUtf8().constData() );
531 bool shouldDeferUriForOtherProviders(
const QString &uri,
const QString &providerKey )
const;
546 bool uriIsBlocklisted(
const QString &uri )
const;
559 QList< QgsProviderSublayerDetails > querySublayers(
const QString &uri, Qgis::SublayerQueryFlags flags = Qgis::SublayerQueryFlags(),
QgsFeedback *feedback =
nullptr )
const;
571 QString fileVectorFilters()
const;
585 QString fileRasterFilters()
const;
600 QString fileMeshFilters()
const;
612 QString fileMeshDatasetFilters()
const;
626 QString filePointCloudFilters()
const;
629 QString databaseDrivers()
const;
631 QString directoryDrivers()
const;
633 QString protocolDrivers()
const;
638 Q_DECL_DEPRECATED
void registerGuis( QWidget *widget )
SIP_DEPRECATED;
666 QDir mLibraryDirectory;
677 QString mVectorFileFilters;
682 QString mRasterFileFilters;
687 QString mMeshFileFilters;
692 QString mMeshDatasetFileFilters;
697 QString mPointCloudFileFilters;
705 QString mDatabaseDrivers;
712 QString mDirectoryDrivers;
720 QString mProtocolDrivers;
722 QList< UnusableUriHandlerInterface * > mUnusableUriHandlers;
727 static bool exists();
The Qgis class provides global constants for use throughout the application.
Extends QApplication to provide access to QGIS specific resources such as theme paths,...
This class represents a coordinate reference system (CRS).
This is the interface for those who want to add custom data items to the browser tree.
Base class for all items in the model.
Abstract base class for spatial data provider implementations.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Container of fields for a vector layer.
Custom exception class which is raised when an operation is not supported.
Contains information pertaining to a candidate provider.
QList< QgsMapLayerType > layerTypes() const
Returns a list of map layer types which are valid options for opening the target using this candidate...
ProviderCandidateDetails(QgsProviderMetadata *metadata, const QList< QgsMapLayerType > &layerTypes)
Constructor for ProviderCandidateDetails, with the specified provider metadata and valid candidate la...
QgsProviderMetadata * metadata() const
Returns the candidate provider metadata.
Contains information about unusable URIs which aren't handled by any registered providers.
QString warning
Contains a short, user-friendly, translated message advising why the URI is not usable.
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,...
QString uri
URI which could not be handled.
QString detailedWarning
Contains a longer, user-friendly, translated message advising why the URI is not usable.
QList< QgsMapLayerType > layerTypes
Contains a list of map layer types which are usually valid options for opening the target URI.
An interface used to handle unusable URIs which aren't handled by any registered providers,...
virtual ~UnusableUriHandlerInterface()=default
virtual UnusableUriDetails details(const QString &uri) const =0
Returns the details for advising the user why the uri is not usable.
virtual bool matchesUri(const QString &uri) const =0
Returns true if the handle is an unusable URI handler for the specified uri.
A registry / canonical manager of data providers.
std::map< QString, QgsProviderMetadata * > Providers
Type for data provider metadata associative container.
WidgetMode
Different ways a source select dialog can be used.
@ Embedded
Used for the data source manager dialog where the widget is embedded as the main content for a partic...
@ None
Basic mode when the widget is used as a standalone dialog.
@ Manager
Used by data items for QgsDataItem::paramWidget().
Contains details about a sub layer available from a dataset.
Base class for raster data providers.
This class allows including a set of layers in a database-side transaction, provided the layer data p...
Represents a vector layer which manages a vector based data sets.
Handles storage of information regarding WKB types and their properties.
const QgsCoordinateReferenceSystem & crs
Setting options for creating vector data providers.