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
188
189
190
191
192
|
class QgsProperty
{
%TypeHeaderCode
#include <qgsprojectproperty.h>
%End
public:
QgsProperty();
virtual ~QgsProperty();
/** Dumps out the keys and values
*
* @param tabs is number of tabs to print; used for pretty-printing hierarchy
*/
virtual void dump( int tabs = 0 ) const = 0;
/** Returns true if is a QgsPropertyKey */
virtual bool isKey() const = 0;
/** Returns true if is a QgsPropertyValue */
virtual bool isValue() const = 0;
/** Returns true if a leaf node
*
* A leaf node is a key node that has either no value or a single value.
* A non-leaf node would be a key node with key sub-nodes.
*
* This is used for entryList() and subkeyList() implementation.
*/
virtual bool isLeaf() const = 0;
/**
* restores property hierarchy to given Dom node
*
* Used for restoring properties from project file
*/
virtual bool readXML( QDomNode & keyNode ) = 0;
/**
* adds property hierarchy to given Dom element
*
* Used for saving properties to project file.
*
* @param nodeName the tag name associated with this element
* @param element the parent (or encompassing) property element
* @param document the overall project file Dom document
*/
virtual bool writeXML( const QString & nodeName,
QDomElement & element,
QDomDocument & document ) = 0;
/** Return the node's value
*
* For QgsPropertyValue nodes, this is straightforward -- just return the
* embedded QVariant, _value. For QgsPropertyKey, this means returning
* the QgsPropertyValue _value that is keyed by its name, if it exists;
* i.e., QgsPropertyKey "foo" will return the property value mapped to its
* name, "foo", in its QHash of QProperties.
*
*/
virtual QVariant value() const = 0;
}; // class QgsProperty
class QgsPropertyValue : QgsProperty
{
%TypeHeaderCode
#include <qgsprojectproperty.h>
%End
public:
QgsPropertyValue();
QgsPropertyValue( const QVariant &value );
virtual ~QgsPropertyValue();
/** Returns true if is a QgsPropertyKey */
virtual bool isKey() const;
/** Returns true if is a QgsPropertyValue */
virtual bool isValue() const;
QVariant value() const;
/** Returns true if is a leaf node
*
* @note I suppose, in a way, value nodes can also be qualified as leaf
* nodes even though we're only counting key nodes.
*/
bool isLeaf() const;
void dump( int tabs = 0 ) const;
bool readXML( QDomNode & keyNode );
bool writeXML( const QString & nodeName,
QDomElement & element,
QDomDocument & document );
int count() const;
/** Return keys that do not contain other keys
* Since QgsPropertyValue isn't a key, don't do anything.
*/
void entryList( QStringList & keyName, QStringList & entries ) const;
};
class QgsPropertyKey : QgsProperty
{
%TypeHeaderCode
#include <qgsprojectproperty.h>
%End
public:
QgsPropertyKey( const QString name = "" );
virtual ~ QgsPropertyKey();
/// every key has a name
// @{
// @note not available in python bindings
// QString name() const;
QString &name();
// @}
/** If this key has a value, it will be stored by its name in its
* properties
*/
QVariant value() const;
/// add the given property key
QgsPropertyKey * addKey( const QString & keyName );
/// remove the given key
void removeKey( const QString & keyName );
/** Set the value associated with this key
* @param name is the key name
* @param value is the value to set
* @return pointer to property value
*/
QgsPropertyValue * setValue( const QString & name, const QVariant & value );
/** Set the value associated with this key
*
* @note that the single value node associated with each key is always
* stored keyed by the current key name
*/
QgsPropertyValue * setValue( const QVariant & value );
void dump( int tabs = 0 ) const;
bool readXML( QDomNode & keyNode );
bool writeXML( const QString &nodeName, QDomElement & element, QDomDocument & document );
/// how many elements are contained within this one?
int count() const;
/// Does this property not have any subkeys or values?
/* virtual */ bool isEmpty() const;
/** Returns true if is a QgsPropertyKey */
virtual bool isKey() const;
/** Returns true if is a QgsPropertyValue */
virtual bool isValue() const;
/// return keys that do not contain other keys
void entryList( QStringList & entries ) const;
/// return keys that contain other keys
void subkeyList( QStringList & entries ) const;
/** Returns true if a leaf node
* A leaf node is a key node that has either no value or a single value.
* A non-leaf node would be a key node with key sub-nodes.
*/
bool isLeaf() const;
/// reset the QgsProperty key to prestine state
virtual void clear();
/// delete any sub-nodes
virtual void clearKeys();
QgsProperty * find( QString & propertyName );
}; // class QgsPropertyKey
|
