API reference - Class QXmlNodeModelIndex

Notation used in Ruby API documentation

Module: QtXmlPatterns

Description: Binding of QXmlNodeModelIndex

Sub-classes: DocumentOrder, QFlags_DocumentOrder, NodeKind, QFlags_NodeKind

Public constructors

new QXmlNodeModelIndexnewConstructor QXmlNodeModelIndex::QXmlNodeModelIndex()
new QXmlNodeModelIndexnew(const QXmlNodeModelIndex other)Constructor QXmlNodeModelIndex::QXmlNodeModelIndex(const QXmlNodeModelIndex &other)

Public methods

[const]bool!=(const QXmlNodeModelIndex other)Method bool QXmlNodeModelIndex::operator!=(const QXmlNodeModelIndex &other)
[const]bool==(const QXmlNodeModelIndex other)Method bool QXmlNodeModelIndex::operator==(const QXmlNodeModelIndex &other)
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]long longadditionalDataMethod qint64 QXmlNodeModelIndex::additionalData()
voidassign(const QXmlNodeModelIndex other)Assigns another object to self
[const]long longdataMethod qint64 QXmlNodeModelIndex::data()
[const]new QXmlNodeModelIndex ptrdupCreates a copy of self
[const]void *internalPointerMethod void *QXmlNodeModelIndex::internalPointer()
[const]boolisNull?Method bool QXmlNodeModelIndex::isNull()
[const]const QAbstractXmlNodeModel ptrmodelMethod const QAbstractXmlNodeModel *QXmlNodeModelIndex::model()
voidresetMethod void QXmlNodeModelIndex::reset()

Public static methods and constants

[static,const]QXmlNodeModelIndex_NodeKindAttributeEnum constant QXmlNodeModelIndex::Attribute
[static,const]QXmlNodeModelIndex_NodeKindCommentEnum constant QXmlNodeModelIndex::Comment
[static,const]QXmlNodeModelIndex_NodeKindDocumentEnum constant QXmlNodeModelIndex::Document
[static,const]QXmlNodeModelIndex_NodeKindElementEnum constant QXmlNodeModelIndex::Element
[static,const]QXmlNodeModelIndex_DocumentOrderFollowsEnum constant QXmlNodeModelIndex::Follows
[static,const]QXmlNodeModelIndex_DocumentOrderIsEnum constant QXmlNodeModelIndex::Is
[static,const]QXmlNodeModelIndex_NodeKindNamespaceEnum constant QXmlNodeModelIndex::Namespace
[static,const]QXmlNodeModelIndex_DocumentOrderPrecedesEnum constant QXmlNodeModelIndex::Precedes
[static,const]QXmlNodeModelIndex_NodeKindProcessingInstructionEnum constant QXmlNodeModelIndex::ProcessingInstruction
[static,const]QXmlNodeModelIndex_NodeKindTextEnum constant QXmlNodeModelIndex::Text

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QXmlNodeModelIndex other)

Description: Method bool QXmlNodeModelIndex::operator!=(const QXmlNodeModelIndex &other)

==

Signature: [const] bool == (const QXmlNodeModelIndex other)

Description: Method bool QXmlNodeModelIndex::operator==(const QXmlNodeModelIndex &other)

Attribute

Signature: [static,const] QXmlNodeModelIndex_NodeKind Attribute

Description: Enum constant QXmlNodeModelIndex::Attribute

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

Comment

Signature: [static,const] QXmlNodeModelIndex_NodeKind Comment

Description: Enum constant QXmlNodeModelIndex::Comment

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

Document

Signature: [static,const] QXmlNodeModelIndex_NodeKind Document

Description: Enum constant QXmlNodeModelIndex::Document

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

Element

Signature: [static,const] QXmlNodeModelIndex_NodeKind Element

Description: Enum constant QXmlNodeModelIndex::Element

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

Follows

Signature: [static,const] QXmlNodeModelIndex_DocumentOrder Follows

Description: Enum constant QXmlNodeModelIndex::Follows

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

Is

Signature: [static,const] QXmlNodeModelIndex_DocumentOrder Is

Description: Enum constant QXmlNodeModelIndex::Is

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

Namespace

Signature: [static,const] QXmlNodeModelIndex_NodeKind Namespace

Description: Enum constant QXmlNodeModelIndex::Namespace

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

Precedes

Signature: [static,const] QXmlNodeModelIndex_DocumentOrder Precedes

Description: Enum constant QXmlNodeModelIndex::Precedes

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

ProcessingInstruction

Signature: [static,const] QXmlNodeModelIndex_NodeKind ProcessingInstruction

Description: Enum constant QXmlNodeModelIndex::ProcessingInstruction

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

Text

Signature: [static,const] QXmlNodeModelIndex_NodeKind Text

Description: Enum constant QXmlNodeModelIndex::Text

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

_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.

additionalData

Signature: [const] long long additionalData

Description: Method qint64 QXmlNodeModelIndex::additionalData()

assign

Signature: void assign (const QXmlNodeModelIndex other)

Description: Assigns another object to self

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.

data

Signature: [const] long long data

Description: Method qint64 QXmlNodeModelIndex::data()

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.

dup

Signature: [const] new QXmlNodeModelIndex ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

internalPointer

Signature: [const] void * internalPointer

Description: Method void *QXmlNodeModelIndex::internalPointer()

isNull?

Signature: [const] bool isNull?

Description: Method bool QXmlNodeModelIndex::isNull()

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.

model

Signature: [const] const QAbstractXmlNodeModel ptr model

Description: Method const QAbstractXmlNodeModel *QXmlNodeModelIndex::model()

new

(1) Signature: [static] new QXmlNodeModelIndex new

Description: Constructor QXmlNodeModelIndex::QXmlNodeModelIndex()

This method creates an object of class QXmlNodeModelIndex.

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

(2) Signature: [static] new QXmlNodeModelIndex new (const QXmlNodeModelIndex other)

Description: Constructor QXmlNodeModelIndex::QXmlNodeModelIndex(const QXmlNodeModelIndex &other)

This method creates an object of class QXmlNodeModelIndex.

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

reset

Signature: void reset

Description: Method void QXmlNodeModelIndex::reset()