QgsAuthMethodEdit Class Reference

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

#include <qgsauthmethodedit.h>

Inheritance diagram for QgsAuthMethodEdit:

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

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

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

Protected Member Functions
	QgsAuthMethodEdit (QWidget *parent=nullptr)
	Construct widget to edit an authentication method configuration.
	~QgsAuthMethodEdit () override=default

Detailed Description

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

Definition at line 29 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

parent

Parent widget

Definition at line 65 of file qgsauthmethodedit.h.

~QgsAuthMethodEdit()

QgsAuthMethodEdit::~QgsAuthMethodEdit ( )

overrideprotecteddefault

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:

• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/auth/qgsauthmethodedit.h