addressee.h

/*
    This file is part of the KContacts framework.
    Copyright (c) 2001 Cornelius Schumacher <[email protected]>
                  2013 Tobias Koenig <[email protected]>

    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_ADDRESSEE_H
#define KCONTACTS_ADDRESSEE_H

#include <QDateTime>
#include <QStringList>
#include <QSharedDataPointer>
#include <QUrl>
#include <QMap>

#include "address.h"
#include "geo.h"
#include "key.h"
#include "email.h"
#include "lang.h"
#include "gender.h"
#include "phonenumber.h"
#include "picture.h"
#include "secrecy.h"
#include "sound.h"
#include "impp.h"
#include "timezone.h"
#include "calendarurl.h"
#include "related.h"
#include "addresseelist.h"
#include "resourcelocatorurl.h"
#include "fieldgroup.h"
#include "title.h"
#include "nickname.h"
#include "role.h"
#include "org.h"
#include "clientpidmap.h"

namespace KContacts {
class KCONTACTS_EXPORT Addressee
{
    friend KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &, const Addressee &);
    friend KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &, Addressee &);

    Q_GADGET
    Q_PROPERTY(bool isEmpty READ isEmpty)
    Q_PROPERTY(QString uid READ uid WRITE setUid)
    Q_PROPERTY(QString name READ name WRITE setName)
    Q_PROPERTY(QString formattedName READ formattedName WRITE setFormattedName)
    Q_PROPERTY(QString familyName READ familyName WRITE setFamilyName)
    Q_PROPERTY(QString givenName READ givenName WRITE setGivenName)
    Q_PROPERTY(QString additionalName READ additionalName WRITE setAdditionalName)
    Q_PROPERTY(QString prefix READ prefix WRITE setPrefix)
    Q_PROPERTY(QString suffix READ suffix WRITE setSuffix)
    Q_PROPERTY(QString nickName READ nickName)
    Q_PROPERTY(QDateTime birthday READ birthday) // ### can't set this due to withTime argument
    Q_PROPERTY(bool birthdayHasTime READ birthdayHasTime)
    Q_PROPERTY(QString mailer READ mailer WRITE setMailer)
    Q_PROPERTY(KContacts::Geo geo READ geo WRITE setGeo)
    Q_PROPERTY(QString title READ title)
    Q_PROPERTY(QString role READ role)
    Q_PROPERTY(QString organization READ organization)
    Q_PROPERTY(QString department READ department WRITE setDepartment)
    Q_PROPERTY(QString note READ note WRITE setNote)
    Q_PROPERTY(QString productId READ productId WRITE setProductId)
    Q_PROPERTY(QDateTime revision READ revision)
    Q_PROPERTY(QString sortString READ sortString WRITE setSortString)
    Q_PROPERTY(KContacts::ResourceLocatorUrl url READ url WRITE setUrl)
    Q_PROPERTY(QString realName READ realName)
    Q_PROPERTY(QString assembledName READ assembledName)
    Q_PROPERTY(QString preferredEmail READ preferredEmail)
    Q_PROPERTY(QStringList categories READ categories WRITE setCategories)
    Q_PROPERTY(QStringList customs READ customs)
    Q_PROPERTY(bool changed READ changed WRITE setChanged)
    Q_PROPERTY(QDate anniversary READ anniversary WRITE setAnniversary)
    Q_PROPERTY(QString assistantsName READ assistantsName WRITE setAssistantsName)
    Q_PROPERTY(QUrl blogFeed READ blogFeed WRITE setBlogFeed)
    Q_PROPERTY(QString managersName READ managersName WRITE setManagersName)
    Q_PROPERTY(QString office READ office WRITE setOffice)
    Q_PROPERTY(QString profession READ profession WRITE setProfession)
    Q_PROPERTY(QString spousesName READ spousesName WRITE setSpousesName)

    // using variants for QML compatibility, can be changed to proper types once QML supports that
    Q_PROPERTY(QVariantList emails READ emailsVariant)
    Q_PROPERTY(QVariantList phoneNumbers READ phoneNumbersVariant)
    Q_PROPERTY(QVariantList addresses READ addressesVariant)
    Q_PROPERTY(QVariantList urls READ urlsVariant)
    Q_PROPERTY(QVariantList impps READ imppsVariant)

    // ### the following properties are still missing:
    // - logos, photos, sounds
    // - keys
    // - the list variants for nicks, titles, roles, orgs
    // - timezone, secrecy, gender, kind, members, relationships, language
    // - field groups, sourceUrls, calendarUrls

public:
    typedef AddresseeList List;
    typedef QHash<QString, Addressee> Map;

    Addressee();

    ~Addressee();

    Addressee(const Addressee &other);

    Addressee &operator=(const Addressee &other);

    bool operator==(const Addressee &other) const;

    bool operator!=(const Addressee &other) const;

    bool isEmpty() const;

    void setUid(const QString &uid);

    QString uid() const;

    static QString uidLabel();

    void setName(const QString &name);

    QString name() const;

    static QString nameLabel();

    void setFormattedName(const QString &formattedName);

    QString formattedName() const;

    static QString formattedNameLabel();

    void setFamilyName(const QString &familyName);

    QString familyName() const;

    static QString familyNameLabel();

    void setGivenName(const QString &givenName);

    QString givenName() const;

    static QString givenNameLabel();

    void setAdditionalName(const QString &additionalName);

    QString additionalName() const;

    static QString additionalNameLabel();

    void setPrefix(const QString &prefix);

    QString prefix() const;

    static QString prefixLabel();

    void setSuffix(const QString &suffix);

    QString suffix() const;

    static QString suffixLabel();

    void setNickName(const QString &nickName);
    void setNickName(const NickName &nickName);
    void insertExtraNickName(const NickName &nickName);
    void setExtraNickNameList(const NickName::List &nickNameList);
    NickName::List extraNickNameList() const;

    QString nickName() const;

    static QString nickNameLabel();

    void setBirthday(const QDateTime &birthday, bool withTime = true);

    void setBirthday(const QDate &birthday);

    QDateTime birthday() const;

    bool birthdayHasTime() const;

    static QString birthdayLabel();

    static QString homeAddressStreetLabel();

    static QString homeAddressPostOfficeBoxLabel();

    static QString homeAddressLocalityLabel();

    static QString homeAddressRegionLabel();

    static QString homeAddressPostalCodeLabel();

    static QString homeAddressCountryLabel();

    static QString homeAddressLabelLabel();

    static QString businessAddressStreetLabel();

    static QString businessAddressPostOfficeBoxLabel();

    static QString businessAddressLocalityLabel();

    static QString businessAddressRegionLabel();

    static QString businessAddressPostalCodeLabel();

    static QString businessAddressCountryLabel();

    static QString businessAddressLabelLabel();

    static QString homePhoneLabel();

    static QString businessPhoneLabel();

    static QString mobilePhoneLabel();

    static QString homeFaxLabel();

    static QString businessFaxLabel();

    static QString carPhoneLabel();

    static QString isdnLabel();

    static QString pagerLabel();

    static QString emailLabel();

    void setMailer(const QString &mailer);

    QString mailer() const;

    static QString mailerLabel();

    void setTimeZone(const TimeZone &timeZone);

    TimeZone timeZone() const;

    static QString timeZoneLabel();

    void setGeo(const Geo &geo);

    Geo geo() const;

    static QString geoLabel();

    //Remove in kf6
    void setTitle(const QString &title);
    void setTitle(const Title &title);
    void insertExtraTitle(const Title &title);
    void setExtraTitleList(const Title::List &urltitle);
    Title::List extraTitleList() const;
    QString title() const;

    static QString titleLabel();

    void setRole(const QString &role);
    void setRole(const Role &role);
    void insertExtraRole(const Role &role);
    void setExtraRoleList(const Role::List &roleList);
    Role::List extraRoleList() const;

    QString role() const;

    static QString roleLabel();

    //Remove in kf6
    void setOrganization(const QString &organization);
    void setOrganization(const Org &organization);
    void insertExtraOrganization(const Org &organization);
    void setExtraOrganizationList(const Org::List &orgList);
    Org::List extraOrganizationList() const;

    QString organization() const;

    static QString organizationLabel();

    void setDepartment(const QString &department);

    QString department() const;

    static QString departmentLabel();

    void setNote(const QString &note);

    QString note() const;

    static QString noteLabel();

    void setProductId(const QString &productId);

    QString productId() const;

    static QString productIdLabel();

    void setRevision(const QDateTime &revision);

    QDateTime revision() const;

    static QString revisionLabel();

    void setSortString(const QString &sortString);

    QString sortString() const;

    static QString sortStringLabel();

    void setUrl(const ResourceLocatorUrl &url);
    //kf6: remove it
    void setUrl(const QUrl &url);

    ResourceLocatorUrl url() const;

    static QString urlLabel();

    void setSecrecy(const Secrecy &secrecy);

    Secrecy secrecy() const;

    static QString secrecyLabel();

    void setLogo(const Picture &logo);

    Picture logo() const;

    static QString logoLabel();

    void setPhoto(const Picture &photo);

    Picture photo() const;

    static QString photoLabel();

    void setSound(const Sound &sound);

    Sound sound() const;

    static QString soundLabel();

    void setNameFromString(const QString &s);

    QString realName() const;

    QString assembledName() const;

    QString fullEmail(const QString &email = QString()) const;

    void insertEmail(const QString &email, bool preferred = false, const QMap<QString, QStringList> &param = QMap<QString, QStringList>());

    void removeEmail(const QString &email);

    QString preferredEmail() const;

    QStringList emails() const;

    void setEmails(const QStringList &list);

    void insertPhoneNumber(const PhoneNumber &phoneNumber);

    void removePhoneNumber(const PhoneNumber &phoneNumber);

    PhoneNumber phoneNumber(PhoneNumber::Type type) const;

    PhoneNumber::List phoneNumbers() const;

    void setPhoneNumbers(const PhoneNumber::List &phoneNumbers);

    PhoneNumber::List phoneNumbers(PhoneNumber::Type type) const;

    PhoneNumber findPhoneNumber(const QString &id) const;

    void insertKey(const Key &key);

    void removeKey(const Key &key);

    Key key(Key::Type type, const QString &customTypeString = QString()) const;

    Key::List keys() const;

    void setKeys(const Key::List &keys);

    Key::List keys(Key::Type type, const QString &customTypeString = QString()) const;

    Key findKey(const QString &id) const;

    void insertAddress(const Address &address);

    void removeAddress(const Address &address);

    Address address(Address::Type type) const;

    Address::List addresses() const;

    Address::List addresses(Address::Type type) const;

    Address findAddress(const QString &id) const;

    void insertCategory(const QString &category);

    void removeCategory(const QString &category);

    bool hasCategory(const QString &category) const;

    void setCategories(const QStringList &category);

    QStringList categories() const;

    void insertCustom(const QString &app, const QString &name, const QString &value);

    void removeCustom(const QString &app, const QString &name);

    QString custom(const QString &app, const QString &name) const;

    void setCustoms(const QStringList &customs);

    QStringList customs() const;

    static void parseEmailAddress(const QString &rawEmail, QString &fullName, QString &email);

    QString toString() const;

    void setChanged(bool value);

    bool changed() const;

    static QString mimeType();

    KContacts::Email::List emailList() const;
    void setEmailList(const Email::List &list);

    void removeLang(const QString &language);
    void insertLang(const Lang &language);
    Lang::List langs() const;
    void setLangs(const Lang::List &langs);

    void setGender(const Gender &gender);
    Gender gender() const;

    QString kind() const;
    void setKind(const QString &kind);

    void insertCalendarUrl(const CalendarUrl &calendarUrl);
    CalendarUrl::List calendarUrlList() const;

    void insertExtraSound(const Sound &sound);
    void setExtraSoundList(const Sound::List &soundList);
    Sound::List extraSoundList() const;

    void insertExtraPhoto(const Picture &picture);
    void setExtraPhotoList(const Picture::List &pictureList);
    Picture::List extraPhotoList() const;

    void insertExtraLogo(const Picture &logo);
    void setExtraLogoList(const Picture::List &logoList);
    Picture::List extraLogoList() const;

    ResourceLocatorUrl::List extraUrlList() const;
    void setExtraUrlList(const ResourceLocatorUrl::List &urlList);
    void insertExtraUrl(const ResourceLocatorUrl &url);

    //Member
    void insertMember(const QString &member);
    void setMembers(const QStringList &c);
    QStringList members() const;

    //Relation
    void insertRelationship(const Related &related);
    void setRelationships(const Related::List &c);
    Related::List relationships() const;

    //Source
    void insertSourceUrl(const QUrl &url);
    void setSourcesUrlList(const QVector<QUrl> &urlList);
    QVector<QUrl> sourcesUrlList() const;

    //Impp
    Impp::List imppList() const;
    void setImppList(const Impp::List &imppList);
    void insertImpp(const Impp &impp);

    //FieldGroup
    FieldGroup::List fieldGroupList() const;
    void setFieldGroupList(const FieldGroup::List &fieldGroupList);
    void insertFieldGroup(const FieldGroup &fieldGroup);

    //ClientPidMap
    ClientPidMap::List clientPidMapList() const;
    void setClientPidMapList(const ClientPidMap::List &clientpidmaplist);
    void insertClientPidMap(const ClientPidMap &clientpidmap);

    QDate anniversary() const;
    void setAnniversary(const QDate &anniversary);

    QString assistantsName() const;
    void setAssistantsName(const QString &assistantsName);

    QUrl blogFeed() const;
    void setBlogFeed(const QUrl &blogFeed);

    QString managersName() const;
    void setManagersName(const QString &managersName);

    QString office() const;
    void setOffice(const QString &office);

    QString profession() const;
    void setProfession(const QString &profession);

    QString spousesName() const;
    void setSpousesName(const QString &spousesName);

private:
    QVariantList emailsVariant() const;
    QVariantList phoneNumbersVariant() const;
    QVariantList addressesVariant() const;
    QVariantList urlsVariant() const;
    QVariantList imppsVariant() const;

    class Private;
    QSharedDataPointer<Private> d;
};

KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &, const Addressee &);
KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &, Addressee &);
}

#define KCONTACTS_ADDRESSEE_METATYPE_DEFINED 1
Q_DECLARE_METATYPE(KContacts::Addressee)

#endif