QDeclarativeDomObject Class Reference

The QDeclarativeDomObject class represents an object instantiation. More...

#include <qdeclarativedom_p.h>

Inheritance diagram for QDeclarativeDomObject:

Public Functions
QByteArray	customTypeData () const
	If this object represents a custom type, returns the data associated with the custom type, otherwise returns an empty QByteArray(). More...
QList< QDeclarativeDomDynamicProperty >	dynamicProperties () const
QDeclarativeDomDynamicProperty	dynamicProperty (const QByteArray &) const
bool	isComponent () const
	Returns true if this object is a sub-component object. More...
bool	isCustomType () const
	Returns true if this object is a custom type. More...
bool	isValid () const
	Returns true if this is a valid QDeclarativeDomObject, false otherwise. More...
int	length () const
	Returns the length in the input data from where the property assignment star ted upto the end of it, or -1 if the property is invalid. More...
QByteArray	objectClassName () const
	Returns the type name as referenced in the qml file. More...
QString	objectId () const
	Returns the QML id assigned to this object, or an empty QByteArray if no id has been assigned. More...
QByteArray	objectType () const
	Returns the fully-qualified type name of this object. More...
int	objectTypeMajorVersion () const
int	objectTypeMinorVersion () const
QDeclarativeDomObject &	operator= (const QDeclarativeDomObject &)
	Assign other to this QDeclarativeDomObject. More...
int	position () const
	Returns the position in the input data where the property assignment started , or -1 if the property is invalid. More...
QList< QDeclarativeDomProperty >	properties () const
	Returns the list of assigned properties on this object. More...
QDeclarativeDomProperty	property (const QByteArray &) const
	Returns the object's name property if a value has been assigned to it, or an invalid QDeclarativeDomProperty otherwise. More...
	QDeclarativeDomObject ()
	Construct an invalid QDeclarativeDomObject. More...
	QDeclarativeDomObject (const QDeclarativeDomObject &)
	Create a copy of other QDeclarativeDomObject. More...
QDeclarativeDomComponent	toComponent () const
	Returns a QDeclarativeDomComponent for this object if it is a sub-component, or an invalid QDeclarativeDomComponent if not. More...
QUrl	url () const
	~QDeclarativeDomObject ()
	Destroy the QDeclarativeDomObject. More...

Properties
QSharedDataPointer< QDeclarativeDomObjectPrivate >	d

Friends
class	QDeclarativeDomComponent
class	QDeclarativeDomDocument
class	QDeclarativeDomValue
class	QDeclarativeDomValueValueInterceptor
class	QDeclarativeDomValueValueSource

Detailed Description

The QDeclarativeDomObject class represents an object instantiation.

Warning

This function is not part of the public interface.

Each object instantiated in a QML file has a corresponding QDeclarativeDomObject
node in the QML DOM.

In addition to the type information that determines the object to
instantiate, QDeclarativeDomObject's also have a set of associated QDeclarativeDomProperty's.
Each QDeclarativeDomProperty represents a QML property assignment on the instantiated
object.  For example,

QGraphicsWidget {
    opacity: 0.5
    size: "100x100"
}

describes a single QDeclarativeDomObject - "QGraphicsWidget" - with two properties, "opacity" and "size". Obviously QGraphicsWidget has many more properties than just these two, but the QML DOM representation only contains those assigned values (or bindings) in the QML file.

Definition at line 156 of file qdeclarativedom_p.h.

Constructors and Destructors

QDeclarativeDomObject() [1/2]

QDeclarativeDomObject::QDeclarativeDomObject

(

)

Construct an invalid QDeclarativeDomObject.

Definition at line 674 of file qdeclarativedom.cpp.

: d(new QDeclarativeDomObjectPrivate)
{
}

QDeclarativeDomObject() [2/2]

QDeclarativeDomObject::QDeclarativeDomObject

(

const QDeclarativeDomObject &

other

)

Create a copy of other QDeclarativeDomObject.

Definition at line 682 of file qdeclarativedom.cpp.

: d(other.d)
{
}

~QDeclarativeDomObject()

QDeclarativeDomObject::~QDeclarativeDomObject

(

)

Destroy the QDeclarativeDomObject.

Definition at line 690 of file qdeclarativedom.cpp.

{
}

Functions

customTypeData()

QByteArray QDeclarativeDomObject::customTypeData

(

)

const

If this object represents a custom type, returns the data associated with the custom type, otherwise returns an empty QByteArray().

QDeclarativeDomObject::isCustomType() can be used to check if this object represents a custom type.

