SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches
RWMimeTextType Class Reference

Represents a Content-Type value with the media type text. More...

#include <rw/mime/RWMimeTextType.h>

Inheritance diagram for RWMimeTextType:
RWMimeContentType RWHandleBase

Public Member Functions

 RWMimeTextType (const RWCString &subType, const RWCString &charset="")
 
 RWMimeTextType (const RWMimeContentType &second)
 
 RWMimeTextType (const RWMimeTextType &second)
 
 RWMimeTextType (void)
 
virtual ~RWMimeTextType (void)
 
RWCString getCharset (void) const
 
RWMimeTextTypeoperator= (const RWMimeTextType &second)
 
void setCharset (const RWCString &charset)
 
- Public Member Functions inherited from RWMimeContentType
 RWMimeContentType (const RWCString &mediaType, const RWCString &subType, const RWMimeParameterList &parameters=RWMimeParameterList())
 
 RWMimeContentType (const RWMimeContentType &second)
 
 RWMimeContentType (void)
 
virtual ~RWMimeContentType (void)
 
RWCString asString (void) const
 
size_t findParameter (const RWCString &name, size_t start=0) const
 
void fromString (const RWCString &contentType)
 
RWCString getMediaType (void) const
 
RWMimeParameter getParameter (size_t i) const
 
size_t getParameterCount (void) const
 
RWCString getParameterValue (const RWCString &name, size_t start=0) const
 
RWCString getSubType (void) const
 
void insertParameter (const RWMimeParameter &parameter)
 
RWMimeContentTypeoperator= (const RWMimeContentType &second)
 
void removeAllParameters (void)
 
void removeParameter (size_t position)
 
void setParameterValue (const RWCString &name, const RWCString &value, size_t start=0)
 
- Public Member Functions inherited from RWHandleBase
bool isValid (void) const
 
bool operator!= (const RWHandleBase &second) const
 
bool operator== (const RWHandleBase &second) const
 

Protected Member Functions

virtual bool checkType (const RWCString &mediaType, const RWCString &subType) const
 
- Protected Member Functions inherited from RWMimeContentType
RWMimeContentTypeImp & body (void) const
 
- Protected Member Functions inherited from RWHandleBase
 RWHandleBase (const RWHandleBase &second)
 
 RWHandleBase (RWBodyBase *body)
 
 RWHandleBase (RWStaticCtor)
 
 RWHandleBase (void)
 
 ~RWHandleBase (void)
 
RWBodyBasebody (void) const
 
RWHandleBaseoperator= (const RWHandleBase &second)
 

Detailed Description

RWMimeTextType represents a Content-Type value with the media type text. The MIME specification states that a Content-Type header for text may contain a charset parameter. If present, the parameter specifies the character set used for the body of the MIME part containing the header. If the charset parameter is not present, the character set of the part is defined as US-ASCII.

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

Reference
RWMimeTextType conforms to the text Content-Type header requirements specified in RFC 2046, section 4.1 (p. 6).

Constructor & Destructor Documentation

◆ RWMimeTextType() [1/4]

RWMimeTextType::RWMimeTextType ( void )

Default constructor. Constructs a text Content-Type value with the subtype "plain". The value does not contain a charset parameter.

Note
A text Content-Type value without a charset parameter defines the character set of the part body as US-ASCII.

◆ RWMimeTextType() [2/4]

RWMimeTextType::RWMimeTextType ( const RWCString & subType,
const RWCString & charset = "" )

Constructs a text Content-Type value with the subtype subType. When a charset argument is present, the new value contains a charset parameter with the value charset. Otherwise, the new value does not contain a charset parameter. The RWCString should contain 7-bit US-ASCII data.

Note
A text Content-Type value without a charset parameter defines the character set of the part body as US-ASCII.

◆ RWMimeTextType() [3/4]

RWMimeTextType::RWMimeTextType ( const RWMimeTextType & second)

Constructs a new handle to the body second refers to.

◆ RWMimeTextType() [4/4]

RWMimeTextType::RWMimeTextType ( const RWMimeContentType & second)

Conversion constructor. Constructs a new handle to the body second refers to. Throws RWMimeError if second does not have the media type "text".

◆ ~RWMimeTextType()

virtual RWMimeTextType::~RWMimeTextType ( void )
virtual

Destructor.

Member Function Documentation

◆ checkType()

virtual bool RWMimeTextType::checkType ( const RWCString & mediaType,
const RWCString & subType ) const
protectedvirtual

Returns true if mediaType is "text", false otherwise. The RWCString should contain 7-bit US-ASCII data.

Reimplemented from RWMimeContentType.

◆ getCharset()

RWCString RWMimeTextType::getCharset ( void ) const

Returns the value of self's charset parameter, or an empty string if self does not contain a charset parameter. The RWCString should contain 7-bit US-ASCII data.

◆ operator=()

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

Makes self a handle identical to second.

◆ setCharset()

void RWMimeTextType::setCharset ( const RWCString & charset)

Sets the value of self's charset parameter. The RWCString should contain 7-bit US-ASCII data.

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