QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
qgsprojectproperty.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsproject.h
3
4 Implements persistent project state.
5
6 -------------------
7 begin : February 24, 2005
8 copyright : (C) 2005 by Mark Coletti
9 email : mcoletti at gmail.com
10***************************************************************************/
11
12/***************************************************************************
13 * *
14 * This program is free software; you can redistribute it and/or modify *
15 * it under the terms of the GNU General Public License as published by *
16 * the Free Software Foundation; either version 2 of the License, or *
17 * (at your option) any later version. *
18 * *
19 ***************************************************************************/
20
21
22#ifndef QGSPROJECTPROPERTY_H
23#define QGSPROJECTPROPERTY_H
24
25#include <QHash>
26#include <QVariant>
27#include <QStringList>
28#include <QCoreApplication>
29
30#include "qgis_core.h"
31
32class QDomNode;
33class QDomElement;
34class QDomDocument;
35
36
49class CORE_EXPORT QgsProjectProperty
50{
51 public:
53 virtual ~QgsProjectProperty() = default;
54
60 virtual void dump( int tabs = 0 ) const = 0;
61
67 virtual bool isKey() const = 0;
68
74 virtual bool isValue() const = 0;
75
84 virtual bool isLeaf() const = 0;
85
91 virtual bool readXml( const QDomNode &keyNode ) = 0;
92
102 virtual bool writeXml( const QString &nodeName,
103 QDomElement &element,
104 QDomDocument &document ) = 0;
105
116 virtual QVariant value() const = 0;
117
118};
119
120
127{
128 public:
129
131
135 QgsProjectPropertyValue( const QVariant &value )
136 : mValue( value )
137 {}
138
139 bool isKey() const override { return false; }
140 bool isValue() const override { return true; }
141 QVariant value() const override { return mValue; }
142
143 //value nodes can also be qualified as leaf nodes even though we only count key nodes.
144 bool isLeaf() const override { return true; }
145
146 void dump( int tabs = 0 ) const override;
147 bool readXml( const QDomNode &keyNode ) override;
148 bool writeXml( const QString &nodeName,
149 QDomElement &element,
150 QDomDocument &document ) override;
151
152 private:
153
154 // We use QVariant as it's very handy to keep multiple types and provides type conversions
155 QVariant mValue;
156
157};
158
159
180{
181 Q_DECLARE_TR_FUNCTIONS( QgsProjectPropertyKey )
182
183 public:
184
188 QgsProjectPropertyKey( const QString &name = QString() );
189 ~QgsProjectPropertyKey() override;
190
195 QString name() const { return mName; }
196
202 void setName( const QString &name );
203
208 QVariant value() const override;
209
213 QgsProjectPropertyKey *addKey( const QString &keyName )
214 {
215 if ( mProperties.contains( keyName ) )
216 delete mProperties.take( keyName );
217
219 mProperties.insert( keyName, p );
220
221 return p;
222 }
223
227 void removeKey( const QString &keyName )
228 {
229 delete mProperties.take( keyName );
230 }
231
238 QgsProjectPropertyValue *setValue( const QString &name, const QVariant &value )
239 {
240 if ( mProperties.contains( name ) )
241 delete mProperties.take( name );
242
244 mProperties.insert( name, p );
245
246 return p;
247 }
248
255 QgsProjectPropertyValue *setValue( const QVariant &value )
256 {
257 return setValue( name(), value );
258 }
259
260 void dump( int tabs = 0 ) const override;
261 bool readXml( const QDomNode &keyNode ) override;
262 bool writeXml( const QString &nodeName, QDomElement &element, QDomDocument &document ) override;
263
267 int count() const { return mProperties.count(); }
268
272 bool isEmpty() const { return mProperties.isEmpty(); }
273
274 bool isKey() const override { return true; }
275 bool isValue() const override { return false; }
276 bool isLeaf() const override;
277
282 void entryList( QStringList &entries ) const;
283
288 void subkeyList( QStringList &entries ) const;
289
293 virtual void clear()
294 {
295 mName.clear();
296 clearKeys();
297 }
298
302 virtual void clearKeys()
303 {
304 qDeleteAll( mProperties );
305 mProperties.clear();
306 }
307
311 QgsProjectProperty *find( const QString &propertyName ) const
312 {
313 return mProperties.value( propertyName );
314 }
315
316 private:
317
319 QString mName;
320
322 QHash < QString, QgsProjectProperty * > mProperties;
323
324};
325
326#endif
Project property key node.
QString name() const
The name of the property is used as identifier.
QgsProjectProperty * find(const QString &propertyName) const
Attempts to find a property with a matching sub-key name.
void removeKey(const QString &keyName)
Removes the specified key.
bool isEmpty() const
Returns true if this property contains no sub-keys.
bool isKey() const override
Returns true if the property is a QgsProjectPropertyKey.
virtual void clearKeys()
Deletes any sub-nodes from the property.
virtual void clear()
Resets the property to a default, empty state.
QgsProjectPropertyKey * addKey(const QString &keyName)
Adds the specified property key as a sub-key.
bool isValue() const override
Returns true if the property is a QgsProjectPropertyValue.
QgsProjectPropertyValue * setValue(const QString &name, const QVariant &value)
Sets the value associated with this key.
int count() const
Returns the number of sub-keys contained by this property.
QgsProjectPropertyValue * setValue(const QVariant &value)
Set the value associated with this key.
Project property value node, contains a QgsProjectPropertyKey's value.
QgsProjectPropertyValue()=default
QVariant value() const override
Returns the node's value.
bool isValue() const override
Returns true if the property is a QgsProjectPropertyValue.
QgsProjectPropertyValue(const QVariant &value)
Constructor for QgsProjectPropertyValue, initialized to a specified value.
bool isKey() const override
Returns true if the property is a QgsProjectPropertyKey.
bool isLeaf() const override
Returns true if property is a leaf node.
An Abstract Base Class for QGIS project property hierarchys.
virtual bool isLeaf() const =0
Returns true if property is a leaf node.
virtual void dump(int tabs=0) const =0
Dumps out the keys and values.
virtual bool readXml(const QDomNode &keyNode)=0
Restores the property hierarchy from a specified DOM node.
virtual bool isKey() const =0
Returns true if the property is a QgsProjectPropertyKey.
virtual bool writeXml(const QString &nodeName, QDomElement &element, QDomDocument &document)=0
Writes the property hierarchy to a specified DOM element.
virtual QVariant value() const =0
Returns the node's value.
virtual bool isValue() const =0
Returns true if the property is a QgsProjectPropertyValue.
virtual ~QgsProjectProperty()=default