resourcecached.h

/*
    This file is part of kabc.
    Copyright (c) 2004 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_RESOURCECACHED_H
#define KABC_RESOURCECACHED_H

#include <kabc/kabc_export.h>
#include <kabc/resource.h>

#include <kresources/idmapper.h>

namespace KABC {

class KABC_DEPRECATED_EXPORT ResourceCached : public Resource
{
  Q_OBJECT

  public:
    ResourceCached();
    ResourceCached( const KConfigGroup &group );
    ~ResourceCached();

    virtual void writeConfig( KConfigGroup &group );

    virtual void insertAddressee( const Addressee &addr );

    virtual void removeAddressee( const Addressee &addr );

    bool loadFromCache();

    void saveToCache();

    void cleanUpCache( const KABC::Addressee::List &list );

    KRES::IdMapper &idMapper();

    bool hasChanges() const;

    void clearChanges();

    void clearChange( const KABC::Addressee &addr );

    void clearChange( const QString &uid );

    KABC::Addressee::List addedAddressees() const;

    KABC::Addressee::List changedAddressees() const;

    KABC::Addressee::List deletedAddressees() const;

  protected:
    virtual QString cacheFile() const;

    virtual QString changesCacheFile( const QString &type ) const;

    void loadChangesCache();

    void saveChangesCache();

    void setIdMapperIdentifier();

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

}

#endif