QAction
The QAction class provides an abstract user interface action that can be inserted into widgets.
This class is a JS wrapper around Qt's QAction class
Example
Hierarchy
↳ QObject‹QActionSignals›
↳ QAction
Index
Constructors
Properties
Methods
- _id
- addEventListener
- children
- data
- delete
- deleteLater
- dumpObjectInfo
- dumpObjectTree
- eventProcessed
- font
- inherits
- isCheckable
- isChecked
- isSeparator
- killTimer
- objectName
- parent
- property
- removeEventListener
- setCheckable
- setChecked
- setData
- setEnabled
- setEventProcessed
- setFont
- setIcon
- setMenu
- setObjectName
- setParent
- setProperty
- setSeparator
- setShortcut
- setShortcutContext
- setText
- startTimer
Constructors
constructor
+ new QAction(): QAction
Overrides QObject.constructor
Returns: QAction
+ new QAction(native: NativeElement): QAction
Overrides QObject.constructor
Parameters:
| Name | Type |
|---|---|
native | NativeElement |
Returns: QAction
+ new QAction(parent: QObject): QAction
Overrides QObject.constructor
Parameters:
| Name | Type |
|---|---|
parent | QObject |
Returns: QAction
Properties
native
• native: NativeElement | null
Inherited from Component.native
Methods
_id
â–¸ _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
▸ addEventListener‹SignalType›(signalType: SignalType, callback: QActionSignals[SignalType], options?: EventListenerOptions): void
Inherited from EventWidget.addEventListener
Type parameters:
â–ª SignalType: keyof QActionSignals
Parameters:
| Name | Type | Description |
|---|---|---|
signalType | SignalType | SignalType is a signal from the widgets signals interface. |
callback | QActionSignals[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:
â–¸ 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:
Returns: void
children
â–¸ children(): QObject[]
Inherited from QObject.children
Returns: QObject[]
data
â–¸ data(): QVariant
Returns: QVariant
delete
â–¸ delete(): void
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
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.
font
â–¸ font(): QFont
Returns: QFont
inherits
â–¸ inherits(className: string): boolean
Inherited from QObject.inherits
Parameters:
| Name | Type |
|---|---|
className | string |
Returns: boolean
isCheckable
â–¸ isCheckable(): boolean
Returns: boolean
isChecked
â–¸ isChecked(): boolean
Returns: boolean
isSeparator
â–¸ isSeparator(): boolean
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
Returns: QObject
property
â–¸ property(name: string): QVariant
Inherited from QObject.property
Parameters:
| Name | Type |
|---|---|
name | string |
Returns: QVariant
removeEventListener
▸ removeEventListener‹SignalType›(signalType: SignalType, callback: QActionSignals[SignalType], options?: EventListenerOptions): void
Inherited from EventWidget.removeEventListener
Type parameters:
â–ª SignalType: keyof QActionSignals
Parameters:
| Name | Type |
|---|---|
signalType | SignalType |
callback | QActionSignals[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
setCheckable
â–¸ setCheckable(isCheckable: boolean): void
Parameters:
| Name | Type |
|---|---|
isCheckable | boolean |
Returns: void
setChecked
â–¸ setChecked(isChecked: boolean): void
Parameters:
| Name | Type |
|---|---|
isChecked | boolean |
Returns: void
setData
â–¸ setData(value: QVariant): void
Parameters:
| Name | Type |
|---|---|
value | QVariant |
Returns: void
setEnabled
â–¸ setEnabled(enabled: boolean): void
Parameters:
| Name | Type |
|---|---|
enabled | boolean |
Returns: void
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
setFont
â–¸ setFont(font: QFont): void
Parameters:
| Name | Type |
|---|---|
font | QFont |
Returns: void
setIcon
â–¸ setIcon(icon: QIcon): void
Parameters:
| Name | Type |
|---|---|
icon | QIcon |
Returns: void
setMenu
â–¸ setMenu(menu: QMenu): void
Parameters:
| Name | Type |
|---|---|
menu | QMenu |
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
setSeparator
â–¸ setSeparator(isSeparator: boolean): void
Parameters:
| Name | Type |
|---|---|
isSeparator | boolean |
Returns: void
setShortcut
â–¸ setShortcut(keysequence: QKeySequence): void
Parameters:
| Name | Type |
|---|---|
keysequence | QKeySequence |
Returns: void
setShortcutContext
â–¸ setShortcutContext(shortcutContext: ShortcutContext): void
Parameters:
| Name | Type |
|---|---|
shortcutContext | ShortcutContext |
Returns: void
setText
â–¸ setText(text: string): void
Parameters:
| Name | Type |
|---|---|
text | string |
Returns: void
startTimer
â–¸ startTimer(intervalMS: number, timerType: TimerType): number
Inherited from QObject.startTimer
Parameters:
| Name | Type | Default |
|---|---|---|
intervalMS | number | - |
timerType | TimerType | TimerType.CoarseTimer |
Returns: number