QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
|
Project property key node. More...
#include <qgsprojectproperty.h>
Public Member Functions | |
QgsProjectPropertyKey (const QString &name=QString()) | |
Create a new QgsProjectPropertyKey with the specified identifier. More... | |
~QgsProjectPropertyKey () override | |
QgsProjectPropertyKey * | addKey (const QString &keyName) |
Adds the specified property key as a sub-key. More... | |
virtual void | clear () |
Resets the property to a default, empty state. More... | |
virtual void | clearKeys () |
Deletes any sub-nodes from the property. More... | |
int | count () const |
Returns the number of sub-keys contained by this property. More... | |
void | dump (int tabs=0) const override |
Dumps out the keys and values. More... | |
void | entryList (QStringList &entries) const |
Returns any sub-keys contained by this property that do not contain other keys. More... | |
QgsProjectProperty * | find (const QString &propertyName) const |
Attempts to find a property with a matching sub-key name. More... | |
bool | isEmpty () const |
Returns true if this property contains no sub-keys. More... | |
bool | isKey () const override |
Returns true if the property is a QgsProjectPropertyKey. More... | |
bool | isLeaf () const override |
Returns true if property is a leaf node. More... | |
bool | isValue () const override |
Returns true if the property is a QgsProjectPropertyValue. More... | |
QString | name () const |
The name of the property is used as identifier. More... | |
bool | readXml (const QDomNode &keyNode) override |
Restores the property hierarchy from a specified DOM node. More... | |
void | removeKey (const QString &keyName) |
Removes the specified key. More... | |
void | setName (const QString &name) |
The name of the property is used as identifier. More... | |
QgsProjectPropertyValue * | setValue (const QString &name, const QVariant &value) |
Sets the value associated with this key. More... | |
QgsProjectPropertyValue * | setValue (const QVariant &value) |
Set the value associated with this key. More... | |
void | subkeyList (QStringList &entries) const |
Returns any sub-keys contained by this property which themselves contain other keys. More... | |
QVariant | value () const override |
If this key has a value, it will be stored by its name in its properties. More... | |
bool | writeXml (const QString &nodeName, QDomElement &element, QDomDocument &document) override |
Writes the property hierarchy to a specified DOM element. More... | |
![]() | |
QgsProjectProperty () | |
virtual | ~QgsProjectProperty ()=default |
virtual void | dump (int tabs=0) const =0 |
Dumps out the keys and values. More... | |
virtual bool | isKey () const =0 |
Returns true if the property is a QgsProjectPropertyKey. More... | |
virtual bool | isLeaf () const =0 |
Returns true if property is a leaf node. More... | |
virtual bool | isValue () const =0 |
Returns true if the property is a QgsProjectPropertyValue. More... | |
virtual bool | readXml (const QDomNode &keyNode)=0 |
Restores the property hierarchy from a specified DOM node. More... | |
virtual QVariant | value () const =0 |
Returns the node's value. More... | |
virtual bool | writeXml (const QString &nodeName, QDomElement &element, QDomDocument &document)=0 |
Writes the property hierarchy to a specified DOM element. More... | |
Project property key node.
Can, itself, contain QgsProjectPropertyKey and QgsProjectPropertyValues.
The internal QHash, mProperties, maps key names to their respective QgsProjectPropertyValue or next QgsProjectPropertyKey in the key name sequence. The key with the current name should contain its QgsProjectPropertyValue.
E.g., given the key sequence "/foo/bar", "foo" will have a corresponding QgsProjectPropertyKey with a name "foo". It will contain an element in its mProperties that maps to "bar", which is another QgsProjectPropertyKey. The "bar" QgsProjectPropertyKey will, in turn, have an element that maps to itself, i.e. "bar", that will contain a QgsProjectPropertyValue.
Definition at line 183 of file qgsprojectproperty.h.
QgsProjectPropertyKey::QgsProjectPropertyKey | ( | const QString & | name = QString() | ) |
Create a new QgsProjectPropertyKey with the specified identifier.
Definition at line 272 of file qgsprojectproperty.cpp.
|
override |
Definition at line 276 of file qgsprojectproperty.cpp.
|
inline |
Adds the specified property key as a sub-key.
Definition at line 218 of file qgsprojectproperty.h.
|
inlinevirtual |
Resets the property to a default, empty state.
Definition at line 298 of file qgsprojectproperty.h.
|
inlinevirtual |
Deletes any sub-nodes from the property.
Definition at line 307 of file qgsprojectproperty.h.
|
inline |
Returns the number of sub-keys contained by this property.
Definition at line 272 of file qgsprojectproperty.h.
|
overridevirtual |
Dumps out the keys and values.
tabs | is number of tabs to print; used for pretty-printing hierarchy |
Implements QgsProjectProperty.
Definition at line 295 of file qgsprojectproperty.cpp.
void QgsProjectPropertyKey::entryList | ( | QStringList & | entries | ) | const |
Returns any sub-keys contained by this property that do not contain other keys.
Definition at line 426 of file qgsprojectproperty.cpp.
|
inline |
Attempts to find a property with a matching sub-key name.
Definition at line 316 of file qgsprojectproperty.h.
|
inline |
Returns true
if this property contains no sub-keys.
Definition at line 277 of file qgsprojectproperty.h.
|
inlineoverridevirtual |
Returns true
if the property is a QgsProjectPropertyKey.
Implements QgsProjectProperty.
Definition at line 279 of file qgsprojectproperty.h.
|
overridevirtual |
Returns true
if property is a leaf node.
A leaf node is a key node that has either no value or only a single value. A non-leaf node would be a key node with key sub-nodes.
This is used for entryList() and subkeyList() implementation.
Implements QgsProjectProperty.
Definition at line 455 of file qgsprojectproperty.cpp.
|
inlineoverridevirtual |
Returns true
if the property is a QgsProjectPropertyValue.
Implements QgsProjectProperty.
Definition at line 280 of file qgsprojectproperty.h.
|
inline |
The name of the property is used as identifier.
Definition at line 199 of file qgsprojectproperty.h.
|
overridevirtual |
Restores the property hierarchy from a specified DOM node.
Used for restoring properties from project file
Implements QgsProjectProperty.
Definition at line 354 of file qgsprojectproperty.cpp.
|
inline |
Removes the specified key.
Definition at line 232 of file qgsprojectproperty.h.
void QgsProjectPropertyKey::setName | ( | const QString & | name | ) |
The name of the property is used as identifier.
Definition at line 474 of file qgsprojectproperty.cpp.
|
inline |
Sets the value associated with this key.
name | is the key name |
value | is the value to set |
Definition at line 243 of file qgsprojectproperty.h.
|
inline |
Set the value associated with this key.
Definition at line 260 of file qgsprojectproperty.h.
void QgsProjectPropertyKey::subkeyList | ( | QStringList & | entries | ) | const |
Returns any sub-keys contained by this property which themselves contain other keys.
Definition at line 440 of file qgsprojectproperty.cpp.
|
overridevirtual |
If this key has a value, it will be stored by its name in its properties.
Implements QgsProjectProperty.
Definition at line 281 of file qgsprojectproperty.cpp.
|
overridevirtual |
Writes the property hierarchy to a specified DOM element.
Used for saving properties to project file.
nodeName | the tag name associated with this element |
element | the parent (or encompassing) property element |
document | the overall project file Dom document |
Implements QgsProjectProperty.
Definition at line 402 of file qgsprojectproperty.cpp.