5. Formatters

The mail formatter hook class is com.novell.evolution.mail.format:1.0.

5.1. Base Formatter

The EMFormat class is the base class for all formatting types. It should only be used to define compound and complex types which do not rely on outputting any textual information, or rely on any screen or print output differences.

NameEMFormat
TargetEMFormatHookTarget

5.2. HTML Formatter

The EMFormatHTML class is the base class for most formatting types which generate HTML output. It renders output to a GtkHTML object. It uses a fairly complex multi-thread approach to the formatting to ensure the user-interface is not blocked for processing. GtkHTML is used in a limited way by this class for HTML parsing and resolution of embedded objects. Embedded objects and Widgets may not be used from formatters which hook onto this entry point.

NameEMFormatHTML
TargetEMFormatHookTarget

This section needs a huge amount of explanation, and/or more detail needs to be added to another section about the formatter class

5.3. HTML Display Formatter

The EMFormatHTMLDisplay class is a subclass of EMFormatHTML, and is used as a mail display widget. As such, it has access to all of the facilities of GtkHTML, such as embedded widgets. Like the EMFormatHTML class, this uses a complex multi-thread architecture.

NameEMFormatHTMLDisplay
TargetEMFormatHookTarget

This section needs a huge amount of explanation, and/or more detail needs to be added to another section about the formatter class

5.4. HTML Print Formatter

The EMFormatHTMLPrint class is a subclass of EMFormatHTML, and is used as a mail printing widget. It cannot access embedded widgets. For most purposes you would normally only connect to the EMFormatHTML hook, and generate generic HTML output which could be printed or shown on-screen if it isn't overriden by the display formatter.

NameEMFormatHTMLPrint
TargetEMFormatHookTarget

This section needs a huge amount of explanation, and/or more detail needs to be added to another section about the formatter class

5.5. Mail Quote Formatter

The EMFormatQuote class is a subclass of EMFormat, and is used as generator for quoted mail content and for inline-forwarding. This formatter converts message objects into a pure HTML stream, which is not parsed directly, but normally fed to the message composer.

NameEMFormatQuote
TargetEMFormatHookTarget

5.6. Mail Formatter Targets

There is only one target for all mail formatters, and it is implied automatically for all formatter hooks.

StructureEMFormatHookTarget
Flags
inline = EM_FORMAT_HANDLER_INLINE
inline_disposition = EM_FORMAT_HANDLER_INLINE_DISPOSITION