QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
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 QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 
- 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...
 
QMutexmutex ()
 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 QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Protected Member Functions inherited from QgsCredentials
 QgsCredentials ()
 
void setInstance (QgsCredentials *theInstance)
 register instance More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Static Public Member Functions inherited from QgsCredentials
static QgsCredentialsinstance ()
 retrieves instance More...
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

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: