KMime::Headers::Generics::Parametrized

Search for usage in LXR

KMime::Headers::Generics::Parametrized Class Reference

#include <kmime_headers.h>

Inheritance diagram for KMime::Headers::Generics::Parametrized:

Public Member Functions

QByteArray as7BitString (bool withHeaderType=true) const override
 
void clear () override
 
bool hasParameter (const QString &key) const
 
bool isEmpty () const override
 
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

Base class for headers containing a parameter list such as "Content-Type".

Definition at line 653 of file kmime_headers.h.

Member Function Documentation

◆ as7BitString()

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

Returns the encoded header.

Parameters
withHeaderTypeSpecifies whether the header-type should be included.

Implements KMime::Headers::Base.

Reimplemented in KMime::Headers::ContentDisposition, and KMime::Headers::ContentType.

Definition at line 826 of file kmime_headers.cpp.

◆ clear()

void KMime::Headers::Generics::Parametrized::clear ( )
overridevirtual

Deletes.

Implements KMime::Headers::Base.

Reimplemented in KMime::Headers::ContentDisposition, and KMime::Headers::ContentType.

Definition at line 887 of file kmime_headers.cpp.

◆ hasParameter()

bool KMime::Headers::Generics::Parametrized::hasParameter ( const QString key) const
Parameters
keythe key of the parameter to check for
Returns
true if a parameter with the given key exists.
Since
4.5

Definition at line 871 of file kmime_headers.cpp.

◆ isEmpty()

bool KMime::Headers::Generics::Parametrized::isEmpty ( ) const
overridevirtual

Checks if this header contains any data.

Implements KMime::Headers::Base.

Reimplemented in KMime::Headers::ContentDisposition, and KMime::Headers::ContentType.

Definition at line 882 of file kmime_headers.cpp.

◆ parameter()

QString KMime::Headers::Generics::Parametrized::parameter ( const QString key) const

Returns the value of the specified parameter.

Parameters
keyThe parameter name.

Definition at line 866 of file kmime_headers.cpp.

◆ parse()

bool KMime::Headers::Generics::Parametrized::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.

Implements KMime::Headers::Generics::Structured.

Reimplemented in KMime::Headers::ContentDisposition, and KMime::Headers::ContentType.

Definition at line 893 of file kmime_headers.cpp.

◆ setParameter()

void KMime::Headers::Generics::Parametrized::setParameter ( const QString key,
const QString value 
)

Sets the parameter key to value.

Parameters
keyThe parameter name.
valueThe new value for key.

Definition at line 876 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-2023 The KDE developers.
Generated on Mon May 8 2023 03:53:03 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.