#include <qgsprojectproperty.h>

Inheritance diagram for QgsPropertyKey:

Public Member Functions
	QgsPropertyKey (const QString &name="")
virtual	~QgsPropertyKey ()
QgsPropertyKey *	addKey (const QString &keyName)
	add the given property key
virtual void	clear ()
	reset the QgsProperty key to prestine state
virtual void	clearKeys ()
	delete any sub-nodes
int	count () const
	how many elements are contained within this one?
void	dump (int tabs=0) const override
	dumps out the keys and values
void	entryList (QStringList &entries) const
	return keys that do not contain other keys
QgsProperty *	find (QString &propertyName)
bool	isEmpty () const
	Does this property not have any subkeys or values?
virtual bool	isKey () const override
	returns true if is a QgsPropertyKey
bool	isLeaf () const override
	returns true if a leaf node
virtual bool	isValue () const override
	returns true if is a QgsPropertyValue
bool	readXML (QDomNode &keyNode) override
	restores property hierarchy to given Dom node
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	subkeyList (QStringList &entries) const
	return keys that contain other keys
QVariant	value () const override
	if this key has a value, it will be stored by its name in its properties
bool	writeXML (const QString &nodeName, QDomElement &element, QDomDocument &document) override
	Property keys will always create a Dom element for itself and then recursively call writeXML for any constituent properties.

const QString &	name () const
	every key has a name
QString &	name ()
Public Member Functions inherited from QgsProperty
	QgsProperty ()
virtual	~QgsProperty ()

Detailed Description

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.

Constructor & Destructor Documentation

QgsPropertyKey::QgsPropertyKey ( const QString & name = "" )

Definition at line 267 of file qgsprojectproperty.cpp.

QgsPropertyKey::~QgsPropertyKey ( )

virtual

Definition at line 271 of file qgsprojectproperty.cpp.

Member Function Documentation

QgsPropertyKey* QgsPropertyKey::addKey ( const QString & keyName )

inline

add the given property key

Definition at line 211 of file qgsprojectproperty.h.

virtual void QgsPropertyKey::clear ( )

inlinevirtual

reset the QgsProperty key to prestine state

Definition at line 283 of file qgsprojectproperty.h.

virtual void QgsPropertyKey::clearKeys ( )

inlinevirtual

delete any sub-nodes

Definition at line 290 of file qgsprojectproperty.h.

int QgsPropertyKey::count ( ) const

inline

how many elements are contained within this one?

Definition at line 258 of file qgsprojectproperty.h.

void QgsPropertyKey::dump ( int tabs = 0 ) const

overridevirtual

dumps out the keys and values

Parameters

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

Implements QgsProperty.

Definition at line 290 of file qgsprojectproperty.cpp.

void QgsPropertyKey::entryList ( QStringList & entries ) const

return keys that do not contain other keys

Definition at line 426 of file qgsprojectproperty.cpp.

QgsProperty* QgsPropertyKey::find ( QString & propertyName )

inline

Definition at line 296 of file qgsprojectproperty.h.

bool QgsPropertyKey::isEmpty ( ) const

inline

Does this property not have any subkeys or values?

Definition at line 261 of file qgsprojectproperty.h.

virtual bool QgsPropertyKey::isKey ( ) const

inlineoverridevirtual

returns true if is a QgsPropertyKey

Implements QgsProperty.

Definition at line 264 of file qgsprojectproperty.h.

bool QgsPropertyKey::isLeaf ( ) const

overridevirtual

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 457 of file qgsprojectproperty.cpp.

virtual bool QgsPropertyKey::isValue ( ) const

inlineoverridevirtual

returns true if is a QgsPropertyValue

Implements QgsProperty.

Definition at line 267 of file qgsprojectproperty.h.

const QString& QgsPropertyKey::name ( ) const

inline

every key has a name

Definition at line 198 of file qgsprojectproperty.h.

QString& QgsPropertyKey::name ( )

inline

Definition at line 200 of file qgsprojectproperty.h.

bool QgsPropertyKey::readXML ( QDomNode & keyNode )

overridevirtual

restores property hierarchy to given Dom node

Used for restoring properties from project file

Implements QgsProperty.

Definition at line 349 of file qgsprojectproperty.cpp.

void QgsPropertyKey::removeKey ( const QString & keyName )

inline

remove the given key

Definition at line 221 of file qgsprojectproperty.h.

QgsPropertyValue* QgsPropertyKey::setValue	(	const QString &	name,
		const QVariant &	value
	)

inline

set the value associated with this key

@param name is the key name
@param value is the value to set

Returns: pointer to property value

Definition at line 231 of file qgsprojectproperty.h.

QgsPropertyValue* QgsPropertyKey::setValue ( const QVariant & value )

inline

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

Definition at line 244 of file qgsprojectproperty.h.

void QgsPropertyKey::subkeyList ( QStringList & entries ) const

return keys that contain other keys

Definition at line 442 of file qgsprojectproperty.cpp.

QVariant QgsPropertyKey::value ( ) const

overridevirtual

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.

bool QgsPropertyKey::writeXML	(	const QString &	nodeName,
		QDomElement &	element,
		QDomDocument &	document
	)

overridevirtual

Property keys will always create a Dom element for itself and then recursively call writeXML for any constituent properties.

Implements QgsProperty.

Definition at line 397 of file qgsprojectproperty.cpp.

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

/tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsprojectproperty.h
/tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsprojectproperty.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation