QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | List of all members
QgsAuthMethodMetadata Class Reference

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

#include <qgsauthmethodmetadata.h>

Public Member Functions

 QgsAuthMethodMetadata (const QString &_key, const QString &_description, const QString &_library)
 Construct an authentication method metadata container. More...
 
QString description () const
 This returns descriptive text for the method. More...
 
QString key () const
 This returns the unique key associated with the method. More...
 
QString library () const
 This returns the library file name. More...
 

Detailed Description

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

The metadata class is used in a lazy load implementation in QgsAuthMethodRegistry. To save memory, auth methods 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 QgsAuthMethodRegistry is created.) QgsProviderMetadata supplies enough information to be able to later load the associated shared library object.

Note
Culled from QgsProviderMetadata
not available in Python bindings

Definition at line 35 of file qgsauthmethodmetadata.h.

Constructor & Destructor Documentation

QgsAuthMethodMetadata::QgsAuthMethodMetadata ( const QString _key,
const QString _description,
const QString _library 
)

Construct an authentication method metadata container.

Parameters
_keyTextual key of the library plugin
_descriptionDescription of the library plugin
_libraryFile name of library plugin

Definition at line 21 of file qgsauthmethodmetadata.cpp.

Member Function Documentation

QString QgsAuthMethodMetadata::description ( ) const

This returns descriptive text for the method.

This is used to provide a descriptive list of available data methods.

Definition at line 34 of file qgsauthmethodmetadata.cpp.

QString QgsAuthMethodMetadata::key ( ) const

This returns the unique key associated with the method.

This key string is used for the associative container in QgsAtuhMethodRegistry

Definition at line 29 of file qgsauthmethodmetadata.cpp.

QString QgsAuthMethodMetadata::library ( ) const

This returns the library file name.

This is used to QLibrary calls to load the method.

Definition at line 39 of file qgsauthmethodmetadata.cpp.


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