addressee.h

/*
    This file is part of libkabc.
    Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>
                  2013 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_ADDRESSEE_H
#define KABC_ADDRESSEE_H

#include <QtCore/QDateTime>
#include <QtCore/QStringList>
#include <QtCore/QSharedDataPointer>

#include <kurl.h>

#include "kabc/address.h"
#include "kabc/geo.h"
#include "kabc/key.h"
#include "kabc/phonenumber.h"
#include "kabc/picture.h"
#include "kabc/secrecy.h"
#include "kabc/sound.h"
#include "kabc/email.h"
#include "kabc/lang.h"
#include "kabc/gender.h"
#include "kabc/timezone.h"
#include "kabc/calendarurl.h"
#include "kabc/addresseelist.h"  // for typedef QList<Addressee> List;

namespace KABC {

#ifndef KDEPIM_NO_KRESOURCES
class Resource;
#endif
class SortMode;

class KABC_EXPORT Addressee
{
  friend KABC_EXPORT QDataStream &operator<<( QDataStream &, const Addressee & );
  friend KABC_EXPORT QDataStream &operator>>( QDataStream &, Addressee & );

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

    Addressee();

    ~Addressee();

    Addressee( const Addressee & );

    Addressee &operator=( const Addressee & );

    bool operator==( const Addressee & ) const;

    bool operator!=( const Addressee & ) 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 );

    QString nickName() const;

    static QString nickNameLabel();

    void setBirthday( const QDateTime &birthday );

    QDateTime birthday() 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();

    void setTitle( const QString &title );

    QString title() const;

    static QString titleLabel();

    void setRole( const QString &role );

    QString role() const;

    static QString roleLabel();

    void setOrganization( const QString &organization );

    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 KUrl &url );

    KUrl 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 & );

    QString realName() const;

    QString assembledName() const;

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

    void insertEmail( const QString &email, bool preferred=false );

    void removeEmail( const QString &email );

    QString preferredEmail() const;

    QStringList emails() const;

    void setEmails( const QStringList& list);
    void setEmailList(const Email::List &list);
    void insertPhoneNumber( const PhoneNumber &phoneNumber );

    void removePhoneNumber( const PhoneNumber &phoneNumber );

    PhoneNumber phoneNumber( PhoneNumber::Type type ) const;

    PhoneNumber::List phoneNumbers() const;

    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, QString customTypeString = QString() ) const;

    Key::List keys() const;

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

    Key::List keys( Key::Type type, 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 & );

    void removeCategory( const QString & );

    bool hasCategory( const QString & ) const;

    void setCategories( const QStringList & );

    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 & );

    QStringList customs() const;

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

    QString toString() const;

#ifndef KDEPIM_NO_KRESOURCES

    void setResource( Resource *resource );

    Resource *resource() const;
#endif

    void setChanged( bool value );

    bool changed() const;

    static void setSortMode( KABC::SortMode *mode );

    bool operator< ( const Addressee &addr ) const;

    static QString mimeType();

    //kf5 merge with insertEmail(...)
    void insertEmail(const QString &email, bool preferred, const QMap<QString, QStringList> &param);

    KABC::Email::List emailList() const;

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

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

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

    void insertCalendarUrl(const KABC::CalendarUrl &calendarUrl);


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

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

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


    QList<KUrl> extraUrlList() const;
    void setExtraUrlList(const QList<KUrl> &urlList);
    void insertExtraUrl(const KUrl &url);


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

    void insertRelationShip(const QString &related);
    void setRelationShips(const QStringList &c);
    QStringList relationShips() const;

    void insertSourceUrl(const KUrl &url);
    void setSourcesUrlList(const QList<KUrl> &urlList);
    QList<KUrl> sourcesUrlList() const;
private:
    class Private;
    QSharedDataPointer<Private> d;
};
#ifdef kabc_EXPORTS
KDE_DUMMY_QHASH_FUNCTION( Addressee )
#endif

KABC_EXPORT QDataStream &operator<<( QDataStream &, const Addressee & );
KABC_EXPORT QDataStream &operator>>( QDataStream &, Addressee & );

}

#define KABC_ADDRESSEE_METATYPE_DEFINED 1
Q_DECLARE_METATYPE( KABC::Addressee )

#endif