kmail
KMail::Interface::BodyPart Class Reference
interface of message body parts. More...
#include <bodypart.h>
Inheritance diagram for KMail::Interface::BodyPart:
Public Types | |
| enum | Display { None, AsIcon, Inline } |
Public Member Functions | |
| virtual QByteArray | asBinary () const =0 |
| virtual QString | asText () const =0 |
| virtual QString | contentDescription () const =0 |
| virtual QString | contentDispositionParameter (const char *parameter) const =0 |
| virtual QString | contentTypeParameter (const char *parameter) const =0 |
| virtual Display | defaultDisplay () const =0 |
| virtual bool | hasCompleteBody () const =0 |
| virtual QString | makeLink (const QString &path) const =0 |
| virtual BodyPartMemento * | memento () const =0 |
| virtual void | setBodyPartMemento (BodyPartMemento *)=0 |
| virtual | ~BodyPart () |
Detailed Description
interface of message body parts.Definition at line 74 of file bodypart.h.
Member Enumeration Documentation
Constructor & Destructor Documentation
| virtual KMail::Interface::BodyPart::~BodyPart | ( | ) | [inline, virtual] |
Definition at line 76 of file bodypart.h.
Member Function Documentation
| virtual QByteArray KMail::Interface::BodyPart::asBinary | ( | ) | const [pure virtual] |
- Returns:
- the decoded (CTE undone) content of the body part, or a null array if this body part instance is of type text.
Implemented in KMail::PartNodeBodyPart.
| virtual QString KMail::Interface::BodyPart::asText | ( | ) | const [pure virtual] |
- Returns:
- the decoded (CTE, canonicalisation, and charset encoding undone) text contained in the body part, or QString::null, it the body part is not of type "text".
Implemented in KMail::PartNodeBodyPart.
| virtual QString KMail::Interface::BodyPart::contentDescription | ( | ) | const [pure virtual] |
- Returns:
- the content of the content-description header field, or QString::null if that header is not present in this body part. RFC 2047 encoding is decoded first.
Implemented in KMail::PartNodeBodyPart.
| virtual QString KMail::Interface::BodyPart::contentDispositionParameter | ( | const char * | parameter | ) | const [pure virtual] |
- Returns:
- the value of the content-disposition header field parameter with name parameter, or QString::null if that parameter is not present in the body's content-disposition header field. RFC 2231 encoding is removed first.
Implemented in KMail::PartNodeBodyPart.
| virtual QString KMail::Interface::BodyPart::contentTypeParameter | ( | const char * | parameter | ) | const [pure virtual] |
- Returns:
- the value of the content-type header field parameter with name parameter, or QString::null, if that that parameter is not present in the body's content-type header field. RFC 2231 encoding is removed first.
Note2 that this method preserves the case of the parameter value returned. So, if the parameter you want to use defines the value to be case-insensitive (such as the smime-type parameter), you need to make sure you do the casemap yourself before comparing to a reference value.
Implemented in KMail::PartNodeBodyPart.
| virtual Display KMail::Interface::BodyPart::defaultDisplay | ( | ) | const [pure virtual] |
- Returns:
- whether this body part should be displayed iconic or inline
Implemented in KMail::PartNodeBodyPart.
| virtual bool KMail::Interface::BodyPart::hasCompleteBody | ( | ) | const [pure virtual] |
- Returns:
- whether this part already has it's complete body fetched e.g. from an IMAP server.
Implemented in KMail::PartNodeBodyPart.
- Returns:
- a string respresentation of an URL that can be used to invoke a BodyPartURLHandler for this body part.
Implemented in KMail::PartNodeBodyPart.
| virtual BodyPartMemento* KMail::Interface::BodyPart::memento | ( | ) | const [pure virtual] |
- Returns:
- the BodyPartMemento set for this part, or null, if none is set.
Implemented in KMail::PartNodeBodyPart.
| virtual void KMail::Interface::BodyPart::setBodyPartMemento | ( | BodyPartMemento * | ) | [pure virtual] |
- Returns:
- register an implementation of the BodyPartMemento interface as a status object with this part.
Implemented in KMail::PartNodeBodyPart.
The documentation for this class was generated from the following file:
