Class: QgsAuthMethodEdit

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

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: clearConfig(), configMap(), loadConfig(), resetConfig(), validateConfig()

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

Abstract 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

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

abstract clearConfig(self)

Clear GUI controls in subclassed widget

abstract configMap(self) → Dict[str, str]

The configuration key-vale map of subclasses

Return type:

Dict[str, str]

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

Load an existing config map into subclassed widget

Parameters:

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

abstract resetConfig(self)

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

abstract validateConfig(self) → bool

Validate the configuration of subclasses

Return type:

bool

signal validityChanged(valid: bool)

Emitted when the configuration validatity changes

Parameters:

valid (bool)