summaryrefslogtreecommitdiffstats
path: root/kabc/vcardconverter.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitce4a32fe52ef09d8f5ff1dd22c001110902b60a2 (patch)
tree5ac38a06f3dde268dc7927dc155896926aaf7012 /kabc/vcardconverter.h
downloadtdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.tar.gz
tdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kabc/vcardconverter.h')
-rw-r--r--kabc/vcardconverter.h163
1 files changed, 163 insertions, 0 deletions
diff --git a/kabc/vcardconverter.h b/kabc/vcardconverter.h
new file mode 100644
index 000000000..6c427d0a9
--- /dev/null
+++ b/kabc/vcardconverter.h
@@ -0,0 +1,163 @@
+/*
+ This file is part of libkabc.
+ Copyright (c) 2002 Tobias Koenig <tokoe@kde.org>
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Library General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Library General Public License for more details.
+
+ You should have received a copy of the GNU Library General Public License
+ along with this library; see the file COPYING.LIB. If not, write to
+ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
+*/
+
+#ifndef KABC_VCARDCONVERTER_H
+#define KABC_VCARDCONVERTER_H
+
+#include <qstring.h>
+
+#include "addressee.h"
+
+namespace KABC {
+
+/**
+ @short 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:
+
+ \code
+
+ QFile file( "myfile.vcf" );
+ file.open( IO_ReadOnly );
+
+ QString data = file.readAll();
+
+ VCardConverter converter;
+ Addressee::List list = converter.parseVCards( data );
+
+ // print formatted name of first contact
+ qDebug( "name=%s", list[ 0 ].formattedName().latin1() );
+
+ \endcode
+*/
+class KABC_EXPORT VCardConverter
+{
+ public:
+
+ /**
+ @li v2_1 - VCard format version 2.1
+ @li v3_0 - VCard format version 3.0
+ */
+ enum Version
+ {
+ v2_1,
+ v3_0
+ };
+
+ /**
+ Constructor.
+ */
+ VCardConverter();
+
+ /**
+ Destructor.
+ */
+ ~VCardConverter();
+
+ /**
+ Creates a string in vCard format which contains the given
+ contact.
+
+ @param addr The contact object
+ @param version The version of the generated vCard format
+ */
+ QString createVCard( const Addressee &addr, Version version = v3_0 );
+
+ /**
+ Creates a string in vCard format which contains the given
+ list of contact.
+
+ @param list The list of contact objects
+ @param version The version of the generated vCard format
+ */
+ // FIXME: Add error handling
+ QString createVCards( Addressee::List list, Version version = v3_0 );
+
+ // FIXME: Add "createVCards( AddressBook * )"
+
+ /**
+ Parses a string in vCard format and returns the first contact.
+ */
+ Addressee parseVCard( const QString& vcard );
+
+ /**
+ Parses a string in vCard format and returns a list of contact objects.
+ */
+ // FIXME: Add error handling
+ Addressee::List parseVCards( const QString& vcard );
+
+ // FIXME: Add "bool parseVCards( AddressBook *, const QString &vcard )"
+
+ /**
+ @deprecated
+ */
+ bool vCardToAddressee( const QString&, Addressee &, Version version = v3_0 ) KDE_DEPRECATED;
+
+ /**
+ @deprecated
+ */
+ bool addresseeToVCard( const Addressee&, QString&, Version version = v3_0 ) KDE_DEPRECATED;
+
+ private:
+ /**
+ Split a string and replaces escaped separators on the fly with
+ unescaped ones.
+ */
+ QStringList splitString( const QChar &sep, const QString &value );
+
+ struct VCardConverterData;
+ VCardConverterData *d;
+};
+
+
+/**
+ Helper functions
+ */
+
+/**
+ * Converts a QDateTime to a date string as it is used in VCard and LDIF files.
+ * The return value is in the form "yyyyMMddThhmmssZ" (e.g. "20031201T120000Z")
+ * @param dateTime date and time to be converted
+ * @since 3.2
+ */
+KABC_EXPORT QString dateToVCardString( const QDateTime &dateTime );
+
+/**
+ * Converts a QDate to a short date string as it is used in VCard and LDIF files.
+ * The return value is in the form "yyyyMMdd" (e.g. "20031201")
+ * @param date date to be converted
+ * @since 3.2
+ */
+KABC_EXPORT QString dateToVCardString( const QDate &date );
+
+/**
+ * Converts a date string as it is used in VCard and LDIF files to a QDateTime value.
+ * If the date string does not contain a time value, it will be returned as 00:00:00.
+ * (e.g. "20031201T120000" will return a QDateTime for 2003-12-01 at 12:00)
+ * @param dateString string representing the date and time.
+ * @since 3.2
+ */
+KABC_EXPORT QDateTime VCardStringToDate( const QString &dateString );
+
+}
+#endif