QGIS API Documentation 3.29.0-Master (19d7edcfed)
qgsauthmethodedit.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsauthbasicedit.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 QGSAUTHMETHODEDIT_H
18#define QGSAUTHMETHODEDIT_H
19
20#include <QWidget>
21
22#include "qgis.h"
23#include "qgis_gui.h"
24
29class GUI_EXPORT QgsAuthMethodEdit : public QWidget
30{
31 Q_OBJECT
32
33 public:
35 virtual bool validateConfig() = 0;
36
38 virtual QgsStringMap configMap() const = 0;
39
40 signals:
42 void validityChanged( bool valid );
43
44 public slots:
45
50 virtual void loadConfig( const QgsStringMap &configmap ) = 0;
51
53 virtual void resetConfig() = 0;
54
56 virtual void clearConfig() = 0;
57
58 protected:
59
65 explicit QgsAuthMethodEdit( QWidget *parent = nullptr )
66 : QWidget( parent )
67 {}
68
69 ~QgsAuthMethodEdit() override = default;
70};
71
72#endif // QGSAUTHMETHODEDIT_H
Abstract base class for the edit widget of authentication method plugins.
virtual bool validateConfig()=0
Validate the configuration of subclasses.
void validityChanged(bool valid)
Emitted when the configuration validatity changes.
~QgsAuthMethodEdit() override=default
virtual void clearConfig()=0
Clear GUI controls in subclassed widget.
virtual void resetConfig()=0
Clear GUI controls in subclassed widget, optionally reloading any previously loaded config map.
virtual QgsStringMap configMap() const =0
The configuration key-vale map of subclasses.
QgsAuthMethodEdit(QWidget *parent=nullptr)
Construct widget to edit an authentication method configuration.
virtual void loadConfig(const QgsStringMap &configmap)=0
Load an existing config map into subclassed widget.
QMap< QString, QString > QgsStringMap
Definition: qgis.h:3622