KIMAP Library
KIMAP::ImapInterval Class Reference
Represents a single interval in an ImapSet. More...
#include <imapset.h>
Public Types | |
typedef qint64 | Id |
typedef QList< ImapInterval > | List |
Public Member Functions | |
Id | begin () const |
Id | end () const |
bool | hasDefinedBegin () const |
bool | hasDefinedEnd () const |
ImapInterval (Id begin, Id end=0) | |
ImapInterval (const ImapInterval &other) | |
ImapInterval () | |
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 |
~ImapInterval () |
Detailed Description
Represents a single interval in an ImapSet.
This class is implicitly shared.
Definition at line 37 of file imapset.h.
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 59 of file imapset.cpp.
ImapInterval::ImapInterval | ( | const ImapInterval & | other | ) |
Copy constructor.
Definition at line 64 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 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 104 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 114 of file imapset.cpp.
bool ImapInterval::hasDefinedBegin | ( | ) | const |
Returns true if this interval has a defined begin.
Definition at line 99 of file imapset.cpp.
bool ImapInterval::hasDefinedEnd | ( | ) | const |
Returns true if this intercal has been defined.
Definition at line 109 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 87 of file imapset.cpp.
void ImapInterval::setBegin | ( | Id | value | ) |
Sets the begin of the interval.
Definition at line 121 of file imapset.cpp.
void ImapInterval::setEnd | ( | Id | value | ) |
Sets the end of this interval.
Definition at line 128 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 92 of file imapset.cpp.
QByteArray ImapInterval::toImapSequence | ( | ) | const |
Converts this set into an IMAP compatible sequence.
Definition at line 135 of file imapset.cpp.
The documentation for this class was generated from the following files: