API reference - Class QAbstractItemModel

_const_cast

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

beginInsertColumns

Signature: void beginInsertColumns (const QModelIndex parent, int first, int last)

Description: Method void QAbstractItemModel::beginInsertColumns(const QModelIndex &parent, int first, int last)

This method is protected and can only be called from inside a derived class.

beginInsertRows

Signature: void beginInsertRows (const QModelIndex parent, int first, int last)

Description: Method void QAbstractItemModel::beginInsertRows(const QModelIndex &parent, int first, int last)

This method is protected and can only be called from inside a derived class.

beginMoveColumns

Signature: bool beginMoveColumns (const QModelIndex sourceParent, int sourceFirst, int sourceLast, const QModelIndex destinationParent, int destinationColumn)

Description: Method bool QAbstractItemModel::beginMoveColumns(const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)

This method is protected and can only be called from inside a derived class.

beginMoveRows

Signature: bool beginMoveRows (const QModelIndex sourceParent, int sourceFirst, int sourceLast, const QModelIndex destinationParent, int destinationRow)

Description: Method bool QAbstractItemModel::beginMoveRows(const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)

This method is protected and can only be called from inside a derived class.

beginRemoveColumns

Signature: void beginRemoveColumns (const QModelIndex parent, int first, int last)

Description: Method void QAbstractItemModel::beginRemoveColumns(const QModelIndex &parent, int first, int last)

This method is protected and can only be called from inside a derived class.

beginRemoveRows

Signature: void beginRemoveRows (const QModelIndex parent, int first, int last)

Description: Method void QAbstractItemModel::beginRemoveRows(const QModelIndex &parent, int first, int last)

This method is protected and can only be called from inside a derived class.

beginResetModel

Signature: void beginResetModel

Description: Method void QAbstractItemModel::beginResetModel()

This method is protected and can only be called from inside a derived class.

buddy

Signature: [const] QModelIndex buddy (const QModelIndex index)

Description: Virtual method QModelIndex QAbstractItemModel::buddy(const QModelIndex &index)

This method can be reimplemented in a derived class.

canFetchMore

Signature: [const] bool canFetchMore (const QModelIndex parent)

Description: Virtual method bool QAbstractItemModel::canFetchMore(const QModelIndex &parent)

This method can be reimplemented in a derived class.

changePersistentIndex

Signature: void changePersistentIndex (const QModelIndex from, const QModelIndex to)

Description: Method void QAbstractItemModel::changePersistentIndex(const QModelIndex &from, const QModelIndex &to)

This method is protected and can only be called from inside a derived class.

changePersistentIndexList

Signature: void changePersistentIndexList (QModelIndex[] from, QModelIndex[] to)

Description: Method void QAbstractItemModel::changePersistentIndexList(const QList<QModelIndex> &from, const QList<QModelIndex> &to)

This method is protected and can only be called from inside a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

Description: Virtual method void QAbstractItemModel::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

columnCount

Signature: [const] int columnCount (const QModelIndex parent)

Description: Virtual method int QAbstractItemModel::columnCount(const QModelIndex &parent)

This method can be reimplemented in a derived class.

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.

createIndex

(1) Signature: [const] QModelIndex createIndex (int row, int column, void * data = 0)

Description: Method QModelIndex QAbstractItemModel::createIndex(int row, int column, void *data)

This method is protected and can only be called from inside a derived class.

(2) Signature: [const] QModelIndex createIndex (int row, int column, int id)

Description: Method QModelIndex QAbstractItemModel::createIndex(int row, int column, int id)

This method is protected and can only be called from inside a derived class.

(3) Signature: [const] QModelIndex createIndex (int row, int column, unsigned int id)

Description: Method QModelIndex QAbstractItemModel::createIndex(int row, int column, quint32 id)

This method is protected and can only be called from inside a derived class.

customEvent

Signature: void customEvent (QEvent ptr arg1)

Description: Virtual method void QAbstractItemModel::customEvent(QEvent *)

This method can be reimplemented in a derived class.

data

Signature: [const] variant data (const QModelIndex index, int role)

Description: Virtual method QVariant QAbstractItemModel::data(const QModelIndex &index, int role)

This method can be reimplemented in a derived class.

