API reference - Class QPersistentModelIndex

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QPersistentModelIndex

Public constructors

new QPersistentModelIndexnewConstructor QPersistentModelIndex::QPersistentModelIndex()
new QPersistentModelIndexnew(const QModelIndex index)Constructor QPersistentModelIndex::QPersistentModelIndex(const QModelIndex &index)
new QPersistentModelIndexnew(const QPersistentModelIndex other)Constructor QPersistentModelIndex::QPersistentModelIndex(const QPersistentModelIndex &other)

Public methods

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

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

!=

(1) Signature: [const] bool != (const QPersistentModelIndex other)

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

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

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

<

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

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

==

(1) Signature: [const] bool == (const QPersistentModelIndex other)

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

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

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

_assign

Signature: void _assign (const QPersistentModelIndex other)

Description: Assigns another object to self

_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

(1) Signature: QPersistentModelIndex assign (const QPersistentModelIndex other)

Description: Method QPersistentModelIndex &QPersistentModelIndex::operator=(const QPersistentModelIndex &other)

(2) Signature: QPersistentModelIndex assign (const QModelIndex other)

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

castToQModelIndex

Signature: [const] QModelIndex castToQModelIndex

Description: Binding for "operator const QModelIndex &".

child

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

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

column

Signature: [const] int column

Description: Method int QPersistentModelIndex::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 QPersistentModelIndex::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 QPersistentModelIndex 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> QPersistentModelIndex::flags()

internalId

Signature: [const] unsigned long long internalId

Description: Method quintptr QPersistentModelIndex::internalId()

internalPointer

Signature: [const] void * internalPointer

Description: Method void *QPersistentModelIndex::internalPointer()

isValid?

Signature: [const] bool isValid?

Description: Method bool QPersistentModelIndex::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 *QPersistentModelIndex::model()

new

(1) Signature: [static] new QPersistentModelIndex new

Description: Constructor QPersistentModelIndex::QPersistentModelIndex()

This method creates an object of class QPersistentModelIndex.

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

(2) Signature: [static] new QPersistentModelIndex new (const QModelIndex index)

Description: Constructor QPersistentModelIndex::QPersistentModelIndex(const QModelIndex &index)

This method creates an object of class QPersistentModelIndex.

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

(3) Signature: [static] new QPersistentModelIndex new (const QPersistentModelIndex other)

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

This method creates an object of class QPersistentModelIndex.

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

parent

Signature: [const] QModelIndex parent

Description: Method QModelIndex QPersistentModelIndex::parent()

row

Signature: [const] int row

Description: Method int QPersistentModelIndex::row()

sibling

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

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

swap

Signature: void swap (QPersistentModelIndex other)

Description: Method void QPersistentModelIndex::swap(QPersistentModelIndex &other)