VMime
contentDispositionField Class Reference
Inheritance diagram for contentDispositionField:
Collaboration diagram for contentDispositionField:

Public Member Functions

bool hasCreationDate () const
 
const datetime getCreationDate () const
 
void setCreationDate (const datetime &creationDate)
 
bool hasModificationDate () const
 
const datetime getModificationDate () const
 
void setModificationDate (const datetime &modificationDate)
 
bool hasReadDate () const
 
const datetime getReadDate () const
 
void setReadDate (const datetime &readDate)
 
bool hasFilename () const
 
const word getFilename () const
 
void setFilename (const word &filename)
 
bool hasSize () const
 
const string getSize () const
 
void setSize (const string &size)
 
- Public Member Functions inherited from parameterizedHeaderField
 ~parameterizedHeaderField ()
 
void copyFrom (const component &other)
 
parameterizedHeaderFieldoperator= (const parameterizedHeaderField &other)
 
bool hasParameter (const string &paramName) const
 
shared_ptr< parameterfindParameter (const string &paramName) const
 
shared_ptr< parametergetParameter (const string &paramName)
 
void appendParameter (shared_ptr< parameter > param)
 
void insertParameterBefore (shared_ptr< parameter > beforeParam, shared_ptr< parameter > param)
 
void insertParameterBefore (const size_t pos, shared_ptr< parameter > param)
 
void insertParameterAfter (shared_ptr< parameter > afterParam, shared_ptr< parameter > param)
 
void insertParameterAfter (const size_t pos, shared_ptr< parameter > param)
 
void removeParameter (shared_ptr< parameter > param)
 
void removeParameter (const size_t pos)
 
void removeAllParameters ()
 
size_t getParameterCount () const
 
bool isEmpty () const
 
const shared_ptr< parametergetParameterAt (const size_t pos)
 
const shared_ptr< const parametergetParameterAt (const size_t pos) const
 
const std::vector< shared_ptr
< const parameter > > 
getParameterList () const
 
const std::vector< shared_ptr
< parameter > > 
getParameterList ()
 
const std::vector< shared_ptr
< component > > 
getChildComponents ()
 
- Public Member Functions inherited from headerField
 ~headerField ()
 
shared_ptr< componentclone () const
 
headerFieldoperator= (const headerField &other)
 
void setName (const string &name)
 
const string getName () const
 
bool isCustom () const
 
virtual shared_ptr< const
headerFieldValue
getValue () const
 
template<typename T >
shared_ptr< const T > getValue () const
 
virtual shared_ptr
< headerFieldValue
getValue ()
 
template<typename T >
shared_ptr< T > getValue ()
 
virtual void setValue (shared_ptr< headerFieldValue > value)
 
virtual void setValueConst (shared_ptr< const headerFieldValue > value)
 
virtual void setValue (const headerFieldValue &value)
 
void setValue (const string &value)
 
size_t getGeneratedSize (const generationContext &ctx)
 
- Public Member Functions inherited from component
 component ()
 
virtual ~component ()
 
void parse (const string &buffer)
 
void parse (const parsingContext &ctx, const string &buffer)
 
void parse (shared_ptr< utility::inputStream > inputStream, const size_t length)
 
void parse (const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)
 
void parse (const parsingContext &ctx, const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)
 
void parse (shared_ptr< utility::inputStream > inputStream, const size_t position, const size_t end, size_t *newPosition=NULL)
 
void parse (const parsingContext &ctx, shared_ptr< utility::inputStream > inputStream, const size_t position, const size_t end, size_t *newPosition=NULL)
 
virtual const string generate (const size_t maxLineLength=lineLengthLimits::infinite, const size_t curLinePos=0) const
 
virtual void generate (utility::outputStream &outputStream, const size_t curLinePos=0, size_t *newLinePos=NULL) const
 
virtual void generate (const generationContext &ctx, utility::outputStream &outputStream, const size_t curLinePos=0, size_t *newLinePos=NULL) const
 
size_t getParsedOffset () const
 
size_t getParsedLength () const
 

