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

#include <qgsauthsettingswidget.h>

Inheritance diagram for QgsAuthSettingsWidget:

[legend]

Public Types
enum	WarningType { ProjectFile , UserSettings }
	The WarningType enum is used to determine the text of the message shown to the user about the destination of the stored clear-text credentials from the "Basic" tab: depending on the provider or the settings, the credentials are stored in the user settings and/or in the project file. More...

Public Slots
bool	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 More...

void	passwordTextChanged (const QString &text)
	Called when password text is changed. More...

void	userNameTextChanged (const QString &text)
	Called when user name text is changed. More...

Public Member Functions
	QgsAuthSettingsWidget (QWidget *parent=nullptr, const QString &configId=QString(), const QString &username=QString(), const QString &password=QString(), const QString &dataprovider=QString())
	Create a dialog for setting an associated authentication config, either from existing configs, or creating/removing them from auth database. More...

bool	btnConvertToEncryptedIsEnabled () const
	convertButtonEnabled, mainly useful for unit tests More...

const QString	configId () const
	configId More...

bool	configurationTabIsSelected ()
	configurationTabIsSelected More...

const QString	dataprovider () const
	dataprovider More...

const QString	password () const
	password More...

void	setBasicText (const QString &basicText)
	setBasicText set the text of the warning label More...

void	setConfigId (const QString &configId)
	setConfigId set the authentication configuration id param configId the authentication configuration id More...

void	setDataprovider (const QString &dataprovider)
	setDataprovider set the data provider key for filtering compatible authentication configurations More...

void	setPassword (const QString &password)
	setPassword set the password More...

void	setStorePasswordChecked (bool checked)
	setStorePasswordCheched check the "Store" checkbox for the password More...

void	setStoreUsernameChecked (bool checked)
	setStoreUsernameChecked check the "Store" checkbox for the username More...

void	setUsername (const QString &username)
	setUsername set the username More...

void	setWarningText (const QString &warningText)
	setWarningText set the text of the warning label More...

void	showStoreCheckboxes (bool enabled)
	showStoreCheckboxes show the "Store" checkboxes for basic auth. More...

bool	storePasswordIsChecked () const
	storePassword More...

bool	storeUsernameIsChecked () const
	storeUsername More...

const QString	username () const
	username More...

Static Public Member Functions
static const QString	formattedWarning (WarningType warning)
	warning text message based upon where credentials are stored More...

Detailed Description

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.

Since: QGIS 3.0

Definition at line 36 of file qgsauthsettingswidget.h.

Member Enumeration Documentation

◆ WarningType

enum QgsAuthSettingsWidget::WarningType

The WarningType enum is used to determine the text of the message shown to the user about the destination of the stored clear-text credentials from the "Basic" tab: depending on the provider or the settings, the credentials are stored in the user settings and/or in the project file.

Enumerator
ProjectFile
UserSettings

Definition at line 50 of file qgsauthsettingswidget.h.

Constructor & Destructor Documentation

◆ QgsAuthSettingsWidget()

QgsAuthSettingsWidget::QgsAuthSettingsWidget	(	QWidget *	parent = `nullptr`,
		const QString &	configId = `QString()`,
		const QString &	username = `QString()`,
		const QString &	password = `QString()`,
		const QString &	dataprovider = `QString()`
	)

explicit

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

Definition at line 23 of file qgsauthsettingswidget.cpp.

Member Function Documentation

◆ btnConvertToEncryptedIsEnabled()

bool QgsAuthSettingsWidget::btnConvertToEncryptedIsEnabled ( ) const

convertButtonEnabled, mainly useful for unit tests

Returns: true if the convert button is enabled

Definition at line 123 of file qgsauthsettingswidget.cpp.

◆ configId()

const QString QgsAuthSettingsWidget::configId ( ) const

configId

Returns: authentication configuration id

Definition at line 118 of file qgsauthsettingswidget.cpp.

◆ configurationTabIsSelected()

bool QgsAuthSettingsWidget::configurationTabIsSelected ( )

configurationTabIsSelected

Returns: true if the configuration tab is the currently selected tab

Definition at line 162 of file qgsauthsettingswidget.cpp.

◆ convertToEncrypted

bool QgsAuthSettingsWidget::convertToEncrypted ( )

slot

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

Returns: return true on success

Definition at line 167 of file qgsauthsettingswidget.cpp.

◆ dataprovider()

const QString QgsAuthSettingsWidget::dataprovider ( ) const

dataprovider

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

Definition at line 100 of file qgsauthsettingswidget.cpp.

◆ formattedWarning()

const QString QgsAuthSettingsWidget::formattedWarning ( WarningType warning )

static

warning text message based upon where credentials are stored

Parameters

warning enum of warning type

Returns: pre-formatted warning text

