QGIS/python/core/qgscredentials.sip
Nyall Dawson c49b5b777f Change a lot of arguments to const references in core/gui
Rationale:
- there was a lot of large objects passed by value, so potentially
there's a speed bump from this
- even for implicitly shared classes like QString/QList there's still
a (small) cost for copying the objects when there's no reason to
- it's the right thing to do!
2015-10-07 12:02:04 +11:00

80 lines
2.3 KiB
Plaintext

class QgsCredentials
{
%TypeHeaderCode
#include <qgscredentials.h>
%End
public:
//! virtual destructor
virtual ~QgsCredentials();
bool get( const QString& realm, QString &username /In,Out/, QString &password /In,Out/, const QString& message = QString::null );
void put( const QString& realm, const QString& username, const QString& password );
bool getMasterPassword( QString &password /In,Out/, bool stored = false );
//! retrieves instance
static QgsCredentials *instance();
/**
* Lock the instance against access from multiple threads. This does not really lock access to get/put methds,
* it will just prevent other threads to lock the instance and continue the execution. When the class is used
* from non-GUI threads, they should call lock() before the get/put calls to avoid race conditions.
* @note added in 2.4
*/
void lock();
/**
* Unlock the instance after being locked.
* @note added in 2.4
*/
void unlock();
/**
* Return pointer to mutex
* @note added in 2.4
*/
QMutex *mutex();
protected:
QgsCredentials();
//! request a password
virtual bool request( const QString& realm, QString &username /In,Out/, QString &password /In,Out/, const QString& message = QString::null ) = 0;
//! request a master password
virtual bool requestMasterPassword( QString &password /In,Out/, bool stored = false ) = 0;
//! register instance
void setInstance( QgsCredentials *theInstance );
private:
QgsCredentials( const QgsCredentials& );
};
/**
\brief Default implementation of credentials interface
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.
*/
class QgsCredentialsConsole : QObject, QgsCredentials
{
%TypeHeaderCode
#include <qgscredentials.h>
%End
public:
QgsCredentialsConsole();
signals:
//! signals that object will be destroyed and shouldn't be used anymore
void destroyed();
protected:
virtual bool request( const QString& realm, QString &username /In,Out/, QString &password /In,Out/, const QString& message = QString::null );
virtual bool requestMasterPassword( QString &password /In,Out/, bool stored = false );
};