contactgroup.h

/*
    This file is part of the KContacts framework.
    SPDX-FileCopyrightText: 2008 Tobias Koenig <[email protected]>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/

#ifndef KCONTACTS_CONTACTGROUP_H
#define KCONTACTS_CONTACTGROUP_H

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

#include "kcontacts_export.h"

class QString;

namespace KContacts
{
/**
 * @short This class represents a group of contacts.
 *
 * It can contain two types of contacts, either a reference
 * or data.
 * The reference entry is just an unique identifier which
 * identifies the real contact in the system.
 * The data entry contains a name and an email address.
 *
 * @author Tobias Koenig <[email protected]>
 * @since 4.3
 */
class KCONTACTS_EXPORT ContactGroup
{
public:
    /**
     * This class represents a contact reference
     */
    class KCONTACTS_EXPORT ContactReference
    {
    public:
        /**
         * A list of contact references.
         */
        typedef QVector<ContactReference> List;

        /**
         * Creates an empty contact reference.
         */
        ContactReference();

        /**
         * Creates a contact reference from an @p other reference.
         */
        ContactReference(const ContactReference &other);

        /**
         * Creates a contact reference for the given contact @p uid.
         */
        ContactReference(const QString &uid);

        /**
         * Destroys the contact reference.
         */
        ~ContactReference();

        /**
         * Sets the contact uid of the contact reference.
         * @param uid identifier of the contact to reference
         * @note That is the Akonadi Item ID of the contact that
         *       is referenced here.
         */
        void setUid(const QString &uid);

        /**
         * Returns the contact uid of the contact reference.
         *
         * @note That is the Akonadi Item ID of the contact that
         *       is referenced here.
         */
        Q_REQUIRED_RESULT QString uid() const;

        /**
         * Sets the contact gid of the contact reference.
         * @param gid globally unique identifier of the contact to reference
         * @since 4.12
         */
        void setGid(const QString &gid);

        /**
         * Returns the contact GID of the contact reference.
         * @since 4.12
         */
        Q_REQUIRED_RESULT QString gid() const;

        /**
         * Sets the preferred email address.
         */
        void setPreferredEmail(const QString &email);

        /**
         * Returns the preferred email address, or an empty string
         * if no preferred email address is set.
         */
        Q_REQUIRED_RESULT QString preferredEmail() const;

        /**
         * Inserts a custom entry.
         * If an entry with the same @p key already exists, it is
         * overwritten.
         *
         * @param key The unique key.
         * @param value The value.
         */
        void insertCustom(const QString &key, const QString &value);

        /**
         * Removes the custom entry with the given @p key.
         */
        void removeCustom(const QString &key);

        /**
         * Returns the value for the given @p key, or an empty string
         * if the entry for that key does not exists.
         */
        Q_REQUIRED_RESULT QString custom(const QString &key) const;

        /**
         * @internal
         */
        ContactReference &operator=(const ContactReference &other);

        /**
         * @internal
         */
        Q_REQUIRED_RESULT bool operator==(const ContactReference &other) const;

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

    /**
     * This class represents a contact group reference
     */
    class KCONTACTS_EXPORT ContactGroupReference
    {
    public:
        /**
         * A list of contact group references.
         */
        typedef QVector<ContactGroupReference> List;

        /**
         * Creates an empty contact group reference.
         */
        ContactGroupReference();

        /**
         * Creates a contact group reference from an @p other reference.
         */
        ContactGroupReference(const ContactGroupReference &other);

        /**
         * Creates a contact group reference for the given contact group @p uid.
         */
        ContactGroupReference(const QString &uid);

        /**
         * Destroys the contact group reference.
         */
        ~ContactGroupReference();

        /**
         * Sets the contact group uid of the contact group reference.
         */
        void setUid(const QString &uid);

        /**
         * Returns the contact group uid of the contact group reference.
         */
        QString uid() const;

        /**
         * Inserts a custom entry.
         * If an entry with the same @p key already exists, it is
         * overwritten.
         *
         * @param key The unique key.
         * @param value The value.
         */
        void insertCustom(const QString &key, const QString &value);

        /**
         * Removes the custom entry with the given @p key.
         */
        void removeCustom(const QString &key);

        /**
         * Returns the value for the given @p key, or an empty string
         * if the entry for that key does not exists.
         */
        QString custom(const QString &key) const;

        /**
         * @internal
         */
        ContactGroupReference &operator=(const ContactGroupReference &other);

        /**
         * @internal
         */
        bool operator==(const ContactGroupReference &other) const;

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

    /**
     * This class represents a contact data object
     */
    class KCONTACTS_EXPORT Data
    {
    public:
        /**
         * A list of contact data.
         */
        typedef QVector<Data> List;

