KMime

kmime_contentindex.h
Go to the documentation of this file.
1 /*
2  Copyright (c) 2006 - 2007 Volker Krause <[email protected]>
3 
4  This library is free software; you can redistribute it and/or modify it
5  under the terms of the GNU Library General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or (at your
7  option) any later version.
8 
9  This library is distributed in the hope that it will be useful, but WITHOUT
10  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12  License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to the
16  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  02110-1301, USA.
18 */
34 #ifndef KMIME_CONTENTINDEX_H
35 #define KMIME_CONTENTINDEX_H
36 
37 #include "kmime_export.h"
38 
39 #include <QSharedDataPointer>
40 #include <QString>
41 #include <QMetaType>
42 
43 namespace KMime
44 {
45 
54 class KMIME_EXPORT ContentIndex
55 {
56 public:
60  ContentIndex();
61 
68  explicit ContentIndex(const QString &index);
69 
73  ContentIndex(const ContentIndex &other);
74 
78  ~ContentIndex();
79 
83  Q_REQUIRED_RESULT bool isValid() const;
84 
91  Q_REQUIRED_RESULT unsigned int pop();
92 
101  void push(unsigned int index);
102 
109  unsigned int up();
110 
115  Q_REQUIRED_RESULT QString toString() const;
116 
122  Q_REQUIRED_RESULT bool operator==(const ContentIndex &index) const;
123 
129  Q_REQUIRED_RESULT bool operator!=(const ContentIndex &index) const;
130 
134  ContentIndex &operator=(const ContentIndex &other);
135 
136 private:
137  //@cond PRIVATE
138  class Private;
140  //@endcond
141 };
142 
143 KMIME_EXPORT uint qHash(const KMime::ContentIndex &);
144 
145 } //namespace KMime
146 
147 Q_DECLARE_METATYPE(KMime::ContentIndex)
148 
149 #endif
KCALENDARCORE_EXPORT uint qHash(const KCalendarCore::Period &key)
A class to uniquely identify message parts (Content) in a hierarchy.
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Jul 11 2020 23:11:42 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.