\section{KABC::Key Class Reference}
\label{classKABC_1_1Key}\index{KABC::Key@{KABC::Key}}
A class to store an encryption key.  


{\tt \#include $<$key.h$>$}

Collaboration diagram for KABC::Key:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=123pt]{classKABC_1_1Key__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
typedef {\bf QValue\-List}$<$ {\bf Key} $>$ {\bf List}\label{classKABC_1_1Key_w0}

\item 
typedef {\bf QValue\-List}$<$ int $>$ {\bf Type\-List}\label{classKABC_1_1Key_w1}

\item 
enum {\bf Types} \{ {\bf X509}, 
{\bf PGP}, 
{\bf Custom}
 \}
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Key} (const {\bf QString} \&text=QString::null, int type=PGP)
\item 
{\bf $\sim$Key} ()
\item 
bool {\bf operator==} (const {\bf Key} \&) const \label{classKABC_1_1Key_a2}

\item 
bool {\bf operator!=} (const {\bf Key} \&) const \label{classKABC_1_1Key_a3}

\item 
void {\bf set\-Id} (const {\bf QString} \&id)
\item 
{\bf QString} {\bf id} () const 
\item 
void {\bf set\-Binary\-Data} (const {\bf QByte\-Array} \&binary)
\item 
{\bf QByte\-Array} {\bf binary\-Data} () const 
\item 
void {\bf set\-Text\-Data} (const {\bf QString} \&text)
\item 
{\bf QString} {\bf text\-Data} () const 
\item 
bool {\bf is\-Binary} () const 
\item 
void {\bf set\-Type} (int type)
\item 
void {\bf set\-Custom\-Type\-String} (const {\bf QString} \&custom)
\item 
int {\bf type} () const 
\item 
{\bf QString} {\bf custom\-Type\-String} () const 
\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
static {\bf Type\-List} {\bf type\-List} ()
\item 
static {\bf QString} {\bf type\-Label} (int type)
\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
KABC\_\-EXPORT {\bf QData\-Stream} \& {\bf operator$<$$<$} ({\bf QData\-Stream} \&, const {\bf Key} \&)\label{classKABC_1_1Key_n0}

\item 
KABC\_\-EXPORT {\bf QData\-Stream} \& {\bf operator$>$$>$} ({\bf QData\-Stream} \&, {\bf Key} \&)\label{classKABC_1_1Key_n1}

\end{CompactItemize}


\subsection{Detailed Description}
A class to store an encryption key. 



Definition at line 33 of file key.h.

\subsection{Member Enumeration Documentation}
\index{KABC::Key@{KABC::Key}!Types@{Types}}
\index{Types@{Types}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf KABC::Key::Types}}\label{classKABC_1_1Key_w5}


{\bf Key}{\rm (p.\,\pageref{classKABC_1_1Key})} types. 

\begin{itemize}
\item X509 - X509 key \item PGP - Pretty Good Privacy key \item Custom - Custom or IANA conform key \end{itemize}


Definition at line 49 of file key.h.

\subsection{Constructor \& Destructor Documentation}
\index{KABC::Key@{KABC::Key}!Key@{Key}}
\index{Key@{Key}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Key::Key (const {\bf QString} \& {\em text} = {\tt QString::null}, int {\em type} = {\tt PGP})}\label{classKABC_1_1Key_a0}


Constructor. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em text}]The text data. \item[{\em type}]The key type, \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf Types}{\rm (p.\,\pageref{classKABC_1_1Key_w5})}. \end{Desc}


Definition at line 28 of file key.cpp.

References KApplication::random\-String().\index{KABC::Key@{KABC::Key}!~Key@{$\sim$Key}}
\index{~Key@{$\sim$Key}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Key::$\sim${\bf Key} ()}\label{classKABC_1_1Key_a1}


Destructor. 



Definition at line 34 of file key.cpp.

\subsection{Member Function Documentation}
\index{KABC::Key@{KABC::Key}!setId@{setId}}
\index{setId@{setId}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Key::set\-Id (const {\bf QString} \& {\em id})}\label{classKABC_1_1Key_a4}


Sets the unique identifier. 



Definition at line 56 of file key.cpp.

References id().\index{KABC::Key@{KABC::Key}!id@{id}}
\index{id@{id}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Key::id () const}\label{classKABC_1_1Key_a5}


Returns the unique identifier. 



Definition at line 61 of file key.cpp.

Referenced by set\-Id().\index{KABC::Key@{KABC::Key}!setBinaryData@{setBinaryData}}
\index{setBinaryData@{setBinaryData}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Key::set\-Binary\-Data (const {\bf QByte\-Array} \& {\em binary})}\label{classKABC_1_1Key_a6}


Sets binary data. 



Definition at line 66 of file key.cpp.\index{KABC::Key@{KABC::Key}!binaryData@{binaryData}}
\index{binaryData@{binaryData}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QByte\-Array} Key::binary\-Data () const}\label{classKABC_1_1Key_a7}


Returns the binary data. 



Definition at line 72 of file key.cpp.\index{KABC::Key@{KABC::Key}!setTextData@{setTextData}}
\index{setTextData@{setTextData}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Key::set\-Text\-Data (const {\bf QString} \& {\em text})}\label{classKABC_1_1Key_a8}


Sets text data. 



Definition at line 77 of file key.cpp.\index{KABC::Key@{KABC::Key}!textData@{textData}}
\index{textData@{textData}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Key::text\-Data () const}\label{classKABC_1_1Key_a9}


Returns the text data. 



Definition at line 83 of file key.cpp.\index{KABC::Key@{KABC::Key}!isBinary@{isBinary}}
\index{isBinary@{isBinary}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Key::is\-Binary () const}\label{classKABC_1_1Key_a10}


Returns whether the key contains binary or text data. 



Definition at line 88 of file key.cpp.\index{KABC::Key@{KABC::Key}!setType@{setType}}
\index{setType@{setType}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Key::set\-Type (int {\em type})}\label{classKABC_1_1Key_a11}


Sets the type,. 

\begin{Desc}
\item[See also:]Type. \end{Desc}


Definition at line 93 of file key.cpp.\index{KABC::Key@{KABC::Key}!setCustomTypeString@{setCustomTypeString}}
\index{setCustomTypeString@{setCustomTypeString}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Key::set\-Custom\-Type\-String (const {\bf QString} \& {\em custom})}\label{classKABC_1_1Key_a12}


Sets custom type string. 



Definition at line 98 of file key.cpp.\index{KABC::Key@{KABC::Key}!type@{type}}
\index{type@{type}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Key::type () const}\label{classKABC_1_1Key_a13}


Returns the type,. 

\begin{Desc}
\item[See also:]Type. \end{Desc}


Definition at line 103 of file key.cpp.\index{KABC::Key@{KABC::Key}!customTypeString@{customTypeString}}
\index{customTypeString@{customTypeString}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Key::custom\-Type\-String () const}\label{classKABC_1_1Key_a14}


Returns the custom type string. 



Definition at line 108 of file key.cpp.\index{KABC::Key@{KABC::Key}!typeList@{typeList}}
\index{typeList@{typeList}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Key::Type\-List} Key::type\-List ()\hspace{0.3cm}{\tt  [static]}}\label{classKABC_1_1Key_e0}


Returns a list of all available key types. 



Definition at line 113 of file key.cpp.\index{KABC::Key@{KABC::Key}!typeLabel@{typeLabel}}
\index{typeLabel@{typeLabel}!KABC::Key@{KABC::Key}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Key::type\-Label (int {\em type})\hspace{0.3cm}{\tt  [static]}}\label{classKABC_1_1Key_e1}


Returns a translated label for a given key type. 



Definition at line 123 of file key.cpp.

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
key.h\item 
key.cpp\end{CompactItemize}
