QCA::Event

Search for usage in LXR

#include <QtCrypto>

Public Types

enum  PasswordStyle { StylePassword, StylePassphrase, StylePIN }
 
enum  Source { KeyStore, Data }
 
enum  Type { Password, Token }
 

Public Member Functions

 Event ()
 
 Event (const Event &from)
 
 ~Event ()
 
QString fileName () const
 
bool isNull () const
 
KeyStoreEntry keyStoreEntry () const
 
KeyStoreInfo keyStoreInfo () const
 
Eventoperator= (const Event &from)
 
PasswordStyle passwordStyle () const
 
void * ptr () const
 
void setPasswordData (PasswordStyle pstyle, const QString &fileName, void *ptr)
 
void setPasswordKeyStore (PasswordStyle pstyle, const KeyStoreInfo &keyStoreInfo, const KeyStoreEntry &keyStoreEntry, void *ptr)
 
void setToken (const KeyStoreInfo &keyStoreInfo, const KeyStoreEntry &keyStoreEntry, void *ptr)
 
Source source () const
 
Type type () const
 

Detailed Description

An asynchronous event.

Events are produced in response to the library's need for some user intervention, such as entering a pin or password, or inserting a cryptographic token.

Event is an abstraction, so you can handle this need in a way that makes sense for your application.

Examples:
eventhandlerdemo.cpp, and keyloader.cpp.

Definition at line 1390 of file qca_core.h.

Member Enumeration Documentation

password variation

If the Type of Event is Password, PasswordStyle tells you whether it is a PIN, passphrase or password.

See also
passwordStyle()
Enumerator
StylePassword 

User should be prompted for a "Password".

StylePassphrase 

User should be prompted for a "Passphrase".

StylePIN 

User should be prompted for a "PIN".

Definition at line 1430 of file qca_core.h.

Source of the event

Events are associated with access to a KeyStore, or access to a file (or bytearray/stream or equivalent). This tells you the type of source that caused the Event.

See also
source()
fileName() for the name, if source is Event::Data
keyStoreInfo() and keyStoreEntry() for the keystore and entry, if the source is Event::KeyStore
Enumerator
KeyStore 

KeyStore generated the event.

Data 

File or bytearray generated the event.

Definition at line 1416 of file qca_core.h.

Type of event

See also
type()
Enumerator
Password 

Asking for a password, PIN or passphrase.

Token 

Asking for a token.

Definition at line 1398 of file qca_core.h.

Constructor & Destructor Documentation

QCA::Event::Event ( )

Constructor.

QCA::Event::Event ( const Event from)

Copy constructor.

Parameters
fromthe Event to copy from
QCA::Event::~Event ( )

Destructor.

Member Function Documentation

QString QCA::Event::fileName ( ) const

Name or other identifier for the file or byte array associated with this event.

This is not meaningful unless the Source is Data.

Examples:
eventhandlerdemo.cpp.
bool QCA::Event::isNull ( ) const

test if this event has been setup correctly

Examples:
eventhandlerdemo.cpp.
KeyStoreEntry QCA::Event::keyStoreEntry ( ) const

The KeyStoreEntry associated with this event.

This is not meaningful unless the Source is KeyStore.

KeyStoreInfo QCA::Event::keyStoreInfo ( ) const

The info of the KeyStore associated with this event.

This is not meaningful unless the Source is KeyStore.

Event& QCA::Event::operator= ( const Event from)

Assignment operator.

Parameters
fromthe Event to copy from
PasswordStyle QCA::Event::passwordStyle ( ) const

the style of password required.

This is not meaningful unless the Type is Event::Password.

See also
PasswordStyle
Examples:
eventhandlerdemo.cpp.
void* QCA::Event::ptr ( ) const

opaque data

void QCA::Event::setPasswordData ( PasswordStyle  pstyle,
const QString fileName,
void *  ptr 
)

Set the values for this Event.

This creates a Password type event, for a file.

Parameters
pstylethe style of information required (e.g. PIN, password or passphrase)
fileNamethe name of the file (or other identifier) that the information is required for
ptropaque data
void QCA::Event::setPasswordKeyStore ( PasswordStyle  pstyle,
const KeyStoreInfo keyStoreInfo,
const KeyStoreEntry keyStoreEntry,
void *  ptr 
)

Set the values for this Event.

This creates a Password type event, for a keystore.

Parameters
pstylethe style of information required (e.g. PIN, password or passphrase)
keyStoreInfoinfo about the keystore that the information is required for
keyStoreEntrythe entry in the keystore that the information is required for
ptropaque data
void QCA::Event::setToken ( const KeyStoreInfo keyStoreInfo,
const KeyStoreEntry keyStoreEntry,
void *  ptr 
)

Set the values for this Event.

This creates a Token type event.

Parameters
keyStoreInfoinfo about the keystore that the token is required for
keyStoreEntrythe entry in the keystore that the token is required for
ptropaque data
Source QCA::Event::source ( ) const

the Source of this event

Examples:
eventhandlerdemo.cpp.
Type QCA::Event::type ( ) const

the Type of this event

Examples:
eventhandlerdemo.cpp, and keyloader.cpp.

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Fri Oct 22 2021 23:04:24 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.