• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

KIMAP Library

KIMAP::ImapInterval

KIMAP::ImapInterval Class Reference

Represents a single interval in an ImapSet. More...

#include <imapset.h>

List of all members.

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

Describes the ids stored in the interval.

Definition at line 43 of file imapset.h.

typedef QList<ImapInterval> KIMAP::ImapInterval::List

A list of ImapInterval objects.

Definition at line 48 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:
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:
  • imapset.h
  • imapset.cpp

KIMAP Library

Skip menu "KIMAP Library"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal