VMime
textPart Class Referenceabstract
Inheritance diagram for textPart:
Collaboration diagram for textPart:

Public Member Functions

virtual ~textPart ()
 
virtual const mediaType getType () const =0
 
virtual const charsetgetCharset () const =0
 
virtual void setCharset (const charset &ch)=0
 
virtual const shared_ptr
< const contentHandler
getText () const =0
 
virtual void setText (shared_ptr< contentHandler > text)=0
 
virtual size_t getPartCount () const =0
 
virtual void generateIn (shared_ptr< bodyPart > message, shared_ptr< bodyPart > parent) const =0
 
virtual void parse (shared_ptr< const bodyPart > message, shared_ptr< const bodyPart > parent, shared_ptr< const bodyPart > textPart)=0
 

Additional Inherited Members

- Protected Member Functions inherited from object
 object ()
 
 object (const object &)
 
objectoperator= (const object &)
 
virtual ~object ()
 

Detailed Description

Generic text part.

Constructor & Destructor Documentation

virtual ~textPart ( )
virtual

Member Function Documentation

virtual void generateIn ( shared_ptr< bodyPart message,
shared_ptr< bodyPart parent 
) const
pure virtual

Generate the text part(s) into the specified message.

Parameters
messagethe message
parentbody part into which generate this part

Implemented in htmlTextPart, and plainTextPart.

virtual const charset& getCharset ( ) const
pure virtual

Return the charset used to encode text in the text part.

Returns
text charset

Implemented in htmlTextPart, and plainTextPart.

virtual size_t getPartCount ( ) const
pure virtual

Return the actual body parts this text part is composed of.

For example, HTML parts are composed of two parts: one "text/html" part, and the plain text part "text/plain".

Returns
number of body parts

Implemented in htmlTextPart, and plainTextPart.

virtual const shared_ptr<const contentHandler> getText ( ) const
pure virtual

Return the text contained in the part.

Returns
text of the part

Implemented in htmlTextPart, and plainTextPart.

virtual const mediaType getType ( ) const
pure virtual

Return the type of text part (eg: "text/html").

Returns
type of text part

Implemented in htmlTextPart, and plainTextPart.

virtual void parse ( shared_ptr< const bodyPart message,
shared_ptr< const bodyPart parent,
shared_ptr< const bodyPart textPart 
)
pure virtual

Parse the text part(s) from the specified message.

Parameters
messagemessage containing the text part
parentpart containing the text part
textPartactual text part

Implemented in htmlTextPart, and plainTextPart.

virtual void setCharset ( const charset ch)
pure virtual

Set the charset used to encode text in the text part.

Parameters
chtext charset

Implemented in htmlTextPart, and plainTextPart.

virtual void setText ( shared_ptr< contentHandler text)
pure virtual

Set the text contained in the part.

Parameters
texttext of the part

Implemented in htmlTextPart, and plainTextPart.


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