QCA::EventHandler Class Reference

Interface class for password / passphrase / PIN and token handlers. More...

#include <qca_core.h>

Inheritance diagram for QCA::EventHandler:

QObject Collaboration diagram for QCA::EventHandler:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 EventHandler (QObject *parent=0)
void start ()
void submitPassword (int id, const SecureArray &password)
void tokenOkay (int id)
void reject (int id)

Public Attributes

Q_SIGNALS __pad0__: void eventReady(int id
Q_SIGNALS const QCA::Eventcontext

Friends

class Private

Detailed Description

Interface class for password / passphrase / PIN and token handlers.

This class is used on client side applications to handle the provision of passwords, passphrases and PINs by users, and to indicate that tokens have been correctly inserted.

The concept behind this class is that the library can raise events (typically using PasswordAsker or TokenAsker), which may (or may not) be handled by the application using a handler object (that has-a EventHandler, or possibly is-a EventHandler) that is connected to the eventReady() signal.

Examples:

eventhandlerdemo.cpp, and keyloader.cpp.


Constructor & Destructor Documentation

QCA::EventHandler::EventHandler QObject parent = 0  ) 
 

Constructor.

Parameters:
parent the parent object for this object


Member Function Documentation

void QCA::EventHandler::start  ) 
 

mandatory function to call after connecting the signal to a slot in your application specific password / passphrase / PIN or token handler

void QCA::EventHandler::submitPassword int  id,
const SecureArray password
 

function to call to return the user provided password, passphrase or PIN.

Parameters:
id the id corresponding to the password request
password the user-provided password, passphrase or PIN.
Note:
the id parameter is the same as that provided in the eventReady() signal.

void QCA::EventHandler::tokenOkay int  id  ) 
 

function to call to indicate that the token has been inserted by the user.

Parameters:
id the id corresponding to the password request
Note:
the id parameter is the same as that provided in the eventReady() signal.

void QCA::EventHandler::reject int  id  ) 
 

function to call to indicate that the user declined to provide a password, passphrase, PIN or token.

Parameters:
id the id corresponding to the password request
Note:
the id parameter is the same as that provided in the eventReady() signal.


The documentation for this class was generated from the following file:
Generated on Fri Jul 6 13:23:49 2007 for Qt Cryptographic Architecture by  doxygen 1.4.6