dataChanged

Signature: [signal] void dataChanged (const QModelIndex topLeft, const QModelIndex bottomRight)

Description: Signal declaration for QAbstractItemModel::dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight)

You can bind a procedure to this signal.

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

decodeData

Signature: bool decodeData (int row, int column, const QModelIndex parent, QDataStream stream)

Description: Method bool QAbstractItemModel::decodeData(int row, int column, const QModelIndex &parent, QDataStream &stream)

This method is protected and can only be called from inside a derived class.

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: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QAbstractItemModel::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (string signal)

Description: Virtual method void QAbstractItemModel::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

dropMimeData

Signature: bool dropMimeData (const QMimeData ptr data, const Qt_DropAction action, int row, int column, const QModelIndex parent)

Description: Virtual method bool QAbstractItemModel::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)

This method can be reimplemented in a derived class.

emit_dataChanged

Signature: void emit_dataChanged (const QModelIndex topLeft, const QModelIndex bottomRight)

Description: Emitter for signal void QAbstractItemModel::dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = 0)

Description: Emitter for signal void QAbstractItemModel::destroyed(QObject *)

Call this method to emit this signal.

emit_headerDataChanged

Signature: void emit_headerDataChanged (const Qt_Orientation orientation, int first, int last)

Description: Emitter for signal void QAbstractItemModel::headerDataChanged(Qt::Orientation orientation, int first, int last)

Call this method to emit this signal.

emit_layoutAboutToBeChanged

Signature: void emit_layoutAboutToBeChanged

Description: Emitter for signal void QAbstractItemModel::layoutAboutToBeChanged()

Call this method to emit this signal.

emit_layoutChanged

Signature: void emit_layoutChanged

Description: Emitter for signal void QAbstractItemModel::layoutChanged()

Call this method to emit this signal.

encodeData

Signature: [const] void encodeData (QModelIndex[] indexes, QDataStream stream)

Description: Method void QAbstractItemModel::encodeData(const QList<QModelIndex> &indexes, QDataStream &stream)

This method is protected and can only be called from inside a derived class.

endInsertColumns

Signature: void endInsertColumns

Description: Method void QAbstractItemModel::endInsertColumns()

This method is protected and can only be called from inside a derived class.

endInsertRows

Signature: void endInsertRows

Description: Method void QAbstractItemModel::endInsertRows()

This method is protected and can only be called from inside a derived class.

endMoveColumns

Signature: void endMoveColumns

Description: Method void QAbstractItemModel::endMoveColumns()

This method is protected and can only be called from inside a derived class.

endMoveRows

Signature: void endMoveRows

Description: Method void QAbstractItemModel::endMoveRows()

This method is protected and can only be called from inside a derived class.

endRemoveColumns

Signature: void endRemoveColumns

Description: Method void QAbstractItemModel::endRemoveColumns()

This method is protected and can only be called from inside a derived class.

endRemoveRows

Signature: void endRemoveRows

Description: Method void QAbstractItemModel::endRemoveRows()

This method is protected and can only be called from inside a derived class.

endResetModel

Signature: void endResetModel

Description: Method void QAbstractItemModel::endResetModel()

This method is protected and can only be called from inside a derived class.

event

Signature: bool event (QEvent ptr arg1)

Description: Virtual method bool QAbstractItemModel::event(QEvent *)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QAbstractItemModel::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

fetchMore

Signature: void fetchMore (const QModelIndex parent)

Description: Virtual method void QAbstractItemModel::fetchMore(const QModelIndex &parent)

This method can be reimplemented in a derived class.

flags

Signature: [const] Qt_QFlags_ItemFlag flags (const QModelIndex index)

Description: Virtual method QFlags<Qt::ItemFlag> QAbstractItemModel::flags(const QModelIndex &index)

This method can be reimplemented in a derived class.

hasChildren

Signature: [const] bool hasChildren (const QModelIndex parent)

Description: Virtual method bool QAbstractItemModel::hasChildren(const QModelIndex &parent)

This method can be reimplemented in a derived class.

hasIndex

Signature: [const] bool hasIndex (int row, int column, const QModelIndex parent = QModelIndex())

Description: Method bool QAbstractItemModel::hasIndex(int row, int column, const QModelIndex &parent)

