QgsPropertyValue Class Reference

#include <qgsprojectproperty.h>

Inheritance diagram for QgsPropertyValue:

[legend]Collaboration diagram for QgsPropertyValue:

[legend]List of all members.

---

Detailed Description

QgsPropertyValue node.

Contains a QgsPropertyKey's value

Definition at line 120 of file qgsprojectproperty.h.

Public Member Functions
	QgsPropertyValue ()
	QgsPropertyValue (QVariant const &value)
virtual	~QgsPropertyValue ()
virtual bool	isKey () const
	returns true if is a QgsPropertyKey
virtual bool	isValue () const
	returns true if is a QgsPropertyValue
QVariant	value () const
	return the node's value
bool	isLeaf () const
	returns true if is a leaf node
void	dump (size_t tabs=0) const
	dumps out the keys and values
bool	readXML (QDomNode &keyNode)
	restores property hierarchy to given Dom node
bool	writeXML (QString const &nodeName, QDomElement &element, QDomDocument &document)
	Parameters: element  created by parent QgsPropertyKey
size_t	count () const
void	entryList (QStringList &keyName, QStringList &entries) const
	return keys that do not contain other keys
Private Attributes
QVariant	value_
	We use QVariant as it's very handy to keep multiple types and provides type conversions.

---

Constructor & Destructor Documentation

QgsPropertyValue::QgsPropertyValue

(

)

[inline]

Definition at line 123 of file qgsprojectproperty.h.

QgsPropertyValue::QgsPropertyValue

(

QVariant const &

value

)

[inline]

Definition at line 126 of file qgsprojectproperty.h.

virtual QgsPropertyValue::~QgsPropertyValue

(

)

[inline, virtual]

Definition at line 130 of file qgsprojectproperty.h.

---

Member Function Documentation

virtual bool QgsPropertyValue::isKey

(

)

const [inline, virtual]

returns true if is a QgsPropertyKey

Implements QgsProperty.

Definition at line 134 of file qgsprojectproperty.h.

virtual bool QgsPropertyValue::isValue

(

)

const [inline, virtual]

returns true if is a QgsPropertyValue

Implements QgsProperty.

Definition at line 138 of file qgsprojectproperty.h.

QVariant QgsPropertyValue::value

(

)

const [inline, virtual]

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.

Implements QgsProperty.

Definition at line 141 of file qgsprojectproperty.h.

bool QgsPropertyValue::isLeaf

(

)

const [inline, virtual]

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.

Implements QgsProperty.

Definition at line 149 of file qgsprojectproperty.h.

void QgsPropertyValue::dump

(

size_t

tabs = 0

)

const [virtual]

dumps out the keys and values

Parameters:

tabs

is number of tabs to print; used for pretty-printing hierarchy

Implements QgsProperty.

Definition at line 26 of file qgsprojectproperty.cpp.

References value_.

bool QgsPropertyValue::readXML

(

QDomNode &

keyNode

)

[virtual]

restores property hierarchy to given Dom node

Used for restoring properties from project file

Implements QgsProperty.

Definition at line 48 of file qgsprojectproperty.cpp.

References value_.

bool QgsPropertyValue::writeXML	(	QString const &	nodeName,
		QDomElement &	element,
		QDomDocument &	document
	)			[virtual]

Parameters:

element

created by parent QgsPropertyKey

Implements QgsProperty.

Definition at line 296 of file qgsprojectproperty.cpp.

References value_.

size_t QgsPropertyValue::count

(

)

const [inline]

Definition at line 160 of file qgsprojectproperty.h.

void QgsPropertyValue::entryList	(	QStringList &	keyName,
		QStringList &	entries
	)			const [inline]

return keys that do not contain other keys

Since QgsPropertyValue isn't a key, don't do anything.

Definition at line 168 of file qgsprojectproperty.h.

---

Member Data Documentation

QVariant QgsPropertyValue::value_ [private]

We use QVariant as it's very handy to keep multiple types and provides type conversions.

Definition at line 176 of file qgsprojectproperty.h.

Referenced by dump(), readXML(), and writeXML().

---

The documentation for this class was generated from the following files:

• src/core/qgsprojectproperty.h
• src/core/qgsprojectproperty.cpp

---