QgsProviderMetadata Class Reference

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

#include <qgsprovidermetadata.h>

Public Member Functions
	QgsProviderMetadata (const QString &_key, const QString &_description, const QString &_library)
const QString &	description () const
	This returns descriptive text for the provider. More...
const QString &	key () const
	This returns the unique key associated with the provider. More...
const QString &	library () const
	This returns the library file name. More...

Detailed Description

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

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 37 of file qgsprovidermetadata.h.

Constructor & Destructor Documentation

QgsProviderMetadata::QgsProviderMetadata	(	const QString &	_key,
		const QString &	_description,
		const QString &	_library
	)

Definition at line 23 of file qgsprovidermetadata.cpp.

Member Function Documentation

QString const & 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 36 of file qgsprovidermetadata.cpp.

QString const & 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 31 of file qgsprovidermetadata.cpp.

QString const & QgsProviderMetadata::library

(

)

const

This returns the library file name.

This is used to QLibrary calls to load the data provider.

Definition at line 41 of file qgsprovidermetadata.cpp.

---

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

• /tmp/buildd/qgis-2.12.0+99unstable/src/core/qgsprovidermetadata.h
• /tmp/buildd/qgis-2.12.0+99unstable/src/core/qgsprovidermetadata.cpp