KMBox::MBoxEntry Class

class KMBox::MBoxEntry

A class that encapsulates an entry of a MBox. More...

Header:	`#include <KMbox/MBoxEntry>`
CMake:	`find_package(KPim6 REQUIRED COMPONENTS Mbox)` `target_link_libraries(mytarget PRIVATE KPim6::Mbox)`

List of all members, including inherited members

Public Types

	List
	Pair

Public Functions

	MBoxEntry()
	MBoxEntry(quint64 offset)
	MBoxEntry(const KMBox::MBoxEntry &other)
	~MBoxEntry()
bool	isValid() const
quint64	messageOffset() const
quint64	messageSize() const
quint64	separatorSize() const
bool	operator!=(const KMBox::MBoxEntry &other) const
KMBox::MBoxEntry &	operator=(const KMBox::MBoxEntry &other)
bool	operator==(const KMBox::MBoxEntry &other) const

Detailed Description

Member Type Documentation

`[alias]` MBoxEntry::List

Describes a list of mbox entry objects.

`[alias]` MBoxEntry::Pair

Describes a pair of mbox entry objects.

Member Function Documentation

MBoxEntry::MBoxEntry()

Creates an invalid mbox entry object.

`[explicit]` MBoxEntry::MBoxEntry(quint64 offset)

Creates an mbox entry object.

offset The offset of the message the object references.

MBoxEntry::MBoxEntry(const KMBox::MBoxEntry &other)

Creates an mbox entry object from an other object.

`[noexcept]` MBoxEntry::~MBoxEntry()

Destroys the mbox entry object.

bool MBoxEntry::isValid() const

Returns whether this is a valid mbox entry object.

quint64 MBoxEntry::messageOffset() const

Returns the offset of the message that is referenced by this mbox entry object.

quint64 MBoxEntry::messageSize() const

Returns the size of the message that is referenced by this mbox entry object.

quint64 MBoxEntry::separatorSize() const

Returns the separator size of the message that is referenced by this mbox entry object.

bool MBoxEntry::operator!=(const KMBox::MBoxEntry &other) const

Returns whether this mbox entry object is not equal to an other.

KMBox::MBoxEntry &MBoxEntry::operator=(const KMBox::MBoxEntry &other)

Replaces this mbox entry object with an other object.

bool MBoxEntry::operator==(const KMBox::MBoxEntry &other) const

Returns whether this mbox entry object is equal to an other.

Contents