API reference - Class QAbstractXmlNodeModel

InheritNamespaces

Signature: [static,const] QAbstractXmlNodeModel_NodeCopySetting InheritNamespaces

Description: Enum constant QAbstractXmlNodeModel::InheritNamespaces

Python specific notes:
The object exposes a readable attribute 'InheritNamespaces'. This is the getter.

PreserveNamespaces

Signature: [static,const] QAbstractXmlNodeModel_NodeCopySetting PreserveNamespaces

Description: Enum constant QAbstractXmlNodeModel::PreserveNamespaces

Python specific notes:
The object exposes a readable attribute 'PreserveNamespaces'. This is the getter.

_const_cast

Signature: [const] QAbstractXmlNodeModel ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_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 ni)

Description: Method QUrl QAbstractXmlNodeModel::baseUri(const QXmlNodeModelIndex &ni)

compareOrder

Signature: [const] QXmlNodeModelIndex_DocumentOrder compareOrder (const QXmlNodeModelIndex ni1, const QXmlNodeModelIndex ni2)

Description: Method QXmlNodeModelIndex::DocumentOrder QAbstractXmlNodeModel::compareOrder(const QXmlNodeModelIndex &ni1, const QXmlNodeModelIndex &ni2)

copyNodeTo

Signature: [const] void copyNodeTo (const QXmlNodeModelIndex node, QAbstractXmlReceiver ptr receiver, const QAbstractXmlNodeModel_QFlags_NodeCopySetting arg3)

Description: Method void QAbstractXmlNodeModel::copyNodeTo(const QXmlNodeModelIndex &node, QAbstractXmlReceiver *const receiver, const QFlags<QAbstractXmlNodeModel::NodeCopySetting> &)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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.

documentUri

Signature: [const] QUrl documentUri (const QXmlNodeModelIndex ni)

Description: Method QUrl QAbstractXmlNodeModel::documentUri(const QXmlNodeModelIndex &ni)

elementById

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

Description: Method QXmlNodeModelIndex QAbstractXmlNodeModel::elementById(const QXmlName &NCName)

isDeepEqual?

Signature: [const] bool isDeepEqual? (const QXmlNodeModelIndex ni1, const QXmlNodeModelIndex ni2)

Description: Method bool QAbstractXmlNodeModel::isDeepEqual(const QXmlNodeModelIndex &ni1, const QXmlNodeModelIndex &ni2)

is_const_object?

Signature: [const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

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

kind

Signature: [const] QXmlNodeModelIndex_NodeKind kind (const QXmlNodeModelIndex ni)

Description: Method QXmlNodeModelIndex::NodeKind QAbstractXmlNodeModel::kind(const QXmlNodeModelIndex &ni)

name

Signature: [const] QXmlName name (const QXmlNodeModelIndex ni)

Description: Method QXmlName QAbstractXmlNodeModel::name(const QXmlNodeModelIndex &ni)

namespaceBindings

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

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

namespaceForPrefix

Signature: [const] short namespaceForPrefix (const QXmlNodeModelIndex ni, short prefix)

Description: Method qint16 QAbstractXmlNodeModel::namespaceForPrefix(const QXmlNodeModelIndex &ni, const qint16 prefix)

new

Signature: [static] new QAbstractXmlNodeModel ptr new

Description: Creates a new object of this class

Python specific notes:
This method is the default initializer of the object.

nodesByIdref

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

Description: Method QVector<QXmlNodeModelIndex> QAbstractXmlNodeModel::nodesByIdref(const QXmlName &NCName)

root

Signature: [const] QXmlNodeModelIndex root (const QXmlNodeModelIndex n)

Description: Method QXmlNodeModelIndex QAbstractXmlNodeModel::root(const QXmlNodeModelIndex &n)

sendNamespaces

Signature: [const] void sendNamespaces (const QXmlNodeModelIndex n, QAbstractXmlReceiver ptr receiver)

Description: Method void QAbstractXmlNodeModel::sendNamespaces(const QXmlNodeModelIndex &n, QAbstractXmlReceiver *const receiver)

sourceLocation

Signature: [const] QSourceLocation sourceLocation (const QXmlNodeModelIndex index)

Description: Method QSourceLocation QAbstractXmlNodeModel::sourceLocation(const QXmlNodeModelIndex &index)

stringValue

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

Description: Method QString QAbstractXmlNodeModel::stringValue(const QXmlNodeModelIndex &n)