rwlogo
SourcePro C++ 12.0

SourcePro® C++ API Reference Guide



   SourcePro C++
Documentation Home

RWMimeContentDispositionHeader Class Reference
[MIME]

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

#include <rw/mime/RWMimeContentDispositionHeader.h>

Inheritance diagram for RWMimeContentDispositionHeader:
RWMimeHeader RWHandleBase

List of all members.

Public Member Functions

 RWMimeContentDispositionHeader (void)
 RWMimeContentDispositionHeader (const RWMimeContentDisposition &contentDisposition)
 RWMimeContentDispositionHeader (const RWMimeContentDispositionHeader &second)
 RWMimeContentDispositionHeader (const RWMimeHeader &second)
RWMimeContentDispositionHeaderoperator= (const RWMimeContentDispositionHeader &second)
virtual ~RWMimeContentDispositionHeader (void)
RWMimeContentDisposition getContentDisposition (void) const
void setContentDisposition (const RWMimeContentDisposition &contentDisposition)

Static Public Attributes

static const RWCString Label

Protected Member Functions

virtual bool checkLabel (const RWCString &label) const
RWMimeContentDispositionHeaderImp & body (void) const

Detailed Description

RWMimeContentDispositionHeader represents the Content-Disposition header of a MIME part. The Content-Disposition specifies the way in which a recipient should present the part.

The Content-Disposition Header specification, RFC 1806, defines two values for the header. A value of inline states that the part should be presented at the same time the rest of the message is presented. A value of attachment states that the part should be treated as a separate file attached to the message. The specification also defines an optional filename parameter that provides a filename for the MIME part.

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

Note:
RWMimeContentDispositionHeader conforms to the Content-Disposition header requirements specified in RFC 1806.

Constructor & Destructor Documentation

RWMimeContentDispositionHeader::RWMimeContentDispositionHeader ( void   ) 

Default constructor. Constructs a header with no value.

Note:
A header with an empty value does not meet the requirements for a Content-Disposition header.
RWMimeContentDispositionHeader::RWMimeContentDispositionHeader ( const RWMimeContentDisposition contentDisposition  ) 

Constructs a header with the value contentDisposition.

RWMimeContentDispositionHeader::RWMimeContentDispositionHeader ( const RWMimeContentDispositionHeader second  ) 

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

RWMimeContentDispositionHeader::RWMimeContentDispositionHeader ( 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 RWMimeContentDispositionHeader::~RWMimeContentDispositionHeader ( void   )  [virtual]

Destructor.


Member Function Documentation

RWMimeContentDispositionHeaderImp& RWMimeContentDispositionHeader::body ( void   )  const [protected]

Returns a reference to the underlying implementation.

Reimplemented from RWMimeHeader.

virtual bool RWMimeContentDispositionHeader::checkLabel ( const RWCString label  )  const [protected, virtual]

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

Reimplemented from RWMimeHeader.

RWMimeContentDisposition RWMimeContentDispositionHeader::getContentDisposition ( void   )  const

Returns a copy of self's value as an RWMimeContentDisposition.

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

Assignment operator. Makes self a handle identical to second.

void RWMimeContentDispositionHeader::setContentDisposition ( const RWMimeContentDisposition contentDisposition  ) 

Sets self's value to contentDisposition.


Member Data Documentation

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

 All Classes Functions Variables Typedefs Enumerations Enumerator Friends

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.