abstractcontactgroupformatter.h

/*
    This file is part of Akonadi Contact.

    Copyright (c) 2010 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 AKONADI_ABSTRACTCONTACTGROUPFORMATTER_H
#define AKONADI_ABSTRACTCONTACTGROUPFORMATTER_H

#include "akonadi-contact_export.h"

#include <QVariant>

namespace KContacts {
class ContactGroup;
}

namespace Akonadi {
class Item;

class AKONADI_CONTACT_EXPORT AbstractContactGroupFormatter
{
public:
    enum HtmlForm {
        SelfcontainedForm,                
        EmbeddableForm,                   
        UserForm = SelfcontainedForm + 42 
    };

    AbstractContactGroupFormatter();

    virtual ~AbstractContactGroupFormatter();

    void setContactGroup(const KContacts::ContactGroup &group);

    Q_REQUIRED_RESULT KContacts::ContactGroup contactGroup() const;

    void setItem(const Akonadi::Item &item);

    Q_REQUIRED_RESULT Akonadi::Item item() const;

    void setAdditionalFields(const QVector<QVariantMap> &fields);

    Q_REQUIRED_RESULT QVector<QVariantMap> additionalFields() const;

    virtual QString toHtml(HtmlForm form = SelfcontainedForm) const = 0;

private:
    //@cond PRIVATE
    Q_DISABLE_COPY(AbstractContactGroupFormatter)

    class Private;
    Private *const d;
    //@endcond
};
}

#endif