QPushButton

Create and control buttons.

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

A QPushButton provides ability to add and manipulate native button widgets.

Example

const { QPushButton } = require("@nodegui/nodegui");

const button = new QPushButton();
button.setText("Hello");

Hierarchy

↳ QAbstractButton‹QPushButtonSignals›

↳ QPushButton

Index

Constructors

• constructor

Properties

• _rawInlineStyle
• actions
• layout
• native
• nodeChildren
• nodeParent
• type

Methods

• activateWindow
• addAction
• addEventListener
• adjustSize
• animateClick
• autoDefault
• autoExclusive
• autoRepeat
• autoRepeatDelay
• autoRepeatInterval
• click
• close
• font
• geometry
• getFlexNode
• hasMouseTracking
• hide
• icon
• iconSize
• inherits
• isCheckable
• isChecked
• isDefault
• isDown
• isEnabled
• isFlat
• isVisible
• lower
• mapFromGlobal
• mapFromParent
• mapToGlobal
• mapToParent
• menu
• move
• objectName
• pos
• property
• raise
• removeEventListener
• repaint
• repolish
• resize
• setAttribute
• setAutoDefault
• setAutoExclusive
• setAutoRepeat
• setAutoRepeatDelay
• setAutoRepeatInterval
• setCheckable
• setChecked
• setContextMenuPolicy
• setCursor
• setDefault
• setDown
• setEnabled
• setFixedSize
• setFlat
• setFlexNodeSizeControlled
• setFont
• setGeometry
• setIcon
• setIconSize
• setInlineStyle
• setLayout
• setMaximumSize
• setMenu
• setMinimumSize
• setMouseTracking
• setNodeParent
• setObjectName
• setProperty
• setShortcut
• setStyleSheet
• setText
• setWindowFlag
• setWindowIcon
• setWindowOpacity
• setWindowState
• setWindowTitle
• shortcut
• show
• showFullScreen
• showMaximized
• showMenu
• showMinimized
• showNormal
• size
• styleSheet
• testAttribute
• text
• toggle
• update
• updateGeometry
• windowOpacity
• windowState
• windowTitle

Constructors

constructor

+ new QPushButton(): QPushButton

Overrides NodeWidget.constructor

Returns: QPushButton

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

Overrides NodeWidget.constructor

Parameters:

Name	Type
parent	NodeWidget‹any›

Returns: QPushButton

+ new QPushButton(native: NativeElement): QPushButton

Overrides NodeWidget.constructor

Parameters:

Name	Type
native	NativeElement

Returns: QPushButton

+ new QPushButton(rawPointer: NativeRawPointer‹any›, disableNativeDeletion?: undefined | false | true): QPushButton

Overrides NodeWidget.constructor

Parameters:

Name	Type
rawPointer	NativeRawPointer‹any›
disableNativeDeletion?	undefined | false | true

Returns: QPushButton

Properties

_rawInlineStyle

• _rawInlineStyle: string = ""

Inherited from QMenu._rawInlineStyle

---

actions

• actions: Set‹QAction›

Inherited from QMenu.actions

---

Optional layout

• layout? : NodeLayout‹QPushButtonSignals›

Inherited from QMenu.layout

---

native

• native: NativeElement

Overrides Component.native

---

nodeChildren

• nodeChildren: Set‹Component›

Inherited from Component.nodeChildren

---

Optional nodeParent

• nodeParent? : Component

Inherited from Component.nodeParent

---

type

• type: string = "widget"

Inherited from QMenu.type

Methods

activateWindow

▸ activateWindow(): void

Inherited from QMenu.activateWindow

Returns: void

---

addAction

▸ addAction(action: QAction | string): QAction

Inherited from QMenu.addAction

Parameters:

Name	Type
action	QAction | string

Returns: QAction

---

addEventListener

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

Inherited from EventWidget.addEventListener

Type parameters:

▪ SignalType: keyof QPushButtonSignals

Parameters:

