NodeWidget

Abstract class to add functionalities common to all Widgets.

*This class implements all methods, properties of Qt's QWidget class so that it can be inherited by all widgets**

NodeWidget is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all widget's easily. Additionally it helps in type checking process. If you wish to create a div like widget use QWidget instead.

*NodeWidget is the base class for all widgets.**

Example

const {

NodeWidget,

QPushButton,

QWidget,

QRadioButton

} = require("@nodegui/nodegui");

// showWidget can accept any widget since it expects NodeWidget

const showWidget = (widget: NodeWidget) => {

widget.show();

};

showWidget(new QPushButton());

showWidget(new QWidget());

showWidget(new QRadioButton());

All Widgets should extend from NodeWidget Implement all native QWidget methods here so that all widgets get access to those aswell

Type parameters

▪ Signals: QWidgetSignals

Hierarchy

↳ YogaWidget‹Signals›

↳ NodeWidget

↳ QMenu

↳ NodeFrame

↳ QAbstractSlider

↳ QAbstractButton

↳ QAbstractSpinBox

↳ QCalendarWidget

↳ NodeDialog

↳ QLCDNumber

↳ QLineEdit

↳ QProgressBar

↳ QComboBox

↳ QTabBar

↳ QTabWidget

↳ QMenuBar

↳ QSvgWidget

↳ QGroupBox

↳ QStatusBar

↳ QWidget

↳ QMainWindow

Index

Constructors

• constructor

Properties

• _layout
• _rawInlineStyle
• native
• nodeChildren
• nodeParent
• type

Accessors

• layout

Methods

• acceptDrops
• accessibleDescription
• accessibleName
• activateWindow
• addAction
• addEventListener
• adjustSize
• autoFillBackground
• baseSize
• childrenRect
• clearFocus
• clearMask
• close
• contextMenuPolicy
• dumpObjectInfo
• dumpObjectTree
• ensurePolished
• eventProcessed
• font
• frameGeometry
• frameSize
• geometry
• getFlexNode
• grabKeyboard
• grabMouse
• hasFocus
• hasHeightForWidth
• hasMouseTracking
• hasTabletTracking
• height
• heightForWidth
• hide
• inherits
• isActiveWindow
• isEnabled
• isFullScreen
• isHidden
• isMaximized
• isMinimized
• isModal
• isVisible
• isWindow
• isWindowModified
• lower
• mapFrom
• mapFromGlobal
• mapFromParent
• mapTo
• mapToGlobal
• mapToParent
• maximumHeight
• maximumSize
• maximumWidth
• minimumHeight
• minimumSize
• minimumSizeHint
• minimumWidth
• move
• normalGeometry
• objectName
• pos
• property
• raise
• rect
• releaseKeyboard
• releaseMouse
• releaseShortcut
• removeAction
• removeEventListener
• repaint
• repolish
• resize
• setAcceptDrops
• setAccessibleDescription
• setAccessibleName
• setAttribute
• setAutoFillBackground
• setBaseSize
• setContentsMargins
• setContextMenuPolicy
• setCursor
• setDisabled
• setEnabled
• setEventProcessed
• setFixedHeight
• setFixedSize
• setFixedWidth
• setFlexNodeSizeControlled
• setFocus
• setFocusPolicy
• setFont
• setGeometry
• setGraphicsEffect
• setHidden
• setInlineStyle
• setLayout
• setMaximumHeight
• setMaximumSize
• setMaximumWidth
• setMinimumHeight
• setMinimumSize
• setMinimumWidth
• setMouseTracking
• setNodeParent
• setObjectName
• setParent
• setProperty
• setShortcutAutoRepeat
• setShortcutEnabled
• setSizeIncrement
• setSizePolicy
• setStatusTip
• setStyleSheet
• setTabletTracking
• setToolTip
• setToolTipDuration
• setUpdatesEnabled
• setVisible
• setWhatsThis
• setWindowFilePath
• setWindowFlag
• setWindowIcon
• setWindowModified
• setWindowOpacity
• setWindowRole
• setWindowState
• setWindowTitle
• show
• showFullScreen
• showMaximized
• showMinimized
• showNormal
• size
• sizeHint
• sizeIncrement
• statusTip
• style
• styleSheet
• testAttribute
• toolTip
• toolTipDuration
• underMouse
• unsetCursor
• unsetLayoutDirection
• unsetLocale
• update
• updateGeometry
• updatesEnabled
• whatsThis
• width
• winId
• windowFilePath
• windowHandle
• windowIcon
• windowOpacity
• windowRole
• windowState
• windowTitle
• x
• y

