KIMAP2::ImapInterval

#include <imapset.h>

Public Types

typedef qint64 Id
 
typedef QList< ImapIntervalList
 

Public Member Functions

 ImapInterval ()
 
 ImapInterval (const ImapInterval &other)
 
 ImapInterval (Id begin, Id end=0)
 
 ~ImapInterval ()
 
Id begin () const
 
Id end () const
 
bool hasDefinedBegin () const
 
bool hasDefinedEnd () const
 
ImapIntervaloperator= (const ImapInterval &other)
 
bool operator== (const ImapInterval &other) const
 
void setBegin (Id value)
 
void setEnd (Id value)
 
Id size () const
 
QByteArray toImapSequence () const
 

Static Public Member Functions

static ImapInterval fromImapSequence (const QByteArray &sequence)
 

Detailed Description

Represents a single interval in an ImapSet.

This class is implicitly shared.

Definition at line 38 of file imapset.h.

Member Typedef Documentation

typedef qint64 KIMAP2::ImapInterval::Id

Describes the ids stored in the interval.

Definition at line 44 of file imapset.h.

A list of ImapInterval objects.

Definition at line 49 of file imapset.h.

Constructor & Destructor Documentation

ImapInterval::ImapInterval ( )

Constructs an interval that covers all positive numbers.

Definition at line 59 of file imapset.cpp.

ImapInterval::ImapInterval ( const ImapInterval other)

Copy constructor.

Definition at line 64 of file imapset.cpp.

ImapInterval::ImapInterval ( Id  begin,
Id  end = 0 
)
explicit

Create a new interval.

Parameters
beginThe begin of the interval.
endKeep default (0) to just set the interval begin

Definition at line 69 of file imapset.cpp.

ImapInterval::~ImapInterval ( )

Destructor.

Definition at line 76 of file imapset.cpp.

Member Function Documentation

ImapInterval::Id ImapInterval::begin ( ) const

Returns the begin of this interval.

The value is the smallest value part of the interval. Only valid if begin is defined.

Definition at line 109 of file imapset.cpp.

ImapInterval::Id ImapInterval::end ( ) const

Returns the end of this interval.

This value is the largest value part of the interval. Only valid if hasDefinedEnd() returned true.

Definition at line 119 of file imapset.cpp.

ImapInterval ImapInterval::fromImapSequence ( const QByteArray sequence)
static

Return the interval corresponding to the given IMAP-compatible QByteArray representation.

Definition at line 159 of file imapset.cpp.

bool ImapInterval::hasDefinedBegin ( ) const

Returns true if this interval has a defined begin.

Definition at line 104 of file imapset.cpp.

bool ImapInterval::hasDefinedEnd ( ) const

Returns true if this intercal has been defined.

Definition at line 114 of file imapset.cpp.

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

Assignment operator.

Definition at line 80 of file imapset.cpp.

bool ImapInterval::operator== ( const ImapInterval other) const

Comparison operator.

Definition at line 88 of file imapset.cpp.

void ImapInterval::setBegin ( Id  value)

Sets the begin of the interval.

Definition at line 127 of file imapset.cpp.

void ImapInterval::setEnd ( Id  value)

Sets the end of this interval.

Definition at line 134 of file imapset.cpp.

ImapInterval::Id ImapInterval::size ( ) const

Returns the size of this interval.

Size is only defined for finite intervals.

Definition at line 93 of file imapset.cpp.

QByteArray ImapInterval::toImapSequence ( ) const

Converts this set into an IMAP compatible sequence.

Definition at line 141 of file imapset.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 Jul 8 2020 23:06:27 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.