headerData

Signature: [const] variant headerData (int section, const Qt_Orientation orientation, int role)

Description: Virtual method QVariant QAbstractItemModel::headerData(int section, Qt::Orientation orientation, int role)

This method can be reimplemented in a derived class.

headerDataChanged

Signature: [signal] void headerDataChanged (const Qt_Orientation orientation, int first, int last)

Description: Signal declaration for QAbstractItemModel::headerDataChanged(Qt::Orientation orientation, int first, int last)

You can bind a procedure to this signal.

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

index

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

Description: Virtual method QModelIndex QAbstractItemModel::index(int row, int column, const QModelIndex &parent)

This method can be reimplemented in a derived class.

insertColumn

Signature: bool insertColumn (int column, const QModelIndex parent = QModelIndex())

Description: Method bool QAbstractItemModel::insertColumn(int column, const QModelIndex &parent)

insertColumns

Signature: bool insertColumns (int column, int count, const QModelIndex parent)

Description: Virtual method bool QAbstractItemModel::insertColumns(int column, int count, const QModelIndex &parent)

This method can be reimplemented in a derived class.

insertRow

Signature: bool insertRow (int row, const QModelIndex parent = QModelIndex())

Description: Method bool QAbstractItemModel::insertRow(int row, const QModelIndex &parent)

insertRows

Signature: bool insertRows (int row, int count, const QModelIndex parent)

Description: Virtual method bool QAbstractItemModel::insertRows(int row, int count, const QModelIndex &parent)

This method can be reimplemented in a derived class.

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.

itemData

Signature: [const] map<int,variant> itemData (const QModelIndex index)

Description: Virtual method QMap<int, QVariant> QAbstractItemModel::itemData(const QModelIndex &index)

This method can be reimplemented in a derived class.

layoutAboutToBeChanged

Signature: [signal] void layoutAboutToBeChanged

Description: Signal declaration for QAbstractItemModel::layoutAboutToBeChanged()

You can bind a procedure to this signal.

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

layoutChanged

Signature: [signal] void layoutChanged

Description: Signal declaration for QAbstractItemModel::layoutChanged()

You can bind a procedure to this signal.

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

match

Signature: [const] QModelIndex[] match (const QModelIndex start, int role, variant value, int hits, Qt_QFlags_MatchFlag flags)

Description: Virtual method QList<QModelIndex> QAbstractItemModel::match(const QModelIndex &start, int role, const QVariant &value, int hits, QFlags<Qt::MatchFlag> flags)

This method can be reimplemented in a derived class.

mimeData

Signature: [const] QMimeData ptr mimeData (QModelIndex[] indexes)

Description: Virtual method QMimeData *QAbstractItemModel::mimeData(const QList<QModelIndex> &indexes)

This method can be reimplemented in a derived class.

mimeTypes

Signature: [const] string[] mimeTypes

Description: Virtual method QStringList QAbstractItemModel::mimeTypes()

This method can be reimplemented in a derived class.

new

Signature: [static] new QAbstractItemModel new (QObject ptr parent = 0)

Description: Constructor QAbstractItemModel::QAbstractItemModel(QObject *parent)

This method creates an object of class QAbstractItemModel.

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

parent

Signature: [const] QModelIndex parent (const QModelIndex child)

Description: Virtual method QModelIndex QAbstractItemModel::parent(const QModelIndex &child)

This method can be reimplemented in a derived class.

persistentIndexList

Signature: [const] QModelIndex[] persistentIndexList

Description: Method QList<QModelIndex> QAbstractItemModel::persistentIndexList()

This method is protected and can only be called from inside a derived class.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QAbstractItemModel::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

removeColumn

Signature: bool removeColumn (int column, const QModelIndex parent = QModelIndex())

Description: Method bool QAbstractItemModel::removeColumn(int column, const QModelIndex &parent)

removeColumns

Signature: bool removeColumns (int column, int count, const QModelIndex parent)

Description: Virtual method bool QAbstractItemModel::removeColumns(int column, int count, const QModelIndex &parent)

This method can be reimplemented in a derived class.

removeRow

Signature: bool removeRow (int row, const QModelIndex parent = QModelIndex())