Protected Member Functions

 contentDispositionField ()
 
 contentDispositionField (contentDispositionField &)
 
- Protected Member Functions inherited from parameterizedHeaderField
 parameterizedHeaderField ()
 
void parseImpl (const parsingContext &ctx, const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)
 
void generateImpl (const generationContext &ctx, utility::outputStream &os, const size_t curLinePos=0, size_t *newLinePos=NULL) const
 
- Protected Member Functions inherited from headerField
 headerField ()
 
 headerField (const string &fieldName)
 
- Protected Member Functions inherited from component
void setParsedBounds (const size_t start, const size_t end)
 
virtual void parseImpl (const parsingContext &ctx, shared_ptr< utility::parserInputStreamAdapter > parser, const size_t position, const size_t end, size_t *newPosition=NULL)
 
- Protected Member Functions inherited from object
 object ()
 
 object (const object &)
 
objectoperator= (const object &)
 
virtual ~object ()
 

Additional Inherited Members

- Static Public Member Functions inherited from headerField
static shared_ptr< headerFieldparseNext (const parsingContext &ctx, const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)
 
- Protected Attributes inherited from headerField
string m_name
 
shared_ptr< headerFieldValuem_value
 

Detailed Description

Describes presentation information, as per RFC-2183.

Constructor & Destructor Documentation

contentDispositionField ( )
protected

Member Function Documentation

const datetime getCreationDate ( ) const

Return the value of the "creation-date" parameter.

Returns
value of the "creation-date" parameter

References parameterizedHeaderField::findParameter(), and datetime::now().

const word getFilename ( ) const

Return the value of the "filename" parameter.

Returns
value of the "filename" parameter

References parameterizedHeaderField::findParameter().

const datetime getModificationDate ( ) const

Return the value of the "modification-date" parameter.

Returns
value of the "modification-date" parameter

References parameterizedHeaderField::findParameter(), and datetime::now().

const datetime getReadDate ( ) const

Return the value of the "read-date" parameter.

Returns
value of the "read-date" parameter

References parameterizedHeaderField::findParameter(), and datetime::now().

const string getSize ( ) const

Return the value of the "size" parameter.

Returns
value of the "size" parameter

References parameterizedHeaderField::findParameter().

bool hasCreationDate ( ) const

Test whether the "creation-date" parameter is set.

Returns
true if the "creation-date" parameter is set, or false otherwise

References parameterizedHeaderField::hasParameter().

bool hasFilename ( ) const

Test whether the "filename" parameter is set.

Returns
true if the "filename" parameter is set, or false otherwise

References parameterizedHeaderField::hasParameter().

bool hasModificationDate ( ) const

Test whether the "modification-date" parameter is set.

Returns
true if the "modification-date" parameter is set, or false otherwise

References parameterizedHeaderField::hasParameter().

bool hasReadDate ( ) const

Test whether the "read-date" parameter is set.

Returns
true if the "read-date" parameter is set, or false otherwise

References parameterizedHeaderField::hasParameter().

bool hasSize ( ) const

Test whether the "size" parameter is set.

Returns
true if the "size" parameter is set, or false otherwise

References parameterizedHeaderField::hasParameter().

void setCreationDate ( const datetime creationDate)

Set the value of the "creation-date" parameter.

Parameters
creationDatenew value for the "creation-date" parameter

References parameterizedHeaderField::getParameter().

void setFilename ( const word filename)

Set the value of the "filename" parameter.

Parameters
filenamenew value for the "filename" parameter

References parameterizedHeaderField::getParameter().

void setModificationDate ( const datetime modificationDate)

Set the value of the "modification-date" parameter.

Parameters
modificationDatenew value for the "modification-date" parameter

References parameterizedHeaderField::getParameter().

void setReadDate ( const datetime readDate)

Set the value of the "read-date" parameter.

Parameters
readDatenew value for the "read-date" parameter

References parameterizedHeaderField::getParameter().

void setSize ( const string size)

Set the value of the "size" parameter.

Parameters
sizenew value for the "size" parameter

References parameterizedHeaderField::getParameter(), and vmime::charsets::US_ASCII.


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