QShortcut

The QShortcut class is used to create keyboard shortcuts.

This class is a JS wrapper around Qt's QShortcut class

Example

const { QShortcut, QKeySequence, QMainWindow } = require("@nodegui/nodegui");
const win = new QMainWindow();
const shortcut = new QShortcut(win);
shortcut.setKey(new QKeySequence("Ctrl+M"));
shortcut.setEnabled(true);
shortcut.addEventListener(QShortcutEvents.activated, () => {
console.log("Shortcut Activated");
});
win.show();
global.win = win;
global.shortcut = shortcut;

Hierarchy

↳ NodeObject‹QShortcutSignals›

↳ QShortcut

Index

Constructors

• constructor

Properties

• native
• nodeChildren
• nodeParent

Methods

• addEventListener
• inherits
• objectName
• property
• removeEventListener
• setAutoRepeat
• setContext
• setEnabled
• setKey
• setNodeParent
• setObjectName
• setProperty

Constructors

constructor

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

Overrides EventWidget.constructor

Parameters:

Name	Type
parent	NodeWidget‹any›

Returns: QShortcut

Properties

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 QShortcutSignals

Parameters:

Name	Type	Description
signalType	SignalType	SignalType is a signal from the widgets signals interface.
callback	Signals[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?: NativeElement): void

Parameters:

Name	Type
event?	NativeElement

Returns: void

---

inherits

▸ inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

Name	Type
className	string

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: Signals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof QShortcutSignals

Parameters:

Name	Type
signalType	SignalType
callback	Signals[SignalType]

Returns: void

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

Inherited from EventWidget.removeEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

▸ (event?: NativeElement): void

Parameters:

Name	Type
event?	NativeElement

Returns: void

---

setAutoRepeat

▸ setAutoRepeat(on: boolean): void

Parameters:

Name	Type
on	boolean

Returns: void

---

setContext

▸ setContext(shortcutContext: ShortcutContext): void

Parameters:

Name	Type
shortcutContext	ShortcutContext

Returns: void

---

setEnabled

▸ setEnabled(enabled: boolean): void

Parameters:

Name	Type
enabled	boolean

Returns: void

---

setKey

▸ setKey(keysequence: QKeySequence): void

Parameters:

Name	Type
keysequence	QKeySequence

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