KIMAP Library
#include <imapset.h>
Public Types | |
typedef qint64 | Id |
typedef QList< ImapInterval > | List |
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 |
ImapInterval & | operator= (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.
Member Typedef Documentation
typedef qint64 KIMAP::ImapInterval::Id |
typedef QList<ImapInterval> KIMAP::ImapInterval::List |
A list of ImapInterval objects.
Constructor & Destructor Documentation
ImapInterval::ImapInterval | ( | ) |
Constructs an interval that covers all positive numbers.
Definition at line 60 of file imapset.cpp.
ImapInterval::ImapInterval | ( | const ImapInterval & | other | ) |
Copy constructor.
Definition at line 65 of file imapset.cpp.
Create a new interval.
- Parameters:
-
begin The begin of the interval. end Keep default (0) to just set the interval begin
Definition at line 70 of file imapset.cpp.
ImapInterval::~ImapInterval | ( | ) |
Destructor.
Definition at line 77 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 107 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 117 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 153 of file imapset.cpp.
bool ImapInterval::hasDefinedBegin | ( | ) | const |
Returns true if this interval has a defined begin.
Definition at line 102 of file imapset.cpp.
bool ImapInterval::hasDefinedEnd | ( | ) | const |
Returns true if this intercal has been defined.
Definition at line 112 of file imapset.cpp.
ImapInterval & ImapInterval::operator= | ( | const ImapInterval & | other | ) |
Assignment operator.
Definition at line 81 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 124 of file imapset.cpp.
void ImapInterval::setEnd | ( | Id | value | ) |
Sets the end of this interval.
Definition at line 131 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 138 of file imapset.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Aug 27 2012 22:08:14 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.