\section{KABC::Format\-Plugin Class Reference}
\label{classKABC_1_1FormatPlugin}\index{KABC::FormatPlugin@{KABC::FormatPlugin}}
Base class for address book formats.  


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

Inheritance diagram for KABC::Format\-Plugin:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=160pt]{classKABC_1_1FormatPlugin__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
virtual bool {\bf load} ({\bf Addressee} \&, {\bf QFile} $\ast$file)=0
\begin{CompactList}\small\item\em Load single addressee from file. \item\end{CompactList}\item 
virtual bool {\bf load\-All} ({\bf Address\-Book} $\ast$, Resource $\ast$, {\bf QFile} $\ast$file)=0
\begin{CompactList}\small\item\em Load whole addressbook from file. \item\end{CompactList}\item 
virtual void {\bf save} (const  {\bf Addressee} \&, {\bf QFile} $\ast$file)=0
\begin{CompactList}\small\item\em Save a single {\bf Addressee}{\rm (p.\,\pageref{classKABC_1_1Addressee})} to file. \item\end{CompactList}\item 
virtual void {\bf save\-All} ({\bf Address\-Book} $\ast$, Resource $\ast$, {\bf QFile} $\ast$file)=0
\begin{CompactList}\small\item\em Save whole addressbook to file. \item\end{CompactList}\item 
virtual bool {\bf check\-Format} ({\bf QFile} $\ast$file) const =0
\begin{CompactList}\small\item\em Checks if given file contains the right format. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Base class for address book formats. 

This class provides an abstract interface for Resource\-File and Resource\-Dir formats. 



Definition at line 42 of file formatplugin.h.

\subsection{Member Function Documentation}
\index{KABC::FormatPlugin@{KABC::Format\-Plugin}!load@{load}}
\index{load@{load}!KABC::FormatPlugin@{KABC::Format\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KABC::Format\-Plugin::load ({\bf Addressee} \&, {\bf QFile} $\ast$ {\em file})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKABC_1_1FormatPlugin_a0}


Load single addressee from file. 



Implemented in {\bf KABC::Binary\-Format} {\rm (p.\,\pageref{classKABC_1_1BinaryFormat_a0})}, and {\bf KABC::VCard\-Format\-Plugin} {\rm (p.\,\pageref{classKABC_1_1VCardFormatPlugin_a2})}.\index{KABC::FormatPlugin@{KABC::Format\-Plugin}!loadAll@{loadAll}}
\index{loadAll@{loadAll}!KABC::FormatPlugin@{KABC::Format\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KABC::Format\-Plugin::load\-All ({\bf Address\-Book} $\ast$, Resource $\ast$, {\bf QFile} $\ast$ {\em file})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKABC_1_1FormatPlugin_a1}


Load whole addressbook from file. 



Implemented in {\bf KABC::Binary\-Format} {\rm (p.\,\pageref{classKABC_1_1BinaryFormat_a1})}, and {\bf KABC::VCard\-Format\-Plugin} {\rm (p.\,\pageref{classKABC_1_1VCardFormatPlugin_a3})}.

Referenced by KABC::Resource\-IMAP::load().\index{KABC::FormatPlugin@{KABC::Format\-Plugin}!save@{save}}
\index{save@{save}!KABC::FormatPlugin@{KABC::Format\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KABC::Format\-Plugin::save (const {\bf Addressee} \&, {\bf QFile} $\ast$ {\em file})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKABC_1_1FormatPlugin_a2}


Save a single {\bf Addressee}{\rm (p.\,\pageref{classKABC_1_1Addressee})} to file. 



Implemented in {\bf KABC::Binary\-Format} {\rm (p.\,\pageref{classKABC_1_1BinaryFormat_a2})}, and {\bf KABC::VCard\-Format\-Plugin} {\rm (p.\,\pageref{classKABC_1_1VCardFormatPlugin_a4})}.\index{KABC::FormatPlugin@{KABC::Format\-Plugin}!saveAll@{saveAll}}
\index{saveAll@{saveAll}!KABC::FormatPlugin@{KABC::Format\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KABC::Format\-Plugin::save\-All ({\bf Address\-Book} $\ast$, Resource $\ast$, {\bf QFile} $\ast$ {\em file})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKABC_1_1FormatPlugin_a3}


Save whole addressbook to file. 



Implemented in {\bf KABC::Binary\-Format} {\rm (p.\,\pageref{classKABC_1_1BinaryFormat_a3})}, and {\bf KABC::VCard\-Format\-Plugin} {\rm (p.\,\pageref{classKABC_1_1VCardFormatPlugin_a5})}.

Referenced by KABC::Resource\-IMAP::save().\index{KABC::FormatPlugin@{KABC::Format\-Plugin}!checkFormat@{checkFormat}}
\index{checkFormat@{checkFormat}!KABC::FormatPlugin@{KABC::Format\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KABC::Format\-Plugin::check\-Format ({\bf QFile} $\ast$ {\em file}) const\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKABC_1_1FormatPlugin_a4}


Checks if given file contains the right format. 



Implemented in {\bf KABC::Binary\-Format} {\rm (p.\,\pageref{classKABC_1_1BinaryFormat_a4})}, and {\bf KABC::VCard\-Format\-Plugin} {\rm (p.\,\pageref{classKABC_1_1VCardFormatPlugin_a6})}.

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