Description: Method bool QAbstractItemModel::removeRow(int row, const QModelIndex &parent)

removeRows

Signature: bool removeRows (int row, int count, const QModelIndex parent)

Description: Virtual method bool QAbstractItemModel::removeRows(int row, int count, const QModelIndex &parent)

This method can be reimplemented in a derived class.

reset

Signature: void reset

Description: Method void QAbstractItemModel::reset()

This method is protected and can only be called from inside a derived class.

revert

Signature: void revert

Description: Virtual method void QAbstractItemModel::revert()

This method can be reimplemented in a derived class.

roleNames

Signature: [const] map<int,bytes> roleNames

Description: Method const QHash<int, QByteArray> &QAbstractItemModel::roleNames()

rowCount

Signature: [const] int rowCount (const QModelIndex parent)

Description: Virtual method int QAbstractItemModel::rowCount(const QModelIndex &parent)

This method can be reimplemented in a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QAbstractItemModel::sender()

This method is protected and can only be called from inside a derived class.

setData

Signature: bool setData (const QModelIndex index, variant value, int role)

Description: Virtual method bool QAbstractItemModel::setData(const QModelIndex &index, const QVariant &value, int role)

This method can be reimplemented in a derived class.

setHeaderData

Signature: bool setHeaderData (int section, const Qt_Orientation orientation, variant value, int role)

Description: Virtual method bool QAbstractItemModel::setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role)

This method can be reimplemented in a derived class.

setItemData

Signature: bool setItemData (const QModelIndex index, map<int,variant> roles)

Description: Virtual method bool QAbstractItemModel::setItemData(const QModelIndex &index, const QMap<int, QVariant> &roles)

This method can be reimplemented in a derived class.

setRoleNames

Signature: void setRoleNames (map<int,bytes> roleNames)

Description: Method void QAbstractItemModel::setRoleNames(const QHash<int, QByteArray> &roleNames)

This method is protected and can only be called from inside a derived class.

setSupportedDragActions

Signature: void setSupportedDragActions (Qt_QFlags_DropAction arg1)

Description: Method void QAbstractItemModel::setSupportedDragActions(QFlags<Qt::DropAction>)

Python specific notes:
The object exposes a writable attribute 'supportedDragActions'. This is the setter.

sibling

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

Description: Method QModelIndex QAbstractItemModel::sibling(int row, int column, const QModelIndex &idx)

sort

Signature: void sort (int column, const Qt_SortOrder order)

Description: Virtual method void QAbstractItemModel::sort(int column, Qt::SortOrder order)

This method can be reimplemented in a derived class.

span

Signature: [const] QSize span (const QModelIndex index)

Description: Virtual method QSize QAbstractItemModel::span(const QModelIndex &index)

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

submit

Signature: bool submit

Description: Virtual method bool QAbstractItemModel::submit()

This method can be reimplemented in a derived class.

supportedDragActions

Signature: [const] Qt_QFlags_DropAction supportedDragActions

Description: Method QFlags<Qt::DropAction> QAbstractItemModel::supportedDragActions()

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

supportedDragActions=

Signature: void supportedDragActions= (Qt_QFlags_DropAction arg1)

Description: Method void QAbstractItemModel::setSupportedDragActions(QFlags<Qt::DropAction>)

Python specific notes:
The object exposes a writable attribute 'supportedDragActions'. This is the setter.

supportedDropActions

Signature: [const] Qt_QFlags_DropAction supportedDropActions

Description: Virtual method QFlags<Qt::DropAction> QAbstractItemModel::supportedDropActions()

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

Description: Virtual method void QAbstractItemModel::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

tr

(1) Signature: [static] string tr (string s, string c = 0)

Description: Static method QString QAbstractItemModel::tr(const char *s, const char *c)

This method is static and can be called without an instance.

(2) Signature: [static] string tr (string s, string c, int n)

Description: Static method QString QAbstractItemModel::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

(1) Signature: [static] string trUtf8 (string s, string c = 0)

Description: Static method QString QAbstractItemModel::trUtf8(const char *s, const char *c)

This method is static and can be called without an instance.

(2) Signature: [static] string trUtf8 (string s, string c, int n)

Description: Static method QString QAbstractItemModel::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.