KTnef::KTNEFAttach Class

class KTnef::KTNEFAttach

Represents a @acronym TNEF attachment. More...

Header: #include <ktnefattach.h>
CMake: find_package(KPim6Tnef REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::Tnef)
Inherits: KTnef::KTNEFPropertySet

Public Types

enum ParseState { Unparsed, TitleParsed, DataParsed, InfoParsed }

Public Functions

KTNEFAttach()
~KTNEFAttach()
bool checkState(int state) const
bool dataParsed() const
QString displayName() const
int displaySize() const
QString extension() const
QString fileName() const
int index() const
bool infoParsed() const
QString mimeTag() const
QString name() const
int offset() const
void setDataParsed()
void setDisplayName(const QString &str)
void setDisplaySize(int size)
void setExtension(const QString &str)
void setFileName(const QString &str)
void setIndex(int indx)
void setInfoParsed()
void setMimeTag(const QString &str)
void setName(const QString &str)
void setOffset(int offset)
void setSize(int size)
void setTitleParsed()
int size() const
bool titleParsed() const
void unsetDataParser()

Detailed Description

Member Type Documentation

enum KTNEFAttach::ParseState

The different attachment parsed states.

Member Function Documentation

KTNEFAttach::KTNEFAttach()

Constructs a @acronym TNEF attachment.

[noexcept] KTNEFAttach::~KTNEFAttach()

Destroys the @acronym TNEF attachment.

bool KTNEFAttach::checkState(int state) const

Sets/Unsets the attachment state according to the state flag must be a #ParseState type.

state a #ParseState type. Returns true if the state is turned-on; else returns false.

bool KTNEFAttach::dataParsed() const

Returns true if the ParseState::DataParsed flag is set; else returns false.

See also setDataParsed().

QString KTNEFAttach::displayName() const

Returns the display name of the attachment.

See also setDisplayName().

int KTNEFAttach::displaySize() const

Returns the display size of the attachment.

See also setDisplaySize().

QString KTNEFAttach::extension() const

Returns the filename extension of the attachment.

See also setExtension().

QString KTNEFAttach::fileName() const

Returns the filename of the attachment.

See also setFileName().

int KTNEFAttach::index() const

Returns the index of the attachment.

See also setIndex().

bool KTNEFAttach::infoParsed() const

Returns true if the #InfoParsed flag is set; else returns false.

See also setInfoParsed().

QString KTNEFAttach::mimeTag() const

Returns the @acronym MIME tag of the attachment.

See also setMimeTag().

QString KTNEFAttach::name() const

Returns the name of the attachment.

See also setName().

int KTNEFAttach::offset() const

Returns the offset value of the attachment.

See also setOffset().

void KTNEFAttach::setDataParsed()

Sets the #DataParsed flag for this attachment.

See also dataParsed().

void KTNEFAttach::setDisplayName(const QString &str)

Sets the display name of this attachment to str.

str is the attachment display name to set.

See also displayName().

void KTNEFAttach::setDisplaySize(int size)

Sets the display size of the attachment to size.

size is the attachment display size to set.

See also displaySize().

void KTNEFAttach::setExtension(const QString &str)

Sets the filename extension of this attachment to str.

str is the attachment filename extension to set.

See also extension().

void KTNEFAttach::setFileName(const QString &str)

Sets the filename of this attachment to str.

str is the attachment filename to set.

See also fileName().

void KTNEFAttach::setIndex(int indx)

Sets the index of this attachment to indx.

indx is the attachment index to set.

See also index().

void KTNEFAttach::setInfoParsed()

Sets the #InfoParsed flag for this attachment.

See also infoParsed().

void KTNEFAttach::setMimeTag(const QString &str)

Sets the @acronym MIME tag of this attachment to str.

str is the attachment @acronym MIME tag to set.

See also mimeTag().

void KTNEFAttach::setName(const QString &str)

Sets the name of this attachment to str.

str is attachment name to set.

See also name().

void KTNEFAttach::setOffset(int offset)

Sets the offset value of this attachment to offset.

offset is the attachment offset to set.

See also offset().

void KTNEFAttach::setSize(int size)

Sets the size of the attachment to size.

size is the attachment size to set.

See also size().

void KTNEFAttach::setTitleParsed()

Sets the #TitleParsed flag for this attachment.

See also titleParsed().

int KTNEFAttach::size() const

Returns the size of the attachment.

See also setSize().

bool KTNEFAttach::titleParsed() const

Returns true if the #TitleParsed flag is set; else returns false.

See also setTitleParsed().

void KTNEFAttach::unsetDataParser()

Unsets the #DataParsed flag for this attachment.