---

addressbook.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., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*/

#ifndef KABC_ADDRESSBOOK_H
#define KABC_ADDRESSBOOK_H

#include <qobject.h>
#include <qptrlist.h>

#include "addressee.h"
#include "field.h"

namespace KABC {

class ErrorHandler;
class Resource;
class Ticket;

class AddressBook : public QObject
{
    Q_OBJECT

    friend QDataStream &operator<<( QDataStream &, const AddressBook & );
    friend QDataStream &operator>>( QDataStream &, AddressBook & );
    friend class StdAddressBook;

  public:
    class Iterator
    {
      public:
        Iterator();
        Iterator( const Iterator & );
        ~Iterator();

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

        struct IteratorData;
        IteratorData *d;
    };

    class ConstIterator
    {
      public:
        ConstIterator();
        ConstIterator( const ConstIterator & );
        ~ConstIterator();
      
        ConstIterator &operator=( const ConstIterator & );
        const Addressee &operator*() const;
        const Addressee* operator->() const;
        ConstIterator &operator++();
        ConstIterator &operator++(int);
        ConstIterator &operator--();
        ConstIterator &operator--(int);
        bool operator==( const ConstIterator &it );
        bool operator!=( const ConstIterator &it );

        struct ConstIteratorData;
        ConstIteratorData *d;
    };
    
    AddressBook();
    virtual ~AddressBook();

    Ticket *requestSaveTicket( Resource *resource=0 );
    
    bool load();

    bool save( Ticket *ticket );

    Iterator begin();

    ConstIterator begin() const;

    Iterator end();

    ConstIterator end() const;

    void clear();
    
    void insertAddressee( const Addressee & );

    void removeAddressee( const Addressee & );

    void removeAddressee( const Iterator & );

    Iterator find( const Addressee & );

    Addressee findByUid( const QString & );

    Addressee::List findByName( const QString & );

    Addressee::List findByEmail( const QString & );

    Addressee::List findByCategory( const QString & );

    virtual QString identifier();

    void dump() const;

    void emitAddressBookLocked() { emit addressBookLocked( this ); }
    void emitAddressBookUnlocked() { emit addressBookUnlocked( this ); }
    void emitAddressBookChanged() { emit addressBookChanged( this ); }

    Field::List fields( int category = Field::All );

    bool addCustomField( const QString &label, int category = Field::All,
                         const QString &key = QString::null,
                         const QString &app = QString::null );

    bool addResource( Resource * );

    bool removeResource( Resource * );

    QPtrList<Resource> resources();

    void setErrorHandler( ErrorHandler * );

    void error( const QString& );

    void cleanUp();

  signals:
    void addressBookChanged( AddressBook * );

    void addressBookLocked( AddressBook * );

    void addressBookUnlocked( AddressBook * );

  protected:
    void deleteRemovedAddressees();
    void setStandardResource( Resource * );
    Resource *standardResource();

  private:
    QPtrList<Resource> mDummy; // Remove in KDE 4
    struct AddressBookData;
    AddressBookData *d;
};

QDataStream &operator<<( QDataStream &, const AddressBook & );
QDataStream &operator>>( QDataStream &, AddressBook & );

}

#endif

---