        /**
         * Creates an empty contact data object.
         */
        Data();

        /**
         * Creates a contact data object from an @p other data object.
         */
        Data(const Data &other);

        /**
         * Creates a contact data object with the given @p name and @p email address.
         */
        Data(const QString &name, const QString &email);

        /**
         * Destroys the contact data object.
         */
        ~Data();

        /**
         * Sets the @p name of the contact data object.
         */
        void setName(const QString &name);

        /**
         * Returns the name of the contact data object.
         */
        Q_REQUIRED_RESULT QString name() const;

        /**
         * Sets the @p email address of the contact data object.
         */
        void setEmail(const QString &email);

        /**
         * Returns the email address of the contact data object.
         */
        Q_REQUIRED_RESULT QString email() const;

        /**
         * Inserts a custom entry.
         * If an entry with the same @p key already exists, it is
         * overwritten.
         *
         * @param key The unique key.
         * @param value The value.
         */
        void insertCustom(const QString &key, const QString &value);

        /**
         * Removes the custom entry with the given @p key.
         */
        void removeCustom(const QString &key);

        /**
         * Returns the value for the given @p key, or an empty string
         * if the entry for that key does not exists.
         */
        Q_REQUIRED_RESULT QString custom(const QString &key) const;

        /**
         * @internal
         */
        Data &operator=(const Data &other);

        /**
         * @internal
         */
        Q_REQUIRED_RESULT bool operator==(const Data &other) const;

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

    /**
     * A list of contact groups.
     */
    typedef QVector<ContactGroup> List;

    /**
     * Creates an empty contact group.
     */
    ContactGroup();

    /**
     * Creates a contact group from an @p other group.
     */
    ContactGroup(const ContactGroup &other);

    /**
     * Creates a contact group with the given name.
     */
    ContactGroup(const QString &name);

    /**
     * Destroys the contact group.
     */
    ~ContactGroup();

    /**
     * Sets the unique @p id of the contact group.
     */
    void setId(const QString &id);

    /**
     * Returns the unique id of the contact group.
     */
    Q_REQUIRED_RESULT QString id() const;

    /**
     * Sets the i18n'd @p name of the contact group.
     */
    void setName(const QString &name);

    /**
     * Returns the i18n'd name of the contact group.
     */
    Q_REQUIRED_RESULT QString name() const;

    /**
     * Returns the number of contacts in this group.
     * That includes the contact references and contact data.
     */
    Q_REQUIRED_RESULT int count() const;

    /**
     * Returns the number of contact references in this group.
     */
    Q_REQUIRED_RESULT int contactReferenceCount() const;

    /**
     * Returns the number of group references in this group.
     */
    Q_REQUIRED_RESULT int contactGroupReferenceCount() const;

    /**
     * Returns the number of contact data objects in this group.
     */
    Q_REQUIRED_RESULT int dataCount() const;

    /**
     * Returns the contact reference at the given @p index.
     */
    Q_REQUIRED_RESULT ContactReference &contactReference(int index);

    /**
     * Returns the contact reference at the given @p index.
     */
    const ContactReference &contactReference(int index) const;

    /**
     * Returns the contact group reference at the given @p index.
     */
    ContactGroupReference &contactGroupReference(int index);

    /**
     * Returns the contact group reference at the given @p index.
     */
    const ContactGroupReference &contactGroupReference(int index) const;

    /**
     * Returns the contact data object at the given @p index.
     */
    Data &data(int index);

    /**
     * Returns the contact data object at the given @p index.
     */
    const Data &data(int index) const;

    /**
     * Appends a new contact @p reference to the contact group.
     */
    void append(const ContactReference &reference);

    /**
     * Appends a new contact group @p reference to the contact group.
     */
    void append(const ContactGroupReference &reference);

    /**
     * Appends a new contact @p data object to the contact group.
     */
    void append(const Data &data);

    /**
     * Removes the given contact @p reference from the contact group.
     */
    void remove(const ContactReference &reference);

    /**
     * Removes the given contact group @p reference from the contact group.
     */
    void remove(const ContactGroupReference &reference);

    /**
     * Removes the given contact @p data object from the contact group.
     */
    void remove(const Data &data);

    /**
     * Removes all contact references from the contact group.
     */
    void removeAllContactReferences();

    /**
     * Removes all contact group references from the contact group.
     */
    void removeAllContactGroupReferences();

    /**
     * Removes all contact data from the contact group.
     */
    void removeAllContactData();

    /**
     * @internal
     */
    ContactGroup &operator=(const ContactGroup &other);

    /**
     * @internal
     */
    Q_REQUIRED_RESULT bool operator==(const ContactGroup &other) const;

    /**
     * Returns the MIME type used for Contact Groups
     */
    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