QGIS API Documentation
3.99.0-Master (a8f284845db)
Loading...
Searching...
No Matches
src
core
auth
qgsauthmethodmetadata.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsauthmethodmetadata.h
3
---------------------
4
begin : September 1, 2015
5
copyright : (C) 2015 by Boundless Spatial, Inc. USA
6
author : Larry Shaffer
7
email : lshaffer at boundlessgeo dot com
8
***************************************************************************
9
* *
10
* This program is free software; you can redistribute it and/or modify *
11
* it under the terms of the GNU General Public License as published by *
12
* the Free Software Foundation; either version 2 of the License, or *
13
* (at your option) any later version. *
14
* *
15
***************************************************************************/
16
17
#ifndef QGSAUTHMETHODMETADATA_H
18
#define QGSAUTHMETHODMETADATA_H
19
20
21
#include "qgis_core.h"
22
#include "
qgis_sip.h
"
23
24
#include <QString>
25
26
#define SIP_NO_FILE
27
28
class
QgsAuthMethod
;
29
44
class
CORE_EXPORT
QgsAuthMethodMetadata
45
{
46
public
:
47
55
QgsAuthMethodMetadata
(
const
QString &
key
,
const
QString &
description
,
const
QString &
library
= QString() )
56
: mKey(
key
)
57
, mDescription(
description
)
58
, mLibrary(
library
)
59
{}
60
61
virtual
~QgsAuthMethodMetadata
() =
default
;
62
68
QString
key
()
const
;
69
75
QString
description
()
const
;
76
82
QString
library
()
const
;
83
88
virtual
QgsAuthMethod
*
createAuthMethod
() const
SIP_FACTORY
;
// TODO QGIS 5 = 0
89
90
//virtual QStringList supportedDataProviders() const; // TODO QGIS 5 = 0;
91
92
private:
93
95
QString mKey;
96
98
QString mDescription;
99
101
QString mLibrary;
102
};
103
104
#endif
// QGSAUTHMETHODMETADATA_H
QgsAuthMethodMetadata::~QgsAuthMethodMetadata
virtual ~QgsAuthMethodMetadata()=default
QgsAuthMethodMetadata::createAuthMethod
virtual QgsAuthMethod * createAuthMethod() const
Class factory to return a pointer to a newly created QgsDataProvider object.
Definition
qgsauthmethodmetadata.cpp:36
QgsAuthMethodMetadata::description
QString description() const
Returns descriptive text for the method.
Definition
qgsauthmethodmetadata.cpp:26
QgsAuthMethodMetadata::QgsAuthMethodMetadata
QgsAuthMethodMetadata(const QString &key, const QString &description, const QString &library=QString())
Construct an authentication method metadata container.
Definition
qgsauthmethodmetadata.h:55
QgsAuthMethodMetadata::key
QString key() const
Returns the unique key associated with the method.
Definition
qgsauthmethodmetadata.cpp:21
QgsAuthMethodMetadata::library
QString library() const
Returns the library file name.
Definition
qgsauthmethodmetadata.cpp:31
QgsAuthMethod
Abstract base class for authentication method plugins.
Definition
qgsauthmethod.h:40
qgis_sip.h
SIP_FACTORY
#define SIP_FACTORY
Definition
qgis_sip.h:83
Generated on
for QGIS API Documentation by
1.15.0