contactgroup.h

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

#include <QtCore/QList>
#include <QtCore/QSharedDataPointer>
#include <QtCore/QMetaType>

#include "kabc_export.h"

class QString;

namespace KABC {

class KABC_EXPORT ContactGroup
{
  public:

    class KABC_EXPORT ContactReference
    {
      public:
        typedef QList<ContactReference> List;

        ContactReference();

        ContactReference( const ContactReference &other );

        ContactReference( const QString &uid );

        ~ContactReference();

        void setUid( const QString &uid );

        QString uid() const;

        void setGid( const QString &gid );

        QString gid() const;

        void setPreferredEmail( const QString &email );

        QString preferredEmail() const;

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

        void removeCustom( const QString &key );

        QString custom( const QString &key ) const;

        ContactReference &operator=( const ContactReference & );

        bool operator==( const ContactReference & ) const;

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

    class KABC_EXPORT ContactGroupReference
    {
      public:
        typedef QList<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 & );

        bool operator==( const ContactGroupReference & ) const;

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

    class KABC_EXPORT Data
    {
      public:
        typedef QList<Data> List;

        Data();

        Data( const Data &other );

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

        ~Data();

        void setName( const QString &name );

        QString name() const;

        void setEmail( const QString &email );

        QString email() const;

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

        void removeCustom( const QString &key );

        QString custom( const QString &key ) const;

        Data &operator=( const Data & );

        bool operator==( const Data & ) const;

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

    typedef QList<ContactGroup> List;

    ContactGroup();

    ContactGroup( const ContactGroup &other );

    ContactGroup( const QString &name );

    ~ContactGroup();

    void setId( const QString &id );

    QString id() const;

    void setName( const QString &name );

    QString name() const;

    unsigned int count() const;

    unsigned int contactReferenceCount() const;

    unsigned int contactGroupReferenceCount() const;

    unsigned int dataCount() const;

    ContactReference &contactReference( unsigned int index );

    const ContactReference &contactReference( unsigned int index ) const;

    ContactGroupReference &contactGroupReference( unsigned int index );

    const ContactGroupReference &contactGroupReference( unsigned int index ) const;

    Data &data( unsigned int index );

    const Data &data( unsigned 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 & );

    bool operator==( const ContactGroup & ) const;

    static QString mimeType();

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

}

#define KABC_CONTACTGROUP_METATYPE_DEFINED
Q_DECLARE_METATYPE( KABC::ContactGroup )

#endif