KABC::FormatPlugin class Reference (kabc Library)

| # kabc Library API Documentation
Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Source Files

# KABC::FormatPlugin Class Reference

Base class for address book formats. More...

`#include <formatplugin.h>`

Inheritance diagram for KABC::FormatPlugin:

[legend]
List of all members.

## Public Member Functions
virtual bool | load (Addressee &, QFile *file)=0
| Load single addressee from file.
virtual bool | loadAll (AddressBook *, Resource *, QFile *file)=0
| Load whole addressbook from file.
virtual void | save (const Addressee &, QFile *file)=0
| Save a single Addressee to file.
virtual void | saveAll (AddressBook *, Resource *, QFile *file)=0
| Save whole addressbook to file.
virtual bool | checkFormat (QFile *file) const =0
| Checks if given file contains the right format.

## Detailed Description

Base class for address book formats.

This class provides an abstract interface for ResourceFile and ResourceDir formats.

Definition at line 42 of file formatplugin.h.

## Member Function Documentation

virtual bool KABC::FormatPlugin::load | ( | Addressee & | ,
|  | QFile * | file
| ) | `[pure virtual]`

| Load single addressee from file. Implemented in KABC::BinaryFormat, and KABC::VCardFormatPlugin.

virtual bool KABC::FormatPlugin::loadAll | ( | AddressBook * | ,
|  | Resource * | ,
|  | QFile * | file
| ) | `[pure virtual]`

| Load whole addressbook from file. Implemented in KABC::BinaryFormat, and KABC::VCardFormatPlugin. Referenced by KABC::ResourceIMAP::load().

virtual void KABC::FormatPlugin::save | ( | const Addressee & | ,
|  | QFile * | file
| ) | `[pure virtual]`

| Save a single Addressee to file. Implemented in KABC::BinaryFormat, and KABC::VCardFormatPlugin.

virtual void KABC::FormatPlugin::saveAll | ( | AddressBook * | ,
|  | Resource * | ,
|  | QFile * | file
| ) | `[pure virtual]`

| Save whole addressbook to file. Implemented in KABC::BinaryFormat, and KABC::VCardFormatPlugin. Referenced by KABC::ResourceIMAP::save().

virtual bool KABC::FormatPlugin::checkFormat | ( | QFile * | file | ) | const`[pure virtual]`

| Checks if given file contains the right format. Implemented in KABC::BinaryFormat, and KABC::VCardFormatPlugin.

The documentation for this class was generated from the following file:

- formatplugin.h

This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Jan 28 13:29:44 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001