Definition at line 894 of file qdeclarativedom.cpp.

{
    return QByteArray();
}

dynamicProperties()

QList< QDeclarativeDomDynamicProperty > QDeclarativeDomObject::dynamicProperties

(

)

const

Definition at line 835 of file qdeclarativedom.cpp.

{
    QList<QDeclarativeDomDynamicProperty> properties;

    for (int i = 0; i < d->object->dynamicProperties.size(); ++i) {
        QDeclarativeDomDynamicProperty p;
        p.d = new QDeclarativeDomDynamicPropertyPrivate;
        p.d->property = d->object->dynamicProperties.at(i);
        p.d->valid = true;

        if (p.d->property.defaultValue)
            p.d->property.defaultValue->addref();

        properties.append(p);
    }

    return properties;
}

dynamicProperty()

QDeclarativeDomDynamicProperty QDeclarativeDomObject::dynamicProperty

(

const QByteArray &

name

)

const

Definition at line 854 of file qdeclarativedom.cpp.

{
    QDeclarativeDomDynamicProperty p;

    if (!isValid())
        return p;

    for (int i = 0; i < d->object->dynamicProperties.size(); ++i) {
        if (d->object->dynamicProperties.at(i).name == name) {
            p.d = new QDeclarativeDomDynamicPropertyPrivate;
            p.d->property = d->object->dynamicProperties.at(i);
            if (p.d->property.defaultValue) p.d->property.defaultValue->addref();
            p.d->valid = true;
        }
    }

    return p;
}

isComponent()

bool QDeclarativeDomObject::isComponent

(

)

const

Returns true if this object is a sub-component object.

Sub-component objects can be converted into QDeclarativeDomComponent instances by calling QDeclarativeDomObject::toComponent().

See also

QDeclarativeDomObject::toComponent()

Definition at line 906 of file qdeclarativedom.cpp.

Referenced by properties(), and toComponent().

{
    return (d->object && (d->object->typeName == "Qt/Component" || d->object->typeName == "QtQuick/Component"));
}

isCustomType()

bool QDeclarativeDomObject::isCustomType

(

)

const

Returns true if this object is a custom type.

Custom types are special types that allow embeddeding non-QML data, such as SVG or HTML data, directly into QML files.

Note

Currently this method will always return false, and is a placekeeper for future functionality.

See also

QDeclarativeDomObject::customTypeData()

Definition at line 883 of file qdeclarativedom.cpp.

{
    return false;
}

isValid()

bool QDeclarativeDomObject::isValid

(

)

const

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

Definition at line 706 of file qdeclarativedom.cpp.

Referenced by dynamicProperty().

{
    return d->object != 0;
}

length()

int QDeclarativeDomObject::length

(

)

const

Returns the length in the input data from where the property assignment star

ted upto the end of it, or -1 if the property is invalid.

Definition at line 942 of file qdeclarativedom.cpp.

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

objectClassName()

QByteArray QDeclarativeDomObject::objectClassName

(

)

const

Returns the type name as referenced in the qml file.

For example, the type of this object would be "Rectangle".

Rectangle { }

Definition at line 733 of file qdeclarativedom.cpp.

{
    if (d->object)
        return d->object->className;
    else
        return QByteArray();
}

objectId()

QString QDeclarativeDomObject::objectId

(

)

const

Returns the QML id assigned to this object, or an empty QByteArray if no id has been assigned.

For example, the object id of this object would be "MyText".

Text { id: myText }

Definition at line 766 of file qdeclarativedom.cpp.

{
    if (d->object) {
        return d->object->id;
    } else {
        return QString();
    }
}

objectType()

QByteArray QDeclarativeDomObject::objectType

(

)

const

Returns the fully-qualified type name of this object.

For example, the type of this object would be "Qt/4.6/Rectangle".

Rectangle { }

Definition at line 719 of file qdeclarativedom.cpp.

{
    if (d->object) return d->object->typeName;
    else return QByteArray();
}

objectTypeMajorVersion()

int QDeclarativeDomObject::objectTypeMajorVersion

(

)

const

Definition at line 741 of file qdeclarativedom.cpp.

{
    if (d->object)
        return d->object->majorVersion;
    else
        return -1;
}

objectTypeMinorVersion()

int QDeclarativeDomObject::objectTypeMinorVersion

(

)

const

Definition at line 749 of file qdeclarativedom.cpp.

{
    if (d->object)
        return d->object->minorVersion;
    else
        return -1;
}

operator=()

