contactgroup.h

/*
  This file is part of the KContacts framework.
  Copyright (c) 2008 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_CONTACTGROUP_H
#define KCONTACTS_CONTACTGROUP_H

#include <QVector>
#include <QSharedDataPointer>
#include <QMetaType>

#include "kcontacts_export.h"

class QString;

namespace KContacts {
class KCONTACTS_EXPORT ContactGroup
{
public:

    class KCONTACTS_EXPORT ContactReference
    {
    public:
        typedef QVector<ContactReference> List;

        ContactReference();

        ContactReference(const ContactReference &other);

        ContactReference(const QString &uid);

        ~ContactReference();

        void setUid(const QString &uid);

        Q_REQUIRED_RESULT QString uid() const;

        void setGid(const QString &gid);

        Q_REQUIRED_RESULT QString gid() const;

        void setPreferredEmail(const QString &email);

        Q_REQUIRED_RESULT QString preferredEmail() const;

        void insertCustom(const QString &key, const QString &value);

        void removeCustom(const QString &key);

        Q_REQUIRED_RESULT QString custom(const QString &key) const;

        ContactReference &operator=(const ContactReference &other);

        Q_REQUIRED_RESULT bool operator==(const ContactReference &other) const;

    private:
        class ContactReferencePrivate;
        QSharedDataPointer<ContactReferencePrivate> d;
    };

    class KCONTACTS_EXPORT ContactGroupReference
    {
    public:
        typedef QVector<ContactGroupReference> List;

        ContactGroupReference();

        ContactGroupReference(const ContactGroupReference &other);

        ContactGroupReference(const QString &uid);

        ~ContactGroupReference();

        void setUid(const QString &uid);

        QString uid() const;

        void insertCustom(const QString &key, const QString &value);

        void removeCustom(const QString &key);

        QString custom(const QString &key) const;

        ContactGroupReference &operator=(const ContactGroupReference &other);

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

    private:
        class ContactGroupReferencePrivate;
        QSharedDataPointer<ContactGroupReferencePrivate> d;
    };

    class KCONTACTS_EXPORT Data
    {
    public:
        typedef QVector<Data> List;

        Data();

        Data(const Data &other);

        Data(const QString &name, const QString &email);

        ~Data();

        void setName(const QString &name);

        Q_REQUIRED_RESULT QString name() const;

        void setEmail(const QString &email);

        Q_REQUIRED_RESULT QString email() const;

        void insertCustom(const QString &key, const QString &value);

        void removeCustom(const QString &key);

        Q_REQUIRED_RESULT QString custom(const QString &key) const;

        Data &operator=(const Data &other);

        Q_REQUIRED_RESULT bool operator==(const Data &other) const;

    private:
        class DataPrivate;
        QSharedDataPointer<DataPrivate> d;
    };

    typedef QVector<ContactGroup> List;

    ContactGroup();

    ContactGroup(const ContactGroup &other);

    ContactGroup(const QString &name);

    ~ContactGroup();

    void setId(const QString &id);

    Q_REQUIRED_RESULT QString id() const;

    void setName(const QString &name);

    Q_REQUIRED_RESULT QString name() const;

    Q_REQUIRED_RESULT int count() const;

    Q_REQUIRED_RESULT int contactReferenceCount() const;

    Q_REQUIRED_RESULT int contactGroupReferenceCount() const;

    Q_REQUIRED_RESULT int dataCount() const;

    Q_REQUIRED_RESULT ContactReference &contactReference(int index);

    const ContactReference &contactReference(int index) const;

    ContactGroupReference &contactGroupReference(int index);

    const ContactGroupReference &contactGroupReference(int index) const;

    Data &data(int index);

    const Data &data(int index) const;

    void append(const ContactReference &reference);

    void append(const ContactGroupReference &reference);

    void append(const Data &data);

    void remove(const ContactReference &reference);

    void remove(const ContactGroupReference &reference);

    void remove(const Data &data);

    void removeAllContactReferences();

    void removeAllContactGroupReferences();

    void removeAllContactData();

    ContactGroup &operator=(const ContactGroup &other);

    Q_REQUIRED_RESULT bool operator==(const ContactGroup &other) const;

    static QString mimeType();

private:
    class Private;
    QSharedDataPointer<Private> d;
};
}
Q_DECLARE_TYPEINFO(KContacts::ContactGroup::ContactGroupReference, Q_MOVABLE_TYPE);
Q_DECLARE_TYPEINFO(KContacts::ContactGroup::ContactReference, Q_MOVABLE_TYPE);

#define KCONTACTS_CONTACTGROUP_METATYPE_DEFINED
Q_DECLARE_METATYPE(KContacts::ContactGroup)

#endif