nodeguy/website/docs/api/generated/classes/nodewidget.md

id	title	sidebar_label
nodewidget	NodeWidget	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

↳ QWidget

↳ NodeFrame

↳ QAbstractSlider

↳ QAbstractButton

↳ QAbstractSpinBox

↳ QCalendarWidget

↳ NodeDialog

↳ QLCDNumber

↳ QLineEdit

↳ QMenuBar

↳ QStatusBar

↳ QMainWindow

↳ QProgressBar

↳ QComboBox

↳ QTabBar

↳ QTabWidget

↳ QGroupBox

Index

Constructors

• constructor

Properties

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

Methods

• activateWindow
• addAction
• addEventListener
• adjustSize
• close
• font
• geometry
• getFlexNode
• hasMouseTracking
• hide
• inherits
• isEnabled
• isVisible
• lower
• move
• objectName
• pos
• property
• raise
• removeEventListener
• repaint
• repolish
• resize
• setAttribute
• setContextMenuPolicy
• setCursor
• setEnabled
• setFixedSize
• setFlexNodeSizeControlled
• setFont
• setGeometry
• setInlineStyle
• setLayout
• setMaximumSize
• setMinimumSize
• setMouseTracking
• setNodeParent
• setObjectName
• setProperty
• setStyleSheet
• setWindowFlag
• setWindowIcon
• setWindowOpacity
• setWindowState
• setWindowTitle
• show
• showFullScreen
• showMaximized
• showMinimized
• showNormal
• size
• styleSheet
• testAttribute
• update
• updateGeometry
• windowOpacity
• windowState
• windowTitle

Constructors

constructor

+ new NodeWidget(native: NativeElement): NodeWidget

Overrides EventWidget.constructor

Parameters:

Name	Type
native	NativeElement

Returns: NodeWidget

Properties

_rawInlineStyle

• _rawInlineStyle: string = ""

---

actions

• actions: Set‹QAction›

---

Optional layout

• layout? : NodeLayout‹Signals›

---

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"

Methods

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

---

close

▸ close(): boolean

Returns: boolean

---

font

▸ font(): QFont

Returns: QFont

---

geometry

▸ geometry(): QRect

Returns: QRect

---

getFlexNode

▸ getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode

---

hasMouseTracking

▸ hasMouseTracking(): boolean

Returns: boolean

---

hide

▸ hide(): void

Returns: void

---

inherits

▸ inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

Name	Type
className	string

Returns: boolean

---

isEnabled

▸ isEnabled(): boolean

Returns: boolean

---

isVisible

▸ isVisible(): boolean

Returns: boolean

---

lower

▸ lower(): void

Returns: void

---

move

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

Parameters:

Name	Type
x	number
y	number

Returns: void

---

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

---

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

---

setAttribute

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

Parameters:

Name	Type
attribute	WidgetAttribute
switchOn	boolean

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

---

setEnabled

▸ setEnabled(enabled: boolean): void

Parameters:

Name	Type
enabled	boolean

Returns: void

---

setFixedSize

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

Parameters:

Name	Type
width	number
height	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

---

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

---

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

---

setMaximumSize

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

Parameters:

Name	Type
maxw	number
maxh	number

Returns: void

---

setMinimumSize

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

Parameters:

Name	Type
minw	number
minh	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

---

setProperty

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

Inherited from NodeObject.setProperty

Parameters:

Name	Type
name	string
value	QVariantType

Returns: boolean

---

setStyleSheet

▸ setStyleSheet(styleSheet: string): void

Parameters:

Name	Type
styleSheet	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

---

setWindowOpacity

▸ setWindowOpacity(opacity: number): void

Parameters:

Name	Type
opacity	number

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

---

styleSheet

▸ styleSheet(): string

Returns: string

---

testAttribute

▸ testAttribute(attribute: WidgetAttribute): boolean

Parameters:

Name	Type
attribute	WidgetAttribute

Returns: boolean

---

update

▸ update(): void

Returns: void

---

updateGeometry

▸ updateGeometry(): void

Returns: void

---

windowOpacity

▸ windowOpacity(): number

Returns: number

---

windowState

▸ windowState(): number

Returns: number

---

windowTitle

▸ windowTitle(): string

Returns: string