KMBox::MBoxEntry Class Reference

#include <mboxentry.h>

Public Types
using	List = QList<MBoxEntry>
using	Pair = QPair<MBoxEntry, MBoxEntry>

Public Member Functions
	MBoxEntry ()
	MBoxEntry (const MBoxEntry &other)
	MBoxEntry (quint64 offset)
	~MBoxEntry ()
bool	isValid () const
quint64	messageOffset () const
quint64	messageSize () const
bool	operator!= (const MBoxEntry &other) const
MBoxEntry &	operator= (const MBoxEntry &other)
bool	operator== (const MBoxEntry &other) const
quint64	separatorSize () const

Detailed Description

A class that encapsulates an entry of a MBox.

Author

Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Since

4.6

Definition at line 24 of file mboxentry.h.

Member Typedef Documentation

List

using KMBox::MBoxEntry::List = QList<MBoxEntry>

Describes a list of mbox entry objects.

Definition at line 30 of file mboxentry.h.

Pair

using KMBox::MBoxEntry::Pair = QPair<MBoxEntry, MBoxEntry>

Describes a pair of mbox entry objects.

Definition at line 35 of file mboxentry.h.

Constructor & Destructor Documentation

MBoxEntry() [1/3]

MBoxEntry::MBoxEntry

(

)

Creates an invalid mbox entry object.

Definition at line 13 of file mboxentry.cpp.

MBoxEntry() [2/3]

MBoxEntry::MBoxEntry ( quint64 offset )

explicit

Creates an mbox entry object.

Parameters

offset

The offset of the message the object references.

Definition at line 18 of file mboxentry.cpp.

MBoxEntry() [3/3]

MBoxEntry::MBoxEntry

(

const MBoxEntry &

other

)

Creates an mbox entry object from an other object.

Definition at line 24 of file mboxentry.cpp.

~MBoxEntry()

MBoxEntry::~MBoxEntry

(

)

Destroys the mbox entry object.

Definition at line 29 of file mboxentry.cpp.

Member Function Documentation

isValid()

bool MBoxEntry::isValid ( ) const

nodiscard

Returns whether this is a valid mbox entry object.

Definition at line 52 of file mboxentry.cpp.

messageOffset()

quint64 MBoxEntry::messageOffset ( ) const

nodiscard

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

Definition at line 57 of file mboxentry.cpp.

messageSize()

quint64 MBoxEntry::messageSize ( ) const

nodiscard

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

Definition at line 62 of file mboxentry.cpp.

operator!=()

bool MBoxEntry::operator!=

(

const MBoxEntry &

other

)

const

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

Definition at line 47 of file mboxentry.cpp.

operator=()

MBoxEntry & MBoxEntry::operator=

(

const MBoxEntry &

other

)

Replaces this mbox entry object with an other object.

Definition at line 33 of file mboxentry.cpp.

operator==()

bool MBoxEntry::operator==

(

const MBoxEntry &

other

)

const

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

Definition at line 42 of file mboxentry.cpp.

separatorSize()

quint64 MBoxEntry::separatorSize ( ) const

nodiscard

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

Definition at line 67 of file mboxentry.cpp.

---

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

• mboxentry.h
• mboxentry.cpp