1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*
Copyright (c) 2006-2007 Boudewijn Rempt <boud@valdyas.org>
Copyright (C) 2006-2007 Thomas Zander <zander@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef _KO_PROPERTIES_H
#define _KO_PROPERTIES_H
#include <QtCore/QString>
#include <QtCore/QMap>
#include <QtCore/QVariant>
#include "koodf_export.h"
class QDomElement;
/**
* A KoProperties is the (de-)serializable representation of
* a key-value map. The serialisation format is XML.
*/
class KOODF_EXPORT KoProperties
{
public:
/**
* Create a new properties object
*/
KoProperties();
/**
* Deep copy the properties object
*/
KoProperties(const KoProperties & rhs);
~KoProperties();
public:
/**
* Fill the properties object from the XML dom node.
*
* load() does not touch existing properties if loading fails.
*
* @param root the root node of the properties subtree.
*/
void load(const QDomElement &root);
/**
* Fill the properties object from the XML encoded
* representation in string.
*
* load() does not touch existing properties if loading fails.
*
* @param string the stored properties.
* @return false if loading failing, true if it succeeded
*/
bool load(const QString &string);
/**
* Returns an iterator over the properties. The iterator is not
* suitable for adding or removing properties.
*/
QMapIterator<QString, QVariant> propertyIterator() const;
/**
* @return true if this KoProperties object does not contain any
* properties.
*/
bool isEmpty() const;
/**
* Create a serialized version of this properties as XML.
* @return the string version of this properties object
*/
QString store();
/**
* @brief Create a serialized version of these properties (as XML) with root as the root element.
* @param root as the root element in the generated XML.
*/
QString store(const QString & root);
void save(QDomElement &root) const;
/**
* Set the property with name to value.
*/
void setProperty(const QString & name, const QVariant & value);
/**
* Set value to the value associated with property name
* @return false if the specified property did not exist.
*/
bool property(const QString & name, QVariant & value) const;
/**
* Return a property by name, wrapped in a QVariant.
* A typical usage:
* @code
* KoProperties *props = new KoProperties();
* props->setProperty("name", "Marcy");
* props->setProperty("age", 25);
* QString name = props->property("name").toString();
* int age = props->property("age").toInt();
* @endcode
* @return a property by name, wrapped in a QVariant.
* @param name the name (or key) with which the variant was registered.
* @see intProperty() stringProperty()
*/
QVariant property(const QString & name) const;
/**
* Return an integer property by name.
* A typical usage:
* @code
* KoProperties *props = new KoProperties();
* props->setProperty("age", 25);
* int age = props->intProperty("age");
* @endcode
* @return an integer property by name
* @param name the name (or key) with which the variant was registered.
* @param def the default value, should there not be any property by the name this will be returned.
* @see property() stringProperty()
*/
int intProperty(const QString & name, int def = 0) const;
/**
* Return a qreal property by name.
* @param name the name (or key) with which the variant was registered.
* @param def the default value, should there not be any property by the name this will be returned.
*/
qreal doubleProperty(const QString & name, qreal def = 0.0) const;
/**
* Return a boolean property by name.
* @param name the name (or key) with which the variant was registered.
* @param def the default value, should there not be any property by the name this will be returned.
*/
bool boolProperty(const QString & name, bool def = false) const;
/**
* Return an QString property by name.
* A typical usage:
* @code
* KoProperties *props = new KoProperties();
* props->setProperty("name", "Marcy");
* QString name = props->stringProperty("name");
* @endcode
* @return an QString property by name
* @param name the name (or key) with which the variant was registered.
* @see property() intProperty()
* @param def the default value, should there not be any property by the name this will be returned.
*/
QString stringProperty(const QString & name, const QString & def = QString()) const;
/**
* Returns true if the specified key is present in this properties
* object.
*/
bool contains(const QString & key) const;
/**
* Returns the value assocatied with the specified key if this
* properties object contains the specified key; otherwise return
* an empty QVariant.
*/
QVariant value(const QString & key) const;
bool operator==(const KoProperties &other) const;
private:
class Private;
Private * const d;
};
#endif // _KO_PROPERTIES_H
|
