QGIS API Documentation
2.2.0-Valmiera
|
QgsPropertyKey node. More...
#include <qgsprojectproperty.h>
Public Member Functions | |
QgsPropertyKey (const QString &name="") | |
virtual | ~QgsPropertyKey () |
QVariant | value () const |
if this key has a value, it will be stored by its name in its properties | |
QgsPropertyKey * | addKey (const QString &keyName) |
add the given property key | |
void | removeKey (const QString &keyName) |
remove the given key | |
QgsPropertyValue * | setValue (const QString &name, const QVariant &value) |
set the value associated with this key | |
QgsPropertyValue * | setValue (const QVariant &value) |
set the value associated with this key | |
void | dump (int tabs=0) const |
dumps out the keys and values | |
bool | readXML (QDomNode &keyNode) |
restores property hierarchy to given Dom node | |
bool | writeXML (const QString &nodeName, QDomElement &element, QDomDocument &document) |
Property keys will always create a Dom element for itself and then recursively call writeXML for any constituent properties. | |
int | count () const |
how many elements are contained within this one? | |
bool | isEmpty () const |
Does this property not have any subkeys or values? | |
virtual bool | isKey () const |
returns true if is a QgsPropertyKey | |
virtual bool | isValue () const |
returns true if is a QgsPropertyValue | |
void | entryList (QStringList &entries) const |
return keys that do not contain other keys | |
void | subkeyList (QStringList &entries) const |
return keys that contain other keys | |
bool | isLeaf () const |
returns true if a leaf node | |
virtual void | clear () |
reset the QgsProperty key to prestine state | |
virtual void | clearKeys () |
delete any sub-nodes | |
QgsProperty * | find (QString &propertyName) |
const QString & | name () const |
every key has a name | |
QString & | name () |
Public Member Functions inherited from QgsProperty | |
QgsProperty () | |
virtual | ~QgsProperty () |
Private Attributes | |
QString | mName |
every key has a name | |
QHash< QString, QgsProperty * > | mProperties |
sub-keys |
QgsPropertyKey node.
Can, itself, contain QgsPropertyKeys and QgsPropertyValues.
The internal QHash, mProperties, maps key names to their respective QgsPropertyValue or next QgsPropertyKey in the key name sequence. The key with the current name should contain its QgsPropertyValue.
E.g., given the key sequence "/foo/bar", "foo" will have a corresponding QgsPropertyKey with a name "foo". It will contain an element in its mProperties that maps to "bar", which is another QgsPropertyKey. The "bar" QgsPropertyKey will, in turn, have an element that maps to itself, i.e. "bar", that will contain a QgsPropertyValue.
Definition at line 190 of file qgsprojectproperty.h.
QgsPropertyKey::QgsPropertyKey | ( | const QString & | name = "" | ) |
Definition at line 267 of file qgsprojectproperty.cpp.
|
virtual |
Definition at line 271 of file qgsprojectproperty.cpp.
References clearKeys().
|
inline |
add the given property key
Definition at line 213 of file qgsprojectproperty.h.
Referenced by _getProperties(), addKey_(), and readXML().
|
inlinevirtual |
reset the QgsProperty key to prestine state
Definition at line 285 of file qgsprojectproperty.h.
|
inlinevirtual |
delete any sub-nodes
Definition at line 292 of file qgsprojectproperty.h.
Referenced by QgsProject::Imp::clear(), and ~QgsPropertyKey().
|
inline |
how many elements are contained within this one?
Definition at line 260 of file qgsprojectproperty.h.
Referenced by isLeaf().
|
virtual |
dumps out the keys and values
tabs | is number of tabs to print; used for pretty-printing hierarchy |
Implements QgsProperty.
Definition at line 290 of file qgsprojectproperty.cpp.
References QgsPropertyValue::dump(), mProperties, name(), QgsDebugMsg, and QgsPropertyValue::value().
Referenced by dump_().
void QgsPropertyKey::entryList | ( | QStringList & | entries | ) | const |
return keys that do not contain other keys
Definition at line 427 of file qgsprojectproperty.cpp.
References mProperties.
Referenced by QgsProject::entryList().
|
inline |
Definition at line 298 of file qgsprojectproperty.h.
References QgsProperty::value().
Referenced by _getProperties(), addKey_(), findKey_(), and removeKey_().
|
inline |
Does this property not have any subkeys or values?
Definition at line 263 of file qgsprojectproperty.h.
|
inlinevirtual |
returns true if is a QgsPropertyKey
Implements QgsProperty.
Definition at line 266 of file qgsprojectproperty.h.
|
virtual |
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.
Implements QgsProperty.
Definition at line 458 of file qgsprojectproperty.cpp.
References count(), and mProperties.
|
inlinevirtual |
returns true if is a QgsPropertyValue
Implements QgsProperty.
Definition at line 269 of file qgsprojectproperty.h.
|
inline |
every key has a name
Definition at line 198 of file qgsprojectproperty.h.
Referenced by addKey_(), dump(), findKey_(), QgsProject::Imp::Imp(), removeKey_(), and value().
|
inline |
Definition at line 201 of file qgsprojectproperty.h.
|
virtual |
restores property hierarchy to given Dom node
Used for restoring properties from project file
Implements QgsProperty.
Definition at line 350 of file qgsprojectproperty.cpp.
References addKey(), mProperties, and QgsDebugMsg.
Referenced by _getProperties().
|
inline |
remove the given key
Definition at line 223 of file qgsprojectproperty.h.
Referenced by removeKey_().
|
inline |
set the value associated with this key
@param name is the key name @param value is the value to set
Definition at line 233 of file qgsprojectproperty.h.
Referenced by addKey_().
|
inline |
set the value associated with this key
Definition at line 246 of file qgsprojectproperty.h.
void QgsPropertyKey::subkeyList | ( | QStringList & | entries | ) | const |
return keys that contain other keys
Definition at line 443 of file qgsprojectproperty.cpp.
References mProperties.
Referenced by QgsProject::subkeyList().
|
virtual |
if this key has a value, it will be stored by its name in its properties
Implements QgsProperty.
Definition at line 276 of file qgsprojectproperty.cpp.
References mProperties, name(), QgsDebugMsg, and QgsProperty::value().
|
virtual |
Property keys will always create a Dom element for itself and then recursively call writeXML for any constituent properties.
Implements QgsProperty.
Definition at line 398 of file qgsprojectproperty.cpp.
References mProperties.
|
private |
every key has a name
Definition at line 306 of file qgsprojectproperty.h.
|
private |
sub-keys
Definition at line 309 of file qgsprojectproperty.h.
Referenced by dump(), entryList(), isLeaf(), readXML(), subkeyList(), value(), and writeXML().