KMime::ContentIndex
#include <contentindex.h>
Public Member Functions | |
ContentIndex () | |
ContentIndex (const ContentIndex &other) | |
ContentIndex (ContentIndex &&) noexcept | |
ContentIndex (QStringView index) | |
~ContentIndex () | |
bool | isValid () const |
bool | operator!= (const ContentIndex &index) const |
ContentIndex & | operator= (const ContentIndex &other) |
ContentIndex & | operator= (ContentIndex &&) noexcept |
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 40 of file contentindex.h.
Constructor & Destructor Documentation
◆ ContentIndex() [1/3]
KMime::ContentIndex::ContentIndex | ( | ) |
Creates an empty content index.
Definition at line 35 of file contentindex.cpp.
◆ ContentIndex() [2/3]
|
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 39 of file contentindex.cpp.
◆ ContentIndex() [3/3]
|
default |
Copy constructor.
◆ ~ContentIndex()
|
default |
Destructor.
Member Function Documentation
◆ isValid()
|
nodiscard |
Returns true if this index is non-empty (valid).
Definition at line 57 of file contentindex.cpp.
◆ operator!=()
|
nodiscard |
Compares this with index
for inequality.
- Parameters
-
index is the content index to compare.
Definition at line 92 of file contentindex.cpp.
◆ operator=()
|
default |
Assignment operator.
◆ operator==()
|
nodiscard |
Compares this with index
for equality.
- Parameters
-
index is the content index to compare.
Definition at line 87 of file contentindex.cpp.
◆ pop()
|
nodiscard |
Removes and returns the top-most index.
Used to recursively descend into the message part hierarchy.
Definition at line 62 of file contentindex.cpp.
◆ push()
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.
Definition at line 67 of file contentindex.cpp.
◆ toString()
|
nodiscard |
Returns a string representation of this content index according to RFC3501 section 6.4.5.
Definition at line 77 of file contentindex.cpp.
◆ up()
unsigned int ContentIndex::up | ( | ) |
Removes and returns the bottom-most index.
Used to navigate to the parent part.
Definition at line 72 of file contentindex.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:11:28 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.