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

#include <headers.h>

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

Public Member Functions
QByteArray	as7BitString (bool withHeaderType=true) const override
template<std::size_t N>
bool	hasParameter (const char(&key)[N]) const
bool	hasParameter (const QString &key) const
bool	hasParameter (QByteArrayView key) const
bool	hasParameter (QLatin1StringView key) const
bool	isEmpty () const override
template<std::size_t N>
QString	parameter (const char(&key)[N]) const
QString	parameter (const QString &key) const
QString	parameter (QByteArrayView key) const
QString	parameter (QLatin1StringView key) const
void	setParameter (const QByteArray &key, const QString &value)
void	setParameter (const QString &key, const QString &value)
Public Member Functions inherited from KMime::Headers::Generics::Structured
QString	asUnicodeString () const override
void	from7BitString (QByteArrayView s) override
void	fromUnicodeString (const QString &s) override
void	fromUnicodeString (const QString &s, const QByteArray &b)
Public Member Functions inherited from KMime::Headers::Base
	Base ()
virtual	~Base ()
void	fromUnicodeString (const QString &s, const QByteArray &b)
bool	is (QByteArrayView t) 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::Generics::Structured
Protected Member Functions inherited from KMime::Headers::Base
QByteArray	typeIntro () const

Additional Inherited Members
Public Types inherited from KMime::Headers::Base
typedef QList< KMime::Headers::Base * >	List

Detailed Description

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

Definition at line 652 of file headers.h.

Member Function Documentation

as7BitString()

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

nodiscardoverridevirtual

Returns the encoded header.

Parameters

withHeaderType

Specifies whether the header-type should be included.

Implements KMime::Headers::Base.

Definition at line 803 of file headers.cpp.

hasParameter() [1/4]

template<std::size_t N>

bool KMime::Headers::Generics::Parametrized::hasParameter ( const char(&) key[N] ) const

inlinenodiscard

Definition at line 699 of file headers.h.

hasParameter() [2/4]

bool KMime::Headers::Generics::Parametrized::hasParameter ( const QString & key ) const

inlinenodiscard

Definition at line 689 of file headers.h.

hasParameter() [3/4]

bool KMime::Headers::Generics::Parametrized::hasParameter ( QByteArrayView key ) const

nodiscard

Parameters

key	the key of the parameter to check for

Returns

true if a parameter with the given key exists.

Since

4.5

Definition at line 843 of file headers.cpp.

hasParameter() [4/4]

bool KMime::Headers::Generics::Parametrized::hasParameter ( QLatin1StringView key ) const

inlinenodiscard

Definition at line 693 of file headers.h.

isEmpty()

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

nodiscardoverridevirtual

Checks if this header contains any data.

Implements KMime::Headers::Base.

Definition at line 854 of file headers.cpp.

parameter() [1/4]

template<std::size_t N>

QString KMime::Headers::Generics::Parametrized::parameter ( const char(&) key[N] ) const

inlinenodiscard

Definition at line 678 of file headers.h.

parameter() [2/4]

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

inlinenodiscard

Definition at line 668 of file headers.h.

parameter() [3/4]

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

nodiscard

Returns the value of the specified parameter.

Parameters

key	The parameter name.

Definition at line 836 of file headers.cpp.

parameter() [4/4]

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

inlinenodiscard

Definition at line 672 of file headers.h.

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

scursor	Pointer to the start of the data still to parse.
send	Pointer to the end of the data.
isCRLF	true if input string is terminated with a CRLF.

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

Definition at line 859 of file headers.cpp.

setParameter() [1/2]

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

Sets the parameter key to value.

Parameters

key	The parameter name.
value	The new value for key.

Definition at line 848 of file headers.cpp.

setParameter() [2/2]

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

inline

Definition at line 709 of file headers.h.

---

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

• headers.h
• headers.cpp