Constructors

constructor

+ new NodeWidget(native: NativeElement): NodeWidget

Overrides EventWidget.constructor

Parameters:

Name	Type
native	NativeElement

Returns: NodeWidget

Properties

Optional _layout

• _layout? : NodeLayout‹Signals›

---

_rawInlineStyle

• _rawInlineStyle: string = ""

---

Abstract native

• native: NativeElement

Inherited from Component.native

---

nodeChildren

• nodeChildren: Set‹Component›

Inherited from Component.nodeChildren

---

Optional nodeParent

• nodeParent? : Component

Inherited from Component.nodeParent

---

type

• type: string = "widget"

Accessors

layout

• get layout(): NodeLayout‹Signals› | undefined

Returns: NodeLayout‹Signals› | undefined

• set layout(l: NodeLayout‹Signals› | undefined): void

Parameters:

Name	Type
l	NodeLayout‹Signals› | undefined

Returns: void

Methods

acceptDrops

▸ acceptDrops(): boolean

Returns: boolean

---

accessibleDescription

▸ accessibleDescription(): string

Returns: string

---

accessibleName

▸ accessibleName(): string

Returns: string

---

activateWindow

▸ activateWindow(): void

Returns: void

---

addAction

▸ addAction(action: QAction | string): QAction

Parameters:

Name	Type
action	QAction | string

Returns: QAction

---

addEventListener

