KMail::HtmlWriter Class Reference
An interface to HTML sinks. More...
#include <htmlwriter.h>
Inheritance diagram for KMail::HtmlWriter:

Public Member Functions | |
virtual void | begin (const QString &cssDefinitions)=0 |
virtual void | end ()=0 |
virtual void | reset ()=0 |
virtual void | write (const QString &str)=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>
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 70 of file htmlwriter.h.
Member Function Documentation
|
Signal the begin of stuff to write, and give the CSS definitions.
Implemented in KMail::TeeHtmlWriter. |
|
Signal the end of stuff to write.
Implemented in KMail::TeeHtmlWriter. |
|
Stop all possibly pending processing in order to be able to call begin() again.
Implemented in KMail::TeeHtmlWriter. |
|
Write out a chunk of text. No HTML escaping is performed. Implemented in KMail::TeeHtmlWriter. |
|
(Start) flushing internal buffers, if any.
Implemented in KMail::TeeHtmlWriter. |
The documentation for this class was generated from the following file: