QDial

Create and control dial slider widgets.

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

A QDial provides ability to add and manipulate native dial slider widgets.

Example

const { QDial } = require("@nodegui/nodegui");
const dial = new QDial();

Hierarchy

↳ QAbstractSlider‹QDialSignals›

↳ QDial

Index

Constructors

• constructor

Properties

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

Methods

• activateWindow
• addEventListener
• adjustSize
• close
• font
• geometry
• getFlexNode
• hasMouseTracking
• hide
• inherits
• isEnabled
• isVisible
• lower
• maximum
• minimum
• move
• notchTarget
• notchesVisible
• objectName
• pos
• property
• raise
• removeEventListener
• repaint
• resize
• setAttribute
• setContextMenuPolicy
• setCursor
• setEnabled
• setFixedSize
• setFlexNodeSizeControlled
• setFont
• setGeometry
• setInlineStyle
• setLayout
• setMaximum
• setMaximumSize
• setMinimum
• setMinimumSize
• setMouseTracking
• setNodeParent
• setNotchTarget
• setNotchesVisible
• setObjectName
• setOrientation
• setProperty
• setSingleStep
• setStyleSheet
• setValue
• setWindowFlag
• setWindowIcon
• setWindowOpacity
• setWindowState
• setWindowTitle
• setWrapping
• show
• showFullScreen
• showMaximized
• showMinimized
• showNormal
• size
• styleSheet
• testAttribute
• update
• updateGeometry
• value
• windowOpacity
• windowState
• windowTitle
• wrapping

Constructors

constructor

+ new QDial(): QDial

Overrides EventWidget.constructor

Returns: QDial

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

Overrides EventWidget.constructor

Parameters:

Name	Type
parent	NodeWidget‹any›

Returns: QDial

Properties

_rawInlineStyle

• _rawInlineStyle: string = ""

Inherited from NodeWidget._rawInlineStyle

---

Optional layout

• layout? : NodeLayout‹QDialSignals›

Inherited from NodeWidget.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 NodeWidget.type

Methods

activateWindow

▸ activateWindow(): void

Inherited from NodeWidget.activateWindow

Returns: void

---

addEventListener

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

Inherited from EventWidget.addEventListener

Type parameters:

▪ SignalType: keyof QDialSignals

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

Inherited from NodeWidget.adjustSize

Returns: void

---

close

▸ close(): boolean

Inherited from NodeWidget.close

Returns: boolean

---

font

▸ font(): QFont

Inherited from NodeWidget.font

Returns: QFont

---

geometry

▸ geometry(): QRect

Inherited from NodeWidget.geometry

Returns: QRect

---

getFlexNode

▸ getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode

---

hasMouseTracking

▸ hasMouseTracking(): boolean

Inherited from NodeWidget.hasMouseTracking

Returns: boolean

---

hide

▸ hide(): void

Inherited from NodeWidget.hide

Returns: void

---

inherits

▸ inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

Name	Type
className	string

Returns: boolean

---

isEnabled

▸ isEnabled(): boolean

Inherited from NodeWidget.isEnabled

Returns: boolean

---

isVisible

▸ isVisible(): boolean

Inherited from NodeWidget.isVisible

Returns: boolean

---

lower

▸ lower(): void

Inherited from NodeWidget.lower

Returns: void

---

maximum

▸ maximum(): number

Inherited from QAbstractSlider.maximum

Returns: number

---

minimum

▸ minimum(): number

Inherited from QAbstractSlider.minimum

Returns: number

---

move

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

Inherited from NodeWidget.move

Parameters:

Name	Type
x	number
y	number

Returns: void

---

notchTarget

▸ notchTarget(): number

Returns: number

---

notchesVisible

▸ notchesVisible(): boolean

Returns: boolean

---

objectName

▸ objectName(): string

Inherited from NodeObject.objectName

Returns: string

---

pos

▸ pos(): object

Inherited from NodeWidget.pos

Returns: object

---

property

▸ property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

Name	Type
name	string

Returns: QVariant

---

raise

▸ raise(): void

Inherited from NodeWidget.raise

Returns: void

---

removeEventListener

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

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof QDialSignals

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

Inherited from NodeWidget.repaint

Returns: void

---

resize

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

Inherited from NodeWidget.resize

Parameters:

Name	Type
width	number
height	number

Returns: void

---

setAttribute

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

Inherited from NodeWidget.setAttribute

Parameters:

Name	Type
attribute	WidgetAttribute
switchOn	boolean

Returns: void

---

setContextMenuPolicy

▸ setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from NodeWidget.setContextMenuPolicy

Parameters:

Name	Type
contextMenuPolicy	ContextMenuPolicy

Returns: void

---

setCursor

▸ setCursor(cursor: CursorShape | QCursor): void

Inherited from NodeWidget.setCursor

Parameters:

Name	Type
cursor	CursorShape | QCursor

Returns: void

---

setEnabled

▸ setEnabled(enabled: boolean): void

Inherited from NodeWidget.setEnabled

Parameters:

Name	Type
enabled	boolean

Returns: void

---

setFixedSize

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

Inherited from NodeWidget.setFixedSize

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

Inherited from NodeWidget.setFont

Parameters:

Name	Type
font	QFont

Returns: void

---

setGeometry

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

Inherited from NodeWidget.setGeometry

Parameters:

Name	Type
x	number
y	number
w	number
h	number

Returns: void

---

setInlineStyle

▸ setInlineStyle(style: string): void

Inherited from NodeWidget.setInlineStyle

Parameters:

Name	Type
style	string

Returns: void

---

setLayout

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

Inherited from NodeWidget.setLayout

Parameters:

Name	Type
parentLayout	NodeLayout‹QDialSignals›

Returns: void

---

setMaximum

▸ setMaximum(maximum: number): void

Inherited from QAbstractSlider.setMaximum

Parameters:

Name	Type
maximum	number

Returns: void

---

setMaximumSize

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

Inherited from NodeWidget.setMaximumSize

Parameters:

Name	Type
maxw	number
maxh	number

Returns: void

---

setMinimum

▸ setMinimum(minimum: number): void

Inherited from QAbstractSlider.setMinimum

Parameters:

Name	Type
minimum	number

Returns: void

---

setMinimumSize

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

Inherited from NodeWidget.setMinimumSize

Parameters:

Name	Type
minw	number
minh	number

Returns: void

---

setMouseTracking

▸ setMouseTracking(isMouseTracked: boolean): void

Inherited from NodeWidget.setMouseTracking

Parameters:

Name	Type
isMouseTracked	boolean

Returns: void

---

setNodeParent

▸ setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

Name	Type
parent?	Component

Returns: void

---

setNotchTarget

▸ setNotchTarget(target: number): void

Parameters:

Name	Type
target	number

Returns: void

---

setNotchesVisible

▸ setNotchesVisible(visible: boolean): void

Parameters:

Name	Type
visible	boolean

Returns: void

---

setObjectName

▸ setObjectName(objectName: string): void

Inherited from NodeWidget.setObjectName

Overrides NodeObject.setObjectName

Parameters:

Name	Type
objectName	string

Returns: void

---

setOrientation

▸ setOrientation(orientation: Orientation): void

Inherited from QAbstractSlider.setOrientation

Parameters:

Name	Type
orientation	Orientation

Returns: void

---

setProperty

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

Inherited from NodeObject.setProperty

Parameters:

Name	Type
name	string
value	QVariantType

Returns: boolean

---

setSingleStep

▸ setSingleStep(step: number): void

Inherited from QAbstractSlider.setSingleStep

Parameters:

Name	Type
step	number

Returns: void

---

setStyleSheet

▸ setStyleSheet(styleSheet: string): void

Inherited from NodeWidget.setStyleSheet

Parameters:

Name	Type
styleSheet	string

Returns: void

---

setValue

▸ setValue(value: number): void

Inherited from QAbstractSlider.setValue

Parameters:

Name	Type
value	number

Returns: void

---

setWindowFlag

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

Inherited from NodeWidget.setWindowFlag

Parameters:

Name	Type
windowType	WindowType
switchOn	boolean

Returns: void

---

setWindowIcon

▸ setWindowIcon(icon: QIcon): void

Inherited from NodeWidget.setWindowIcon

Parameters:

Name	Type
icon	QIcon

Returns: void

---

setWindowOpacity

▸ setWindowOpacity(opacity: number): void

Inherited from NodeWidget.setWindowOpacity

Parameters:

Name	Type
opacity	number

Returns: void

---

setWindowState

▸ setWindowState(state: WindowState): void

Inherited from NodeWidget.setWindowState

Parameters:

Name	Type
state	WindowState

Returns: void

---

setWindowTitle

▸ setWindowTitle(title: string): void

Inherited from NodeWidget.setWindowTitle

Parameters:

Name	Type
title	string

Returns: void

---

setWrapping

▸ setWrapping(on: boolean): void

Parameters:

Name	Type
on	boolean

Returns: void

---

show

▸ show(): void

Inherited from NodeWidget.show

Returns: void

---

showFullScreen

▸ showFullScreen(): void

Inherited from NodeWidget.showFullScreen

Returns: void

---

showMaximized

▸ showMaximized(): void

Inherited from NodeWidget.showMaximized

Returns: void

---

showMinimized

▸ showMinimized(): void

Inherited from NodeWidget.showMinimized

Returns: void

---

showNormal

▸ showNormal(): void

Inherited from NodeWidget.showNormal

Returns: void

---

size

▸ size(): QSize

Inherited from NodeWidget.size

Returns: QSize

---

styleSheet

▸ styleSheet(): string

Inherited from NodeWidget.styleSheet

Returns: string

---

testAttribute

▸ testAttribute(attribute: WidgetAttribute): boolean

Inherited from NodeWidget.testAttribute

Parameters:

Name	Type
attribute	WidgetAttribute

Returns: boolean

---

update

▸ update(): void

Inherited from NodeWidget.update

Returns: void

---

updateGeometry

▸ updateGeometry(): void

Inherited from NodeWidget.updateGeometry

Returns: void

---

value

▸ value(): number

Inherited from QAbstractSlider.value

Returns: number

---

windowOpacity

▸ windowOpacity(): number

Inherited from NodeWidget.windowOpacity

Returns: number

---

windowState

▸ windowState(): number

Inherited from NodeWidget.windowState

Returns: number

---

windowTitle

▸ windowTitle(): string

Inherited from NodeWidget.windowTitle

Returns: string

---

wrapping

▸ wrapping(): boolean

Returns: boolean