Class: QgsAuthMethodEdit

Abstract base class for the edit widget of authentication method plugins

Class Hierarchy

Inheritance diagram of qgis.gui.QgsAuthMethodEdit

Base classes

QWidget

QObject

QPaintDevice

Methods

clearConfig

Clear GUI controls in subclassed widget

configMap

The configuration key-vale map of subclasses

loadConfig

Load an existing config map into subclassed widget

resetConfig

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

validateConfig

Validate the configuration of subclasses

Signals

validityChanged

Emitted when the configuration validatity changes

class qgis.gui.QgsAuthMethodEdit[source]

Bases: QWidget

__init__(parent: QWidget | None = None)

Construct widget to edit an authentication method configuration

Note

Non-public since this is an abstract base class

Parameters:

parent (Optional[QWidget] = None) – Parent widget

clearConfig(self)[source]

Clear GUI controls in subclassed widget

configMap(self) Dict[str, str][source]

The configuration key-vale map of subclasses

Return type:

Dict[str, str]

loadConfig(self, configmap: Dict[str | None, str | None])[source]

Load an existing config map into subclassed widget

Parameters:

configmap (Dict[Optional[str], Optional[str]])

resetConfig(self)[source]

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

validateConfig(self) bool[source]

Validate the configuration of subclasses

Return type:

bool

signal validityChanged(valid: bool)[source]

Emitted when the configuration validatity changes

Parameters:

valid (bool)