1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2015 The Qt Company Ltd. |
4 | ** Contact: http://www.qt.io/licensing/ |
5 | ** |
6 | ** This file is part of the QtVersit module of the Qt Toolkit. |
7 | ** |
8 | ** $QT_BEGIN_LICENSE:LGPL21$ |
9 | ** Commercial License Usage |
10 | ** Licensees holding valid commercial Qt licenses may use this file in |
11 | ** accordance with the commercial license agreement provided with the |
12 | ** Software or, alternatively, in accordance with the terms contained in |
13 | ** a written agreement between you and The Qt Company. For licensing terms |
14 | ** and conditions see http://www.qt.io/terms-conditions. For further |
15 | ** information use the contact form at http://www.qt.io/contact-us. |
16 | ** |
17 | ** GNU Lesser General Public License Usage |
18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
19 | ** General Public License version 2.1 or version 3 as published by the Free |
20 | ** Software Foundation and appearing in the file LICENSE.LGPLv21 and |
21 | ** LICENSE.LGPLv3 included in the packaging of this file. Please review the |
22 | ** following information to ensure the GNU Lesser General Public License |
23 | ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and |
24 | ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
25 | ** |
26 | ** As a special exception, The Qt Company gives you certain additional |
27 | ** rights. These rights are described in The Qt Company LGPL Exception |
28 | ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
29 | ** |
30 | ** $QT_END_LICENSE$ |
31 | ** |
32 | ****************************************************************************/ |
33 | |
34 | #ifndef QVERSITPROPERTY_H |
35 | #define QVERSITPROPERTY_H |
36 | |
37 | #include <QtCore/qhash.h> |
38 | #include <QtCore/qshareddata.h> |
39 | #include <QtCore/qstringlist.h> |
40 | #include <QtCore/qvariant.h> |
41 | |
42 | #include <QtVersit/qversitglobal.h> |
43 | |
44 | QT_BEGIN_NAMESPACE_VERSIT |
45 | |
46 | class QVersitPropertyPrivate; |
47 | class Q_VERSIT_EXPORT QVersitProperty |
48 | { |
49 | public: |
50 | enum ValueType { |
51 | PlainType, |
52 | CompoundType, |
53 | ListType, |
54 | BinaryType, |
55 | VersitDocumentType, |
56 | PreformattedType |
57 | }; |
58 | |
59 | QVersitProperty(); |
60 | QVersitProperty(const QVersitProperty& other); |
61 | ~QVersitProperty(); |
62 | |
63 | QVersitProperty& operator=(const QVersitProperty& other); |
64 | bool operator==(const QVersitProperty& other) const; |
65 | bool operator!=(const QVersitProperty& other) const; |
66 | |
67 | void setGroups(const QStringList& groups); |
68 | QStringList groups() const; |
69 | |
70 | void setName(const QString& name); |
71 | QString name() const; |
72 | |
73 | void insertParameter(const QString& name, const QString& value); |
74 | void removeParameter(const QString& name, const QString& value); |
75 | void removeParameters(const QString& name); |
76 | |
77 | void setParameters(const QMultiHash<QString,QString>& parameters); |
78 | QMultiHash<QString,QString> parameters() const; |
79 | |
80 | void setValue(const QVariant& value); |
81 | QVariant variantValue() const; |
82 | template <typename T> T value() const |
83 | { |
84 | return variantValue().value<T>(); |
85 | } |
86 | QString value() const; |
87 | |
88 | void setValueType(ValueType type); |
89 | ValueType valueType() const; |
90 | |
91 | bool isEmpty() const; |
92 | void clear(); |
93 | |
94 | private: |
95 | |
96 | QSharedDataPointer<QVersitPropertyPrivate> d; |
97 | }; |
98 | |
99 | Q_VERSIT_EXPORT uint qHash(const QVersitProperty& key); |
100 | #ifndef QT_NO_DEBUG_STREAM |
101 | Q_VERSIT_EXPORT QDebug operator<<(QDebug dbg, const QVersitProperty& property); |
102 | #endif |
103 | |
104 | QT_END_NAMESPACE_VERSIT |
105 | |
106 | #endif // QVERSITPROPERTY_H |
107 | |