collectionpropertiespage.h

/*
    Copyright (c) 2008 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_COLLECTIONPROPERTIESPAGE_H
#define AKONADI_COLLECTIONPROPERTIESPAGE_H

#include "akonadi_export.h"

#include <QWidget>

namespace Akonadi {

class Collection;

class AKONADI_EXPORT CollectionPropertiesPage : public QWidget
{
    Q_OBJECT
public:
    explicit CollectionPropertiesPage(QWidget *parent = 0);

    ~CollectionPropertiesPage();

    virtual void load(const Collection &collection) = 0;

    virtual void save(Collection &collection) = 0;

    virtual bool canHandle(const Collection &collection) const;

    void setPageTitle(const QString &title);

    QString pageTitle() const;

private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};

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

    virtual CollectionPropertiesPage *createWidget(QWidget *parent = 0) const = 0;
};

#define AKONADI_COLLECTION_PROPERTIES_PAGE_FACTORY(factoryName, className) \
class factoryName : public Akonadi::CollectionPropertiesPageFactory \
{ \
  public: \
    inline Akonadi::CollectionPropertiesPage *createWidget( QWidget *parent = 0 ) const \
    { \
      return new className( parent ); \
    } \
};

}

#endif