QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
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 & key () const
 this returns the unique key associated with the provider More...
 
const QString & description () const
 this returns descriptive text for 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.

Constructor & Destructor Documentation

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

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.

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

QString const & QgsProviderMetadata::library ( ) const

this returns the library file name

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


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