SourcePro® API Reference Guide

 
List of all members | Public Member Functions | Static Public Attributes | Protected Member Functions
RWMimeContentDescriptionHeader Class Reference

Represents the Content-Description header of a MIME part. More...

#include <rw/mime/RWMimeContentDescriptionHeader.h>

Inheritance diagram for RWMimeContentDescriptionHeader:
RWMimeHeader RWHandleBase

Public Member Functions

 RWMimeContentDescriptionHeader (void)
 
 RWMimeContentDescriptionHeader (const RWCString &description)
 
 RWMimeContentDescriptionHeader (const RWMimeContentDescriptionHeader &second)
 
 RWMimeContentDescriptionHeader (const RWMimeHeader &second)
 
virtual ~RWMimeContentDescriptionHeader (void)
 
RWCString getDescription (void) const
 
RWMimeContentDescriptionHeaderoperator= (const RWMimeContentDescriptionHeader &second)
 
void setDescription (const RWCString &description)
 
- Public Member Functions inherited from RWMimeHeader
 RWMimeHeader (void)
 
 RWMimeHeader (const RWCString &label)
 
 RWMimeHeader (const RWMimeHeader &second)
 
virtual ~RWMimeHeader (void)
 
RWCString asString (void) const
 
void fromString (const RWCString &headerString)
 
RWCString getLabel (void) const
 
RWMimeHeaderoperator= (const RWMimeHeader &second)
 
- Public Member Functions inherited from RWHandleBase
bool isValid (void) const
 
bool operator!= (const RWHandleBase &second) const
 
bool operator< (const RWHandleBase &second) const
 
bool operator== (const RWHandleBase &second) const
 

Static Public Attributes

static const RWCString Label
 

Protected Member Functions

RWMimeUnstructuredHeaderImp & body (void) const
 
virtual bool checkLabel (const RWCString &label) const
 
- Protected Member Functions inherited from RWMimeHeader
RWMimeHeaderImp & body (void) const
 
- Protected Member Functions inherited from RWHandleBase
 RWHandleBase (void)
 
 RWHandleBase (RWStaticCtor)
 
 RWHandleBase (RWBodyBase *body)
 
 RWHandleBase (const RWHandleBase &second)
 
 ~RWHandleBase (void)
 
RWBodyBasebody (void) const
 
RWHandleBaseoperator= (const RWHandleBase &second)
 

Detailed Description

RWMimeContentDescriptionHeader represents the Content-Description header of a MIME part. The Content-Description provides a short text description of the contents of the message part. For example, a MIME message containing a sales report might contain the Content-Description header

Content-Description: Sales report for last quarter.

An instance of this class is a handle to a private, reference-counted body.

Reference
RWMimeContentDescriptionHeader conforms to the Content-Description header requirements specified in RFC 2045, Section 8 (p. 27).

Constructor & Destructor Documentation

RWMimeContentDescriptionHeader::RWMimeContentDescriptionHeader ( void  )

Default constructor. Constructs a header with an empty value.

RWMimeContentDescriptionHeader::RWMimeContentDescriptionHeader ( const RWCString description)

Constructs a header with the value description. Does not validate description. The description provided must be in US-ASCII format or be encoded according to the guidelines in RFC 2047 for the header to meet the requirements of the Internet Message Format specification. The RWCString should contain 7-bit US-ASCII data.

RWMimeContentDescriptionHeader::RWMimeContentDescriptionHeader ( const RWMimeContentDescriptionHeader second)

Copy constructor. Constructs a new handle to the body second refers to.

RWMimeContentDescriptionHeader::RWMimeContentDescriptionHeader ( const RWMimeHeader second)

Conversion constructor. Constructs a new handle to the body second refers to. Throws RWMimeError if second does not have the label "Content-Description".

virtual RWMimeContentDescriptionHeader::~RWMimeContentDescriptionHeader ( void  )
virtual

Destructor.

Member Function Documentation

RWMimeUnstructuredHeaderImp& RWMimeContentDescriptionHeader::body ( void  ) const
protected

Returns a reference to the underlying implementation.

virtual bool RWMimeContentDescriptionHeader::checkLabel ( const RWCString label) const
protectedvirtual

Returns true if label matches "Content-Description", false otherwise. The comparison is case-insensitive. The RWCString should contain 7-bit US-ASCII data.

Reimplemented from RWMimeHeader.

RWCString RWMimeContentDescriptionHeader::getDescription ( void  ) const

Returns the content description value contained within this header. The RWCString should contain 7-bit US-ASCII data.

RWMimeContentDescriptionHeader& RWMimeContentDescriptionHeader::operator= ( const RWMimeContentDescriptionHeader second)

Assignment operator. Makes self a handle identical to second.

void RWMimeContentDescriptionHeader::setDescription ( const RWCString description)

Sets the content description value contained within this header. The RWCString should contain 7-bit US-ASCII data.

Member Data Documentation

const RWCString RWMimeContentDescriptionHeader::Label
static

Static constant string containing "Content-Description", the label for a Content-Description header. The RWCString should contain 7-bit US-ASCII data.

Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.