resource.h

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

#include "addressbook.h"
#include "distributionlist.h"
#include "plugin.h"
#include "kresources/resource.h"

namespace KABC {

class KABC_DEPRECATED_EXPORT Ticket
{
    friend class Resource;

  public:
    ~Ticket();

    Resource *resource();

  private:
    Ticket( Resource *resource );

    class Private;
    Private *const d;
};

class KABC_DEPRECATED_EXPORT Resource : public KRES::Resource
{
  Q_OBJECT

  public:

    class ConstIterator;
    class KABC_DEPRECATED_EXPORT Iterator
    {
      friend class KABC::Resource::ConstIterator;
      friend class KABC::Resource;
      public:
        Iterator();
        Iterator( const Iterator & );
        virtual ~Iterator();

        virtual Iterator &operator=( const Iterator & );
        virtual const Addressee &operator*() const;
        virtual Addressee &operator*();
        virtual Iterator &operator++();
        virtual Iterator &operator++( int );
        virtual Iterator &operator--();
        virtual Iterator &operator--( int );
        virtual bool operator==( const Iterator &it ) const;
        virtual bool operator!=( const Iterator &it ) const;

      private:
        class Private;
        Private *const d;
    };

    class KABC_DEPRECATED_EXPORT ConstIterator
    {
      friend class KABC::Resource;

      public:
        ConstIterator();
        ConstIterator( const ConstIterator & );
#ifndef QT_STRICT_ITERATORS

        ConstIterator( const Iterator & );
#endif
        virtual ~ConstIterator();

        virtual ConstIterator &operator=( const ConstIterator & );
        virtual const Addressee &operator*() const;
        virtual ConstIterator &operator++();
        virtual ConstIterator &operator++( int );
        virtual ConstIterator &operator--();
        virtual ConstIterator &operator--( int );
        virtual bool operator==( const ConstIterator &it ) const;
        virtual bool operator!=( const ConstIterator &it ) const;

      private:
        class Private;
        Private *const d;
    };

    typedef Iterator iterator;

    typedef ConstIterator const_iterator;

    Resource();

    Resource( const KConfigGroup &group );

    virtual ~Resource();

    virtual ConstIterator begin() const;
    ConstIterator constBegin() const { return begin(); }

    virtual Iterator begin();

    virtual ConstIterator end() const;
    ConstIterator constEnd() const { return end(); }

    virtual Iterator end();

    AddressBook *addressBook();

    virtual void writeConfig( KConfigGroup &group );

    virtual Ticket *requestSaveTicket() = 0;

    virtual void releaseSaveTicket( Ticket *ticket ) = 0;

    virtual bool load() = 0;

    virtual bool asyncLoad();

    virtual void insertAddressee( const Addressee &addr );

    virtual void removeAddressee( const Addressee &addr );

    virtual bool save( Ticket *ticket ) = 0;

    virtual bool asyncSave( Ticket *ticket );

    virtual Addressee findByUid( const QString &uid );

    virtual Addressee::List findByName( const QString &name );

    virtual Addressee::List findByEmail( const QString &email );

    virtual Addressee::List findByCategory( const QString &category );

    virtual void clear();

    virtual void insertDistributionList( DistributionList *list );

    virtual void removeDistributionList( DistributionList *list );

    virtual DistributionList *findDistributionListByIdentifier( const QString &identifier );

    virtual DistributionList *findDistributionListByName(
      const QString &name,
      Qt::CaseSensitivity caseSensitivity = Qt::CaseSensitive );

    virtual QList<DistributionList*> allDistributionLists();

    virtual QStringList allDistributionListNames() const;

    void setAddressBook( AddressBook *addr );

  Q_SIGNALS:
    void loadingFinished( Resource *resource );

    void loadingError( Resource *resource, const QString &msg );

    void savingFinished( Resource *resource );

    void savingError( Resource *resource, const QString &msg );

  protected:
    Ticket *createTicket( Resource * );

    Addressee::Map mAddrMap;

    DistributionListMap mDistListMap;

  private:
    class Private;
    Private *const d;
};

}

#endif