QGIS API Documentation  2.99.0-Master (37c43df)
Signals | Public Member Functions | Protected Member Functions | List of all members
QgsCredentialsConsole Class Reference

Implementation of credentials interface for the console. More...

#include <qgscredentials.h>

Inheritance diagram for QgsCredentialsConsole:
Inheritance graph
[legend]

Signals

void destroyed ()
 signals that object will be destroyed and shouldn't be used anymore More...
 

Public Member Functions

 QgsCredentialsConsole ()
 
- 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

Implementation of credentials interface for the console.

This class outputs message to the standard output and retrieves input from standard input. Therefore it won't be the right choice for apps without GUI.

Definition at line 125 of file qgscredentials.h.

Constructor & Destructor Documentation

§ QgsCredentialsConsole()

QgsCredentialsConsole::QgsCredentialsConsole ( )

Definition at line 128 of file qgscredentials.cpp.

Member Function Documentation

§ destroyed

void QgsCredentialsConsole::destroyed ( )
signal

signals that object will be destroyed and shouldn't be used anymore

§ request()

bool QgsCredentialsConsole::request ( const QString &  realm,
QString &  username,
QString &  password,
const QString &  message = QString::null 
)
overrideprotectedvirtual

request a password

Implements QgsCredentials.

Definition at line 133 of file qgscredentials.cpp.

§ requestMasterPassword()

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

request a master password

Implements QgsCredentials.

Definition at line 149 of file qgscredentials.cpp.


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