QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
QgsPropertyValue Class Reference

QgsPropertyValue node. More...

#include <qgsprojectproperty.h>

Inheritance diagram for QgsPropertyValue:
Inheritance graph
[legend]

Public Member Functions

 QgsPropertyValue ()
 
 QgsPropertyValue (const QVariant &value)
 
virtual ~QgsPropertyValue ()
 
virtual bool isKey () const
 returns true if is a QgsPropertyKey More...
 
virtual bool isValue () const
 returns true if is a QgsPropertyValue More...
 
QVariant value () const
 return the node's value More...
 
bool isLeaf () const
 returns true if is a leaf node More...
 
void dump (int tabs=0) const
 dumps out the keys and values More...
 
bool readXML (QDomNode &keyNode)
 restores property hierarchy to given Dom node More...
 
bool writeXML (const QString &nodeName, QDomElement &element, QDomDocument &document)
 keyElement created by parent QgsPropertyKey More...
 
int count () const
 
void entryList (QStringList &keyName, QStringList &entries) const
 return keys that do not contain other keys More...
 
- Public Member Functions inherited from QgsProperty
 QgsProperty ()
 
virtual ~QgsProperty ()
 

Detailed Description

QgsPropertyValue node.

Contains a QgsPropertyKey's value

Constructor & Destructor Documentation

QgsPropertyValue::QgsPropertyValue ( )
inline
QgsPropertyValue::QgsPropertyValue ( const QVariant &  value)
inline
virtual QgsPropertyValue::~QgsPropertyValue ( )
inlinevirtual

Member Function Documentation

int QgsPropertyValue::count ( ) const
inline
void QgsPropertyValue::dump ( int  tabs = 0) const
virtual

dumps out the keys and values

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

Implements QgsProperty.

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.

virtual bool QgsPropertyValue::isKey ( ) const
inlinevirtual

returns true if is a QgsPropertyKey

Implements QgsProperty.

bool QgsPropertyValue::isLeaf ( ) const
inlinevirtual

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.

virtual bool QgsPropertyValue::isValue ( ) const
inlinevirtual

returns true if is a QgsPropertyValue

Implements QgsProperty.

bool QgsPropertyValue::readXML ( QDomNode &  keyNode)
virtual

restores property hierarchy to given Dom node

Used for restoring properties from project file

Implements QgsProperty.

QVariant QgsPropertyValue::value ( ) const
inlinevirtual

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.

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

keyElement created by parent QgsPropertyKey

Implements QgsProperty.


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