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

const { QAction, QMenu } = require("@nodegui/nodegui");
const menu = new QMenu();
const menuAction = new QAction();
menuAction.setText("subAction");
menuAction.addEventListener("triggered", () => {
console.log("Action clicked");
});
menu.addAction(menuAction);

Hierarchy

QObjectQActionSignals

QAction

Index

Constructors

Properties

Methods

Constructors

constructor

+ new QAction(): QAction

Overrides QObject.constructor

Returns: QAction

+ new QAction(native: NativeElement): QAction

Overrides QObject.constructor

Parameters:

NameType
nativeNativeElement

Returns: QAction

+ new QAction(parent: QObject): QAction

Overrides QObject.constructor

Parameters:

NameType
parentQObject

Returns: QAction

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: QActionSignals[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof QActionSignals

Parameters:

NameTypeDescription
signalTypeSignalTypeSignalType is a signal from the widgets signals interface.
callbackQActionSignals[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


children

children(): QObject[]

Inherited from QObject.children

Returns: QObject[]


data

data(): QVariant

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


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:

NameType
classNamestring

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:

NameType
timerIdnumber

Returns: void


objectName

objectName(): string

Inherited from QObject.objectName

Returns: string


parent

parent(): QObject

Inherited from QObject.parent

Returns: QObject


property

property(name: string): QVariant

Inherited from QObject.property

Parameters:

NameType
namestring

Returns: QVariant


removeEventListener

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

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof QActionSignals

Parameters:

NameType
signalTypeSignalType
callbackQActionSignals[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


setCheckable

setCheckable(isCheckable: boolean): void

Parameters:

NameType
isCheckableboolean

Returns: void


setChecked

setChecked(isChecked: boolean): void

Parameters:

NameType
isCheckedboolean

Returns: void


setData

setData(value: QVariant): void

Parameters:

NameType
valueQVariant

Returns: void


setEnabled

setEnabled(enabled: boolean): void

Parameters:

NameType
enabledboolean

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:

NameTypeDescription
isProcessedbooleantrue if the event has been processed.

Returns: void


setFont

setFont(font: QFont): void

Parameters:

NameType
fontQFont

Returns: void


setIcon

setIcon(icon: QIcon): void

Parameters:

NameType
iconQIcon

Returns: void


setMenu

setMenu(menu: QMenu): void

Parameters:

NameType
menuQMenu

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


setSeparator

setSeparator(isSeparator: boolean): void

Parameters:

NameType
isSeparatorboolean

Returns: void


setShortcut

setShortcut(keysequence: QKeySequence): void

Parameters:

NameType
keysequenceQKeySequence

Returns: void


setShortcutContext

setShortcutContext(shortcutContext: ShortcutContext): void

Parameters:

NameType
shortcutContextShortcutContext

Returns: void


setText

setText(text: string): void

Parameters:

NameType
textstring

Returns: void


startTimer

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

Inherited from QObject.startTimer

Parameters:

NameTypeDefault
intervalMSnumber-
timerTypeTimerTypeTimerType.CoarseTimer

Returns: number