nodeguy/website/docs/api/generated/classes/nodeobject.md
Atul R 392aa3cd4c
Adds automatic docs for now (#308)
* 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

5.6 KiB
Raw Blame History

id title sidebar_label
nodeobject NodeObject NodeObject

Type parameters

Signals: QObjectSignals

Hierarchy

EventWidgetSignals

NodeObject

QObject

QMovie

NodeLayout

YogaWidget

QAction

QSystemTrayIcon

QShortcut

Index

Constructors

Properties

Methods

Constructors

constructor

+ new NodeObject(native: NativeElement): NodeObject

Inherited from EventWidget.constructor

Parameters:

Name Type
native NativeElement

Returns: NodeObject

Properties

Abstract native

native: NativeElement

Inherited from Component.native


nodeChildren

nodeChildren: Setunknown = new Set()

Inherited from Component.nodeChildren


Optional nodeParent

nodeParent? : Component

Inherited from Component.nodeParent

Methods

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

Parameters:

Name Type
event? NativeElement

Returns: void


inherits

inherits(className: string): boolean

Parameters:

Name Type
className string

Returns: boolean


objectName

objectName(): string

Returns: string


property

property(name: string): QVariant

Parameters:

Name Type
name string

Returns: QVariant


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

Parameters:

Name Type
event? NativeElement

Returns: void


setNodeParent

setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

Name Type
parent? Component

Returns: void


setObjectName

setObjectName(objectName: string): void

Parameters:

Name Type
objectName string

Returns: void


setProperty

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

Parameters:

Name Type
name string
value QVariantType

Returns: boolean