QGIS API Documentation  2.99.0-Master (6a61179)
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=QgisGui::ModalDialogFlags)
 
 ~QgsCredentialDialog ()
 
- Public Member Functions inherited from QgsCredentials
virtual ~QgsCredentials ()
 virtual destructor More...
 
bool get (const QString &realm, QString &username, QString &password, const QString &message=QString::null)
 
bool getMasterPassword (QString &password, bool stored=false)
 
void lock ()
 Lock the instance against access from multiple threads. More...
 
QMutex * mutex ()
 Return pointer to mutex. More...
 
void put (const QString &realm, const QString &username, const QString &password)
 
void unlock ()
 Unlock the instance after being locked. More...
 

Protected Member Functions

virtual bool request (const QString &realm, QString &username, QString &password, const QString &message=QString::null) override
 request a password More...
 
virtual bool requestMasterPassword (QString &password, bool stored=false) override
 request a master password More...
 
- Protected Member Functions inherited from QgsCredentials
 QgsCredentials ()
 
void setInstance (QgsCredentials *theInstance)
 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 31 of file qgscredentialdialog.h.

Constructor & Destructor Documentation

§ QgsCredentialDialog()

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

Definition at line 32 of file qgscredentialdialog.cpp.

§ ~QgsCredentialDialog()

QgsCredentialDialog::~QgsCredentialDialog ( )

Definition at line 49 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::null 
)
overrideprotectedvirtual

request a password

Implements QgsCredentials.

Definition at line 53 of file qgscredentialdialog.cpp.

§ requestMasterPassword()

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

request a master password

Implements QgsCredentials.

Definition at line 104 of file qgscredentialdialog.cpp.


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