kmail Library API Documentation

KMail::HtmlWriter Class Reference

An interface to HTML sinks. More...

#include <htmlwriter.h>

Inheritance diagram for KMail::HtmlWriter:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual void reset ()=0
virtual void queue (const QString &str)=0
virtual void flush ()=0

Detailed Description

An interface to HTML sinks.

Author:
Marc Mutz <mutz@kde.org>
Deprecated:
KMail should be ported to Interface::HtmlWriter.
This interface exposes internal working models. The queueing vs. writing() issues exposed here should be hidden by using two different implementations of KHTMLPartHtmlWriter: one for queueing, and one for writing. This should be fixed before the release, so we an keep the plugin interface stable.

Operate this interface in one and only one of the following two modes:

Sync Mode

In sync mode, use begin() to initiate a session, then write() some chunks of HTML code and finally end() the session.

Async Mode

In async mode, use begin() to initialize a session, then queue() some chunks of HTML code and finally end the session by calling flush().

Queued HTML code is fed to the html sink using a timer. For this to work, control must return to the event loop so timer events are delivered.

Combined mode

You may combine the two modes in the following way only. Any number of write() calls can precede queue() calls, but once a chunk has been queued, you must not write() more data, only queue() it.

Naturally, whenever you queued data in a given session, that session must be ended by calling flush(), not end().

Definition at line 98 of file htmlwriter.h.


Member Function Documentation

virtual void KMail::HtmlWriter::reset  )  [pure virtual]
 

Stop all possibly pending processing in order to be able to call begin() again.

Implemented in KMail::TeeHtmlWriter.

virtual void KMail::HtmlWriter::flush  )  [pure virtual]
 

(Start) flushing internal buffers, if any.

Implemented in KMail::TeeHtmlWriter.


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Aug 23 18:21:55 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003