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

↳ QObject‹QShortcutSignals›

↳ QShortcut

Index

Constructors

• constructor

Properties

• native

Methods

• _id
• addEventListener
• children
• delete
• deleteLater
• dumpObjectInfo
• dumpObjectTree
• eventProcessed
• inherits
• killTimer
• objectName
• parent
• property
• removeEventListener
• setAutoRepeat
• setContext
• setEnabled
• setEventProcessed
• setKey
• setObjectName
• setParent
• setProperty
• startTimer

Constructors

constructor

+ new QShortcut(arg?: QWidget‹QWidgetSignals› | NativeElement): QShortcut

Overrides QObject.constructor

Parameters:

Name	Type
arg?	QWidget‹QWidgetSignals› | NativeElement

Returns: QShortcut

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

▸ addEventListener‹SignalType›(signalType: SignalType, callback: QShortcutSignals[SignalType], options?: EventListenerOptions): 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	QShortcutSignals[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:

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:

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:

const button = new QPushButton();

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

Returns: void

---

children

▸ children(): QObject[]

Inherited from QObject.children

Returns: QObject[]

---

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.

---

inherits

▸ inherits(className: string): boolean

Inherited from QObject.inherits

Parameters:

Name	Type
className	string

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

Inherited from QObject.parent

Returns: QObject

---

property

▸ property(name: string): QVariant

Inherited from QObject.property

Parameters:

Name	Type
name	string

Returns: QVariant

---

removeEventListener

▸ removeEventListener‹SignalType›(signalType: SignalType, callback: QShortcutSignals[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof QShortcutSignals

Parameters:

Name	Type
signalType	SignalType
callback	QShortcutSignals[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

---

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

---

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

---

setKey

▸ setKey(keysequence: QKeySequence): void

Parameters:

Name	Type
keysequence	QKeySequence

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

---

startTimer

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

Inherited from QObject.startTimer

Parameters:

Name	Type	Default
intervalMS	number	-
timerType	TimerType	TimerType.CoarseTimer

Returns: number