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

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

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.