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

QAbstractButtonQPushButtonSignals

QPushButton

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

+ new QPushButton(): QPushButton

Overrides NodeWidget.constructor

Returns: QPushButton

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

Overrides NodeWidget.constructor

Parameters:

NameType
parentNodeWidget‹any›

Returns: QPushButton

+ new QPushButton(native: NativeElement): QPushButton

Overrides NodeWidget.constructor

Parameters:

NameType
nativeNativeElement

Returns: QPushButton

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

Overrides NodeWidget.constructor

Parameters:

NameType
rawPointerNativeRawPointer‹any›
disableNativeDeletion?undefined | false | true

Returns: QPushButton

Properties

Optional _layout

_layout? : NodeLayoutQPushButtonSignals

Inherited from QMenu._layout


_rawInlineStyle

_rawInlineStyle: string = ""

Inherited from QMenu._rawInlineStyle


actions

actions: Set‹QAction

Inherited from QMenu.actions


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

Accessors

layout

get layout(): NodeLayoutQPushButtonSignals› | undefined

Inherited from QMenu.layout

Returns: NodeLayoutQPushButtonSignals› | undefined

set layout(l: NodeLayoutQPushButtonSignals› | undefined): void

Inherited from QMenu.layout

Parameters:

NameType
lNodeLayoutQPushButtonSignals› | undefined

Returns: void

Methods

acceptDrops

acceptDrops(): boolean

Inherited from QMenu.acceptDrops

Returns: boolean


activateWindow

activateWindow(): void

Inherited from QMenu.activateWindow

Returns: void


addAction

addAction(action: QAction | string): QAction

Inherited from QMenu.addAction

Parameters:

NameType
actionQAction | string

Returns: QAction


addEventListener

