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

KMIME Library

KMime::ContentIndex

KMime::ContentIndex Class Reference

A class to uniquely identify message parts (Content) in a hierarchy. More...

#include <kmime_contentindex.h>

List of all members.


Public Member Functions

 ContentIndex (const ContentIndex &other)
 ContentIndex (const QString &index)
 ContentIndex ()
bool isValid () const
bool operator!= (const ContentIndex &index) const
ContentIndex & operator= (const ContentIndex &other)
bool operator== (const ContentIndex &index) const
unsigned int pop ()
void push (unsigned int index)
QString toString () const
 ~ContentIndex ()

Detailed Description

A class to uniquely identify message parts (Content) in a hierarchy.

This class is implicitly shared.

Based on RFC3501 section 6.4.5 and thus compatible with IMAP.

Definition at line 54 of file kmime_contentindex.h.


Constructor & Destructor Documentation

KMime::ContentIndex::ContentIndex (  ) 

Creates an empty content index.

Definition at line 50 of file kmime_contentindex.cpp.

KMime::ContentIndex::ContentIndex ( const QString &  index  )  [explicit]

Creates a content index based on the specified string representation.

Parameters:
index is a string representation of a message part index according to RFC3501 section 6.4.5.

Definition at line 54 of file kmime_contentindex.cpp.

ContentIndex::ContentIndex ( const ContentIndex &  other  ) 

Copy constructor.

Definition at line 68 of file kmime_contentindex.cpp.

ContentIndex::~ContentIndex (  ) 

Destructor.

Definition at line 72 of file kmime_contentindex.cpp.


Member Function Documentation

bool KMime::ContentIndex::isValid (  )  const

Returns true if this index is non-empty (valid).

Definition at line 76 of file kmime_contentindex.cpp.

bool KMime::ContentIndex::operator!= ( const ContentIndex &  index  )  const

Compares this with index for inequality.

Parameters:
index is the content index to compare.

Definition at line 105 of file kmime_contentindex.cpp.

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

Assignment operator.

Definition at line 110 of file kmime_contentindex.cpp.

bool KMime::ContentIndex::operator== ( const ContentIndex &  index  )  const

Compares this with index for equality.

Parameters:
index is the content index to compare.

Definition at line 100 of file kmime_contentindex.cpp.

unsigned int KMime::ContentIndex::pop (  ) 

Removes and returns the top-most index.

Used to recursively descend into the message part hierarchy.

See also:
push().

Definition at line 81 of file kmime_contentindex.cpp.

void KMime::ContentIndex::push ( unsigned int  index  ) 

Adds index to the content index.

Used when ascending the message part hierarchy.

Parameters:
index is the top-most content index part.
See also:
pop().

Definition at line 86 of file kmime_contentindex.cpp.

QString KMime::ContentIndex::toString (  )  const

Returns a string representation of this content index according to RFC3501 section 6.4.5.

Definition at line 91 of file kmime_contentindex.cpp.


The documentation for this class was generated from the following files:
  • kmime_contentindex.h
  • kmime_contentindex.cpp

KMIME Library

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.8
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