QAbstractItemModel

This can be useful when debugging memory problems with help from setLogCreateQObject() and setLogDestroyQObject(). The number is hash of the memory address of the C++ object.

Returns: number

a unique number which is valid for the lifetime of the C++ object.

addEventListener

▸ addEventListener‹SignalType›(signalType: SignalType, callback: any[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.addEventListener

Type parameters:

▪ SignalType: keyof any

Parameters:

Name	Type	Description
`signalType`	SignalType	SignalType is a signal from the widgets signals interface.
`callback`	any[SignalType]	Corresponding callback for the signal as mentioned in the widget's signal interface
`options?`	EventListenerOptions	Extra optional options controlling how this event listener is added.

Returns: void

void

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener('clicked',(checked)=>console.log("clicked"));
// here clicked is a value from QPushButtonSignals interface

▸ addEventListener(eventType: WidgetEventTypes, callback: function, options?: EventListenerOptions): void

Inherited from EventWidget.addEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
`event?`	NativeRawPointer‹"QEvent"›

▪Optional options: EventListenerOptions

Extra optional options controlling how this event listener is added.

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));

Returns: void

beginInsertColumns

▸ beginInsertColumns(parent: QModelIndex, first: number, last: number): void

Parameters:

Name	Type
`parent`	QModelIndex
`first`	number
`last`	number

Returns: void

beginInsertRows

▸ beginInsertRows(parent: QModelIndex, first: number, last: number): void

Parameters:

Name	Type
`parent`	QModelIndex
`first`	number
`last`	number

Returns: void

beginMoveColumns

▸ beginMoveColumns(sourceParent: QModelIndex, sourceFirst: number, sourceLast: number, destinationParent: QModelIndex, destinationChild: number): boolean

Parameters:

Name	Type
`sourceParent`	QModelIndex
`sourceFirst`	number
`sourceLast`	number
`destinationParent`	QModelIndex
`destinationChild`	number

Returns: boolean

beginMoveRows

▸ beginMoveRows(sourceParent: QModelIndex, sourceFirst: number, sourceLast: number, destinationParent: QModelIndex, destinationChild: number): boolean

Parameters:

Name	Type
`sourceParent`	QModelIndex
`sourceFirst`	number
`sourceLast`	number
`destinationParent`	QModelIndex
`destinationChild`	number

Returns: boolean

beginRemoveColumns

▸ beginRemoveColumns(parent: QModelIndex, first: number, last: number): void

Parameters:

Name	Type
`parent`	QModelIndex
`first`	number
`last`	number

Returns: void

beginRemoveRows

▸ beginRemoveRows(parent: QModelIndex, first: number, last: number): void

Parameters:

Name	Type
`parent`	QModelIndex
`first`	number
`last`	number

Returns: void

beginResetModel

▸ beginResetModel(): void

Returns: void

buddy

▸ buddy(child: QModelIndex): QModelIndex

Parameters:

Name	Type
`child`	QModelIndex

Returns: QModelIndex

checkIndex

▸ checkIndex(index: QModelIndex): boolean

Parameters:

Name	Type
`index`	QModelIndex

Returns: boolean

children

▸ children(): QObject[]

Inherited from QObject.children

Returns: QObject[]

columnCount

▸ columnCount(parent: QModelIndex‹›): number

Parameters:

Name	Type	Default
`parent`	QModelIndex‹›	new QModelIndex()

Returns: number

createIndex

▸ createIndex(row: number, column: number): QModelIndex

Parameters:

Name	Type
`row`	number
`column`	number

Returns: QModelIndex

data

▸ data(index: QModelIndex, role: ItemDataRole): QVariant

Parameters:

Name	Type	Default
`index`	QModelIndex	-
`role`	ItemDataRole	ItemDataRole.DisplayRole

Returns: QVariant

delete

▸ delete(): void

Inherited from QObject.delete

Returns: void

deleteLater

▸ deleteLater(): void

Inherited from QObject.deleteLater

Returns: void

dumpObjectInfo

▸ dumpObjectInfo(): void

Inherited from QObject.dumpObjectInfo

Returns: void

dumpObjectTree

▸ dumpObjectTree(): void

Inherited from QObject.dumpObjectTree

Returns: void

emitDataChanged

▸ emitDataChanged(topLeft: QModelIndex, bottomRight: QModelIndex, roles: ItemDataRole[]): void

Parameters:

Name	Type
`topLeft`	QModelIndex
`bottomRight`	QModelIndex
`roles`	ItemDataRole[]

Returns: void

endInsertColumns

▸ endInsertColumns(): void

Returns: void

endInsertRows

▸ endInsertRows(): void

Returns: void

endMoveColumns

▸ endMoveColumns(): void

Returns: void

endMoveRows

▸ endMoveRows(): void

Returns: void

endRemoveColumns

▸ endRemoveColumns(): void

Returns: void

endRemoveRows

▸ endRemoveRows(): void

Returns: void

endResetModel

▸ endResetModel(): void

Returns: void

eventProcessed

▸ eventProcessed(): boolean

Inherited from EventWidget.eventProcessed

Get the state of the event processed flag

See setEventProcessed().

Returns: boolean

boolean True if the current event is flagged as processed.

flags

▸ flags(index: QModelIndex): ItemFlag

Parameters:

Name	Type
`index`	QModelIndex

Returns: ItemFlag

hasIndex

▸ hasIndex(row: number, column: number, parent: QModelIndex‹›): boolean

