.TH "KABC::VCardConverter" kde3 "11 Jun 2005" "Version Version 3.4.1" "kabc Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KABC::VCardConverter \- Class to converting contact objects into vCard format and vice versa.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <vcardconverter.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBVersion\fP { \fBv2_1\fP, \fBv3_0\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBVCardConverter\fP ()"
.br
.ti -1c
.RI "\fB~VCardConverter\fP ()"
.br
.ti -1c
.RI "\fBQString\fP \fBcreateVCard\fP (const \fBAddressee\fP &addr, \fBVersion\fP version=v3_0)"
.br
.ti -1c
.RI "\fBQString\fP \fBcreateVCards\fP (\fBAddressee::List\fP list, \fBVersion\fP version=v3_0)"
.br
.ti -1c
.RI "\fBAddressee\fP \fBparseVCard\fP (const \fBQString\fP &vcard)"
.br
.ti -1c
.RI "\fBAddressee::List\fP \fBparseVCards\fP (const \fBQString\fP &vcard)"
.br
.ti -1c
.RI "bool \fBvCardToAddressee\fP (const \fBQString\fP &, \fBAddressee\fP &, \fBVersion\fP version=v3_0) KDE_DEPRECATED"
.br
.ti -1c
.RI "bool \fBaddresseeToVCard\fP (const \fBAddressee\fP &, \fBQString\fP &, \fBVersion\fP version=v3_0) KDE_DEPRECATED"
.br
.in -1c
.SH "Detailed Description"
.PP 
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.
.PP
Example:
.PP
.PP
.nf
  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() );
.fi
.PP
 
.PP
Definition at line 56 of file vcardconverter.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKABC::VCardConverter::Version\fP"
.PP
.PD 0
.IP "\(bu" 2
v2_1 - VCard format version 2.1 
.IP "\(bu" 2
v3_0 - VCard format version 3.0 
.PP

.PP
Definition at line 64 of file vcardconverter.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KABC::VCardConverter::VCardConverter ()"
.PP
Constructor. 
.PP
.SS "KABC::VCardConverter::~\fBVCardConverter\fP ()"
.PP
Destructor. 
.PP
.SH "Member Function Documentation"
.PP 
.SS "\fBQString\fP KABC::VCardConverter::createVCard (const \fBAddressee\fP & addr, \fBVersion\fP version = \fCv3_0\fP)"
.PP
Creates a string in vCard format which contains the given contact. 
.PP
\fBParameters:\fP
.RS 4
\fIaddr\fP The contact object 
.br
\fIversion\fP The version of the generated vCard format 
.RE
.PP

.SS "\fBQString\fP KABC::VCardConverter::createVCards (\fBAddressee::List\fP list, \fBVersion\fP version = \fCv3_0\fP)"
.PP
Creates a string in vCard format which contains the given list of contact. 
.PP
\fBParameters:\fP
.RS 4
\fIlist\fP The list of contact objects 
.br
\fIversion\fP The version of the generated vCard format 
.RE
.PP

.PP
Referenced by KABC::VCardFormatPlugin::save(), and KABC::VCardFormatPlugin::saveAll().
.SS "\fBAddressee\fP KABC::VCardConverter::parseVCard (const \fBQString\fP & vcard)"
.PP
Parses a string in vCard format and returns the first contact. 
.PP
.SS "\fBAddressee::List\fP KABC::VCardConverter::parseVCards (const \fBQString\fP & vcard)"
.PP
Parses a string in vCard format and returns a list of contact objects. 
.PP
Referenced by KABC::VCardFormatPlugin::load(), and KABC::VCardFormatPlugin::loadAll().
.SS "bool KABC::VCardConverter::vCardToAddressee (const \fBQString\fP &, \fBAddressee\fP &, \fBVersion\fP version = \fCv3_0\fP)"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.SS "bool KABC::VCardConverter::addresseeToVCard (const \fBAddressee\fP &, \fBQString\fP &, \fBVersion\fP version = \fCv3_0\fP)"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP


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