• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

kabc

KABC::Key

KABC::Key Class Reference

A class to store an encryption key. More...

#include <key.h>

List of all members.


Public Types


Public Member Functions

QByteArray binaryData () const
QString customTypeString () const
QString id () const
bool isBinary () const
 Key (const Key &other)
 Key (const QString &text=QString(), Type type=PGP)
bool operator!= (const Key &) const
Key & operator= (const Key &other)
bool operator== (const Key &) const
void setBinaryData (const QByteArray &data)
void setCustomTypeString (const QString &type)
void setId (const QString &identifier)
void setTextData (const QString &data)
void setType (Type type)
QString textData () const
QString toString () const
Type type () const
 ~Key ()

Static Public Member Functions

static QString typeLabel (Type type)
static TypeList typeList ()

Friends

QDataStream & operator<< (QDataStream &, const Key &)
QDataStream & operator>> (QDataStream &, Key &)

Detailed Description

A class to store an encryption key.

Definition at line 34 of file key.h.


Member Typedef Documentation

typedef QList<Key> KABC::Key::List

List of keys.

Definition at line 43 of file key.h.

typedef QList<Type> KABC::Key::TypeList

List of key types.

Definition at line 57 of file key.h.


Member Enumeration Documentation

enum KABC::Key::Type

Key types.

Enumerator:
X509  X509 key.
PGP  Pretty Good Privacy key.
Custom  Custom or IANA conform key.

Definition at line 48 of file key.h.


Constructor & Destructor Documentation

Key::Key ( const QString &  text = QString(),
Type  type = PGP 
) [explicit]

Creates a new key.

Parameters:
text The text data.
type The key type, see Types.

Definition at line 59 of file key.cpp.

Key::Key ( const Key &  other  ) 

Copy constructor.

Definition at line 67 of file key.cpp.

Key::~Key (  ) 

Destroys the key.

Definition at line 72 of file key.cpp.


Member Function Documentation

QByteArray Key::binaryData (  )  const

Returns the binary data.

Definition at line 137 of file key.cpp.

QString Key::customTypeString (  )  const

Returns the custom type string.

Definition at line 173 of file key.cpp.

QString Key::id (  )  const

Returns the unique identifier.

Definition at line 126 of file key.cpp.

bool Key::isBinary (  )  const

Returns whether the key contains binary or text data.

Definition at line 153 of file key.cpp.

bool Key::operator!= ( const Key &  other  )  const

Not-equal operator.

Definition at line 107 of file key.cpp.

Key & Key::operator= ( const Key &  other  ) 

Assignment operator.

Parameters:
other The Key instance to assign to this

Definition at line 112 of file key.cpp.

bool Key::operator== ( const Key &  other  )  const

Equality operator.

Definition at line 76 of file key.cpp.

void Key::setBinaryData ( const QByteArray &  data  ) 

Sets binary data.

Definition at line 131 of file key.cpp.

void Key::setCustomTypeString ( const QString &  type  ) 

Sets custom type string.

Definition at line 163 of file key.cpp.

void Key::setId ( const QString &  identifier  ) 

Sets the unique identifier.

Definition at line 121 of file key.cpp.

void Key::setTextData ( const QString &  data  ) 

Sets text data.

Definition at line 142 of file key.cpp.

void Key::setType ( Type  type  ) 

Sets the type.

Parameters:
type The type of the key
See also:
Type

Definition at line 158 of file key.cpp.

QString Key::textData (  )  const

Returns the text data.

Definition at line 148 of file key.cpp.

QString Key::toString (  )  const

Returns a string representation of the key.

Definition at line 178 of file key.cpp.

Key::Type Key::type (  )  const

Returns the type, see Type.

Definition at line 168 of file key.cpp.

QString Key::typeLabel ( Type  type  )  [static]

Returns a translated label for a given key type.

Definition at line 212 of file key.cpp.

Key::TypeList Key::typeList (  )  [static]

Returns a list of all available key types.

Definition at line 201 of file key.cpp.


Friends And Related Function Documentation

QDataStream& operator<< ( QDataStream &  ,
const Key &   
) [friend]

Serializes the key object into the stream.

QDataStream& operator>> ( QDataStream &  ,
Key &   
) [friend]

Initializes the key object from the stream.


The documentation for this class was generated from the following files:
  • key.h
  • key.cpp

kabc

Skip menu "kabc"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.8
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal