Class: QgsAuthSettingsWidget¶

class qgis.gui.QgsAuthSettingsWidget¶

Bases: PyQt5.QtWidgets.QWidget

Widget for entering authentication credentials both in the form username/password and by using QGIS Authentication Database and its authentication configurations.

The widget also offers the functionality to convert username/password credentials to an authentication configuration.

New in version 3.0.

QgsAuthSettingsWidget(parent: QWidget = None, configId: str = ‘’, username: str = ‘’, password: str = ‘’, dataprovider: str = ‘’) Create a dialog for setting an associated authentication config, either from existing configs, or creating/removing them from auth database

Parameters

parent – Parent widget
configId – authentication configuration id
username –
password –

dataprovider –

The key of the calling layer provider, if applicable

Methods

`actionEvent`
`btnConvertToEncryptedIsEnabled`	convertButtonEnabled, mainly useful for unit tests
`changeEvent`
`childEvent`
`closeEvent`
`configId`	rtype str
`configurationTabIsSelected`	rtype bool
`connectNotify`
`contextMenuEvent`
`convertToEncrypted`	convertToEncrypted is called when the convert to encrypted button is clicked and it creates a Basic authentication configuration from username and password specified in the Basic tab
`create`
`customEvent`
`dataprovider`	rtype str
`destroy`
`disconnectNotify`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`dropEvent`
`enterEvent`
`event`
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPreviousChild`
`formattedWarning`	warning text message based upon where credentials are stored
`hideEvent`
`initPainter`
`inputMethodEvent`
`isSignalConnected`
`keyPressEvent`
`keyReleaseEvent`
`leaveEvent`
`metric`
`mouseDoubleClickEvent`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`moveEvent`
`nativeEvent`
`paintEvent`
`password`	rtype str
`receivers`
`resizeEvent`
`sender`
`senderSignalIndex`
`setBasicText`	setBasicText set the text of the warning label
`setConfigId`	setConfigId set the authentication configuration id param configId the authentication configuration id
`setDataprovider`	setDataprovider set the data provider key for filtering compatible authentication configurations
`setPassword`	setPassword set the password
`setStorePasswordChecked`	setStorePasswordCheched check the “Store” checkbox for the password
`setStoreUsernameChecked`	setStoreUsernameChecked check the “Store” checkbox for the username
`setUsername`	setUsername set the username
`setWarningText`	setWarningText set the text of the warning label
`sharedPainter`
`showEvent`
`showStoreCheckboxes`	showStoreCheckboxes show the “Store” checkboxes for basic auth.
`storePasswordIsChecked`	storePassword
`storeUsernameIsChecked`	storeUsername
`tabletEvent`
`timerEvent`
`updateMicroFocus`
`username`	rtype str
`wheelEvent`

Attributes

`ProjectFile`
`UserSettings`

ProjectFile = 0¶

UserSettings = 1¶

class WarningType¶

Bases: int

baseClass¶: alias of qgis._gui.QgsAuthSettingsWidget

actionEvent(self, QActionEvent)¶

btnConvertToEncryptedIsEnabled(self) → bool¶

convertButtonEnabled, mainly useful for unit tests

Return type: bool
Returns: True if the convert button is enabled

changeEvent(self, QEvent)¶

childEvent(self, QChildEvent)¶

closeEvent(self, QCloseEvent)¶

configId(self) → str¶

configId(None) → None

Return type: str
Returns: authentication configuration id

configurationTabIsSelected(self) → bool¶

configurationTabIsSelected(None) → None

Return type: bool
Returns: True if the configuration tab is the currently selected tab

connectNotify(self, QMetaMethod)¶

contextMenuEvent(self, QContextMenuEvent)¶

convertToEncrypted(self) → bool¶

convertToEncrypted is called when the convert to encrypted button is clicked and it creates a Basic authentication configuration from username and password specified in the Basic tab

Return type: bool
Returns: return True on success

create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶

customEvent(self, QEvent)¶

dataprovider(self) → str¶

dataprovider(None) → None

Return type: str
Returns: the data provider key used to filter compatible authentication configurations

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶

disconnectNotify(self, QMetaMethod)¶

dragEnterEvent(self, QDragEnterEvent)¶

dragLeaveEvent(self, QDragLeaveEvent)¶

dragMoveEvent(self, QDragMoveEvent)¶

dropEvent(self, QDropEvent)¶

enterEvent(self, QEvent)¶

event(self, QEvent) → bool¶

focusInEvent(self, QFocusEvent)¶

focusNextChild(self) → bool¶

focusNextPrevChild(self, bool) → bool¶

focusOutEvent(self, QFocusEvent)¶

focusPreviousChild(self) → bool¶

formattedWarning(warning: QgsAuthSettingsWidget.WarningType) → str¶

warning text message based upon where credentials are stored

Parameters: warning (QgsAuthSettingsWidget.WarningType) – enum of warning type
Return type: str
Returns: pre-formatted warning text

hideEvent(self, QHideEvent)¶

initPainter(self, QPainter)¶

inputMethodEvent(self, QInputMethodEvent)¶

isSignalConnected(self, QMetaMethod) → bool¶

keyPressEvent(self, QKeyEvent)¶

keyReleaseEvent(self, QKeyEvent)¶

leaveEvent(self, QEvent)¶

metric(self, QPaintDevice.PaintDeviceMetric) → int¶

mouseDoubleClickEvent(self, QMouseEvent)¶

mouseMoveEvent(self, QMouseEvent)¶

mousePressEvent(self, QMouseEvent)¶

mouseReleaseEvent(self, QMouseEvent)¶

moveEvent(self, QMoveEvent)¶

nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]¶

paintEvent(self, QPaintEvent)¶

password(self) → str¶

password(None) → None

Return type: str
Returns: basic authentication password

receivers(self, PYQT_SIGNAL) → int¶

resizeEvent(self, QResizeEvent)¶

sender(self) → QObject¶

senderSignalIndex(self) → int¶

setBasicText(self, basicText: str)¶

setBasicText set the text of the warning label

Parameters: basicText (str) – the text of the basic tab label

setConfigId(self, configId: str)¶

setConfigId set the authentication configuration id param configId the authentication configuration id

Parameters: configId (str) –

setDataprovider(self, dataprovider: str)¶

setDataprovider set the data provider key for filtering compatible authentication configurations

Parameters: dataprovider (str) – data provider key

setPassword(self, password: str)¶

setPassword set the password

Parameters: password (str) – the password

setStorePasswordChecked(self, checked: bool)¶

setStorePasswordCheched check the “Store” checkbox for the password

Parameters: checked (bool) –