abstractcontactformatter.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_ABSTRACTCONTACTFORMATTER_H
#define AKONADI_ABSTRACTCONTACTFORMATTER_H

#include "akonadi-contact_export.h"

#include <QtCore/QVariantMap>

namespace KABC {
class Addressee;
}

namespace Akonadi {
class Item;

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

    AbstractContactFormatter();

    virtual ~AbstractContactFormatter();

    void setContact( const KABC::Addressee &contact );

    KABC::Addressee contact() const;

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

    Akonadi::Item item() const;

    void setCustomFieldDescriptions( const QList<QVariantMap> &descriptions );

    QList<QVariantMap> customFieldDescriptions() const;

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

  private:
    //@cond PRIVATE
    Q_DISABLE_COPY( AbstractContactFormatter )

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

}

#endif