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

NodeObjectQActionSignals

QAction

Index

Constructors

Properties

Methods

Constructors

constructor

+ new QAction(): QAction

Overrides EventWidget.constructor

Returns: QAction

+ new QAction(native: NativeElement): QAction

Overrides EventWidget.constructor

Parameters:

NameType
nativeNativeElement

Returns: QAction

+ new QAction(parent: NodeWidget‹any›): QAction

Overrides EventWidget.constructor

Parameters:

NameType
parentNodeWidget‹any›

Returns: QAction

Properties

Optional icon

icon? : QIcon


Optional menu

menu? : QMenu


native

native: NativeElement

Overrides Component.native


nodeChildren

nodeChildren: Set‹Component

Inherited from Component.nodeChildren


Optional nodeParent

nodeParent? : Component

Inherited from Component.nodeParent

Methods

addEventListener

addEventListener<SignalType>(signalType: SignalType, callback: Signals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof QActionSignals

Parameters:

NameTypeDescription
signalTypeSignalTypeSignalType is a signal from the widgets signals interface.
callbackSignals[SignalType]Corresponding callback for the signal as mentioned in the widget's signal interface

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): void

Inherited from EventWidget.addEventListener

Parameters:

eventType: WidgetEventTypes

callback: function

For example in the case of QPushButton:

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

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

Parameters:

NameType
event?NativeRawPointer‹"QEvent"›

Returns: void


font

font(): QFont

Returns: QFont


inherits

inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

NameType
classNamestring

Returns: boolean


isCheckable

isCheckable(): boolean

Returns: boolean


isChecked

isChecked(): boolean

Returns: boolean


isSeparator

isSeparator(): boolean

Returns: boolean


objectName

objectName(): string

Inherited from NodeObject.objectName

Returns: string


property

property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

NameType
namestring

Returns: QVariant


removeEventListener

removeEventListener<SignalType>(signalType: SignalType, callback: Signals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof QActionSignals

Parameters:

NameType
signalTypeSignalType
callbackSignals[SignalType]

Returns: void

removeEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from EventWidget.removeEventListener

Parameters:

eventType: WidgetEventTypes

callback: function

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

Parameters:

NameType
event?NativeRawPointer‹"QEvent"›

Returns: void


setCheckable

setCheckable(isCheckable: boolean): void

Parameters:

NameType
isCheckableboolean

Returns: void


setChecked

setChecked(isChecked: boolean): void

Parameters:

NameType
isCheckedboolean

Returns: void


setEnabled

setEnabled(enabled: boolean): void

Parameters:

NameType
enabledboolean

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


setNodeParent

setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

NameType
parent?Component

Returns: void


setObjectName

setObjectName(objectName: string): void

Inherited from NodeObject.setObjectName

Parameters:

NameType
objectNamestring

Returns: void


setProperty

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

Inherited from NodeObject.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