website/docs/api/generated/classes/mymodel.md
↳ MyModel
+ new MyModel(): MyModel
Inherited from QAbstractItemModel.constructor
Overrides QObject.constructor
Returns: MyModel
• native: NativeElement | null
Inherited from Component.native
▸ _id(): number
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‹SignalType›(signalType: SignalType, callback: any[SignalType], options?: EventListenerOptions): void
Inherited from EventWidget.addEventListener
Overrides 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
Overrides 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(parent: QModelIndex, first: number, last: number): void
Inherited from QAbstractItemModel.beginInsertColumns
Overrides QAbstractItemModel.beginInsertColumns
Parameters:
| Name | Type |
|---|---|
parent | QModelIndex |
first | number |
last | number |
Returns: void
▸ beginInsertRows(parent: QModelIndex, first: number, last: number): void
Inherited from QAbstractItemModel.beginInsertRows
Overrides QAbstractItemModel.beginInsertRows
Parameters:
| Name | Type |
|---|---|
parent | QModelIndex |
first | number |
last | number |
Returns: void
▸ beginMoveColumns(sourceParent: QModelIndex, sourceFirst: number, sourceLast: number, destinationParent: QModelIndex, destinationChild: number): boolean
Inherited from QAbstractItemModel.beginMoveColumns
Overrides QAbstractItemModel.beginMoveColumns
Parameters:
| Name | Type |
|---|---|
sourceParent | QModelIndex |
sourceFirst | number |
sourceLast | number |
destinationParent | QModelIndex |
destinationChild | number |
Returns: boolean
▸ beginMoveRows(sourceParent: QModelIndex, sourceFirst: number, sourceLast: number, destinationParent: QModelIndex, destinationChild: number): boolean
Inherited from QAbstractItemModel.beginMoveRows
Overrides QAbstractItemModel.beginMoveRows
Parameters:
| Name | Type |
|---|---|
sourceParent | QModelIndex |
sourceFirst | number |
sourceLast | number |
destinationParent | QModelIndex |
destinationChild | number |
Returns: boolean
▸ beginRemoveColumns(parent: QModelIndex, first: number, last: number): void
Inherited from QAbstractItemModel.beginRemoveColumns
Overrides QAbstractItemModel.beginRemoveColumns
Parameters:
| Name | Type |
|---|---|
parent | QModelIndex |
first | number |
last | number |
Returns: void
▸ beginRemoveRows(parent: QModelIndex, first: number, last: number): void
Inherited from QAbstractItemModel.beginRemoveRows
Overrides QAbstractItemModel.beginRemoveRows
Parameters:
| Name | Type |
|---|---|
parent | QModelIndex |
first | number |
last | number |
Returns: void
▸ beginResetModel(): void
Inherited from QAbstractItemModel.beginResetModel
Overrides QAbstractItemModel.beginResetModel
Returns: void
▸ buddy(child: QModelIndex): QModelIndex
Inherited from QAbstractItemModel.buddy
Overrides QAbstractItemModel.buddy
Parameters:
| Name | Type |
|---|---|
child | QModelIndex |
Returns: QModelIndex
▸ checkIndex(index: QModelIndex): boolean
Inherited from QAbstractItemModel.checkIndex
Overrides QAbstractItemModel.checkIndex
Parameters:
| Name | Type |
|---|---|
index | QModelIndex |
Returns: boolean
▸ children(): QObject[]
Inherited from QObject.children
Returns: QObject[]
▸ columnCount(parent: QModelIndex‹›): number
Overrides QAbstractItemModel.columnCount
Parameters:
| Name | Type | Default |
|---|---|---|
parent | QModelIndex‹› | new QModelIndex() |
Returns: number
▸ createIndex(row: number, column: number): QModelIndex
Inherited from QAbstractItemModel.createIndex
Overrides QAbstractItemModel.createIndex
Parameters:
| Name | Type |
|---|---|
row | number |
column | number |
Returns: QModelIndex
▸ data(index: QModelIndex, role: ItemDataRole): QVariant
Overrides QAbstractItemModel.data
Parameters:
| Name | Type | Default |
|---|---|---|
index | QModelIndex | - |
role | ItemDataRole | ItemDataRole.DisplayRole |
Returns: QVariant
▸ delete(): void
Returns: void
▸ deleteLater(): void
Inherited from QObject.deleteLater
Overrides QObject.deleteLater
Returns: void
▸ dumpObjectInfo(): void
Inherited from QObject.dumpObjectInfo
Overrides QObject.dumpObjectInfo
Returns: void
▸ dumpObjectTree(): void
Inherited from QObject.dumpObjectTree
Overrides QObject.dumpObjectTree
Returns: void
▸ emitDataChanged(topLeft: QModelIndex, bottomRight: QModelIndex, roles: ItemDataRole[]): void
Inherited from QAbstractItemModel.emitDataChanged
Overrides QAbstractItemModel.emitDataChanged
Parameters:
| Name | Type |
|---|---|
topLeft | QModelIndex |
bottomRight | QModelIndex |
roles | ItemDataRole[] |
Returns: void
▸ endInsertColumns(): void
Inherited from QAbstractItemModel.endInsertColumns
Overrides QAbstractItemModel.endInsertColumns
Returns: void
▸ endInsertRows(): void
Inherited from QAbstractItemModel.endInsertRows
Overrides QAbstractItemModel.endInsertRows
Returns: void
▸ endMoveColumns(): void
Inherited from QAbstractItemModel.endMoveColumns
Overrides QAbstractItemModel.endMoveColumns
Returns: void
▸ endMoveRows(): void
Inherited from QAbstractItemModel.endMoveRows
Overrides QAbstractItemModel.endMoveRows
Returns: void
▸ endRemoveColumns(): void
Inherited from QAbstractItemModel.endRemoveColumns
Overrides QAbstractItemModel.endRemoveColumns
Returns: void
▸ endRemoveRows(): void
Inherited from QAbstractItemModel.endRemoveRows
Overrides QAbstractItemModel.endRemoveRows
Returns: void
▸ endResetModel(): void
Inherited from QAbstractItemModel.endResetModel
Overrides QAbstractItemModel.endResetModel
Returns: void
▸ eventProcessed(): boolean
Inherited from EventWidget.eventProcessed
Overrides 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(index: QModelIndex): ItemFlag
Inherited from QAbstractTableModel.flags
Overrides QAbstractItemModel.flags
Parameters:
| Name | Type |
|---|---|
index | QModelIndex |
Returns: ItemFlag
▸ hasChildren(parent: QModelIndex): boolean
Inherited from QAbstractTableModel.hasChildren
Overrides QAbstractTableModel.hasChildren
Parameters:
| Name | Type |
|---|---|
parent | QModelIndex |
Returns: boolean
▸ hasIndex(row: number, column: number, parent: QModelIndex‹›): boolean
Inherited from QAbstractItemModel.hasIndex
Overrides QAbstractItemModel.hasIndex
Parameters:
| Name | Type | Default |
|---|---|---|
row | number | - |
column | number | - |
parent | QModelIndex‹› | new QModelIndex() |
Returns: boolean
▸ headerData(section: number, orientation: Orientation, role: number): QVariant
Inherited from QAbstractItemModel.headerData
Overrides QAbstractItemModel.headerData
Parameters:
| Name | Type |
|---|---|
section | number |
orientation | Orientation |
role | number |
Returns: QVariant
▸ index(row: number, column: number, parent: QModelIndex‹›): QModelIndex
Inherited from QAbstractTableModel.index
Overrides QAbstractItemModel.index
Parameters:
| Name | Type | Default |
|---|---|---|
row | number | - |
column | number | - |
parent | QModelIndex‹› | new QModelIndex() |
Returns: QModelIndex
▸ inherits(className: string): boolean
Inherited from QObject.inherits
Parameters:
| Name | Type |
|---|---|
className | string |
Returns: boolean
▸ killTimer(timerId: number): void
Inherited from QObject.killTimer
Parameters:
| Name | Type |
|---|---|
timerId | number |
Returns: void
▸ objectName(): string
Inherited from QObject.objectName
Overrides QObject.objectName
Returns: string
▸ parent(): QObject
Returns: QObject
▸ parentModelIndex(child: QModelIndex): QModelIndex
Inherited from QAbstractTableModel.parentModelIndex
Overrides QAbstractItemModel.parentModelIndex
Parameters:
| Name | Type |
|---|---|
child | QModelIndex |
Returns: QModelIndex
▸ property(name: string): QVariant
Inherited from QObject.property
Parameters:
| Name | Type |
|---|---|
name | string |
Returns: QVariant
▸ removeEventListener‹SignalType›(signalType: SignalType, callback: any[SignalType], options?: EventListenerOptions): void
Inherited from EventWidget.removeEventListener
Overrides 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
Overrides EventWidget.removeEventListener
Parameters:
▪ eventType: WidgetEventTypes
▪ callback: function
▸ (event?: NativeRawPointer‹"QEvent"›): void
Parameters:
| Name | Type |
|---|---|
event? | NativeRawPointer‹"QEvent"› |
▪Optional options: EventListenerOptions
Returns: void
▸ rowCount(parent: QModelIndex‹›): number
Overrides QAbstractItemModel.rowCount
Parameters:
| Name | Type | Default |
|---|---|---|
parent | QModelIndex‹› | new QModelIndex() |
Returns: number
▸ setData(index: QModelIndex, value: QVariant, role: ItemDataRole): boolean
Inherited from QAbstractItemModel.setData
Overrides QAbstractItemModel.setData
Parameters:
| Name | Type | Default |
|---|---|---|
index | QModelIndex | - |
value | QVariant | - |
role | ItemDataRole | ItemDataRole.EditRole |
Returns: boolean
▸ setEventProcessed(isProcessed: boolean): void
Inherited from EventWidget.setEventProcessed
Overrides 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(objectName: string): void
Inherited from QObject.setObjectName
Overrides QObject.setObjectName
Parameters:
| Name | Type |
|---|---|
objectName | string |
Returns: void
▸ setParent(parent: QObject): void
Inherited from QObject.setParent
Parameters:
| Name | Type |
|---|---|
parent | QObject |
Returns: void
▸ setProperty(name: string, value: QVariantType): boolean
Inherited from QObject.setProperty
Overrides QObject.setProperty
Parameters:
| Name | Type |
|---|---|
name | string |
value | QVariantType |
Returns: boolean
▸ sibling(row: number, column: number, index: QModelIndex): QModelIndex
Inherited from QAbstractTableModel.sibling
Overrides QAbstractTableModel.sibling
Parameters:
| Name | Type |
|---|---|
row | number |
column | number |
index | QModelIndex |
Returns: QModelIndex
▸ startTimer(intervalMS: number, timerType: TimerType): number
Inherited from QObject.startTimer
Overrides QObject.startTimer
Parameters:
| Name | Type | Default |
|---|---|---|
intervalMS | number | - |
timerType | TimerType | TimerType.CoarseTimer |
Returns: number
▸ timerHit(): void
Returns: void