nodeguy/website/docs/api/generated/globals.md
Atul R 2ceed980b4
adds test docs (#695)
* adds test docs

* update docs

* update api docs

* change to master
2020-09-19 20:12:08 +02:00

22 KiB
Raw Blame History

id title sidebar_label
globals @nodegui/nodegui Globals

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

FlexLayoutSignals

Ƭ FlexLayoutSignals: QLayoutSignals


FlexNode

Ƭ FlexNode: NativeRawPointer"YGNodeRef"


ImageFormats

Ƭ ImageFormats: "BMP" | "GIF" | "JPG" | "JPEG" | "PNG" | "PBM" | "PGM" | "PPM" | "XBM" | "XPM" | "SVG"


NativeElement

Ƭ NativeElement: object

Type declaration:

  •  **key**: *string*
  • type: "native"


NativeRawPointer

Ƭ NativeRawPointer: object

Type declaration:


QAbstractScrollAreaSignals

Ƭ QAbstractScrollAreaSignals: QFrameSignals


QApplicationSignals

Ƭ QApplicationSignals: QObjectSignals


QBoxLayoutSignals

Ƭ QBoxLayoutSignals: QLayoutSignals


QDialSignals

Ƭ QDialSignals: QAbstractSliderSignals


QErrorMessageSignals

Ƭ QErrorMessageSignals: QDialogSignals


QFrameSignals

Ƭ QFrameSignals: QWidgetSignals


QGridLayoutSignals

Ƭ QGridLayoutSignals: QLayoutSignals


QLayoutSignals

Ƭ QLayoutSignals: QObjectSignals


QListViewSignals

Ƭ QListViewSignals: QAbstractItemViewSignals


QMainWindowSignals

Ƭ QMainWindowSignals: QWidgetSignals


QMenuBarSignals

Ƭ QMenuBarSignals: QWidgetSignals


QMenuSignals

Ƭ QMenuSignals: QWidgetSignals


QPushButtonSignals

Ƭ QPushButtonSignals: QAbstractButtonSignals


QRadioButtonSignals

Ƭ QRadioButtonSignals: QAbstractButtonSignals


QScrollAreaSignals

Ƭ QScrollAreaSignals: QAbstractScrollAreaSignals


QScrollBarSignals

Ƭ QScrollBarSignals: QAbstractSliderSignals


QSliderSignals

Ƭ QSliderSignals: QAbstractSliderSignals


QTableViewSignals

Ƭ QTableViewSignals: QAbstractItemViewSignals


QVariantType

Ƭ QVariantType: NativeElement | string | number | boolean


SupportedFormats

Ƭ SupportedFormats: "gif" | "webp"

Variables

Const addon

addon: any = require('../../../build/Release/nodegui_core.node')


Const c1item1

c1item1: QTreeWidgetItem = new QTreeWidgetItem(item1)


Const c1item2

c1item2: QTreeWidgetItem = new QTreeWidgetItem(item1)


Const columnFour

columnFour: QLabel = new QLabel()


Const columnOne

columnOne: QLabel = new QLabel()


Const columnThree

columnThree: QLabel = new QLabel()


Const columnTwo

columnTwo: QLabel = new QLabel()


Const icon

icon: QIcon = new QIcon(myImage)


Const item1

item1: QTreeWidgetItem = new QTreeWidgetItem()


Const item2

item2: QTreeWidgetItem = new QTreeWidgetItem()


Const item3

item3: QTreeWidgetItem = new QTreeWidgetItem()


Const item4

item4: QTreeWidgetItem = new QTreeWidgetItem()


Const item5

item5: QTreeWidgetItem = new QTreeWidgetItem()


Const item6

item6: QTreeWidgetItem = new QTreeWidgetItem()


Const myImage

myImage: "./website/static/img/logo.png" = "./website/static/img/logo.png"


Const outer

outer: QWidget = new QWidget()


Const outerLayout

outerLayout: QGridLayout = new QGridLayout()


Const testImagePath

testImagePath: string = path.resolve(__dirname, 'assets', 'nodegui.png')


Const tree

tree: QTreeWidget = new QTreeWidget()


Const win

win: QMainWindow = new QMainWindow()

Functions

addDefaultErrorHandler

addDefaultErrorHandler(native: NativeElement, emitter: EventEmitter): void

Parameters:

Name Type
native NativeElement
emitter EventEmitter

Returns: void


checkIfNapiExternal

checkIfNapiExternal(arg: any): boolean

Parameters:

Name Type
arg any

Returns: boolean


checkIfNativeElement

checkIfNativeElement(arg: any): boolean

Parameters:

Name Type
arg any

Returns: boolean


createTreeWidget

createTreeWidget(): QTreeWidget

Returns: QTreeWidget


main

main(): void

Returns: void


noop

noop(): void

Returns: void


prepareInlineStyleSheet

prepareInlineStyleSheetSignals(widget: NodeWidgetSignals, rawStyle: string): string

Type parameters:

Signals: QWidgetSignals

Parameters:

Name Type
widget NodeWidgetSignals
rawStyle string

Returns: string


wrapWithActivateUvLoop

wrapWithActivateUvLoopT(func: T): T

Type parameters:

T: Function

Parameters:

Name Type
func T

Returns: T