KDE 4.2 API Reference kmail
KMail::HtmlWriter Class Reference
#include <htmlwriter.h>
Detailed Description
An interface to HTML sinks.
- Deprecated:
- KMail should be ported to Interface::HtmlWriter. This interface exposes internal working models. The queuing vs. writing() issues exposed here should be hidden by using two different implementations of KHTMLPartHtmlWriter: one for queuing, and one for writing. This should be fixed before the release, so we an keep the plugin interface stable.
Mode
In sync mode, use begin() to initiate a session, then write() some chunks of HTML code and finally end() the session.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.
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 99 of file htmlwriter.h.
Public Member Functions | |
| virtual void | embedPart (const QByteArray &contentId, const QString &url)=0 |
| virtual void | flush ()=0 |
| virtual void | queue (const QString &str)=0 |
| virtual void | reset ()=0 |
| virtual | ~HtmlWriter () |
Constructor & Destructor Documentation
| virtual KMail::HtmlWriter::~HtmlWriter | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual void KMail::HtmlWriter::embedPart | ( | const QByteArray & | contentId, | |
| const QString & | url | |||
| ) | [pure virtual] |
Embed a part with Content-ID contentId, using url url.
Implemented in KMail::FileHtmlWriter, KMail::KHtmlPartHtmlWriter, and KMail::TeeHtmlWriter.
| virtual void KMail::HtmlWriter::flush | ( | ) | [pure virtual] |
(Start) flushing internal buffers, if any.
Implemented in KMail::FileHtmlWriter, KMail::KHtmlPartHtmlWriter, and KMail::TeeHtmlWriter.
| virtual void KMail::HtmlWriter::queue | ( | const QString & | str | ) | [pure virtual] |
Implemented in KMail::FileHtmlWriter, KMail::KHtmlPartHtmlWriter, and KMail::TeeHtmlWriter.
| virtual void KMail::HtmlWriter::reset | ( | ) | [pure virtual] |
Stop all possibly pending processing in order to be able to call begin() again.
Implemented in KMail::FileHtmlWriter, KMail::KHtmlPartHtmlWriter, and KMail::TeeHtmlWriter.
The documentation for this class was generated from the following file:
