kmail

KMail::Interface::BodyPartFormatter

KMail::Interface::BodyPartFormatter Class Reference

#include <bodypartformatter.h>

List of all members.


Public Types

enum  Result { Ok, NeedContent, AsIcon, Failed }

Public Member Functions

virtual Result format (BodyPart *part, KMail::HtmlWriter *writer) const =0
virtual ~BodyPartFormatter ()

Detailed Description

Definition at line 46 of file interfaces/bodypartformatter.h.

Member Enumeration Documentation

enum KMail::Interface::BodyPartFormatter::Result

  • Ok returned when format() generated some HTML
  • NeedContent returned when format() needs the body of the part
  • AsIcon returned when the part should be shown iconified
  • Failed returned when formatting failed. Currently equivalent to Ok
Enumerator:
Ok 
NeedContent 
AsIcon 
Failed 

Definition at line 56 of file interfaces/bodypartformatter.h.

Constructor & Destructor Documentation

virtual KMail::Interface::BodyPartFormatter::~BodyPartFormatter (  )  [inline, virtual]

Definition at line 48 of file interfaces/bodypartformatter.h.

Member Function Documentation

virtual Result KMail::Interface::BodyPartFormatter::format ( BodyPart *  part,
KMail::HtmlWriter *  writer 
) const [pure virtual]

Format body part part by generating some HTML and writing that to writer.

Returns:
the result code (see above)

The documentation for this class was generated from the following file: