/usr/include/KF5/KContacts/kcontacts/vcardconverter.h is in libkf5contacts-dev 4:17.12.3-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | /*
This file is part of the KContacts framework.
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 KCONTACTS_VCARDCONVERTER_H
#define KCONTACTS_VCARDCONVERTER_H
#include "kcontacts_export.h"
#include "kcontacts/addressee.h"
#include <QString>
namespace KContacts
{
/**
@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( 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() );
\endcode
*/
class KCONTACTS_EXPORT VCardConverter
{
public:
/**
@li v2_1 - VCard format version 2.1
@li v3_0 - VCard format version 3.0
@li v4_0 - VCard format version 4.0
*/
enum Version {
v2_1,
v3_0,
v4_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
*/
QByteArray createVCard(const Addressee &addr, Version version = v3_0) const;
/**
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
QByteArray createVCards(const Addressee::List &list, Version version = v3_0) const;
/**
* @since 4.9.1
*/
QByteArray exportVCard(const Addressee &addr, Version version) const;
/**
* @since 4.9.1
*/
QByteArray exportVCards(const Addressee::List &list, Version version) const;
/**
Parses a string in vCard format and returns the first contact.
*/
Addressee parseVCard(const QByteArray &vcard) const;
/**
Parses a string in vCard format and returns a list of contact objects.
*/
// FIXME: Add error handling
Addressee::List parseVCards(const QByteArray &vcard) const;
private:
Q_DISABLE_COPY(VCardConverter)
class VCardConverterPrivate;
VCardConverterPrivate *const 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
*/
KCONTACTS_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
*/
KCONTACTS_EXPORT QString dateToVCardString(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.
*/
KCONTACTS_EXPORT QDateTime VCardStringToDate(const QString &dateString);
/**
* @brief adaptIMAttributes. Convert KAddressBook attribute to VCard IM Attribute
* @param data
*/
KCONTACTS_EXPORT void adaptIMAttributes(QByteArray &data);
}
#endif
|