Class: QgsAuthConfigSelect

Selector widget for authentication configs.

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

class qgis.gui.QgsAuthConfigSelect

Bases: QWidget

__init__(parent: QWidget | None = None, dataprovider: str | None = '')

Create a dialog for setting an associated authentication config, either from existing configs, or creating/removing them from auth database

Parameters:

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

• dataprovider (Optional[str] = '') – The key of the calling layer provider, if applicable

clearMessage(self)

Clear and hide small message bar

configId(self) → str

Gets the authentication config id for the resource

Return type:

str

signal selectedConfigIdChanged

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.

signal selectedConfigIdRemoved

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.

setConfigId(self, authcfg: str | None)

Sets the authentication config id for the resource

Parameters:

authcfg (Optional[str])

setDataProviderKey(self, key: str | None)

Sets key of layer provider, if applicable

Parameters:

key (Optional[str])

showMessage(self, msg: str | None)

Show a small message bar with a close button

Parameters:

msg (Optional[str])