QgsCredentialDialog Class Reference

A generic dialog for requesting credentials. More...

#include <qgscredentialdialog.h>

Inheritance diagram for QgsCredentialDialog:

Signals
void	credentialsRequested (const QString &, QString *, QString *, const QString &, bool *)
void	credentialsRequestedMasterPassword (QString *, bool, bool *)

Public Member Functions
	QgsCredentialDialog (QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
	QgsCredentialDialog constructor.
Public Member Functions inherited from QgsCredentials
virtual	~QgsCredentials ()=default
bool	get (const QString &realm, QString &username, QString &password, const QString &message=QString(), bool requestCredentials=true)
	Requests credentials for the specified realm.
bool	getMasterPassword (QString &password, bool stored=false)
void	lock ()
	Lock the instance against access from multiple threads.
QMutex *	mutex ()
	Returns pointer to mutex.
void	put (const QString &realm, const QString &username, const QString &password)
	Stores the correct username and password for the specified realm.
void	unlock ()
	Unlock the instance after being locked.

Protected Member Functions
bool	request (const QString &realm, QString &username, QString &password, const QString &message=QString()) override
	request a password
bool	requestMasterPassword (QString &password, bool stored=false) override
	request a master password
Protected Member Functions inherited from QgsCredentials
	QgsCredentials ()=default
void	setInstance (QgsCredentials *instance)
	register instance

Additional Inherited Members
Static Public Member Functions inherited from QgsCredentials
static QgsCredentials *	instance ()
	retrieves instance

Detailed Description

A generic dialog for requesting credentials.

Definition at line 35 of file qgscredentialdialog.h.

Constructor & Destructor Documentation

QgsCredentialDialog()

QgsCredentialDialog::QgsCredentialDialog	(	QWidget *	parent = nullptr,
		Qt::WindowFlags	fl = QgsGuiUtils::ModalDialogFlags )

QgsCredentialDialog constructor.

Definition at line 47 of file qgscredentialdialog.cpp.

Member Function Documentation

credentialsRequested

void QgsCredentialDialog::credentialsRequested ( const QString & , QString * , QString * , const QString & , bool *  )

signal

Note

not available in Python bindings

credentialsRequestedMasterPassword

void QgsCredentialDialog::credentialsRequestedMasterPassword ( QString * , bool , bool *  )

signal

Note

not available in Python bindings

request()

bool QgsCredentialDialog::request ( const QString & realm, QString & username, QString & password, const QString & message = QString() )

overrideprotectedvirtual

request a password

Implements QgsCredentials.

Definition at line 114 of file qgscredentialdialog.cpp.

requestMasterPassword()

bool QgsCredentialDialog::requestMasterPassword ( QString & password, bool stored = false )

overrideprotectedvirtual

request a master password

Implements QgsCredentials.

Definition at line 178 of file qgscredentialdialog.cpp.

---

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

• /build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/gui/qgscredentialdialog.h
• /build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/gui/qgscredentialdialog.cpp