Public Member Functions | List of all members
KMail::PartNodeBodyPart Class Reference

#include <partnodebodypart.h>

Inheritance diagram for KMail::PartNodeBodyPart:
KMail::Interface::BodyPart

Public Member Functions

 PartNodeBodyPart (partNode &n, const TQTextCodec *codec=0)
 
TQString makeLink (const TQString &path) const
 
TQString asText () const
 
TQByteArray asBinary () const
 
TQString contentTypeParameter (const char *param) const
 
TQString contentDescription () const
 
TQString contentDispositionParameter (const char *param) const
 
bool hasCompleteBody () const
 
Interface::BodyPartMemento * memento () const
 
void setBodyPartMemento (Interface::BodyPartMemento *memento)
 
BodyPart::Display defaultDisplay () const
 
void setDefaultDisplay (BodyPart::Display)
 

Additional Inherited Members

- Public Types inherited from KMail::Interface::BodyPart
enum  Display { None , AsIcon , Inline }
 

Detailed Description

an implemenation of the BodyPart interface using partNodes

Definition at line 48 of file partnodebodypart.h.

Member Function Documentation

◆ asBinary()

TQByteArray KMail::PartNodeBodyPart::asBinary ( ) const
virtual
Returns
the decoded (CTE undone) content of the body part, or a null array if this body part instance is of type text.

Implements KMail::Interface::BodyPart.

Definition at line 62 of file partnodebodypart.cpp.

◆ asText()

TQString KMail::PartNodeBodyPart::asText ( ) const
virtual
Returns
the decoded (CTE, canonicalisation, and charset encoding undone) text contained in the body part, or TQString(), it the body part is not of type "text".

Implements KMail::Interface::BodyPart.

Definition at line 56 of file partnodebodypart.cpp.

◆ contentDescription()

TQString KMail::PartNodeBodyPart::contentDescription ( ) const
virtual
Returns
the content of the content-description header field, or TQString() if that header is not present in this body part. RFC 2047 encoding is decoded first.

Implements KMail::Interface::BodyPart.

Definition at line 70 of file partnodebodypart.cpp.

◆ contentDispositionParameter()

TQString KMail::PartNodeBodyPart::contentDispositionParameter ( const char *  parameter) const
virtual
Returns
the value of the content-disposition header field parameter with name parameter, or TQString() if that parameter is not present in the body's content-disposition header field. RFC 2231 encoding is removed first.

The notes made for contentTypeParameter() above apply here as well.

Implements KMail::Interface::BodyPart.

Definition at line 74 of file partnodebodypart.cpp.

◆ contentTypeParameter()

TQString KMail::PartNodeBodyPart::contentTypeParameter ( const char *  parameter) const
virtual
Returns
the value of the content-type header field parameter with name parameter, or TQString(), if that that parameter is not present in the body's content-type header field. RFC 2231 encoding is removed first.

Note that this method will suppress queries to certain standard parameters (most notably "charset") to keep plugins decent.

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.

Implements KMail::Interface::BodyPart.

Definition at line 66 of file partnodebodypart.cpp.

◆ defaultDisplay()

KMail::Interface::BodyPart::Display KMail::PartNodeBodyPart::defaultDisplay ( ) const
virtual
Returns
whether this body part should be displayed iconic or inline

Implements KMail::Interface::BodyPart.

Definition at line 92 of file partnodebodypart.cpp.

◆ hasCompleteBody()

bool KMail::PartNodeBodyPart::hasCompleteBody ( ) const
virtual
Returns
whether this part already has it's complete body fetched e.g. from an IMAP server.

Implements KMail::Interface::BodyPart.

Definition at line 79 of file partnodebodypart.cpp.

◆ makeLink()

TQString KMail::PartNodeBodyPart::makeLink ( const TQString &  path) const
virtual
Returns
a string respresentation of an URL that can be used to invoke a BodyPartURLHandler for this body part.

Implements KMail::Interface::BodyPart.

Definition at line 48 of file partnodebodypart.cpp.

◆ memento()

KMail::Interface::BodyPartMemento * KMail::PartNodeBodyPart::memento ( ) const
virtual
Returns
the BodyPartMemento set for this part, or null, if none is set.

Implements KMail::Interface::BodyPart.

Definition at line 84 of file partnodebodypart.cpp.

◆ setBodyPartMemento()

void KMail::PartNodeBodyPart::setBodyPartMemento ( Interface::BodyPartMemento *  )
virtual
Returns
register an implementation of the BodyPartMemento interface as a status object with this part.

Implements KMail::Interface::BodyPart.

Definition at line 88 of file partnodebodypart.cpp.

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