KContacts::VCardConverter Class Reference

#include <vcardconverter.h>

Public Types
enum	Version { v2_1 , v3_0 , v4_0 }

Public Member Functions
	VCardConverter ()
	~VCardConverter ()
QByteArray	createVCard (const Addressee &addr, Version version=v3_0) const
QByteArray	createVCards (const Addressee::List &list, Version version=v3_0) const
QByteArray	exportVCard (const Addressee &addr, Version version) const
QByteArray	exportVCards (const Addressee::List &list, Version version) const
Addressee	parseVCard (const QByteArray &vcard) const
Addressee::List	parseVCards (const QByteArray &vcard) const

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( QIODevice::ReadOnly );
 
QByteArray data = file.readAll();
 
VCardConverter converter;
Addressee::List list = converter.parseVCards( data );
 
// print formatted name of first contact
qDebug( "name=%s", list[ 0 ].formattedName().toLatin1() );

Definition at line 40 of file vcardconverter.h.

Member Enumeration Documentation

Version

enum KContacts::VCardConverter::Version

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

Definition at line 48 of file vcardconverter.h.

Constructor & Destructor Documentation

VCardConverter()

VCardConverter::VCardConverter

(

)

Constructor.

Definition at line 13 of file vcardconverter.cpp.

~VCardConverter()

VCardConverter::~VCardConverter

(

)

Destructor.

Definition at line 18 of file vcardconverter.cpp.

Member Function Documentation

createVCard()

QByteArray VCardConverter::createVCard	(	const Addressee &	addr,
		Version	version = v3_0 ) const

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 49 of file vcardconverter.cpp.

createVCards()

QByteArray VCardConverter::createVCards	(	const Addressee::List &	list,
		Version	version = v3_0 ) const

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 57 of file vcardconverter.cpp.

exportVCard()

QByteArray VCardConverter::exportVCard	(	const Addressee &	addr,
		Version	version ) const

Since

4.9.1

Definition at line 22 of file vcardconverter.cpp.

exportVCards()

QByteArray VCardConverter::exportVCards	(	const Addressee::List &	list,
		Version	version ) const

Since

4.9.1

Definition at line 30 of file vcardconverter.cpp.

parseVCard()

Addressee VCardConverter::parseVCard

(

const QByteArray &

vcard

)

const

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

Definition at line 76 of file vcardconverter.cpp.

parseVCards()

Addressee::List VCardConverter::parseVCards

(

const QByteArray &

vcard

)

const

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

Definition at line 83 of file vcardconverter.cpp.

---

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

• vcardconverter.h
• vcardconverter.cpp