QGIS API Documentation  3.23.0-Master (eb871beae0)
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 #define SIP_NO_FILE
21 
22 #include <QString>
23 
24 #include "qgis_core.h"
25 #include "qgis_sip.h"
26 
27 class QgsAuthMethod;
28 
43 class CORE_EXPORT QgsAuthMethodMetadata
44 {
45  public:
46 
54  QgsAuthMethodMetadata( const QString &key, const QString &description, const QString &library = QString() )
55  : mKey( key )
56  , mDescription( description )
57  , mLibrary( library )
58  {}
59 
60  virtual ~QgsAuthMethodMetadata() = default;
61 
67  QString key() const;
68 
74  QString description() const;
75 
81  QString library() const;
82 
87  virtual QgsAuthMethod *createAuthMethod() const SIP_FACTORY; // TODO QGIS 4 = 0
88 
89  //virtual QStringList supportedDataProviders() const; // TODO QGIS 4 = 0;
90 
91  private:
92 
94  QString mKey;
95 
97  QString mDescription;
98 
100  QString mLibrary;
101 };
102 
103 #endif // QGSAUTHMETHODMETADATA_H
Holds data auth method key, description, and associated shared library file information.
virtual ~QgsAuthMethodMetadata()=default
QgsAuthMethodMetadata(const QString &key, const QString &description, const QString &library=QString())
Construct an authentication method metadata container.
Abstract base class for authentication method plugins.
Definition: qgsauthmethod.h:43
#define SIP_FACTORY
Definition: qgis_sip.h:76