QDeclarativeDomObject & QDeclarativeDomObject::operator=

(

const QDeclarativeDomObject &

other

)

Assign other to this QDeclarativeDomObject.

Definition at line 697 of file qdeclarativedom.cpp.

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

position()

int QDeclarativeDomObject::position

(

)

const

Returns the position in the input data where the property assignment started

, or -1 if the property is invalid.

Definition at line 930 of file qdeclarativedom.cpp.

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

properties()

QList< QDeclarativeDomProperty > QDeclarativeDomObject::properties

(

)

const

Returns the list of assigned properties on this object.

In the following example, "text" and "x" properties would be returned.

Text {
    text: "Hello world!"
    x: 100
}

Definition at line 786 of file qdeclarativedom.cpp.

Referenced by dynamicProperties(), and property().

{
    QList<QDeclarativeDomProperty> rv;

    if (!d->object || isComponent())
        return rv;

    QDeclarativeDomObjectPrivate::Properties properties = d->properties();
    for (int ii = 0; ii < properties.count(); ++ii) {

        QDeclarativeDomProperty domProperty;
        domProperty.d->property = properties.at(ii).first;
        domProperty.d->property->addref();
        domProperty.d->propertyName = properties.at(ii).second;
        rv << domProperty;

    }

    if (d->object->defaultProperty) {
        QDeclarativeDomProperty domProperty;
        domProperty.d->property = d->object->defaultProperty;
        domProperty.d->property->addref();
        domProperty.d->propertyName = d->object->defaultProperty->name;
        rv << domProperty;
    }

    return rv;
}

property()

QDeclarativeDomProperty QDeclarativeDomObject::property

(

const QByteArray &

name

)

const

Returns the object's name property if a value has been assigned to it, or an invalid QDeclarativeDomProperty otherwise.

In the example below, {object.property("source")} would return a valid QDeclarativeDomProperty, and {object.property("tile")} an invalid QDeclarativeDomProperty.

Image { source: "sample.jpg" }

Definition at line 826 of file qdeclarativedom.cpp.

{
    QList<QDeclarativeDomProperty> props = properties();
    for (int ii = 0; ii < props.count(); ++ii)
        if (props.at(ii).propertyName() == name)
            return props.at(ii);
    return QDeclarativeDomProperty();
}

toComponent()

QDeclarativeDomComponent QDeclarativeDomObject::toComponent

(

)

const

Returns a QDeclarativeDomComponent for this object if it is a sub-component, or an invalid QDeclarativeDomComponent if not.

QDeclarativeDomObject::isComponent() can be used to check if this object represents a sub-component.

See also

QDeclarativeDomObject::isComponent()

Definition at line 918 of file qdeclarativedom.cpp.

{
    QDeclarativeDomComponent rv;
    if (isComponent())
        rv.d = d;
    return rv;
}

url()

QUrl QDeclarativeDomObject::url

(

)

const

Definition at line 952 of file qdeclarativedom.cpp.

{
    if (d && d->object)
        return d->object->url;
    else
        return QUrl();
}

Friends and Related Functions

QDeclarativeDomComponent

friend class QDeclarativeDomComponent

friend

Definition at line 192 of file qdeclarativedom_p.h.

QDeclarativeDomDocument

friend class QDeclarativeDomDocument

friend

Definition at line 191 of file qdeclarativedom_p.h.

QDeclarativeDomValue

friend class QDeclarativeDomValue

friend

Definition at line 193 of file qdeclarativedom_p.h.

QDeclarativeDomValueValueInterceptor

friend class QDeclarativeDomValueValueInterceptor

friend

Definition at line 195 of file qdeclarativedom_p.h.

QDeclarativeDomValueValueSource

friend class QDeclarativeDomValueValueSource

friend

Definition at line 194 of file qdeclarativedom_p.h.

Properties

d

QSharedDataPointer<QDeclarativeDomObjectPrivate> QDeclarativeDomObject::d

private

Definition at line 196 of file qdeclarativedom_p.h.

Referenced by QDeclarativeDomComponent::componentRoot(), dynamicProperties(), dynamicProperty(), isComponent(), isValid(), length(), QDeclarativeDomValueValueSource::object(), QDeclarativeDomValueValueInterceptor::object(), objectClassName(), objectId(), objectType(), objectTypeMajorVersion(), objectTypeMinorVersion(), operator=(), position(), properties(), QDeclarativeDomDocument::rootObject(), toComponent(), QDeclarativeDomValue::toObject(), and url().

---

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

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