QAbstractItemModel

Hierarchy

QObject‹any›

QAbstractItemModel

QAbstractTableModel

Index

Constructors

Properties

Methods

Constructors

constructor

+ new QAbstractItemModel(): QAbstractItemModel

Overrides QObject.constructor

Returns: QAbstractItemModel

Properties

native

native: NativeElement | null

Inherited from Component.native

Methods

_id

_id(): number

Inherited from QObject._id

Get an ID identifying the underlying C++ object.

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

addEventListenerSignalType›(signalType: SignalType, callback: any[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof any

Parameters:

NameTypeDescription
signalTypeSignalTypeSignalType is a signal from the widgets signals interface.
callbackany[SignalType]Corresponding callback for the signal as mentioned in the widget's signal interface
options?EventListenerOptionsExtra 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:

NameType
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:

NameType
parentQModelIndex
firstnumber
lastnumber

Returns: void


beginInsertRows

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

Parameters:

NameType
parentQModelIndex
firstnumber
lastnumber

Returns: void


beginMoveColumns

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

Parameters:

NameType
sourceParentQModelIndex
sourceFirstnumber
sourceLastnumber
destinationParentQModelIndex
destinationChildnumber

Returns: boolean


beginMoveRows

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

Parameters:

NameType
sourceParentQModelIndex
sourceFirstnumber
sourceLastnumber
destinationParentQModelIndex
destinationChildnumber

Returns: boolean


beginRemoveColumns

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

Parameters:

NameType
parentQModelIndex
firstnumber
lastnumber

Returns: void


beginRemoveRows

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

Parameters:

NameType
parentQModelIndex
firstnumber
lastnumber

Returns: void


beginResetModel

beginResetModel(): void

Returns: void


buddy

buddy(child: QModelIndex): QModelIndex

Parameters:

NameType
childQModelIndex

Returns: QModelIndex


checkIndex

checkIndex(index: QModelIndex): boolean

Parameters:

NameType
indexQModelIndex

Returns: boolean


children

children(): QObject[]

Inherited from QObject.children

Returns: QObject[]


columnCount

columnCount(parent: QModelIndex‹›): number

Parameters:

NameTypeDefault
parentQModelIndex‹›new QModelIndex()

Returns: number


createIndex

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

Parameters:

NameType
rownumber
columnnumber

Returns: QModelIndex


data

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

Parameters:

NameTypeDefault
indexQModelIndex-
roleItemDataRoleItemDataRole.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:

NameType
topLeftQModelIndex
bottomRightQModelIndex
rolesItemDataRole[]

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:

NameType
indexQModelIndex

Returns: ItemFlag


hasIndex

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

Parameters:

NameTypeDefault
rownumber-
columnnumber-
parentQModelIndex‹›new QModelIndex()

Returns: boolean


headerData

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

Parameters:

NameType
sectionnumber
orientationOrientation
rolenumber

Returns: QVariant


index

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

Parameters:

NameTypeDefault
rownumber-
columnnumber-
parentQModelIndex‹›new QModelIndex()

Returns: QModelIndex


inherits

inherits(className: string): boolean

Inherited from QObject.inherits

Parameters:

NameType
classNamestring

Returns: boolean


killTimer

killTimer(timerId: number): void

Inherited from QObject.killTimer

Parameters:

NameType
timerIdnumber

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:

NameType
childQModelIndex

Returns: QModelIndex


property

property(name: string): QVariant

Inherited from QObject.property

Parameters:

NameType
namestring

Returns: QVariant


removeEventListener

removeEventListenerSignalType›(signalType: SignalType, callback: any[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof any

Parameters:

NameType
signalTypeSignalType
callbackany[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:

NameType
event?NativeRawPointer‹"QEvent"›

Optional options: EventListenerOptions

Returns: void


rowCount

rowCount(parent: QModelIndex‹›): number

Parameters:

NameTypeDefault
parentQModelIndex‹›new QModelIndex()

Returns: number


setData

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

Parameters:

NameTypeDefault
indexQModelIndex-
valueQVariant-
roleItemDataRoleItemDataRole.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:

NameTypeDescription
isProcessedbooleantrue if the event has been processed.

Returns: void


setObjectName

setObjectName(objectName: string): void

Inherited from QObject.setObjectName

Parameters:

NameType
objectNamestring

Returns: void


setParent

setParent(parent: QObject): void

Inherited from QObject.setParent

Parameters:

NameType
parentQObject

Returns: void


setProperty

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

Inherited from QObject.setProperty

Parameters:

NameType
namestring
valueQVariantType

Returns: boolean


startTimer

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

Inherited from QObject.startTimer

Parameters:

NameTypeDefault
intervalMSnumber-
timerTypeTimerTypeTimerType.CoarseTimer

Returns: number