QDeclarativeDomProperty Class Reference

The QDeclarativeDomProperty class represents one property assignment in the QML DOM tree. More...

#include <qdeclarativedom_p.h>

Public Functions
bool	isDefaultProperty () const
	Return true if this property is used as a default property in the QML document. More...
bool	isValid () const
	Returns true if this is a valid QDeclarativeDomProperty, false otherwise. More...
int	length () const
	Returns the length in the input data from where the property ID started upto the end of it, or -1 if the property is invalid. More...
QDeclarativeDomProperty &	operator= (const QDeclarativeDomProperty &)
	Assign other to this QDeclarativeDomProperty. More...
int	position () const
	Returns the position in the input data where the property ID startd, or -1 if the property is invalid. More...
QByteArray	propertyName () const
	Return the name of this property. More...
QList< QByteArray >	propertyNameParts () const
	Return the name of this property, split into multiple parts in the case of dot properties. More...
	QDeclarativeDomProperty ()
	Construct an invalid QDeclarativeDomProperty. More...
	QDeclarativeDomProperty (const QDeclarativeDomProperty &)
	Create a copy of other QDeclarativeDomProperty. More...
QDeclarativeDomValue	value () const
	Returns the QDeclarativeDomValue that is assigned to this property, or an invalid QDeclarativeDomValue if no value is assigned. More...
	~QDeclarativeDomProperty ()
	Destroy the QDeclarativeDomProperty. More...

Properties
QSharedDataPointer< QDeclarativeDomPropertyPrivate >	d

Friends
class	QDeclarativeDomDynamicProperty
class	QDeclarativeDomObject

Detailed Description

The QDeclarativeDomProperty class represents one property assignment in the QML DOM tree.

Warning

This function is not part of the public interface.

Properties in QML can be assigned QML QDeclarativeDomValue{values}.

See also

QDeclarativeDomObject

Definition at line 101 of file qdeclarativedom_p.h.

Constructors and Destructors

QDeclarativeDomProperty() [1/2]

QDeclarativeDomProperty::QDeclarativeDomProperty

(

)

Construct an invalid QDeclarativeDomProperty.

Definition at line 253 of file qdeclarativedom.cpp.

: d(new QDeclarativeDomPropertyPrivate)
{
}

QDeclarativeDomProperty() [2/2]

QDeclarativeDomProperty::QDeclarativeDomProperty

(

const QDeclarativeDomProperty &

other

)

Create a copy of other QDeclarativeDomProperty.

Definition at line 261 of file qdeclarativedom.cpp.

: d(other.d)
{
}

~QDeclarativeDomProperty()

QDeclarativeDomProperty::~QDeclarativeDomProperty

(

)

Destroy the QDeclarativeDomProperty.

Definition at line 269 of file qdeclarativedom.cpp.

{
}

Functions

isDefaultProperty()

bool QDeclarativeDomProperty::isDefaultProperty

(

)

const

Return true if this property is used as a default property in the QML document.

<Text text="hello"/>
<Text>hello</Text>

The above two examples return the same DOM tree, except that the second has the default property flag set on the text property. Observe that whether or not a property has isDefaultProperty set is determined by how the property is used, and not only by whether the property is the types default property.

Definition at line 354 of file qdeclarativedom.cpp.

{
    return d->property && d->property->isDefault;
}

isValid()

bool QDeclarativeDomProperty::isValid

(

)

const

Returns true if this is a valid QDeclarativeDomProperty, false otherwise.

Definition at line 285 of file qdeclarativedom.cpp.

{
    return d->property != 0;
}

length()

int QDeclarativeDomProperty::length

(

)

const

Returns the length in the input data from where the property ID started upto the end of it, or -1 if the property is invalid.

Definition at line 394 of file qdeclarativedom.cpp.

{
    if (d && d->property)
        return d->property->location.range.length;
    else
        return -1;
}

operator=()

QDeclarativeDomProperty & QDeclarativeDomProperty::operator=

(

const QDeclarativeDomProperty &

other

)

Assign other to this QDeclarativeDomProperty.

Definition at line 276 of file qdeclarativedom.cpp.

{
    d = other.d;
    return *this;
}

position()

int QDeclarativeDomProperty::position

(

)

const

Returns the position in the input data where the property ID startd, or -1 if the property is invalid.

Definition at line 382 of file qdeclarativedom.cpp.

{
    if (d && d->property) {
        return d->property->location.range.offset;
    } else
        return -1;
}

propertyName()

QByteArray QDeclarativeDomProperty::propertyName

(

)

const

Return the name of this property.

Text {
    x: 10
    y: 10
    font.bold: true
}

As illustrated above, a property name can be a simple string, such as "x" or "y", or a more complex "dot property", such as "font.bold". In both cases the full name is returned ("x", "y" and "font.bold") by this method.

For dot properties, a split version of the name can be accessed by calling QDeclarativeDomProperty::propertyNameParts().

See also

QDeclarativeDomProperty::propertyNameParts()

Definition at line 311 of file qdeclarativedom.cpp.

Referenced by QDeclarativeDomObject::property().

{
    return d->propertyName;
}

propertyNameParts()

QList< QByteArray > QDeclarativeDomProperty::propertyNameParts

(

)

const

Return the name of this property, split into multiple parts in the case of dot properties.

Text {
    x: 10
    y: 10
    font.bold: true
}

For each of the properties shown above, this method would return ("x"), ("y") and ("font", "bold").

See also

QDeclarativeDomProperty::propertyName()

Definition at line 333 of file qdeclarativedom.cpp.

{
    if (d->propertyName.isEmpty()) return QList<QByteArray>();
    else return d->propertyName.split('.');
}

value()

QDeclarativeDomValue QDeclarativeDomProperty::value

(

)

const

Returns the QDeclarativeDomValue that is assigned to this property, or an invalid QDeclarativeDomValue if no value is assigned.

Definition at line 363 of file qdeclarativedom.cpp.

{
    QDeclarativeDomValue rv;
    if (d->property) {
        rv.d->property = d->property;
        if (d->property->values.count())
            rv.d->value = d->property->values.at(0);
        else
            rv.d->value = d->property->onValues.at(0);
        rv.d->property->addref();
        rv.d->value->addref();
    }
    return rv;
}

Friends and Related Functions

QDeclarativeDomDynamicProperty

friend class QDeclarativeDomDynamicProperty

friend

Definition at line 123 of file qdeclarativedom_p.h.

QDeclarativeDomObject

friend class QDeclarativeDomObject

friend

Definition at line 122 of file qdeclarativedom_p.h.

Properties

d

QSharedDataPointer<QDeclarativeDomPropertyPrivate> QDeclarativeDomProperty::d

private

Definition at line 124 of file qdeclarativedom_p.h.

Referenced by QDeclarativeDomDynamicProperty::defaultValue(), isDefaultProperty(), isValid(), length(), operator=(), position(), QDeclarativeDomObject::properties(), propertyName(), propertyNameParts(), and value().

---

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

• /src/declarative/qml/qdeclarativedom_p.h
• /src/declarative/qml/qdeclarativedom.cpp