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

↳ NodeObject‹QActionSignals›

↳ QAction

Index

Constructors

• constructor

Properties

• icon
• menu
• native
• nodeChildren
• nodeParent

Methods

• addEventListener
• data
• dumpObjectInfo
• dumpObjectTree
• eventProcessed
• font
• inherits
• isCheckable
• isChecked
• isSeparator
• objectName
• property
• removeEventListener
• setCheckable
• setChecked
• setData
• setEnabled
• setEventProcessed
• setFont
• setIcon
• setMenu
• setNodeParent
• setObjectName
• setProperty
• setSeparator
• setShortcut
• setShortcutContext
• setText

Constructors

constructor

+ new QAction(): QAction

Overrides EventWidget.constructor

Returns: QAction

+ new QAction(native: NativeElement): QAction

Overrides EventWidget.constructor

Parameters:

Name	Type
native	NativeElement

Returns: QAction

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

Overrides EventWidget.constructor

Parameters:

Name	Type
parent	NodeWidget‹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: QActionSignals[SignalType]): 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

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:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

data

▸ data(): QVariant

Returns: QVariant

---

dumpObjectInfo

▸ dumpObjectInfo(): void

Inherited from NodeObject.dumpObjectInfo

Returns: void

---

dumpObjectTree

▸ dumpObjectTree(): void

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

Parameters:

Name	Type
className	string

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:

Name	Type
name	string

Returns: QVariant

---

removeEventListener

▸ removeEventListener‹SignalType›(signalType: SignalType, callback: QActionSignals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof QActionSignals

Parameters:

Name	Type
signalType	SignalType
callback	QActionSignals[SignalType]

Returns: void

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

Inherited from EventWidget.removeEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

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

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

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

---

setNodeParent

▸ setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

Name	Type
parent?	Component

Returns: void

---

setObjectName

▸ setObjectName(objectName: string): void

Inherited from NodeObject.setObjectName

Parameters:

Name	Type
objectName	string

Returns: void

---

setProperty

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

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