#include <htmlwriter.h>
Public Member Functions | |
| virtual void | reset ()=0 |
| virtual void | queue (const TQString &str)=0 |
| virtual void | flush ()=0 |
| virtual void | embedPart (const TQCString &contentId, const TQString &url)=0 |
Detailed Description
An interface to HTML sinks.
- 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 TDEHTMLPartHtmlWriter: 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 #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.
Member Function Documentation
◆ embedPart()
|
pure virtual |
Embed a part with Content-ID contentId, using url url.
Implemented in KMail::TeeHtmlWriter.
◆ flush()
|
pure virtual |
(Start) flushing internal buffers, if any.
Implemented in KMail::TeeHtmlWriter.
◆ reset()
|
pure virtual |
Stop all possibly pending processing in order to be able to call #begin() again.
Implemented in KMail::TeeHtmlWriter.
The documentation for this class was generated from the following file: