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

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

Accessors

• layout

Methods

• acceptDrops
• activateWindow
• addAction
• addEventListener
• adjustSize
• clearFocus
• close
• eventProcessed
• font
• frameGeometry
• geometry
• getFlexNode
• hasMouseTracking
• hasTracking
• hide
• inherits
• invertedAppearance
• invertedControls
• isActiveWindow
• isEnabled
• isSliderDown
• isVisible
• lower
• mapFromGlobal
• mapFromParent
• mapToGlobal
• mapToParent
• maximum
• maximumSize
• minimum
• minimumSize
• move
• notchSize
• notchTarget
• notchesVisible
• objectName
• orientation
• pageStep
• pos
• property
• raise
• removeAction
• removeEventListener
• repaint
• repolish
• resize
• setAcceptDrops
• setAttribute
• setContextMenuPolicy
• setCursor
• setEnabled
• setEventProcessed
• setFixedSize
• setFlexNodeSizeControlled
• setFocus
• setFocusPolicy
• setFont
• setGeometry
• setGraphicsEffect
• setInlineStyle
• setInvertedAppearance
• setInvertedControls
• setLayout
• setMaximum
• setMaximumSize
• setMinimum
• setMinimumSize
• setMouseTracking
• setNodeParent
• setNotchTarget
• setNotchesVisible
• setObjectName
• setOrientation
• setPageStep
• setProperty
• setRange
• setSingleStep
• setSliderDown
• setSliderPosition
• setStyleSheet
• setTracking
• setValue
• setWindowFlag
• setWindowIcon
• setWindowOpacity
• setWindowState
• setWindowTitle
• setWrapping
• show
• showFullScreen
• showMaximized
• showMinimized
• showNormal
• singleStep
• size
• sliderPosition
• styleSheet
• testAttribute
• triggerAction
• update
• updateGeometry
• value
• windowOpacity
• windowState
• windowTitle
• wrapping
• x
• y

Constructors

constructor

+ new QDial(): QDial

Overrides NodeWidget.constructor

Returns: QDial

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

Overrides NodeWidget.constructor

Parameters:

Name	Type
parent	NodeWidget‹any›

Returns: QDial

Properties

Optional _layout

• _layout? : NodeLayout‹QDialSignals›

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(): NodeLayout‹QDialSignals› | undefined

Inherited from QMenu.layout

Returns: NodeLayout‹QDialSignals› | undefined

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

Inherited from QMenu.layout

Parameters:

Name	Type
l	NodeLayout‹QDialSignals› | 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:

Name	Type
action	QAction | string

Returns: QAction

---

addEventListener

▸ addEventListener‹SignalType›(signalType: SignalType, callback: QDialSignals[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	QDialSignals[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

---

clearFocus

▸ clearFocus(): void

Inherited from QMenu.clearFocus

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

---

frameGeometry

▸ frameGeometry(): QRect

Inherited from QMenu.frameGeometry

Returns: QRect

---

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

---

hasTracking

▸ hasTracking(): boolean

Inherited from QAbstractSlider.hasTracking

Returns: boolean

---

hide

▸ hide(): void

Inherited from QMenu.hide

Returns: void

---

inherits

▸ inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

Name	Type
className	string

Returns: boolean

---

invertedAppearance

▸ invertedAppearance(): boolean

Inherited from QAbstractSlider.invertedAppearance

Returns: boolean

---

invertedControls

▸ invertedControls(): boolean

Inherited from QAbstractSlider.invertedControls

Returns: boolean

---

isActiveWindow

▸ isActiveWindow(): boolean

Inherited from QMenu.isActiveWindow

Returns: boolean

---

isEnabled

▸ isEnabled(): boolean

Inherited from QMenu.isEnabled

Returns: boolean

---

isSliderDown

▸ isSliderDown(): boolean

Inherited from QAbstractSlider.isSliderDown

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

---

maximum

▸ maximum(): number

Inherited from QAbstractSlider.maximum

Returns: number

---

maximumSize

▸ maximumSize(): QSize

Inherited from QMenu.maximumSize

Returns: QSize

---

minimum

▸ minimum(): number

Inherited from QAbstractSlider.minimum

Returns: number

---

minimumSize

▸ minimumSize(): QSize

Inherited from QMenu.minimumSize

Returns: QSize

---

move

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

Inherited from QMenu.move

Parameters:

Name	Type
x	number
y	number

Returns: void

---

notchSize

▸ notchSize(): number

Returns: number

---

notchTarget

▸ notchTarget(): number

Returns: number

---

notchesVisible

▸ notchesVisible(): boolean

Returns: boolean

---

objectName

▸ objectName(): string

Inherited from NodeObject.objectName

Returns: string

---

orientation

▸ orientation(): Orientation

Inherited from QAbstractSlider.orientation

Returns: Orientation

---

pageStep

▸ pageStep(): number

Inherited from QAbstractSlider.pageStep

Returns: number

---

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

---

removeAction

▸ removeAction(action: QAction): void

Inherited from QMenu.removeAction

Parameters:

Name	Type
action	QAction

Returns: void

---

removeEventListener

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

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof QDialSignals

Parameters:

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

---

setAcceptDrops

▸ setAcceptDrops(on: boolean): void

Inherited from QMenu.setAcceptDrops

Parameters:

Name	Type
on	boolean

Returns: void

---

setAttribute

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

Inherited from QMenu.setAttribute

Parameters:

Name	Type
attribute	WidgetAttribute
switchOn	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

---

setEnabled

▸ setEnabled(enabled: boolean): void

Inherited from QMenu.setEnabled

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

---

setFixedSize

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

Inherited from QMenu.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

---

setFocus

▸ setFocus(reason: FocusReason): void

Inherited from QMenu.setFocus

Parameters:

Name	Type	Default
reason	FocusReason	FocusReason.OtherFocusReason

Returns: void

---

setFocusPolicy

▸ setFocusPolicy(policy: FocusPolicy): void

Inherited from QMenu.setFocusPolicy

Parameters:

Name	Type
policy	FocusPolicy

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

---

setGraphicsEffect

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

Inherited from QMenu.setGraphicsEffect

Parameters:

Name	Type
effect	QGraphicsEffect‹any›

Returns: void

---

setInlineStyle

▸ setInlineStyle(style: string): void

Inherited from QMenu.setInlineStyle

Parameters:

Name	Type
style	string

Returns: void

---

setInvertedAppearance

▸ setInvertedAppearance(inverted: boolean): void

Inherited from QAbstractSlider.setInvertedAppearance

Parameters:

Name	Type
inverted	boolean

Returns: void

---

setInvertedControls

▸ setInvertedControls(inverted: boolean): void

Inherited from QAbstractSlider.setInvertedControls

Parameters:

Name	Type
inverted	boolean

Returns: void

---

setLayout

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

Inherited from QMenu.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 QMenu.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 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

---

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

---

setPageStep

▸ setPageStep(step: number): void

Inherited from QAbstractSlider.setPageStep

Parameters:

Name	Type
step	number

Returns: void

---

setProperty

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

Inherited from NodeObject.setProperty

Parameters:

Name	Type
name	string
value	QVariantType

Returns: boolean

---

setRange

▸ setRange(min: number, max: number): void

Inherited from QAbstractSlider.setRange

Parameters:

Name	Type
min	number
max	number

Returns: void

---

setSingleStep

▸ setSingleStep(step: number): void

Inherited from QAbstractSlider.setSingleStep

Parameters:

Name	Type
step	number

Returns: void

---

setSliderDown

▸ setSliderDown(down: boolean): void

Inherited from QAbstractSlider.setSliderDown

Parameters:

Name	Type
down	boolean

Returns: void

---

setSliderPosition

▸ setSliderPosition(position: number): void

Inherited from QAbstractSlider.setSliderPosition

Parameters:

Name	Type
position	number

Returns: void

---

setStyleSheet

▸ setStyleSheet(styleSheet: string): void

Inherited from QMenu.setStyleSheet

Parameters:

Name	Type
styleSheet	string

Returns: void

---

setTracking

▸ setTracking(enable: boolean): void

Inherited from QAbstractSlider.setTracking

Parameters:

Name	Type
enable	boolean

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 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

---

setWrapping

▸ setWrapping(on: boolean): void

Parameters:

Name	Type
on	boolean

Returns: void

---

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

---

showMinimized

▸ showMinimized(): void

Inherited from QMenu.showMinimized

Returns: void

---

showNormal

▸ showNormal(): void

Inherited from QMenu.showNormal

Returns: void

---

singleStep

▸ singleStep(): number

Inherited from QAbstractSlider.singleStep

Returns: number

---

size

▸ size(): QSize

Inherited from QMenu.size

Returns: QSize

---

sliderPosition

▸ sliderPosition(): number

Inherited from QAbstractSlider.sliderPosition

Returns: number

---

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

---

triggerAction

▸ triggerAction(action: SliderAction): void

Inherited from QAbstractSlider.triggerAction

Parameters:

Name	Type
action	SliderAction

Returns: void

---

update

▸ update(): void

Inherited from QMenu.update

Returns: void

---

updateGeometry

▸ updateGeometry(): void

Inherited from QMenu.updateGeometry

Returns: void

---

value

▸ value(): number

Inherited from QAbstractSlider.value

Returns: number

---

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

---

wrapping

▸ wrapping(): boolean

Returns: boolean

---

x

▸ x(): number

Inherited from QMenu.x

Returns: number

---

y

▸ y(): number

Inherited from QMenu.y

Returns: number