QGIS API Documentation  2.99.0-Master (7d4f81d)
Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
QgsAuthMethodEdit Class Referenceabstract

Abstract base class for the edit widget of authentication method plugins. More...

#include <qgsauthmethodedit.h>

Inheritance diagram for QgsAuthMethodEdit:
Inheritance graph
[legend]

Public Slots

virtual void clearConfig ()=0
 Clear GUI controls in subclassed widget. More...
 
virtual void loadConfig (const QgsStringMap &configmap)=0
 Load an existing config map into subclassed widget. More...
 
virtual void resetConfig ()=0
 Clear GUI controls in subclassed widget, optionally reloading any previously loaded config map. More...
 

Signals

void validityChanged (bool valid)
 Emitted when the configuration validatity changes. More...
 

Public Member Functions

virtual QgsStringMap configMap () const =0
 The configuration key-vale map of subclasses. More...
 
virtual bool validateConfig ()=0
 Validate the configuration of subclasses. More...
 

Protected Member Functions

 QgsAuthMethodEdit (QWidget *parent=nullptr)
 Construct widget to edit an authentication method configuration. More...
 
virtual ~QgsAuthMethodEdit ()=default
 

Detailed Description

Abstract base class for the edit widget of authentication method plugins.

Definition at line 28 of file qgsauthmethodedit.h.

Constructor & Destructor Documentation

◆ QgsAuthMethodEdit()

QgsAuthMethodEdit::QgsAuthMethodEdit ( QWidget *  parent = nullptr)
inlineexplicitprotected

Construct widget to edit an authentication method configuration.

Note
Non-public since this is an abstract base class
Parameters
parentParent widget

Definition at line 64 of file qgsauthmethodedit.h.

◆ ~QgsAuthMethodEdit()

virtual QgsAuthMethodEdit::~QgsAuthMethodEdit ( )
protectedvirtualdefault

Member Function Documentation

◆ clearConfig

virtual void QgsAuthMethodEdit::clearConfig ( )
pure virtualslot

Clear GUI controls in subclassed widget.

◆ configMap()

virtual QgsStringMap QgsAuthMethodEdit::configMap ( ) const
pure virtual

The configuration key-vale map of subclasses.

◆ loadConfig

virtual void QgsAuthMethodEdit::loadConfig ( const QgsStringMap configmap)
pure virtualslot

Load an existing config map into subclassed widget.

Parameters
configmap

◆ resetConfig

virtual void QgsAuthMethodEdit::resetConfig ( )
pure virtualslot

Clear GUI controls in subclassed widget, optionally reloading any previously loaded config map.

◆ validateConfig()

virtual bool QgsAuthMethodEdit::validateConfig ( )
pure virtual

Validate the configuration of subclasses.

◆ validityChanged

void QgsAuthMethodEdit::validityChanged ( bool  valid)
signal

Emitted when the configuration validatity changes.


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