Definition at line 105 of file qgsauthsettingswidget.cpp.

◆ password()

const QString QgsAuthSettingsWidget::password ( ) const

password

Returns: basic authentication password

Definition at line 77 of file qgsauthsettingswidget.cpp.

◆ passwordTextChanged

void QgsAuthSettingsWidget::passwordTextChanged ( const QString & text )

slot

Called when password text is changed.

Note: Not available in Python bindings

Definition at line 194 of file qgsauthsettingswidget.cpp.

◆ setBasicText()

void QgsAuthSettingsWidget::setBasicText ( const QString & basicText )

setBasicText set the text of the warning label

Parameters

basicText the text of the basic tab label

Definition at line 59 of file qgsauthsettingswidget.cpp.

◆ setConfigId()

void QgsAuthSettingsWidget::setConfigId ( const QString & configId )

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

Definition at line 88 of file qgsauthsettingswidget.cpp.

◆ setDataprovider()

void QgsAuthSettingsWidget::setDataprovider ( const QString & dataprovider )

setDataprovider set the data provider key for filtering compatible authentication configurations

Parameters

dataprovider data provider key

Definition at line 94 of file qgsauthsettingswidget.cpp.

◆ setPassword()

void QgsAuthSettingsWidget::setPassword ( const QString & password )

setPassword set the password

Parameters

password the password

Definition at line 82 of file qgsauthsettingswidget.cpp.

◆ setStorePasswordChecked()

void QgsAuthSettingsWidget::setStorePasswordChecked ( bool checked )

setStorePasswordCheched check the "Store" checkbox for the password

Parameters

checked

See also: showStoreCheckboxes

Definition at line 147 of file qgsauthsettingswidget.cpp.

◆ setStoreUsernameChecked()

void QgsAuthSettingsWidget::setStoreUsernameChecked ( bool checked )

setStoreUsernameChecked check the "Store" checkbox for the username

Parameters

checked

See also: showStoreCheckboxes

Definition at line 142 of file qgsauthsettingswidget.cpp.

◆ setUsername()

void QgsAuthSettingsWidget::setUsername ( const QString & username )

setUsername set the username

Parameters

username the user name

Definition at line 71 of file qgsauthsettingswidget.cpp.

◆ setWarningText()

void QgsAuthSettingsWidget::setWarningText ( const QString & warningText )

setWarningText set the text of the warning label

Parameters

warningText the text of the warning label

See also: formattedWarning()

Definition at line 54 of file qgsauthsettingswidget.cpp.

◆ showStoreCheckboxes()

void QgsAuthSettingsWidget::showStoreCheckboxes ( bool enabled )

showStoreCheckboxes show the "Store" checkboxes for basic auth.

Some connection configurations allow the user to enter credentials for testing the connection without storing them in the project. "Store" checkboxes are disabled by default.

Parameters

enabled

Definition at line 128 of file qgsauthsettingswidget.cpp.

◆ storePasswordIsChecked()

bool QgsAuthSettingsWidget::storePasswordIsChecked ( ) const

storePassword

Returns: true if "Store" checkbox for the password is checked

Definition at line 152 of file qgsauthsettingswidget.cpp.

◆ storeUsernameIsChecked()

bool QgsAuthSettingsWidget::storeUsernameIsChecked ( ) const

storeUsername

Returns: true if "Store" checkbox for the username is checked

Definition at line 157 of file qgsauthsettingswidget.cpp.

◆ username()

const QString QgsAuthSettingsWidget::username ( ) const

username

Returns: basic authentication username

Definition at line 66 of file qgsauthsettingswidget.cpp.

◆ userNameTextChanged

void QgsAuthSettingsWidget::userNameTextChanged ( const QString & text )

slot

Called when user name text is changed.

Note: Not available in Python bindings

Definition at line 188 of file qgsauthsettingswidget.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.20.0+99unstable/src/gui/auth/qgsauthsettingswidget.h
/build/qgis-3.20.0+99unstable/src/gui/auth/qgsauthsettingswidget.cpp

Public Types

Public Slots

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ WarningType

Constructor & Destructor Documentation

◆ QgsAuthSettingsWidget()

Member Function Documentation

◆ btnConvertToEncryptedIsEnabled()

◆ configId()

◆ configurationTabIsSelected()

◆ convertToEncrypted

◆ dataprovider()

◆ formattedWarning()

◆ password()

◆ passwordTextChanged

◆ setBasicText()

◆ setConfigId()

◆ setDataprovider()

◆ setPassword()

◆ setStorePasswordChecked()

◆ setStoreUsernameChecked()

◆ setUsername()

◆ setWarningText()

◆ showStoreCheckboxes()

◆ storePasswordIsChecked()

◆ storeUsernameIsChecked()

◆ username()

◆ userNameTextChanged