nodeguy/qprogressbar.md at 392aa3cd4c3f69a0401131beeec14394dec24d1e

* adds basic typedoc

* backup

* Adds all docs to source code

* Adds autogenerated docs

* Fixes doc links

* Updates docs

2019-12-29 00:42:06 +05:30

20 KiB

Raw Blame History

id	title	sidebar_label
qprogressbar	QProgressBar	QProgressBar

Create and control progress bar widgets.

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

A QProgressBar provides ability to add and manipulate native progress bar widgets.

Example

const { QProgressBar } = require("@nodegui/nodegui");

const progressBar = new QProgressBar();

Hierarchy

↳ NodeWidget‹QProgressBarSignals›

↳ QProgressBar

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

+ new QProgressBar(): QProgressBar

Overrides EventWidget.constructor

Returns: QProgressBar

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

Overrides EventWidget.constructor

Parameters:

Name	Type
`parent`	NodeWidget‹any›

Returns: QProgressBar

Properties

_rawInlineStyle

• _rawInlineStyle: string = ""

Inherited from NodeWidget._rawInlineStyle

`Optional` layout

• layout? : NodeLayout‹QProgressBarSignals›

Inherited from NodeWidget.layout

native

• native: NativeElement

Overrides Component.native

nodeChildren

• nodeChildren: Set‹unknown› = new Set()

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 QProgressBarSignals

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?: NativeElement): void

Parameters:

Name	Type
`event?`	NativeElement

Returns: void

adjustSize

▸ adjustSize(): void

Inherited from NodeWidget.adjustSize

Returns: void

close

▸ close(): boolean

Inherited from NodeWidget.close

Returns: boolean

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

move

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

Inherited from NodeWidget.move

Parameters:

Name	Type
`x`	number
`y`	number

Returns: void

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 QProgressBarSignals

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?: NativeElement): void

Parameters:

Name	Type
`event?`	NativeElement

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

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‹QProgressBarSignals›): void

Inherited from NodeWidget.setLayout

Parameters:

Name	Type
`parentLayout`	NodeLayout‹QProgressBarSignals›

Returns: void

setMaximum

▸ setMaximum(max: number): void

Parameters:

Name	Type
`max`	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(min: number): void

Parameters:

Name	Type
`min`	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

setObjectName

▸ setObjectName(objectName: string): void

Inherited from NodeWidget.setObjectName

Overrides NodeObject.setObjectName

Parameters:

Name	Type
`objectName`	string

Returns: void

setOrientation

▸ setOrientation(orientation: Orientation): void

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

setStyleSheet

▸ setStyleSheet(styleSheet: string): void

Inherited from NodeWidget.setStyleSheet

Parameters:

Name	Type
`styleSheet`	string

Returns: void

setValue

▸ setValue(value: number): void

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

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

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

20 KiB Raw Blame History Unescape Escape

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_rawInlineStyle

Optional layout

native

nodeChildren

Optional nodeParent

type

Methods

activateWindow

addEventListener

adjustSize

close

geometry

getFlexNode

hasMouseTracking

hide

inherits

isEnabled

isVisible

lower

move

objectName

pos

property

raise

removeEventListener

repaint

resize

setAttribute

setContextMenuPolicy

setCursor

setEnabled

setFixedSize

setFlexNodeSizeControlled

setGeometry

setInlineStyle

setLayout

setMaximum

setMaximumSize

setMinimum

setMinimumSize

setMouseTracking

setNodeParent

setObjectName

setOrientation

setProperty

setStyleSheet

setValue

setWindowFlag

setWindowIcon

setWindowOpacity

setWindowState

setWindowTitle

show

showFullScreen

showMaximized

showMinimized

showNormal

size

styleSheet

testAttribute

update

updateGeometry

value

windowOpacity

windowState

windowTitle

20 KiB

Raw Blame History

`Optional` layout

`Optional` nodeParent