KDE PIM / Developers / API Docs / kmail

KMail::HtmlWriter Class Reference

An interface to HTML sinks. More...

#include <htmlwriter.h>

Inherits KMail::Interface::HtmlWriter.

Inherited by KMail::FileHtmlWriter, KMail::KHtmlPartHtmlWriter, and KMail::TeeHtmlWriter.

List of all members.

Public Member Functions


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:

Mode

In sync mode, use
See also:
begin() to initiate a session, then

write() some chunks of HTML code and finally

end() the session.

Mode

In async mode, use
See also:
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.

mode

You may combine the two modes in the following way only. Any number of
See also:
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
See also:
flush(), not

end().


Member Function Documentation

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

Stop all possibly pending processing in order to be able to call.

See also:
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: