API reference - Class QModelIndex

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QModelIndex

Public constructors

new QModelIndexnewConstructor QModelIndex::QModelIndex()

Public methods

[const]bool!=(const QModelIndex other)Method bool QModelIndex::operator!=(const QModelIndex &other)
[const]bool<(const QModelIndex other)Method bool QModelIndex::operator<(const QModelIndex &other)
[const]bool==(const QModelIndex other)Method bool QModelIndex::operator==(const QModelIndex &other)
[const]QModelIndex ptr_const_castReturns a non-const reference to self.
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.
voidassign(const QModelIndex other)Assigns another object to self
[const]QModelIndexchild(int row,
int column)
Method QModelIndex QModelIndex::child(int row, int column)
[const]intcolumnMethod int QModelIndex::column()
[const]variantdata(int role = Qt::DisplayRole)Method QVariant QModelIndex::data(int role)
[const]new QModelIndex ptrdupCreates a copy of self
[const]Qt_QFlags_ItemFlagflagsMethod QFlags<Qt::ItemFlag> QModelIndex::flags()
[const]unsigned long longinternalIdMethod quintptr QModelIndex::internalId()
[const]void *internalPointerMethod void *QModelIndex::internalPointer()
[const]boolisValid?Method bool QModelIndex::isValid()
[const]const QAbstractItemModel ptrmodelMethod const QAbstractItemModel *QModelIndex::model()
[const]QModelIndexparentMethod QModelIndex QModelIndex::parent()
[const]introwMethod int QModelIndex::row()
[const]QModelIndexsibling(int row,
int column)
Method QModelIndex QModelIndex::sibling(int row, int column)
[const]QModelIndexsiblingAtColumn(int column)Method QModelIndex QModelIndex::siblingAtColumn(int column)
[const]QModelIndexsiblingAtRow(int row)Method QModelIndex QModelIndex::siblingAtRow(int row)

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 QModelIndex other)

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

<

Signature: [const] bool < (const QModelIndex other)

Description: Method bool QModelIndex::operator<(const QModelIndex &other)

==

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

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

_const_cast

Signature: [const] QModelIndex 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.

assign

Signature: void assign (const QModelIndex other)

Description: Assigns another object to self

child

Signature: [const] QModelIndex child (int row, int column)

Description: Method QModelIndex QModelIndex::child(int row, int column)

column

Signature: [const] int column

Description: Method int QModelIndex::column()

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] variant data (int role = Qt::DisplayRole)

Description: Method QVariant QModelIndex::data(int role)

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 QModelIndex ptr dup

Description: Creates a copy of self

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

flags

Signature: [const] Qt_QFlags_ItemFlag flags

Description: Method QFlags<Qt::ItemFlag> QModelIndex::flags()

internalId

Signature: [const] unsigned long long internalId

Description: Method quintptr QModelIndex::internalId()

internalPointer

Signature: [const] void * internalPointer

Description: Method void *QModelIndex::internalPointer()

isValid?

Signature: [const] bool isValid?

Description: Method bool QModelIndex::isValid()

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 QAbstractItemModel ptr model

Description: Method const QAbstractItemModel *QModelIndex::model()

new

Signature: [static] new QModelIndex new

Description: Constructor QModelIndex::QModelIndex()

This method creates an object of class QModelIndex.

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

parent

Signature: [const] QModelIndex parent

Description: Method QModelIndex QModelIndex::parent()

row

Signature: [const] int row

Description: Method int QModelIndex::row()

sibling

Signature: [const] QModelIndex sibling (int row, int column)

Description: Method QModelIndex QModelIndex::sibling(int row, int column)

siblingAtColumn

Signature: [const] QModelIndex siblingAtColumn (int column)

Description: Method QModelIndex QModelIndex::siblingAtColumn(int column)

siblingAtRow

Signature: [const] QModelIndex siblingAtRow (int row)

Description: Method QModelIndex QModelIndex::siblingAtRow(int row)