Name	Type	Description
signalType	SignalType	SignalType is a signal from the widgets signals interface.
callback	QPushButtonSignals[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

---

adjustSize

▸ adjustSize(): void

Inherited from QMenu.adjustSize

Returns: void

---

animateClick

▸ animateClick(msec: number): void

Inherited from QAbstractButton.animateClick

Parameters:

Name	Type
msec	number

Returns: void

---

autoDefault

▸ autoDefault(): boolean

Returns: boolean

---

autoExclusive

▸ autoExclusive(): boolean

Inherited from QAbstractButton.autoExclusive

Returns: boolean

---

autoRepeat

▸ autoRepeat(): boolean

Inherited from QAbstractButton.autoRepeat

Returns: boolean

---

autoRepeatDelay

▸ autoRepeatDelay(): number

Inherited from QAbstractButton.autoRepeatDelay

Returns: number

---

autoRepeatInterval

▸ autoRepeatInterval(): number

Inherited from QAbstractButton.autoRepeatInterval

Returns: number

---

click

▸ click(): void

Inherited from QAbstractButton.click

Returns: void

---

close

▸ close(): boolean

Inherited from QMenu.close

Returns: boolean

---

font

▸ font(): QFont

Inherited from QMenu.font

Returns: QFont

---

geometry

▸ geometry(): QRect

Inherited from QMenu.geometry

Returns: QRect

---

getFlexNode

▸ getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode

---

hasMouseTracking

▸ hasMouseTracking(): boolean

Inherited from QMenu.hasMouseTracking

Returns: boolean

---

hide

▸ hide(): void

Inherited from QMenu.hide

Returns: void

---

icon

▸ icon(): QIcon

Inherited from QAbstractButton.icon

Returns: QIcon

---

iconSize

▸ iconSize(): QSize

Inherited from QAbstractButton.iconSize

Returns: QSize

---

inherits

▸ inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

Name	Type
className	string

Returns: boolean

---

isCheckable

▸ isCheckable(): boolean

Inherited from QAbstractButton.isCheckable

Returns: boolean

---

isChecked

▸ isChecked(): boolean

Inherited from QAbstractButton.isChecked

Returns: boolean

---

isDefault

▸ isDefault(): boolean

Returns: boolean

---

isDown

▸ isDown(): boolean

Inherited from QAbstractButton.isDown

Returns: boolean

---

isEnabled

▸ isEnabled(): boolean

Inherited from QMenu.isEnabled

Returns: boolean

---

isFlat

▸ isFlat(): boolean

Returns: boolean

---

isVisible

▸ isVisible(): boolean

Inherited from QMenu.isVisible

Returns: boolean

---

lower

▸ lower(): void

Inherited from QMenu.lower

Returns: void

---

mapFromGlobal

▸ mapFromGlobal(pos: QPoint): QPoint

Inherited from QMenu.mapFromGlobal

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

mapFromParent

▸ mapFromParent(pos: QPoint): QPoint

Inherited from QMenu.mapFromParent

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

mapToGlobal

▸ mapToGlobal(pos: QPoint): QPoint

Inherited from QMenu.mapToGlobal

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

mapToParent

▸ mapToParent(pos: QPoint): QPoint

Inherited from QMenu.mapToParent

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

menu

▸ menu(): QMenu | null

Returns: QMenu | null

---

move

▸ move(x: number, y: number): void

Inherited from QMenu.move

Parameters:

Name	Type
x	number
y	number

Returns: void

---

objectName

▸ objectName(): string

Inherited from NodeObject.objectName

Returns: string

---

pos

▸ pos(): object

Inherited from QMenu.pos

Returns: object

• x: number

• y: number

---

property

▸ property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

Name	Type
name	string

Returns: QVariant

---

raise

▸ raise(): void

Inherited from QMenu.raise

Returns: void

---

removeEventListener

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

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof QPushButtonSignals

Parameters:

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

---

repaint

▸ repaint(): void

Inherited from QMenu.repaint

Returns: void

---

repolish

▸ repolish(): void

Inherited from QMenu.repolish

Returns: void

---

resize

▸ resize(width: number, height: number): void

Inherited from QMenu.resize

Parameters:

Name	Type
width	number
height	number

Returns: void

---

setAttribute

▸ setAttribute(attribute: WidgetAttribute, switchOn: boolean): void

Inherited from QMenu.setAttribute

Parameters:

Name	Type
attribute	WidgetAttribute
switchOn	boolean

Returns: void

---

setAutoDefault

▸ setAutoDefault(auto: boolean): void

Parameters:

Name	Type
auto	boolean

Returns: void

---

setAutoExclusive

▸ setAutoExclusive(enable: boolean): void

Inherited from QAbstractButton.setAutoExclusive

Parameters:

Name	Type
enable	boolean

Returns: void

---

setAutoRepeat

▸ setAutoRepeat(enable: boolean): void

Inherited from QAbstractButton.setAutoRepeat

Parameters:

Name	Type
enable	boolean

Returns: void

---

setAutoRepeatDelay

▸ setAutoRepeatDelay(delay: number): void

Inherited from QAbstractButton.setAutoRepeatDelay

Parameters:

Name	Type
delay	number

Returns: void

---

setAutoRepeatInterval

▸ setAutoRepeatInterval(interval: number): void

Inherited from QAbstractButton.setAutoRepeatInterval

Parameters:

Name	Type
interval	number

Returns: void

---

setCheckable

▸ setCheckable(checkable: boolean): void

Inherited from QAbstractButton.setCheckable

Parameters:

Name	Type
checkable	boolean

Returns: void

---

setChecked

▸ setChecked(checked: boolean): void

Inherited from QAbstractButton.setChecked

Parameters:

Name	Type
checked	boolean

Returns: void

---

setContextMenuPolicy

▸ setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from QMenu.setContextMenuPolicy

Parameters:

Name	Type
contextMenuPolicy	ContextMenuPolicy

Returns: void

---

setCursor

▸ setCursor(cursor: CursorShape | QCursor): void

Inherited from QMenu.setCursor

Parameters:

Name	Type
cursor	CursorShape | QCursor

Returns: void

---

setDefault

▸ setDefault(isDefault: boolean): void

Parameters:

Name	Type
isDefault	boolean

Returns: void

---

setDown

▸ setDown(down: boolean): void

Inherited from QAbstractButton.setDown

Parameters:

Name	Type
down	boolean

Returns: void

---

setEnabled

▸ setEnabled(enabled: boolean): void

Inherited from QMenu.setEnabled

Parameters:

Name	Type
enabled	boolean

Returns: void

---

setFixedSize

▸ setFixedSize(width: number, height: number): void

Inherited from QMenu.setFixedSize

Parameters:

Name	Type
width	number
height	number

Returns: void

---

setFlat

▸ setFlat(isFlat: boolean): void

Parameters:

Name	Type
isFlat	boolean

Returns: void

---

setFlexNodeSizeControlled

▸ setFlexNodeSizeControlled(isSizeControlled: boolean): void

Inherited from YogaWidget.setFlexNodeSizeControlled

sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged).

