.TH "KABC::FormatPlugin" 3 "28 Jan 2004" "kabc Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KABC::FormatPlugin \- Base class for address book formats.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <formatplugin.h>\fP
.PP
Inherits Plugin.
.PP
Inherited by \fBKABC::BinaryFormat\fP, and \fBKABC::VCardFormatPlugin\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual bool \fBload\fP (\fBAddressee\fP &, \fBQFile\fP *file)=0"
.br
.RI "\fILoad single addressee from file. \fP"
.ti -1c
.RI "virtual bool \fBloadAll\fP (\fBAddressBook\fP *, Resource *, \fBQFile\fP *file)=0"
.br
.RI "\fILoad whole addressbook from file. \fP"
.ti -1c
.RI "virtual void \fBsave\fP (const  \fBAddressee\fP &, \fBQFile\fP *file)=0"
.br
.RI "\fISave a single \fBAddressee\fP to file. \fP"
.ti -1c
.RI "virtual void \fBsaveAll\fP (\fBAddressBook\fP *, Resource *, \fBQFile\fP *file)=0"
.br
.RI "\fISave whole addressbook to file. \fP"
.ti -1c
.RI "virtual bool \fBcheckFormat\fP (\fBQFile\fP *file) const =0"
.br
.RI "\fIChecks if given file contains the right format. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Base class for address book formats. 

This class provides an abstract interface for ResourceFile and ResourceDir formats. 
.PP
Definition at line 42 of file formatplugin.h.
.SH "Member Function Documentation"
.PP 
.SS "virtual bool KABC::FormatPlugin::load (\fBAddressee\fP &, \fBQFile\fP * file)\fC [pure virtual]\fP"
.PP
Load single addressee from file. Implemented in \fBKABC::BinaryFormat\fP, and \fBKABC::VCardFormatPlugin\fP.
.SS "virtual bool KABC::FormatPlugin::loadAll (\fBAddressBook\fP *, Resource *, \fBQFile\fP * file)\fC [pure virtual]\fP"
.PP
Load whole addressbook from file. Implemented in \fBKABC::BinaryFormat\fP, and \fBKABC::VCardFormatPlugin\fP.
.PP
Referenced by KABC::ResourceIMAP::load().
.SS "virtual void KABC::FormatPlugin::save (const \fBAddressee\fP &, \fBQFile\fP * file)\fC [pure virtual]\fP"
.PP
Save a single \fBAddressee\fP to file. Implemented in \fBKABC::BinaryFormat\fP, and \fBKABC::VCardFormatPlugin\fP.
.SS "virtual void KABC::FormatPlugin::saveAll (\fBAddressBook\fP *, Resource *, \fBQFile\fP * file)\fC [pure virtual]\fP"
.PP
Save whole addressbook to file. Implemented in \fBKABC::BinaryFormat\fP, and \fBKABC::VCardFormatPlugin\fP.
.PP
Referenced by KABC::ResourceIMAP::save().
.SS "virtual bool KABC::FormatPlugin::checkFormat (\fBQFile\fP * file) const\fC [pure virtual]\fP"
.PP
Checks if given file contains the right format. Implemented in \fBKABC::BinaryFormat\fP, and \fBKABC::VCardFormatPlugin\fP.

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