kmail

bodypartformatter.h

Go to the documentation of this file.
00001 /*  -*- mode: C++; c-file-style: "gnu" -*-
00002     bodypartformatter.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_INTERFACE_BODYPARTFORMATTER_H__
00035 #define __KMAIL_INTERFACE_BODYPARTFORMATTER_H__
00036 
00037 namespace KMail {
00038 
00039   class HtmlWriter;
00040 
00041   namespace Interface {
00042 
00043     class BodyPart;
00044     class BodyPartURLHandler;
00045 
00046     class BodyPartFormatter {
00047     public:
00048       virtual ~BodyPartFormatter() {}
00049 
00056       enum Result { Ok, NeedContent, AsIcon, Failed };
00057 
00064       virtual Result format( BodyPart * part, KMail::HtmlWriter * writer ) const = 0;
00065     };
00066 
00080     class BodyPartFormatterPlugin {
00081     public:
00082       virtual ~BodyPartFormatterPlugin() {}
00083 
00084       virtual const BodyPartFormatter * bodyPartFormatter( int idx ) const = 0;
00085       virtual const char * type( int idx ) const = 0;
00086       virtual const char * subtype( int idx ) const = 0;
00087 
00088       virtual const BodyPartURLHandler * urlHandler( int idx ) const = 0;
00089     };
00090 
00091   } // namespace Interface
00092 
00093 } // namespace KMail
00094 
00095 #endif // __KMAIL_INTERFACE_BODYPARTFORMATTER_H__