KMime::ContentIndex

KMime::ContentIndex Class Reference

#include <kmime_contentindex.h>

Public Member Functions

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

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 51 of file kmime_contentindex.cpp.

KMime::ContentIndex::ContentIndex ( const QString index)
explicit

Creates a content index based on the specified string representation.

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

Definition at line 55 of file kmime_contentindex.cpp.

ContentIndex::ContentIndex ( const ContentIndex other)

Copy constructor.

Definition at line 69 of file kmime_contentindex.cpp.

ContentIndex::~ContentIndex ( )

Destructor.

Definition at line 73 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 77 of file kmime_contentindex.cpp.

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

Compares this with index for inequality.

Parameters
indexis the content index to compare.

Definition at line 112 of file kmime_contentindex.cpp.

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

Assignment operator.

Definition at line 117 of file kmime_contentindex.cpp.

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

Compares this with index for equality.

Parameters
indexis the content index to compare.

Definition at line 107 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(), up().

Definition at line 82 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
indexis the top-most content index part.
See also
pop(), up().

Definition at line 87 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 97 of file kmime_contentindex.cpp.

unsigned int ContentIndex::up ( )

Removes and returns the bottom-most index.

Used to navigate to the parent part.

See also
push(), pop().

Definition at line 92 of file kmime_contentindex.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 Mon Aug 3 2020 23:11:20 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.