A registry / canonical manager of data providers. More...

#include <qgsproviderregistry.h>

Public Types
typedef std::map< QString, QgsProviderMetadata * >	Providers
	Open the given vector data source. More...

Public Member Functions
virtual	~QgsProviderRegistry ()
	Virtual dectructor. More...

virtual QString	databaseDrivers () const
	Return a string containing the available database drivers. More...

virtual QString	directoryDrivers () const
	Return a string containing the available directory drivers. More...

virtual QString	fileRasterFilters () const
	Return raster file filter string. More...

virtual QString	fileVectorFilters () const
	Return vector file filter string. More...

void *	function (const QString &providerKey, const QString &functionName)
	Get pointer to provider function. More...

QString	library (const QString &providerKey) const
	Return path for the library of the provider. More...

const QDir &	libraryDirectory () const
	Return library directory where plugins are found. More...

QString	pluginList (bool asHtml=false) const
	Return list of provider plugins found. More...

virtual QString	protocolDrivers () const
	Return a string containing the available protocol drivers. More...

QgsDataProvider *	provider (const QString &providerKey, const QString &dataSource)
	Create an instance of the provider. More...

int	providerCapabilities (const QString &providerKey) const
	Return the provider capabilities. More...

QLibrary *	providerLibrary (const QString &providerKey) const

QStringList	providerList () const
	Return list of available providers by their keys. More...

const QgsProviderMetadata *	providerMetadata (const QString &providerKey) const
	Return metadata of the provider or NULL if not found. More...

void	registerGuis (QWidget *widget)

QWidget *	selectWidget (const QString &providerKey, QWidget *parent=nullptr, const Qt::WindowFlags &fl=Qt::WindowFlags())
	Returns a widget for selecting layers from a provider. More...

void	setLibraryDirectory (const QDir &path)
	Set library directory where to search for plugins. More...

Static Public Member Functions
static QgsProviderRegistry *	instance (const QString &pluginPath=QString::null)
	Means of accessing canonical single instance. More...

Detailed Description

A registry / canonical manager of data providers.

This is a Singleton class that manages data provider access.

Loaded providers may be restricted using QGIS_PROVIDER_FILE environment variable. QGIS_PROVIDER_FILE is regexp pattern applied to provider file name (not provider key). For example, if the variable is set to gdal|ogr|postgres it will load only providers gdal, ogr and postgres.

Definition at line 45 of file qgsproviderregistry.h.

Member Typedef Documentation

◆ Providers

typedef std::map<QString, QgsProviderMetadata*> QgsProviderRegistry::Providers

Open the given vector data source.

Similar to open(QString const &), except that the user specifies a data provider with which to open the data source instead of using the default data provider that QgsDataManager would figure out to use. This should be useful when (and if) there will exist more than one data provider that can handle a given data source. (E.g., use GDAL to open an SDTS file, or a different data provider that uses sdts++.)

Called by QgsDataManager::open().

Parameters

name	could be a file, URI
provider	is the key for the dataprovider used to open name

Returns: NULL if unable to open vector data source

Temporarily always returns false until finished implementing.

Eventually would be nice if could make QgsDataManager smart enough to figure out whether the given name mapped to a vector, raster, or database source.Type for data provider metadata associative container

Definition at line 171 of file qgsproviderregistry.h.

Constructor & Destructor Documentation

◆ ~QgsProviderRegistry()

QgsProviderRegistry::~QgsProviderRegistry ( )

virtual

Virtual dectructor.

Definition at line 248 of file qgsproviderregistry.cpp.

Member Function Documentation

◆ databaseDrivers()

QString QgsProviderRegistry::databaseDrivers ( ) const

virtual

Return a string containing the available database drivers.

Definition at line 514 of file qgsproviderregistry.cpp.

◆ directoryDrivers()

QString QgsProviderRegistry::directoryDrivers ( ) const

virtual

Return a string containing the available directory drivers.

Definition at line 519 of file qgsproviderregistry.cpp.

◆ fileRasterFilters()

QString QgsProviderRegistry::fileRasterFilters ( ) const

virtual

Return raster file filter string.

Returns a string suitable for a QFileDialog of raster file formats supported by all data providers.

This walks through all data providers appending calls to their buildSupportedRasterFileFilter to a string, which is then returned.

Note: This replaces QgsRasterLayer::buildSupportedRasterFileFilter()

Definition at line 509 of file qgsproviderregistry.cpp.

◆ fileVectorFilters()

QString QgsProviderRegistry::fileVectorFilters ( ) const

virtual

Return vector file filter string.

Returns a string suitable for a QFileDialog of vector file formats supported by all data providers.

This walks through all data providers appending calls to their fileVectorFilters to a string, which is then returned.

Note

It'd be nice to eventually be raster/vector neutral.

Definition at line 504 of file qgsproviderregistry.cpp.

◆ function()

void * QgsProviderRegistry::function	(	const QString &	providerKey,
		const QString &	functionName
	)

Get pointer to provider function.

Parameters

providerKey	identificator of the provider
functionName	name of function

Returns: pointer to function or NULL on error

Definition at line 454 of file qgsproviderregistry.cpp.

◆ instance()

QgsProviderRegistry * QgsProviderRegistry::instance ( const QString & pluginPath = QString::null )

static

Means of accessing canonical single instance.

Definition at line 49 of file qgsproviderregistry.cpp.

◆ library()

QString QgsProviderRegistry::library ( const QString & providerKey ) const

Return path for the library of the provider.

Definition at line 278 of file qgsproviderregistry.cpp.

◆ libraryDirectory()

QDir const & QgsProviderRegistry::libraryDirectory ( ) const

Return library directory where plugins are found.

Definition at line 331 of file qgsproviderregistry.cpp.

◆ pluginList()

QString QgsProviderRegistry::pluginList ( bool asHtml = false ) const

Return list of provider plugins found.

Definition at line 291 of file qgsproviderregistry.cpp.

◆ protocolDrivers()

QString QgsProviderRegistry::protocolDrivers ( ) const

virtual

Return a string containing the available protocol drivers.

Definition at line 524 of file qgsproviderregistry.cpp.

◆ provider()

QgsDataProvider * QgsProviderRegistry::provider	(	const QString &	providerKey,
		const QString &	dataSource
	)

Create an instance of the provider.

Copied from QgsVectorLayer::setDataProvider TODO: Make it work in the generic environment.

Parameters

providerKey	identificator of the provider
dataSource	string containing data source for the provider

Returns: instance of provider or NULL on error

TODO: Is this class really the best place to put a data provider loader? It seems more sensible to provide the code in one place rather than in qgsrasterlayer, qgsvectorlayer, serversourceselect, etc.

Definition at line 349 of file qgsproviderregistry.cpp.

◆ providerCapabilities()

int QgsProviderRegistry::providerCapabilities ( const QString & providerKey ) const

Return the provider capabilities.

Parameters

providerKey identificator of the provider

Note: Added in 2.6

Definition at line 403 of file qgsproviderregistry.cpp.

◆ providerLibrary()

QLibrary * QgsProviderRegistry::providerLibrary ( const QString & providerKey ) const

Definition at line 473 of file qgsproviderregistry.cpp.

◆ providerList()

QStringList QgsProviderRegistry::providerList ( ) const

Return list of available providers by their keys.

Definition at line 529 of file qgsproviderregistry.cpp.

◆ providerMetadata()

const QgsProviderMetadata * QgsProviderRegistry::providerMetadata ( const QString & providerKey ) const

Return metadata of the provider or NULL if not found.

Definition at line 539 of file qgsproviderregistry.cpp.

◆ registerGuis()

void QgsProviderRegistry::registerGuis ( QWidget * widget )

Definition at line 489 of file qgsproviderregistry.cpp.

◆ selectWidget()

QWidget * QgsProviderRegistry::selectWidget	(	const QString &	providerKey,
		QWidget *	parent = `nullptr`,
		const Qt::WindowFlags &	fl = `Qt::WindowFlags()`
	)

Returns a widget for selecting layers from a provider.

Definition at line 423 of file qgsproviderregistry.cpp.

◆ setLibraryDirectory()

void QgsProviderRegistry::setLibraryDirectory ( const QDir & path )

Set library directory where to search for plugins.

Definition at line 324 of file qgsproviderregistry.cpp.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsproviderregistry.h
/tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsproviderregistry.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Providers

Constructor & Destructor Documentation

◆ ~QgsProviderRegistry()

Member Function Documentation

◆ databaseDrivers()

◆ directoryDrivers()

◆ fileRasterFilters()

◆ fileVectorFilters()

◆ function()

◆ instance()

◆ library()

◆ libraryDirectory()

◆ pluginList()

◆ protocolDrivers()

◆ provider()

◆ providerCapabilities()

◆ providerLibrary()

◆ providerList()

◆ providerMetadata()

◆ registerGuis()

◆ selectWidget()

◆ setLibraryDirectory()