KMBox::MBoxEntry

KMBox::MBoxEntry Class Reference

#include <mboxentry.h>

Public Types

typedef QVector< MBoxEntryList
 
typedef QPair< MBoxEntry, MBoxEntryPair
 

Public Member Functions

 MBoxEntry ()
 
 MBoxEntry (quint64 offset)
 
 MBoxEntry (const MBoxEntry &other)
 
 ~MBoxEntry ()
 
bool isValid () const
 
quint64 messageOffset () const
 
quint64 messageSize () const
 
bool operator!= (const MBoxEntry &other) const
 
MBoxEntryoperator= (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[email protected]@kde[email protected].org
Since
4.6

Definition at line 24 of file mboxentry.h.

Member Typedef Documentation

Describes a list of mbox entry objects.

Definition at line 30 of file mboxentry.h.

Describes a pair of mbox entry objects.

Definition at line 35 of file mboxentry.h.

Constructor & Destructor Documentation

MBoxEntry::MBoxEntry ( )

Creates an invalid mbox entry object.

Definition at line 13 of file mboxentry.cpp.

MBoxEntry::MBoxEntry ( quint64  offset)
explicit

Creates an mbox entry object.

Parameters
offsetThe offset of the message the object references.

Definition at line 18 of file mboxentry.cpp.

MBoxEntry::MBoxEntry ( const MBoxEntry other)

Creates an mbox entry object from an other object.

Definition at line 24 of file mboxentry.cpp.

MBoxEntry::~MBoxEntry ( )

Destroys the mbox entry object.

Definition at line 29 of file mboxentry.cpp.

Member Function Documentation

bool MBoxEntry::isValid ( ) const

Returns whether this is a valid mbox entry object.

Definition at line 52 of file mboxentry.cpp.

quint64 MBoxEntry::messageOffset ( ) const

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

Definition at line 57 of file mboxentry.cpp.

quint64 MBoxEntry::messageSize ( ) const

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

Definition at line 62 of file mboxentry.cpp.

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.

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

Replaces this mbox entry object with an other object.

Definition at line 33 of file mboxentry.cpp.

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.

quint64 MBoxEntry::separatorSize ( ) const

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:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Aug 5 2020 23:07:01 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.