QGIS API Documentation  3.20.0-Odense (decaadbb31)
Signals | Public Member Functions | Protected Member Functions | List of all members
QgsCredentialDialog Class Reference

A generic dialog for requesting credentials. More...

#include <qgscredentialdialog.h>

Inheritance diagram for QgsCredentialDialog:
Inheritance graph
[legend]

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. More...
 
- Public Member Functions inherited from QgsCredentials
virtual ~QgsCredentials ()=default
 Destructor. More...
 
bool get (const QString &realm, QString &username, QString &password, const QString &message=QString())
 Requests credentials for the specified realm. More...
 
bool getMasterPassword (QString &password, bool stored=false)
 
void lock ()
 Lock the instance against access from multiple threads. More...
 
QMutex * mutex ()
 Returns pointer to mutex. More...
 
void put (const QString &realm, const QString &username, const QString &password)
 Stores the correct username and password for the specified realm. More...
 
void unlock ()
 Unlock the instance after being locked. More...
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from QgsCredentials
static QgsCredentialsinstance ()
 retrieves instance More...
 

Detailed Description

A generic dialog for requesting credentials.

Definition at line 34 of file qgscredentialdialog.h.

Constructor & Destructor Documentation

◆ QgsCredentialDialog()

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

QgsCredentialDialog constructor.

Definition at line 44 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 117 of file qgscredentialdialog.cpp.

◆ requestMasterPassword()

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

request a master password

Implements QgsCredentials.

Definition at line 180 of file qgscredentialdialog.cpp.


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