addEventListenerSignalType›(signalType: SignalType, callback: QPushButtonSignals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof QPushButtonSignals

Parameters:

NameTypeDescription
signalTypeSignalTypeSignalType is a signal from the widgets signals interface.
callbackQPushButtonSignals[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


adjustSize

adjustSize(): void

Inherited from QMenu.adjustSize

Returns: void


animateClick

animateClick(msec: number): void

Inherited from QAbstractButton.animateClick

Parameters:

NameType
msecnumber

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


clearFocus

clearFocus(): void

Inherited from QMenu.clearFocus

Returns: void


click

click(): void

Inherited from QAbstractButton.click

Returns: void


close

close(): boolean

Inherited from QMenu.close

Returns: boolean


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

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:

NameType
classNamestring

Returns: boolean


isActiveWindow

isActiveWindow(): boolean

Inherited from QMenu.isActiveWindow

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:

NameType
posQPoint

Returns: QPoint


mapFromParent

mapFromParent(pos: QPoint): QPoint

Inherited from QMenu.mapFromParent

Parameters:

NameType
posQPoint

Returns: QPoint


mapToGlobal

mapToGlobal(pos: QPoint): QPoint

Inherited from QMenu.mapToGlobal

Parameters:

NameType
posQPoint

Returns: QPoint


mapToParent

mapToParent(pos: QPoint): QPoint

Inherited from QMenu.mapToParent

Parameters:

NameType
posQPoint

Returns: QPoint


maximumSize

maximumSize(): QSize

Inherited from QMenu.maximumSize

Returns: QSize


menu

menu(): QMenu | null

Returns: QMenu | null


minimumSize

minimumSize(): QSize

Inherited from QMenu.minimumSize

Returns: QSize


move

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

Inherited from QMenu.move

Parameters:

NameType
xnumber
ynumber

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:

NameType
namestring

Returns: QVariant


raise

raise(): void

Inherited from QMenu.raise

Returns: void


removeAction

removeAction(action: QAction): void

Inherited from QMenu.removeAction

Parameters:

NameType
actionQAction

Returns: void


removeEventListener

removeEventListenerSignalType›(signalType: SignalType, callback: QPushButtonSignals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof QPushButtonSignals

Parameters:

NameType
signalTypeSignalType
callbackQPushButtonSignals[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


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:

NameType
widthnumber
heightnumber

Returns: void


setAcceptDrops

setAcceptDrops(on: boolean): void

Inherited from QMenu.setAcceptDrops

Parameters:

NameType
onboolean

Returns: void


setAttribute

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

Inherited from QMenu.setAttribute

Parameters:

NameType
attributeWidgetAttribute
switchOnboolean

Returns: void


setAutoDefault

setAutoDefault(auto: boolean): void

Parameters:

NameType
autoboolean

Returns: void


setAutoExclusive

setAutoExclusive(enable: boolean): void

Inherited from QAbstractButton.setAutoExclusive

Parameters:

NameType
enableboolean

Returns: void


setAutoRepeat

setAutoRepeat(enable: boolean): void

Inherited from QAbstractButton.setAutoRepeat

Parameters:

NameType
enableboolean

Returns: void


setAutoRepeatDelay

setAutoRepeatDelay(delay: number): void

Inherited from QAbstractButton.setAutoRepeatDelay

Parameters:

NameType
delaynumber

Returns: void


setAutoRepeatInterval

setAutoRepeatInterval(interval: number): void

Inherited from QAbstractButton.setAutoRepeatInterval

Parameters:

NameType
intervalnumber

Returns: void


setCheckable

setCheckable(checkable: boolean): void

Inherited from QAbstractButton.setCheckable

Parameters:

NameType
checkableboolean

Returns: void


setChecked

setChecked(checked: boolean): void

Inherited from QAbstractButton.setChecked

Parameters:

NameType
checkedboolean

Returns: void


setContextMenuPolicy

setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from QMenu.setContextMenuPolicy

Parameters:

NameType
contextMenuPolicyContextMenuPolicy

Returns: void


setCursor

setCursor(cursor: CursorShape | QCursor): void

Inherited from QMenu.setCursor

Parameters:

NameType
cursorCursorShape | QCursor

Returns: void


setDefault

setDefault(isDefault: boolean): void

Parameters:

NameType
isDefaultboolean

Returns: void


setDown

setDown(down: boolean): void

Inherited from QAbstractButton.setDown

Parameters:

NameType
downboolean

Returns: void


setEnabled

setEnabled(enabled: boolean): void

Inherited from QMenu.setEnabled

Parameters:

NameType
enabledboolean

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:

NameTypeDescription
isProcessedbooleantrue if the event has been processed.

Returns: void


setFixedSize

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

Inherited from QMenu.setFixedSize

Parameters:

NameType
widthnumber
heightnumber

Returns: void


setFlat

setFlat(isFlat: boolean): void

Parameters:

NameType
isFlatboolean

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:

NameTypeDescription
isSizeControlledboolean

Returns: void


setFocus

setFocus(reason: FocusReason): void

Inherited from QMenu.setFocus

Parameters:

NameTypeDefault
reasonFocusReasonFocusReason.OtherFocusReason

Returns: void


setFocusPolicy

setFocusPolicy(policy: FocusPolicy): void

Inherited from QMenu.setFocusPolicy

Parameters:

NameType
policyFocusPolicy

Returns: void


setFont

setFont(font: QFont): void

Inherited from QMenu.setFont

Parameters:

NameType
fontQFont

Returns: void


setGeometry

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

Inherited from QMenu.setGeometry

Parameters:

NameType
xnumber
ynumber
wnumber
hnumber

Returns: void


setGraphicsEffect

setGraphicsEffect(effect: QGraphicsEffect‹any›): void

Inherited from QMenu.setGraphicsEffect

Parameters:

NameType
effectQGraphicsEffect‹any›

Returns: void


setIcon

setIcon(icon: QIcon): void

Inherited from QAbstractButton.setIcon

Parameters:

NameType
iconQIcon

Returns: void


setIconSize

setIconSize(iconSize: QSize): void

Inherited from QAbstractButton.setIconSize

Parameters:

NameType
iconSizeQSize

Returns: void


setInlineStyle

setInlineStyle(style: string): void

Inherited from QMenu.setInlineStyle

Parameters:

NameType
stylestring

Returns: void


setLayout

setLayout(parentLayout: NodeLayoutQPushButtonSignals›): void

Inherited from QMenu.setLayout

Parameters:

NameType
parentLayoutNodeLayoutQPushButtonSignals

Returns: void


setMaximumSize

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

Inherited from QMenu.setMaximumSize

Parameters:

NameType
maxwnumber
maxhnumber

Returns: void


setMenu

setMenu(menu: QMenu): void

Parameters:

NameType
menuQMenu

Returns: void


setMinimumSize

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

Inherited from QMenu.setMinimumSize

Parameters:

NameType
minwnumber
minhnumber

Returns: void


setMouseTracking

setMouseTracking(isMouseTracked: boolean): void

Inherited from QMenu.setMouseTracking

Parameters:

NameType
isMouseTrackedboolean

Returns: void


setNodeParent

setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

NameType
parent?Component

Returns: void


setObjectName

setObjectName(objectName: string): void

Inherited from QMenu.setObjectName

Overrides NodeObject.setObjectName

Parameters:

NameType
objectNamestring

Returns: void


setProperty

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

Inherited from NodeObject.setProperty

Parameters:

NameType
namestring
valueQVariantType

Returns: boolean


setShortcut

setShortcut(key: QKeySequence): void

Inherited from QAbstractButton.setShortcut

Parameters:

NameType
keyQKeySequence

Returns: void


setStyleSheet

setStyleSheet(styleSheet: string): void

Inherited from QMenu.setStyleSheet

Parameters:

NameType
styleSheetstring

Returns: void


setText

setText(text: string): void

Inherited from QAbstractButton.setText

Parameters:

NameType
textstring

Returns: void


setWindowFlag

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

Inherited from QMenu.setWindowFlag

Parameters:

NameType
windowTypeWindowType
switchOnboolean

Returns: void


setWindowIcon

setWindowIcon(icon: QIcon): void

Inherited from QMenu.setWindowIcon

Parameters:

NameType
iconQIcon

Returns: void


setWindowOpacity

setWindowOpacity(opacity: number): void

Inherited from QMenu.setWindowOpacity

Parameters:

NameType
opacitynumber

Returns: void


setWindowState

setWindowState(state: WindowState): void

Inherited from QMenu.setWindowState

Parameters:

NameType
stateWindowState

Returns: void


setWindowTitle

setWindowTitle(title: string): void

Inherited from QMenu.setWindowTitle

Parameters:

NameType
titlestring

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:

NameType
attributeWidgetAttribute

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