.TH "KABC::Key" kde3 "11 Jun 2005" "Version Version 3.4.1" "kabc Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KABC::Key \- A class to store an encryption key.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <key.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "typedef \fBQValueList\fP< \fBKey\fP > \fBList\fP"
.br
.ti -1c
.RI "typedef \fBQValueList\fP< int > \fBTypeList\fP"
.br
.ti -1c
.RI "enum \fBTypes\fP { \fBX509\fP, \fBPGP\fP, \fBCustom\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKey\fP (const \fBQString\fP &text=QString::null, int type=PGP)"
.br
.ti -1c
.RI "\fB~Key\fP ()"
.br
.ti -1c
.RI "bool \fBoperator==\fP (const \fBKey\fP &) const "
.br
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBKey\fP &) const "
.br
.ti -1c
.RI "void \fBsetId\fP (const \fBQString\fP &id)"
.br
.ti -1c
.RI "\fBQString\fP \fBid\fP () const "
.br
.ti -1c
.RI "void \fBsetBinaryData\fP (const \fBQByteArray\fP &binary)"
.br
.ti -1c
.RI "\fBQByteArray\fP \fBbinaryData\fP () const "
.br
.ti -1c
.RI "void \fBsetTextData\fP (const \fBQString\fP &text)"
.br
.ti -1c
.RI "\fBQString\fP \fBtextData\fP () const "
.br
.ti -1c
.RI "bool \fBisBinary\fP () const "
.br
.ti -1c
.RI "void \fBsetType\fP (int type)"
.br
.ti -1c
.RI "void \fBsetCustomTypeString\fP (const \fBQString\fP &custom)"
.br
.ti -1c
.RI "int \fBtype\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBcustomTypeString\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBTypeList\fP \fBtypeList\fP ()"
.br
.ti -1c
.RI "static \fBQString\fP \fBtypeLabel\fP (int type)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "KABC_EXPORT \fBQDataStream\fP & \fBoperator<<\fP (\fBQDataStream\fP &, const \fBKey\fP &)"
.br
.ti -1c
.RI "KABC_EXPORT \fBQDataStream\fP & \fBoperator>>\fP (\fBQDataStream\fP &, \fBKey\fP &)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A class to store an encryption key. 
.PP
Definition at line 33 of file key.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKABC::Key::Types\fP"
.PP
\fBKey\fP types. 
.PP
.PD 0
.IP "\(bu" 2
X509 - X509 key 
.IP "\(bu" 2
PGP - Pretty Good Privacy key 
.IP "\(bu" 2
Custom - Custom or IANA conform key 
.PP

.PP
Definition at line 49 of file key.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "Key::Key (const \fBQString\fP & text = \fCQString::null\fP, int type = \fCPGP\fP)"
.PP
Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fItext\fP The text data. 
.br
\fItype\fP The key type, 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBTypes\fP. 
.RE
.PP

.PP
Definition at line 28 of file key.cpp.
.PP
References KApplication::randomString().
.SS "Key::~\fBKey\fP ()"
.PP
Destructor. 
.PP
Definition at line 34 of file key.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void Key::setId (const \fBQString\fP & id)"
.PP
Sets the unique identifier. 
.PP
Definition at line 56 of file key.cpp.
.PP
References id().
.SS "\fBQString\fP Key::id () const"
.PP
Returns the unique identifier. 
.PP
Definition at line 61 of file key.cpp.
.PP
Referenced by setId().
.SS "void Key::setBinaryData (const \fBQByteArray\fP & binary)"
.PP
Sets binary data. 
.PP
Definition at line 66 of file key.cpp.
.SS "\fBQByteArray\fP Key::binaryData () const"
.PP
Returns the binary data. 
.PP
Definition at line 72 of file key.cpp.
.SS "void Key::setTextData (const \fBQString\fP & text)"
.PP
Sets text data. 
.PP
Definition at line 77 of file key.cpp.
.SS "\fBQString\fP Key::textData () const"
.PP
Returns the text data. 
.PP
Definition at line 83 of file key.cpp.
.SS "bool Key::isBinary () const"
.PP
Returns whether the key contains binary or text data. 
.PP
Definition at line 88 of file key.cpp.
.SS "void Key::setType (int type)"
.PP
Sets the type,. 
.PP
\fBSee also:\fP
.RS 4
Type. 
.RE
.PP

.PP
Definition at line 93 of file key.cpp.
.SS "void Key::setCustomTypeString (const \fBQString\fP & custom)"
.PP
Sets custom type string. 
.PP
Definition at line 98 of file key.cpp.
.SS "int Key::type () const"
.PP
Returns the type,. 
.PP
\fBSee also:\fP
.RS 4
Type. 
.RE
.PP

.PP
Definition at line 103 of file key.cpp.
.SS "\fBQString\fP Key::customTypeString () const"
.PP
Returns the custom type string. 
.PP
Definition at line 108 of file key.cpp.
.SS "\fBKey::TypeList\fP Key::typeList ()\fC [static]\fP"
.PP
Returns a list of all available key types. 
.PP
Definition at line 113 of file key.cpp.
.SS "\fBQString\fP Key::typeLabel (int type)\fC [static]\fP"
.PP
Returns a translated label for a given key type. 
.PP
Definition at line 123 of file key.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kabc Library from the source code.
