kmail

htmlwriter.h

Go to the documentation of this file.
00001 /*  -*- c++ -*-
00002     interfaces/htmlwriter.h
00003 
00004     This file is part of KMail's plugin interface.
00005     Copyright (c) 2003 Marc Mutz <mutz@kde.org>
00006 
00007     KMail is free software; you can redistribute it and/or modify it
00008     under the terms of the GNU General Public License as published by
00009     the Free Software Foundation; either version 2 of the License, or
00010     (at your option) any later version.
00011 
00012     KMail is distributed in the hope that it will be useful, but
00013     WITHOUT ANY WARRANTY; without even the implied warranty of
00014     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015     General Public License for more details.
00016 
00017     You should have received a copy of the GNU General Public License
00018     along with this program; if not, write to the Free Software
00019     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
00020 
00021     In addition, as a special exception, the copyright holders give
00022     permission to link the code of this program with any edition of
00023     the Qt library by Trolltech AS, Norway (or with modified versions
00024     of Qt that use the same license as Qt), and distribute linked
00025     combinations including the two.  You must obey the GNU General
00026     Public License in all respects for all of the code used other than
00027     Qt.  If you modify this file, you may extend this exception to
00028     your version of the file, but you are not obligated to do so.  If
00029     you do not wish to do so, delete this exception statement from
00030     your version.
00031 */
00032 
00033 #ifndef __KMAIL_INTERFACES_HTMLWRITER_H__
00034 #define __KMAIL_INTERFACES_HTMLWRITER_H__
00035 
00036 class QCString;
00037 class QString;
00038 
00039 namespace KMail {
00040 
00046   namespace Interface {
00047     class HtmlWriter {
00048     public:
00049       virtual ~HtmlWriter() {}
00050 
00052       virtual void begin( const QString & cssDefinitions ) = 0;
00054       virtual void write( const QString & html ) = 0;
00056       virtual void end() = 0;
00057     };
00058   }
00059 
00099   class HtmlWriter : public Interface::HtmlWriter {
00100   public:
00101     virtual ~HtmlWriter() {}
00102 
00105     virtual void reset() = 0;
00106 
00107     virtual void queue( const QString & str ) = 0;
00109     virtual void flush() = 0;
00110 
00114     virtual void embedPart( const QCString & contentId, const QString & url ) = 0;
00115   };
00116 
00117 } // namespace KMail
00118 
00119 #endif // __KMAIL_INTERFACES_HTMLWRITER_H__
00120