API reference - Class QSimpleXmlNodeModel

Notation used in Ruby API documentation

Module: QtXmlPatterns

Description: Binding of QSimpleXmlNodeModel

Class hierarchy: QSimpleXmlNodeModel » QAbstractXmlNodeModel

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]QUrlbaseUri(const QXmlNodeModelIndex node)Method QUrl QSimpleXmlNodeModel::baseUri(const QXmlNodeModelIndex &node)
[const]QXmlNodeModelIndexelementById(const QXmlName id)Method QXmlNodeModelIndex QSimpleXmlNodeModel::elementById(const QXmlName &id)
[const]QXmlNamePoolnamePoolMethod QXmlNamePool &QSimpleXmlNodeModel::namePool()
[const]QXmlName[]namespaceBindings(const QXmlNodeModelIndex arg1)Method QVector<QXmlName> QSimpleXmlNodeModel::namespaceBindings(const QXmlNodeModelIndex &)
[const]QXmlNodeModelIndex[]nodesByIdref(const QXmlName idref)Method QVector<QXmlNodeModelIndex> QSimpleXmlNodeModel::nodesByIdref(const QXmlName &idref)
[const]stringstringValue(const QXmlNodeModelIndex node)Method QString QSimpleXmlNodeModel::stringValue(const QXmlNodeModelIndex &node)

Detailed description

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

baseUri

Signature: [const] QUrl baseUri (const QXmlNodeModelIndex node)

Description: Method QUrl QSimpleXmlNodeModel::baseUri(const QXmlNodeModelIndex &node)

This is a reimplementation of QAbstractXmlNodeModel::baseUri

elementById

Signature: [const] QXmlNodeModelIndex elementById (const QXmlName id)

Description: Method QXmlNodeModelIndex QSimpleXmlNodeModel::elementById(const QXmlName &id)

This is a reimplementation of QAbstractXmlNodeModel::elementById

namePool

Signature: [const] QXmlNamePool namePool

Description: Method QXmlNamePool &QSimpleXmlNodeModel::namePool()

namespaceBindings

Signature: [const] QXmlName[] namespaceBindings (const QXmlNodeModelIndex arg1)

Description: Method QVector<QXmlName> QSimpleXmlNodeModel::namespaceBindings(const QXmlNodeModelIndex &)

This is a reimplementation of QAbstractXmlNodeModel::namespaceBindings

nodesByIdref

Signature: [const] QXmlNodeModelIndex[] nodesByIdref (const QXmlName idref)

Description: Method QVector<QXmlNodeModelIndex> QSimpleXmlNodeModel::nodesByIdref(const QXmlName &idref)

This is a reimplementation of QAbstractXmlNodeModel::nodesByIdref

stringValue

Signature: [const] string stringValue (const QXmlNodeModelIndex node)

Description: Method QString QSimpleXmlNodeModel::stringValue(const QXmlNodeModelIndex &node)

This is a reimplementation of QAbstractXmlNodeModel::stringValue