kabc Library API Documentation

KABC::VCardConverter Class Reference

Class to converting contact objects into vCard format and vice versa. More...

#include <vcardconverter.h>

List of all members.

Public Types

enum  Version

Public Methods

 VCardConverter ()
 ~VCardConverter ()
QString createVCard (const Addressee &addr, Version version=v3_0)
QString createVCards (Addressee::List list, Version version=v3_0)
Addressee parseVCard (const QString &vcard)
Addressee::List parseVCards (const QString &vcard)
bool vCardToAddressee (const QString &, Addressee &, Version version=v3_0) KDE_DEPRECATED
bool addresseeToVCard (const Addressee &, QString &, Version version=v3_0) KDE_DEPRECATED


Detailed Description

Class to converting contact objects into vCard format and vice versa.

This class implements reading and writing of contact using from/to the vCard format. Currently vCard version 2.1 and 3.0 is supported.

Example:

  QFile file( "myfile.vcf" );
  file.open( IO_ReadOnly );
  
  QTextStream s( &file );
  s.setEncoding( QTextStream::UnicodeUTF8 );

  QString data = s.read();

  VCardConverter converter;
  Addressee::List list = converter.parseVCards( data );

  // print formatted name of first contact
  qDebug( "name=%s", list[ 0 ].formattedName().latin1() );

Definition at line 56 of file vcardconverter.h.


Member Enumeration Documentation

enum KABC::VCardConverter::Version
 

  • v2_1 - VCard format version 2.1
  • v3_0 - VCard format version 3.0

Definition at line 64 of file vcardconverter.h.


Constructor & Destructor Documentation

VCardConverter::VCardConverter  
 

Constructor.

Definition at line 35 of file vcardconverter.cpp.

VCardConverter::~VCardConverter  
 

Destructor.

Definition at line 40 of file vcardconverter.cpp.


Member Function Documentation

QString VCardConverter::createVCard const Addressee   addr,
Version    version = v3_0
 

Creates a string in vCard format which contains the given contact.

Parameters:
addr  The contact object
version  The version of the generated vCard format

Definition at line 46 of file vcardconverter.cpp.

References QValueList< Addressee >::append(), createVCards(), and KDE::version().

QString VCardConverter::createVCards Addressee::List    list,
Version    version = v3_0
 

Creates a string in vCard format which contains the given list of contact.

Parameters:
list  The list of contact objects
version  The version of the generated vCard format

Definition at line 54 of file vcardconverter.cpp.

References KDE::version().

Referenced by createVCard(), KABC::VCardFormatPlugin::save(), and KABC::VCardFormatPlugin::saveAll().

Addressee VCardConverter::parseVCard const QString   vcard
 

Parses a string in vCard format and returns the first contact.

Definition at line 61 of file vcardconverter.cpp.

References parseVCards().

Addressee::List VCardConverter::parseVCards const QString   vcard
 

Parses a string in vCard format and returns a list of contact objects.

Definition at line 68 of file vcardconverter.cpp.

Referenced by KABC::VCardFormatPlugin::load(), KABC::VCardFormatPlugin::loadAll(), and parseVCard().

bool VCardConverter::vCardToAddressee const QString  ,
Addressee  ,
Version    version = v3_0
 

Deprecated:

Definition at line 77 of file vcardconverter.cpp.

References KDE::version().

bool VCardConverter::addresseeToVCard const Addressee  ,
QString  ,
Version    version = v3_0
 

Deprecated:

Definition at line 90 of file vcardconverter.cpp.

References KDE::version().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kabc Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 22 14:25:37 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003