QDeclarativeDomDocument Class Reference

The QDeclarativeDomDocument class represents the root of a QML document. More...

#include <qdeclarativedom_p.h>

Public Functions
QList< QDeclarativeError >	errors () const
	Returns the last load errors. More...
QList< QDeclarativeDomImport >	imports () const
	Returns all import statements in qml. More...
bool	load (QDeclarativeEngine *, const QByteArray &, const QUrl &=QUrl())
	Loads a QDeclarativeDomDocument from data. More...
QDeclarativeDomDocument &	operator= (const QDeclarativeDomDocument &)
	Assign other to this QDeclarativeDomDocument. More...
	QDeclarativeDomDocument ()
	Construct an empty QDeclarativeDomDocument. More...
	QDeclarativeDomDocument (const QDeclarativeDomDocument &)
	Create a copy of other QDeclarativeDomDocument. More...
QDeclarativeDomObject	rootObject () const
	Returns the document's root object, or an invalid QDeclarativeDomObject if the document has no root. More...
	~QDeclarativeDomDocument ()
	Destroy the QDeclarativeDomDocument. More...

Properties
QSharedDataPointer< QDeclarativeDomDocumentPrivate >	d

Detailed Description

The QDeclarativeDomDocument class represents the root of a QML document.

Warning

This function is not part of the public interface.

A QML document is a self-contained snippet of QML, usually contained in a single file. Each document has a root object, accessible through QDeclarativeDomDocument::rootObject().

The QDeclarativeDomDocument class allows the programmer to inspect a QML document by calling QDeclarativeDomDocument::load().

The following example loads a QML file from disk, and prints out its root object type and the properties assigned in the root object.

QFile file(inputFileName);
file.open(QIODevice::ReadOnly);
QByteArray xmlData = file.readAll();

QDeclarativeDomDocument document;
document.load(qmlengine, xmlData);

QDeclarativeDomObject rootObject = document.rootObject();
qDebug() << rootObject.objectType();
foreach(QDeclarativeDomProperty property, rootObject.properties())
    qDebug() << property.propertyName();

Definition at line 81 of file qdeclarativedom_p.h.

Constructors and Destructors

QDeclarativeDomDocument() [1/2]

QDeclarativeDomDocument::QDeclarativeDomDocument

(

)

Construct an empty QDeclarativeDomDocument.

Definition at line 101 of file qdeclarativedom.cpp.

: d(new QDeclarativeDomDocumentPrivate)
{
}

QDeclarativeDomDocument() [2/2]

QDeclarativeDomDocument::QDeclarativeDomDocument

(

const QDeclarativeDomDocument &

other

)

Create a copy of other QDeclarativeDomDocument.

Definition at line 109 of file qdeclarativedom.cpp.

: d(other.d)
{
}

~QDeclarativeDomDocument()

QDeclarativeDomDocument::~QDeclarativeDomDocument

(

)

Destroy the QDeclarativeDomDocument.

Definition at line 117 of file qdeclarativedom.cpp.

{
}

Functions

errors()

QList< QDeclarativeError > QDeclarativeDomDocument::errors

(

)

const

Returns the last load errors.

The load errors will be reset after a successful call to load().

See also

load()

Definition at line 190 of file qdeclarativedom.cpp.

{
    return d->errors;
}

imports()

QList< QDeclarativeDomImport > QDeclarativeDomDocument::imports

(

)

const

Returns all import statements in qml.

Definition at line 133 of file qdeclarativedom.cpp.

{
    return d->imports;
}

load()

bool QDeclarativeDomDocument::load	(	QDeclarativeEngine *	engine,
		const QByteArray &	data,
		const QUrl &	url = QUrl()
	)

Loads a QDeclarativeDomDocument from data.

data should be valid QML data. On success, true is returned. If the data is malformed, false is returned and QDeclarativeDomDocument::errors() contains an error description.

See also

QDeclarativeDomDocument::loadError()

Definition at line 145 of file qdeclarativedom.cpp.

{
    d->errors.clear();
    d->imports.clear();

    QDeclarativeEnginePrivate *ep = QDeclarativeEnginePrivate::get(engine);
    QDeclarativeTypeData *td = ep->typeLoader.get(data, url, QDeclarativeTypeLoader::PreserveParser);

    if(td->isError()) {
        d->errors = td->errors();
        td->release();
        return false;
    } else if(!td->isCompleteOrError()) {
        QDeclarativeError error;
        error.setDescription(QLatin1String("QDeclarativeDomDocument supports local types only"));
        d->errors << error;
        td->release();
        return false;
    }

    for (int i = 0; i < td->parser().imports().size(); ++i) {
        QDeclarativeScriptParser::Import parserImport = td->parser().imports().at(i);
        QDeclarativeDomImport domImport;
        domImport.d->type = static_cast<QDeclarativeDomImportPrivate::Type>(parserImport.type);
        domImport.d->uri = parserImport.uri;
        domImport.d->qualifier = parserImport.qualifier;
        domImport.d->version = parserImport.version;
        d->imports += domImport;
    }

    if (td->parser().tree()) {
        d->root = td->parser().tree();
        d->root->addref();
    }

    td->release();
    return true;
}

operator=()

QDeclarativeDomDocument & QDeclarativeDomDocument::operator=

(

const QDeclarativeDomDocument &

other

)

Assign other to this QDeclarativeDomDocument.

Definition at line 124 of file qdeclarativedom.cpp.

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

rootObject()

QDeclarativeDomObject QDeclarativeDomDocument::rootObject

(

)

const

Returns the document's root object, or an invalid QDeclarativeDomObject if the document has no root.

In the sample QML below, the root object will be the QDeclarativeItem type.

Item {
    Text {
        text: "Hello World"
    }
}

Definition at line 208 of file qdeclarativedom.cpp.

{
    QDeclarativeDomObject rv;
    rv.d->object = d->root;
    if (rv.d->object) rv.d->object->addref();
    return rv;
}

Properties

d

QSharedDataPointer<QDeclarativeDomDocumentPrivate> QDeclarativeDomDocument::d

private

Definition at line 97 of file qdeclarativedom_p.h.

Referenced by errors(), imports(), load(), operator=(), and rootObject().

---

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

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