Parameters:

Name	Type	Description
isSizeControlled	boolean

Returns: void

---

setFont

▸ setFont(font: QFont): void

Inherited from QMenu.setFont

Parameters:

Name	Type
font	QFont

Returns: void

---

setGeometry

▸ setGeometry(x: number, y: number, w: number, h: number): void

Inherited from QMenu.setGeometry

Parameters:

Name	Type
x	number
y	number
w	number
h	number

Returns: void

---

setIcon

▸ setIcon(icon: QIcon): void

Inherited from QAbstractButton.setIcon

Parameters:

Name	Type
icon	QIcon

Returns: void

---

setIconSize

▸ setIconSize(iconSize: QSize): void

Inherited from QAbstractButton.setIconSize

Parameters:

Name	Type
iconSize	QSize

Returns: void

---

setInlineStyle

▸ setInlineStyle(style: string): void

Inherited from QMenu.setInlineStyle

Parameters:

Name	Type
style	string

Returns: void

---

setLayout

▸ setLayout(parentLayout: NodeLayout‹QPushButtonSignals›): void

Inherited from QMenu.setLayout

Parameters:

Name	Type
parentLayout	NodeLayout‹QPushButtonSignals›

Returns: void

---

setMaximumSize

▸ setMaximumSize(maxw: number, maxh: number): void

Inherited from QMenu.setMaximumSize

Parameters:

Name	Type
maxw	number
maxh	number

Returns: void

---

setMenu

▸ setMenu(menu: QMenu): void

Parameters:

Name	Type
menu	QMenu

Returns: void

---

setMinimumSize

▸ setMinimumSize(minw: number, minh: number): void

Inherited from QMenu.setMinimumSize

Parameters:

Name	Type
minw	number
minh	number

Returns: void

---

setMouseTracking

▸ setMouseTracking(isMouseTracked: boolean): void

Inherited from QMenu.setMouseTracking

Parameters:

Name	Type
isMouseTracked	boolean

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 QMenu.setObjectName

Overrides 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

---

setShortcut

▸ setShortcut(key: QKeySequence): void

Inherited from QAbstractButton.setShortcut

Parameters:

Name	Type
key	QKeySequence

Returns: void

---

setStyleSheet

▸ setStyleSheet(styleSheet: string): void

Inherited from QMenu.setStyleSheet

Parameters:

Name	Type
styleSheet	string

Returns: void

---

setText

▸ setText(text: string): void

Inherited from QAbstractButton.setText

Parameters:

Name	Type
text	string

Returns: void

---

setWindowFlag

▸ setWindowFlag(windowType: WindowType, switchOn: boolean): void

Inherited from QMenu.setWindowFlag

Parameters:

Name	Type
windowType	WindowType
switchOn	boolean

Returns: void

---

setWindowIcon

▸ setWindowIcon(icon: QIcon): void

Inherited from QMenu.setWindowIcon

Parameters:

Name	Type
icon	QIcon

Returns: void

---

setWindowOpacity

▸ setWindowOpacity(opacity: number): void

Inherited from QMenu.setWindowOpacity

Parameters:

Name	Type
opacity	number

Returns: void

---

setWindowState

▸ setWindowState(state: WindowState): void

Inherited from QMenu.setWindowState

Parameters:

Name	Type
state	WindowState

Returns: void

---

setWindowTitle

▸ setWindowTitle(title: string): void

Inherited from QMenu.setWindowTitle

Parameters:

Name	Type
title	string

Returns: void

---

shortcut

▸ shortcut(): QKeySequence

Inherited from QAbstractButton.shortcut

Returns: QKeySequence

---

show

▸ show(): void

Inherited from QMenu.show

Returns: void

---

showFullScreen

▸ showFullScreen(): void

Inherited from QMenu.showFullScreen

Returns: void

---

showMaximized

▸ showMaximized(): void

Inherited from QMenu.showMaximized

Returns: void

---

showMenu

▸ showMenu(): void

Returns: void

---

showMinimized

▸ showMinimized(): void

Inherited from QMenu.showMinimized

Returns: void

---

showNormal

▸ showNormal(): void

Inherited from QMenu.showNormal

Returns: void

---

size

▸ size(): QSize

Inherited from QMenu.size

Returns: QSize

---

styleSheet

▸ styleSheet(): string

Inherited from QMenu.styleSheet

Returns: string

---

testAttribute

▸ testAttribute(attribute: WidgetAttribute): boolean

Inherited from QMenu.testAttribute

Parameters:

Name	Type
attribute	WidgetAttribute

Returns: boolean

---

text

▸ text(): string

Inherited from QAbstractButton.text

Returns: string

---

toggle

▸ toggle(): void

Inherited from QAbstractButton.toggle

Returns: void

---

update

▸ update(): void

Inherited from QMenu.update

Returns: void

---

updateGeometry

▸ updateGeometry(): void

Inherited from QMenu.updateGeometry

Returns: void

---

windowOpacity

▸ windowOpacity(): number

Inherited from QMenu.windowOpacity

Returns: number

---

windowState

▸ windowState(): number

Inherited from QMenu.windowState

Returns: number

---

windowTitle

▸ windowTitle(): string

Inherited from QMenu.windowTitle

Returns: string