kmail

bodypart.h

Go to the documentation of this file.
00001 /*  -*- mode: C++; c-file-style: "gnu" -*-
00002     bodypart.h
00003 
00004     This file is part of KMail's plugin interface.
00005     Copyright (c) 2004 Marc Mutz <mutz@kde.org>,
00006                        Ingo Kloecker <kloecker@kde.org>
00007 
00008     KMail is free software; you can redistribute it and/or modify it
00009     under the terms of the GNU General Public License as published by
00010     the Free Software Foundation; either version 2 of the License, or
00011     (at your option) any later version.
00012 
00013     KMail is distributed in the hope that it will be useful, but
00014     WITHOUT ANY WARRANTY; without even the implied warranty of
00015     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00016     General Public License for more details.
00017 
00018     You should have received a copy of the GNU General Public License
00019     along with this program; if not, write to the Free Software
00020     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
00021 
00022     In addition, as a special exception, the copyright holders give
00023     permission to link the code of this program with any edition of
00024     the Qt library by Trolltech AS, Norway (or with modified versions
00025     of Qt that use the same license as Qt), and distribute linked
00026     combinations including the two.  You must obey the GNU General
00027     Public License in all respects for all of the code used other than
00028     Qt.  If you modify this file, you may extend this exception to
00029     your version of the file, but you are not obligated to do so.  If
00030     you do not wish to do so, delete this exception statement from
00031     your version.
00032 */
00033 
00034 #ifndef __KMAIL_INTERFACES_BODYPART_H__
00035 #define __KMAIL_INTERFACES_BODYPART_H__
00036 
00037 template <typename T> class QMemArray;
00038 typedef QMemArray<char> QByteArray;
00039 class QString;
00040 
00041 namespace KMail {
00042   namespace Interface {
00043 
00044     class Observer;
00045     class Observable;
00046 
00050     class BodyPartMemento {
00051     public:
00052       virtual ~BodyPartMemento() {}
00053 
00060       virtual Observer * asObserver() = 0;
00061 
00068       virtual Observable * asObservable() = 0;
00069     };
00070 
00074     class BodyPart {
00075     public:
00076       virtual ~BodyPart() {}
00077 
00082       virtual QString makeLink( const QString & path ) const = 0;
00083 
00089       virtual QString asText() const = 0;
00090 
00095       virtual QByteArray asBinary() const = 0;
00096 
00113       virtual QString contentTypeParameter( const char * parameter ) const = 0;
00114 
00120       virtual QString contentDescription() const = 0;
00121 
00122       //virtual int contentDisposition() const = 0;
00132       virtual QString contentDispositionParameter( const char * parameter ) const = 0;
00133 
00138       virtual bool hasCompleteBody() const = 0;
00139 
00144       virtual BodyPartMemento * memento() const = 0;
00145 
00150       virtual void setBodyPartMemento( BodyPartMemento * ) = 0;
00151 
00152       enum Display { None, AsIcon, Inline };
00156       virtual Display defaultDisplay() const = 0;
00157     };
00158 
00159   } // namespace Interface
00160 
00161 } // namespace KMail
00162 
00163 #endif // __KMAIL_INTERFACES_BODYPART_H__