QCA::PasswordAsker Class Reference

#include <QtCrypto>

Inheritance diagram for QCA::PasswordAsker:

Signals
void	responseReady ()

Public Member Functions
	PasswordAsker (QObject *parent=nullptr)
bool	accepted () const
void	ask (Event::PasswordStyle pstyle, const KeyStoreInfo &keyStoreInfo, const KeyStoreEntry &keyStoreEntry, void *ptr)
void	ask (Event::PasswordStyle pstyle, const QString &fileName, void *ptr)
void	cancel ()
SecureArray	password () const
void	waitForResponse ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
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)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

User password / passphrase / PIN handler.

This class is used to obtain a password from a user.

Examples

eventhandlerdemo.cpp.

Definition at line 1660 of file qca_core.h.

Constructor & Destructor Documentation

PasswordAsker()

QCA::PasswordAsker::PasswordAsker

(

QObject *

parent = nullptr

)

Construct a new asker.

Parameters

parent

the parent object for this QObject

Member Function Documentation

accepted()

bool QCA::PasswordAsker::accepted

(

)

const

Determine whether the password / passphrase was accepted or not.

In this context, returning true is indicative of the user clicking "Ok" or equivalent; and returning false indicates that either the user clicked "Cancel" or equivalent, or that the cancel() function was called, or that the request is still pending.

ask() [1/2]

void QCA::PasswordAsker::ask	(	Event::PasswordStyle	pstyle,
		const KeyStoreInfo &	keyStoreInfo,
		const KeyStoreEntry &	keyStoreEntry,
		void *	ptr )

queue a password / passphrase request associated with a key store

Parameters

pstyle	the type of information required (e.g. PIN, passphrase or password)
keyStoreInfo	info of the key store that the information is required for
keyStoreEntry	the item in the key store that the information is required for (if applicable)
ptr	opaque data

Examples

eventhandlerdemo.cpp.

ask() [2/2]

void QCA::PasswordAsker::ask	(	Event::PasswordStyle	pstyle,
		const QString &	fileName,
		void *	ptr )

queue a password / passphrase request associated with a file

Parameters

pstyle	the type of information required (e.g. PIN, passphrase or password)
fileName	the name of the file that the information is required for
ptr	opaque data

cancel()

void QCA::PasswordAsker::cancel

(

)

Cancel the pending password / passphrase request.

password()

SecureArray QCA::PasswordAsker::password

(

)

const

The password / passphrase / PIN provided by the user in response to the asker request.

This may be empty.

Examples

eventhandlerdemo.cpp.

responseReady

void QCA::PasswordAsker::responseReady ( )

signal

Emitted when the asker process has been completed.

You should check whether the user accepted() the response prior to relying on the password().

waitForResponse()

void QCA::PasswordAsker::waitForResponse

(

)

Block until the password / passphrase request is completed.

You can use the responseReady signal instead of blocking, if appropriate.

Examples

eventhandlerdemo.cpp.

---

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

• qca_core.h