Parameters:

Name	Type	Default
`row`	number	-
`column`	number	-
`parent`	QModelIndex‹›	new QModelIndex()

Returns: boolean

headerData

▸ headerData(section: number, orientation: Orientation, role: number): QVariant

Parameters:

Name	Type
`section`	number
`orientation`	Orientation
`role`	number

Returns: QVariant

index

▸ index(row: number, column: number, parent: QModelIndex‹›): QModelIndex

Parameters:

Name	Type	Default
`row`	number	-
`column`	number	-
`parent`	QModelIndex‹›	new QModelIndex()

Returns: QModelIndex

inherits

▸ inherits(className: string): boolean

Inherited from QObject.inherits

Parameters:

Name	Type
`className`	string

Returns: boolean

killTimer

▸ killTimer(timerId: number): void

Inherited from QObject.killTimer

Parameters:

Name	Type
`timerId`	number

Returns: void

objectName

▸ objectName(): string

Inherited from QObject.objectName

Returns: string

parent

▸ parent(): QObject

Inherited from QObject.parent

Returns: QObject

parentModelIndex

▸ parentModelIndex(child: QModelIndex): QModelIndex

Note: This corresponds to QAbstractItemModel::parent(QModelIndex). It has been given a different name in TS.

Parameters:

Name	Type
`child`	QModelIndex

Returns: QModelIndex

property

▸ property(name: string): QVariant

Inherited from QObject.property

Parameters:

Name	Type
`name`	string

Returns: QVariant

removeEventListener

▸ removeEventListener‹SignalType›(signalType: SignalType, callback: any[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof any

Parameters:

Name	Type
`signalType`	SignalType
`callback`	any[SignalType]
`options?`	EventListenerOptions

Returns: void

▸ removeEventListener(eventType: WidgetEventTypes, callback: function, options?: EventListenerOptions): void

Inherited from EventWidget.removeEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
`event?`	NativeRawPointer‹"QEvent"›

▪Optional options: EventListenerOptions

Returns: void

rowCount

▸ rowCount(parent: QModelIndex‹›): number

Parameters:

Name	Type	Default
`parent`	QModelIndex‹›	new QModelIndex()

Returns: number

setData

▸ setData(index: QModelIndex, value: QVariant, role: ItemDataRole): boolean

Parameters:

Name	Type	Default
`index`	QModelIndex	-
`value`	QVariant	-
`role`	ItemDataRole	ItemDataRole.EditRole

Returns: boolean

setEventProcessed

▸ setEventProcessed(isProcessed: boolean): void

Inherited from EventWidget.setEventProcessed

Mark the current event as having been processed

This method is used to indicate that the currently dispatched event has been processed and no further processing by superclasses is required. It only makes sense to call this method from an event handler.

When set, this flag will cause NodeGui's QObject::event() method to return true and not call the superclass event(), effectively preventing any further processing on this event.

Parameters:

Name	Type	Description
`isProcessed`	boolean	true if the event has been processed.

Returns: void

setObjectName

▸ setObjectName(objectName: string): void

Inherited from QObject.setObjectName

Parameters:

Name	Type
`objectName`	string

Returns: void

setParent

▸ setParent(parent: QObject): void

Inherited from QObject.setParent

Parameters:

Name	Type
`parent`	QObject

Returns: void

setProperty

▸ setProperty(name: string, value: QVariantType): boolean

Inherited from QObject.setProperty

Parameters:

Name	Type
`name`	string
`value`	QVariantType

Returns: boolean

startTimer

▸ startTimer(intervalMS: number, timerType: TimerType): number

Inherited from QObject.startTimer

Parameters:

Name	Type	Default
`intervalMS`	number	-
`timerType`	TimerType	TimerType.CoarseTimer

Returns: number

Hierarchy#

Index#

Constructors#

Properties#

Methods#

Constructors#

constructor#

Properties#

native#

Methods#

_id#

addEventListener#

beginInsertColumns#

beginInsertRows#

beginMoveColumns#

beginMoveRows#

beginRemoveColumns#

beginRemoveRows#

beginResetModel#

buddy#

checkIndex#

children#

columnCount#

createIndex#

data#

delete#

deleteLater#

dumpObjectInfo#

dumpObjectTree#

emitDataChanged#

endInsertColumns#

endInsertRows#

endMoveColumns#

endMoveRows#

endRemoveColumns#

endRemoveRows#

endResetModel#

eventProcessed#

flags#

hasIndex#

headerData#

index#

inherits#

killTimer#

objectName#

parent#

parentModelIndex#

property#

removeEventListener#

rowCount#

setData#

setEventProcessed#

setObjectName#

setParent#

setProperty#

startTimer#

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

native

Methods

_id

addEventListener

beginInsertColumns

beginInsertRows

beginMoveColumns

beginMoveRows

beginRemoveColumns

beginRemoveRows

beginResetModel

buddy

checkIndex

children

columnCount

createIndex

data

delete

deleteLater

dumpObjectInfo

dumpObjectTree

emitDataChanged

endInsertColumns

endInsertRows

endMoveColumns

endMoveRows

endRemoveColumns

endRemoveRows

endResetModel

eventProcessed

flags

hasIndex

headerData

index

inherits

killTimer

objectName

parent

parentModelIndex

property

removeEventListener

rowCount

setData

setEventProcessed

setObjectName

setParent

setProperty

startTimer