itemserializerplugin.h

/*
    Copyright (c) 2007 Till Adam <adam@kde.org>
    Copyright (c) 2007 Volker Krause <vkrause@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 AKONADI_ITEMSERIALIZERPLUGIN_H
#define AKONADI_ITEMSERIALIZERPLUGIN_H

#include <QtCore/QByteArray>
#include <QtCore/QSet>

#include "item.h"
#include "akonadi_export.h"

class QIODevice;

namespace Akonadi {

class AKONADI_EXPORT ItemSerializerPlugin
{
  public:
    virtual ~ItemSerializerPlugin();

    virtual bool deserialize( Item& item, const QByteArray& label, QIODevice& data, int version ) = 0;

    virtual void serialize( const Item& item, const QByteArray& label, QIODevice& data, int &version ) = 0;

    virtual QSet<QByteArray> parts( const Item &item ) const;

    static void overridePluginLookup( QObject *plugin );

};

class AKONADI_EXPORT ItemSerializerPluginV2 : public ItemSerializerPlugin
{
  public:
    virtual ~ItemSerializerPluginV2();

    virtual void apply( Item &item, const Item &other );

    virtual QSet<QByteArray> availableParts( const Item &item ) const;
};

}

Q_DECLARE_INTERFACE( Akonadi::ItemSerializerPlugin, "org.freedesktop.Akonadi.ItemSerializerPlugin/1.0" )
Q_DECLARE_INTERFACE( Akonadi::ItemSerializerPluginV2, "org.freedesktop.Akonadi.ItemSerializerPlugin/1.1" )

#endif