Qt Cryptographic Architecture
Public Member Functions | List of all members
QCA::KeyStoreInfo Class Reference

#include <QtCrypto>

Public Member Functions

QString id () const
 
bool isNull () const
 
 KeyStoreInfo ()
 
 KeyStoreInfo (KeyStore::Type type, const QString &id, const QString &name)
 
 KeyStoreInfo (const KeyStoreInfo &from)
 
QString name () const
 
KeyStoreInfooperator= (const KeyStoreInfo &from)
 
KeyStore::Type type () const
 

Detailed Description

Key store information, outside of a KeyStore object.

This class is used in conjunction with the Event class, and related classes such as PasswordAsker and TokenAsker, to describe the key store source of the Event.

Each KeyStoreInfo represents a single KeyStore, and describes the type of store (e.g. smartcard or PGP keyring - see KeyStore::Type), and a couple of names. The id() of a KeyStore is used to reference it, and is typically of the form "qca-mystorename". The name() of a KeyStore is used to describe it (i.e. this is the "pretty" name to show the user), and is typically of the form "My Store Name".

Examples:
eventhandlerdemo.cpp.

Constructor & Destructor Documentation

QCA::KeyStoreInfo::KeyStoreInfo ( )

Constructor.

Note
This form of constructor for KeyStoreInfo produces an object that does not describe any KeyStore, and isNull() will return true.
QCA::KeyStoreInfo::KeyStoreInfo ( KeyStore::Type  type,
const QString &  id,
const QString &  name 
)

Standard constructor.

This builds a KeyStoreInfo object that descibes a KeyStore.

Parameters
typethe type of KeyStore
idthe identification of the KeyStore
namethe descriptive name of the KeyStore
QCA::KeyStoreInfo::KeyStoreInfo ( const KeyStoreInfo from)

Copy constructor.

Parameters
fromthe KeyStoreInfo to copy from

Member Function Documentation

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

Assignment operator.

Parameters
fromthe KeyStoreInfo to copy from
bool QCA::KeyStoreInfo::isNull ( ) const

Test if this object is valid.

Returns
true if the object is not valid
KeyStore::Type QCA::KeyStoreInfo::type ( ) const

The Type of KeyStore that this KeyStoreInfo object describes.

QString QCA::KeyStoreInfo::id ( ) const

The unique identification of the KeyStore that this KeyStoreInfo object describes.

QString QCA::KeyStoreInfo::name ( ) const

The descriptive name of the KeyStore that this KeyStoreInfo object describes.


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