noteutils.h

/*  This file is part of the KDE project
    Copyright (C) 2011 Christian Mollekopf <chrigi_1@fastmail.fm>

    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 NOTEUTILS_H
#define NOTEUTILS_H

#include "akonadi-notes_export.h"

#include <QtCore/QUrl>

class KDateTime;
class QString;

namespace boost {
  template <typename T> class shared_ptr;
}

namespace KMime {
  class Message;
  typedef boost::shared_ptr<Message> MessagePtr;
}
namespace Akonadi {
namespace NoteUtils {

AKONADI_NOTES_EXPORT QString noteMimeType();

AKONADI_NOTES_EXPORT QString noteIconName();

class AKONADI_NOTES_EXPORT Attachment
{
public:
  Attachment( const QUrl &url, const QString &mimetype );
  Attachment( const QByteArray &data, const QString &mimetype );
  Attachment( const Attachment & );
  ~Attachment();

  bool operator==( const Attachment & ) const;
  void operator=( const Attachment & );

  QUrl url() const;

  QByteArray data() const;

  QString mimetype() const;

  void setLabel( const QString &label );

  QString label() const;
private:
  //@cond PRIVATE
  class AttachmentPrivate;
  AttachmentPrivate * const d_ptr;
  Q_DECLARE_PRIVATE( Attachment )
  //@endcond
};

class AKONADI_NOTES_EXPORT NoteMessageWrapper
{
public:
  NoteMessageWrapper();
  explicit NoteMessageWrapper( const KMime::MessagePtr & );
  ~NoteMessageWrapper();

  void setUid( const QString &uid );

  QString uid() const;

  enum Classification {
    Public,
    Private,
    Confidential
  };

  void setClassification( Classification );

  Classification classification() const;

  void setTitle( const QString &title );

  QString title() const;

  void setText( const QString &text, Qt::TextFormat format = Qt::PlainText );

  QString text() const;

  Qt::TextFormat textFormat() const;

  QString toPlainText() const;

  void setCreationDate( const KDateTime &creationDate );

  KDateTime creationDate() const;

  void setLastModifiedDate( const KDateTime &lastModifiedDate );

  KDateTime lastModifiedDate() const;

  void setFrom( const QString &from );

  QString from() const;

  QList<Attachment> &attachments();

  QMap<QString, QString> &custom();

  KMime::MessagePtr message() const;

private:
  //@cond PRIVATE
  class NoteMessageWrapperPrivate;
  NoteMessageWrapperPrivate * const d_ptr;
  Q_DECLARE_PRIVATE( NoteMessageWrapper )
  //@endcond
};

}
}

#endif