KMime::Headers::ContentDisposition

KMime::Headers::ContentDisposition Class Reference

#include <kmime_headers.h>

Inheritance diagram for KMime::Headers::ContentDisposition:

Public Member Functions

QByteArray as7BitString (bool withHeaderType=true) const override
 
void clear () override
 
contentDisposition disposition () const
 
QString filename () const
 
bool isEmpty () const override
 
void setDisposition (contentDisposition disp)
 
void setFilename (const QString &filename)
 
- Public Member Functions inherited from KMime::Headers::Generics::Parametrized
bool hasParameter (const QString &key) const
 
QString parameter (const QString &key) const
 
void setParameter (const QString &key, const QString &value)
 
- Public Member Functions inherited from KMime::Headers::Generics::Structured
QString asUnicodeString () const override
 
void from7BitString (const char *s, size_t len) override
 
void from7BitString (const QByteArray &s) override
 
void fromUnicodeString (const QString &s, const QByteArray &b) override
 
- Public Member Functions inherited from KMime::Headers::Base
 Base ()
 
virtual ~Base ()
 
bool is (const char *t) const
 
bool isMimeHeader () const
 
QByteArray rfc2047Charset () const
 
void setRFC2047Charset (const QByteArray &cs)
 
virtual const char * type () const
 

Protected Member Functions

bool parse (const char *&scursor, const char *const send, bool isCRLF=false) override
 
- Protected Member Functions inherited from KMime::Headers::Base
QByteArray typeIntro () const
 

Additional Inherited Members

- Public Types inherited from KMime::Headers::Base
typedef QVector< KMime::Headers::Base * > List
 

Detailed Description

Represents a "Content-Disposition" header.

See also
RFC 2183

Definition at line 1153 of file kmime_headers.h.

Member Function Documentation

QByteArray KMime::Headers::ContentDisposition::as7BitString ( bool  withHeaderType = true) const
overridevirtual

Returns the encoded header.

Parameters
withHeaderTypeSpecifies whether the header-type should be included.

Reimplemented from KMime::Headers::Generics::Parametrized.

Definition at line 2083 of file kmime_headers.cpp.

void KMime::Headers::ContentDisposition::clear ( )
overridevirtual

Deletes.

Reimplemented from KMime::Headers::Generics::Parametrized.

Definition at line 2112 of file kmime_headers.cpp.

contentDisposition KMime::Headers::ContentDisposition::disposition ( ) const

Returns the content disposition.

Definition at line 2118 of file kmime_headers.cpp.

QString KMime::Headers::ContentDisposition::filename ( ) const

Returns the suggested filename for the associated MIME part.

This is just a convenience function, it is equivalent to calling parameter( "filename" );

Definition at line 2127 of file kmime_headers.cpp.

bool KMime::Headers::ContentDisposition::isEmpty ( ) const
overridevirtual

Checks if this header contains any data.

Reimplemented from KMime::Headers::Generics::Parametrized.

Definition at line 2108 of file kmime_headers.cpp.

bool KMime::Headers::ContentDisposition::parse ( const char *&  scursor,
const char *const  send,
bool  isCRLF = false 
)
overrideprotectedvirtual

This method parses the raw header and needs to be implemented in every sub-class.

Parameters
scursorPointer to the start of the data still to parse.
sendPointer to the end of the data.
isCRLFtrue if input string is terminated with a CRLF.

Reimplemented from KMime::Headers::Generics::Parametrized.

Definition at line 2135 of file kmime_headers.cpp.

void KMime::Headers::ContentDisposition::setDisposition ( contentDisposition  disp)

Sets the content disposition.

Parameters
dispThe new content disposition.

Definition at line 2122 of file kmime_headers.cpp.

void KMime::Headers::ContentDisposition::setFilename ( const QString filename)

Sets the suggested filename for the associated MIME part.

This is just a convenience function, it is equivalent to calling setParameter( "filename", filename );

Parameters
filenameThe filename.

Definition at line 2131 of file kmime_headers.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Aug 10 2020 23:16:30 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.