bodypart.h

Go to the documentation of this file.

/*  -*- mode: C++; c-file-style: "gnu" -*-
    bodypart.h

    This file is part of KMail's plugin interface.
    Copyright (c) 2004 Marc Mutz <mutz@kde.org>,
                       Ingo Kloecker <kloecker@kde.org>

    KMail is free software; you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    KMail 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
    General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

    In addition, as a special exception, the copyright holders give
    permission to link the code of this program with any edition of
    the Qt library by Trolltech AS, Norway (or with modified versions
    of Qt that use the same license as Qt), and distribute linked
    combinations including the two.  You must obey the GNU General
    Public License in all respects for all of the code used other than
    Qt.  If you modify this file, you may extend this exception to
    your version of the file, but you are not obligated to do so.  If
    you do not wish to do so, delete this exception statement from
    your version.
*/

#ifndef __KMAIL_INTERFACES_BODYPART_H__
#define __KMAIL_INTERFACES_BODYPART_H__

class QByteArray;
class QString;

namespace KMime {
  class Content;
}

namespace MessageViewer {
class NodeHelper;
namespace Interface {

/*FIXME(Andras) review, port
  class Observer;
  class Observable;
*/
  class BodyPartMemento {
  public:
    virtual ~BodyPartMemento() {}

    virtual void detach() = 0;
#if 0
//FIXME(Andras) review, port
    virtual Observer * asObserver() = 0;

    virtual Observable * asObservable() = 0;
#endif
  };

  class BodyPart {
  public:
    virtual ~BodyPart() {}

    virtual QString makeLink( const QString & path ) const = 0;

    virtual QString asText() const = 0;

    virtual QByteArray asBinary() const = 0;

    virtual QString contentTypeParameter( const char * parameter ) const = 0;

    virtual QString contentDescription() const = 0;

    //virtual int contentDisposition() const = 0;
    virtual QString contentDispositionParameter( const char * parameter ) const = 0;

    virtual bool hasCompleteBody() const = 0;

    virtual BodyPartMemento * memento() const = 0;

    virtual void setBodyPartMemento( BodyPartMemento * ) = 0;

    enum Display { None, AsIcon, Inline };
    virtual Display defaultDisplay() const = 0;

    virtual KMime::Content* content() const = 0;

    virtual KMime::Content* topLevelContent() const = 0;

    virtual MessageViewer::NodeHelper* nodeHelper() const = 0;
  };

} // namespace Interface

}

#endif // __KMAIL_INTERFACES_BODYPART_H__