▸ addEventListener‹SignalType›(signalType: SignalType, callback: Signals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

▪ SignalType: keyof Signals

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?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

adjustSize

▸ adjustSize(): void

Returns: void

---

autoFillBackground

▸ autoFillBackground(): boolean

Returns: boolean

---

baseSize

▸ baseSize(): QSize

Returns: QSize

---

childrenRect

▸ childrenRect(): QRect

Returns: QRect

---

clearFocus

▸ clearFocus(): void

Returns: void

---

clearMask

▸ clearMask(): void

Returns: void

---

close

▸ close(): boolean

Returns: boolean

---

contextMenuPolicy

▸ contextMenuPolicy(): ContextMenuPolicy

Returns: ContextMenuPolicy

---

dumpObjectInfo

▸ dumpObjectInfo(): void

Inherited from NodeObject.dumpObjectInfo

Returns: void

---

dumpObjectTree

▸ dumpObjectTree(): void

Inherited from NodeObject.dumpObjectTree

Returns: void

---

ensurePolished

▸ ensurePolished(): void

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

---

frameGeometry

▸ frameGeometry(): QRect

Returns: QRect

---

frameSize

▸ frameSize(): QSize

Returns: QSize

---

geometry

▸ geometry(): QRect

Returns: QRect

---

getFlexNode

▸ getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode

---

grabKeyboard

▸ grabKeyboard(): void

Returns: void

---

grabMouse

▸ grabMouse(): void

Returns: void

---

hasFocus

▸ hasFocus(): boolean

Returns: boolean

---

hasHeightForWidth

▸ hasHeightForWidth(): boolean

Returns: boolean

---

hasMouseTracking

▸ hasMouseTracking(): boolean

Returns: boolean

---

hasTabletTracking

▸ hasTabletTracking(): boolean

Returns: boolean

---

height

▸ height(): number

Returns: number

---

heightForWidth

▸ heightForWidth(w: number): number

Parameters:

Name	Type
w	number

Returns: number

---

hide

▸ hide(): void

Returns: void

---

inherits

▸ inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

Name	Type
className	string

Returns: boolean

---

isActiveWindow

▸ isActiveWindow(): boolean

Returns: boolean

---

isEnabled

▸ isEnabled(): boolean

Returns: boolean

---

isFullScreen

▸ isFullScreen(): boolean

Returns: boolean

---

isHidden

▸ isHidden(): boolean

Returns: boolean

---

isMaximized

▸ isMaximized(): boolean

Returns: boolean

---

isMinimized

▸ isMinimized(): boolean

Returns: boolean

---

isModal

▸ isModal(): boolean

Returns: boolean

---

isVisible

▸ isVisible(): boolean

Returns: boolean

---

isWindow

▸ isWindow(): boolean

Returns: boolean

---

isWindowModified

▸ isWindowModified(): boolean

Returns: boolean

---

lower

▸ lower(): void

Returns: void

---

mapFrom

▸ mapFrom(parent: QWidget, pos: QPoint): QPoint

Parameters:

Name	Type
parent	QWidget
pos	QPoint

Returns: QPoint

---

mapFromGlobal

▸ mapFromGlobal(pos: QPoint): QPoint

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

mapFromParent

▸ mapFromParent(pos: QPoint): QPoint

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

mapTo

▸ mapTo(parent: QWidget, pos: QPoint): QPoint

Parameters:

Name	Type
parent	QWidget
pos	QPoint

Returns: QPoint

---

mapToGlobal

▸ mapToGlobal(pos: QPoint): QPoint

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

mapToParent

▸ mapToParent(pos: QPoint): QPoint

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

maximumHeight

▸ maximumHeight(): number

Returns: number

---

maximumSize

▸ maximumSize(): QSize

Returns: QSize

---

maximumWidth

▸ maximumWidth(): number

Returns: number

---

minimumHeight

▸ minimumHeight(): number

Returns: number

---

minimumSize

▸ minimumSize(): QSize

Returns: QSize

---

minimumSizeHint

▸ minimumSizeHint(): QSize

Returns: QSize

---

minimumWidth

▸ minimumWidth(): number

Returns: number

---

move

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

Parameters:

Name	Type
x	number
y	number

Returns: void

---

normalGeometry

▸ normalGeometry(): QRect

Returns: QRect

---

objectName

▸ objectName(): string

Inherited from NodeObject.objectName

Returns: string

---

pos

▸ pos(): object

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

Returns: void

---

rect

▸ rect(): QRect

Returns: QRect

---

releaseKeyboard

▸ releaseKeyboard(): void

Returns: void

---

releaseMouse

▸ releaseMouse(): void

Returns: void

---

releaseShortcut

▸ releaseShortcut(id: number): void

Parameters:

Name	Type
id	number

Returns: void

---

removeAction

▸ removeAction(action: QAction): void

Parameters:

Name	Type
action	QAction

Returns: void

---

removeEventListener

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

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof Signals

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?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

repaint

▸ repaint(): void

Returns: void

---

repolish

▸ repolish(): void

Returns: void

---

resize

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

Parameters:

Name	Type
width	number
height	number

Returns: void

---

setAcceptDrops

▸ setAcceptDrops(on: boolean): void

Parameters:

Name	Type
on	boolean

Returns: void

---

setAccessibleDescription

▸ setAccessibleDescription(description: string): void

Parameters:

Name	Type
description	string

Returns: void

---

setAccessibleName

▸ setAccessibleName(name: string): void

Parameters:

Name	Type
name	string

Returns: void

---

setAttribute

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

Parameters:

Name	Type
attribute	WidgetAttribute
switchOn	boolean

Returns: void

---

setAutoFillBackground

▸ setAutoFillBackground(enabled: boolean): void

Parameters:

Name	Type
enabled	boolean

Returns: void

---

setBaseSize

▸ setBaseSize(size: QSize): void

Parameters:

Name	Type
size	QSize

Returns: void

---

setContentsMargins

▸ setContentsMargins(left: number, top: number, right: number, bottom: number): void

Parameters:

Name	Type
left	number
top	number
right	number
bottom	number

Returns: void

---

setContextMenuPolicy

▸ setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Parameters:

Name	Type
contextMenuPolicy	ContextMenuPolicy

Returns: void

---

setCursor

▸ setCursor(cursor: CursorShape | QCursor): void

Parameters:

Name	Type
cursor	CursorShape | QCursor

Returns: void

---

setDisabled

▸ setDisabled(disable: boolean): void

Parameters:

Name	Type
disable	boolean

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

---

setFixedHeight

▸ setFixedHeight(h: number): void

Parameters:

Name	Type
h	number

Returns: void

---

setFixedSize

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

Parameters:

Name	Type
width	number
height	number

Returns: void

---

setFixedWidth

▸ setFixedWidth(w: number): void

Parameters:

Name	Type
w	number

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

---

setFocus

▸ setFocus(reason: FocusReason): void

Parameters:

Name	Type	Default
reason	FocusReason	FocusReason.OtherFocusReason

Returns: void

---

setFocusPolicy

▸ setFocusPolicy(policy: FocusPolicy): void

Parameters:

Name	Type
policy	FocusPolicy

Returns: void

---

setFont

▸ setFont(font: QFont): void

Parameters:

Name	Type
font	QFont

Returns: void

---

setGeometry

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

Parameters:

Name	Type
x	number
y	number
w	number
h	number

Returns: void

---

setGraphicsEffect

▸ setGraphicsEffect(effect: QGraphicsEffect‹any›): void

Parameters:

Name	Type
effect	QGraphicsEffect‹any›

Returns: void

---

setHidden

▸ setHidden(hidden: boolean): void

Parameters:

Name	Type
hidden	boolean

Returns: void

---

setInlineStyle

▸ setInlineStyle(style: string): void

Parameters:

Name	Type
style	string

Returns: void

---

setLayout

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

Parameters:

Name	Type
parentLayout	NodeLayout‹Signals›

Returns: void

---

setMaximumHeight

▸ setMaximumHeight(maxh: number): void

Parameters:

Name	Type
maxh	number

Returns: void

---

setMaximumSize

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

Parameters:

Name	Type
maxw	number
maxh	number

Returns: void

---

setMaximumWidth

▸ setMaximumWidth(maxw: number): void

Parameters:

Name	Type
maxw	number

Returns: void

---

setMinimumHeight

▸ setMinimumHeight(minh: number): void

Parameters:

Name	Type
minh	number

Returns: void

---

setMinimumSize

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

Parameters:

Name	Type
minw	number
minh	number

Returns: void

---

setMinimumWidth

▸ setMinimumWidth(minw: number): void

Parameters:

Name	Type
minw	number

Returns: void

---

setMouseTracking

▸ setMouseTracking(isMouseTracked: boolean): void

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

Overrides NodeObject.setObjectName

Parameters:

Name	Type
objectName	string

Returns: void

---

setParent

▸ setParent(parent: NodeObject‹QObjectSignals›): void

Inherited from NodeObject.setParent

Parameters:

Name	Type
parent	NodeObject‹QObjectSignals›

Returns: void

---

setProperty

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

Inherited from NodeObject.setProperty

Parameters:

Name	Type
name	string
value	QVariantType

Returns: boolean

---

setShortcutAutoRepeat

▸ setShortcutAutoRepeat(id: number, enable: boolean): void

Parameters:

Name	Type	Default
id	number	-
enable	boolean	true

Returns: void

---

setShortcutEnabled

▸ setShortcutEnabled(id: number, enable: boolean): void

Parameters:

Name	Type	Default
id	number	-
enable	boolean	true

Returns: void

---

setSizeIncrement

▸ setSizeIncrement(w_or_size: QSize | number, h: number): void

Parameters:

Name	Type	Default
w_or_size	QSize | number	-
h	number	0

Returns: void

---

setSizePolicy

▸ setSizePolicy(horizontal: QSizePolicyPolicy, vertical: QSizePolicyPolicy): void

Parameters:

Name	Type
horizontal	QSizePolicyPolicy
vertical	QSizePolicyPolicy

Returns: void

---

setStatusTip

▸ setStatusTip(statusTip: string): void

Parameters:

Name	Type
statusTip	string

Returns: void

---

setStyleSheet

▸ setStyleSheet(styleSheet: string): void

Parameters:

Name	Type
styleSheet	string

Returns: void

---

setTabletTracking

▸ setTabletTracking(enable: boolean): void

Parameters:

Name	Type
enable	boolean

Returns: void

---

setToolTip

▸ setToolTip(text: string): void

Parameters:

Name	Type
text	string

Returns: void

---

setToolTipDuration

▸ setToolTipDuration(msec: number): void

Parameters:

Name	Type
msec	number

Returns: void

---

setUpdatesEnabled

▸ setUpdatesEnabled(enable: boolean): void

Parameters:

Name	Type
enable	boolean

Returns: void

---

setVisible

▸ setVisible(visible: boolean): void

Parameters:

Name	Type
visible	boolean

Returns: void

---

setWhatsThis

▸ setWhatsThis(whatsThis: string): void

Parameters:

Name	Type
whatsThis	string

Returns: void

---

setWindowFilePath

▸ setWindowFilePath(filePath: string): void

Parameters:

Name	Type
filePath	string

Returns: void

---

setWindowFlag

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

Parameters:

Name	Type
windowType	WindowType
switchOn	boolean

Returns: void

---

setWindowIcon

▸ setWindowIcon(icon: QIcon): void

Parameters:

Name	Type
icon	QIcon

Returns: void

---

setWindowModified

▸ setWindowModified(modified: boolean): void

Parameters:

Name	Type
modified	boolean

Returns: void

---

setWindowOpacity

▸ setWindowOpacity(opacity: number): void

Parameters:

Name	Type
opacity	number

Returns: void

---

setWindowRole

▸ setWindowRole(role: string): void

Parameters:

Name	Type
role	string

Returns: void

---

setWindowState

▸ setWindowState(state: WindowState): void

Parameters:

Name	Type
state	WindowState

Returns: void

---

setWindowTitle

▸ setWindowTitle(title: string): void

Parameters:

Name	Type
title	string

Returns: void

---

show

▸ show(): void

Returns: void

---

showFullScreen

▸ showFullScreen(): void

Returns: void

---

showMaximized

▸ showMaximized(): void

Returns: void

---

showMinimized

▸ showMinimized(): void

Returns: void

---

showNormal

▸ showNormal(): void

Returns: void

---

size

▸ size(): QSize

Returns: QSize

---

sizeHint

▸ sizeHint(): QSize

Returns: QSize

---

sizeIncrement

▸ sizeIncrement(): QSize

Returns: QSize

---

statusTip

▸ statusTip(): string

Returns: string

---

style

▸ style(): QStyle

Returns: QStyle

---

styleSheet

▸ styleSheet(): string

Returns: string

---

testAttribute

▸ testAttribute(attribute: WidgetAttribute): boolean

Parameters:

Name	Type
attribute	WidgetAttribute

Returns: boolean

---

toolTip

▸ toolTip(): string

Returns: string

---

toolTipDuration

▸ toolTipDuration(): number

Returns: number

---

underMouse

▸ underMouse(): boolean

Returns: boolean

---

unsetCursor

▸ unsetCursor(): void

Returns: void

---

unsetLayoutDirection

▸ unsetLayoutDirection(): void

Returns: void

---

unsetLocale

▸ unsetLocale(): void

Returns: void

---

update

▸ update(): void

Returns: void

---

updateGeometry

▸ updateGeometry(): void

Returns: void

---

updatesEnabled

▸ updatesEnabled(): boolean

Returns: boolean

---

whatsThis

▸ whatsThis(): string

Returns: string

---

width

▸ width(): number

Returns: number

---

winId

▸ winId(): number

Returns: number

---

windowFilePath

▸ windowFilePath(): string

Returns: string

---

windowHandle

▸ windowHandle(): QWindow | null

Returns: QWindow | null

---

windowIcon

▸ windowIcon(): QIcon

Returns: QIcon

---

windowOpacity

▸ windowOpacity(): number

Returns: number

---

windowRole

▸ windowRole(): string

Returns: string

---

windowState

▸ windowState(): WindowState

Returns: WindowState

---

windowTitle

▸ windowTitle(): string

Returns: string

---

x

▸ x(): number

Returns: number

---

y

▸ y(): number

Returns: number