website/docs/api/generated/globals.md
Ƭ FlexLayoutSignals: QLayoutSignals
Ƭ FlexNode: NativeRawPointer‹"YGNodeRef"›
Ƭ ImageFormats: "BMP" | "GIF" | "JPG" | "JPEG" | "PNG" | "PBM" | "PGM" | "PPM" | "XBM" | "XPM" | "SVG"
Ƭ JsWrapFunction: function
▸ (element: any): any
Parameters:
| Name | Type |
|---|---|
element | any |
Ƭ NativeElement: object
[ key: string]: any
type: "native"
Ƭ NativeRawPointer: Record‹T, unknown›
Ƭ QAbstractItemSignals: QObjectSignals
Ƭ QAbstractScrollAreaSignals: QFrameSignals
Ƭ QBoxLayoutSignals: QLayoutSignals
Ƭ QDialSignals: QAbstractSliderSignals
Ƭ QErrorMessageSignals: QDialogSignals
Ƭ QFrameSignals: QWidgetSignals
Ƭ QGridLayoutSignals: QLayoutSignals
Ƭ QHeaderViewSignals: QAbstractItemViewSignals
Ƭ QItemSelectionModelSignals: QObjectSignals
Ƭ QLayoutSignals: QObjectSignals
Ƭ QListViewSignals: QAbstractItemViewSignals
Ƭ QMainWindowSignals: QWidgetSignals
Ƭ QPushButtonSignals: QAbstractButtonSignals
Ƭ QRadioButtonSignals: QAbstractButtonSignals
Ƭ QScrollAreaSignals: QAbstractScrollAreaSignals
Ƭ QScrollBarSignals: QAbstractSliderSignals
Ƭ QSliderSignals: QAbstractSliderSignals
Ƭ QTableViewSignals: QAbstractItemViewSignals
Ƭ QVariantType: NativeElement | string | string[] | number | boolean | QRect
Ƭ SupportedFormats: "gif" | "webp"
Const COLS• COLS: 3 = 3
Const ROWS• ROWS: 2 = 2
Const addon• addon: any = require('../../../build/Release/nodegui_core.node')
Const centralWidget• centralWidget: QWidget‹QWidgetSignals› = new QWidget()
Const combobox• combobox: QComboBox‹› = new QComboBox()
Const currentIndexLabel• currentIndexLabel: QLabel‹› = new QLabel()
Const log• log: log = console.log.bind(console)
Const rootLayout• rootLayout: QBoxLayout‹› = new QBoxLayout(Direction.TopToBottom)
Const stackedLayout• stackedLayout: QStackedLayout‹› = new QStackedLayout()
Const testImagePath• testImagePath: string = path.resolve(__dirname, 'assets', 'nodegui.png')
Let win• win: QMainWindow = null
Const wrapperCache• wrapperCache: WrapperCache‹› = new WrapperCache()
▸ addDefaultErrorHandler(native: NativeElement, emitter: EventEmitter): void
Parameters:
| Name | Type |
|---|---|
native | NativeElement |
emitter | EventEmitter |
Returns: void
▸ checkIfNapiExternal(arg: any): boolean
Parameters:
| Name | Type |
|---|---|
arg | any |
Returns: boolean
▸ checkIfNativeElement(arg: any): arg is NativeElement
Parameters:
| Name | Type |
|---|---|
arg | any |
Returns: arg is NativeElement
Const createPage▸ createPage(text: string): QWidget‹QWidgetSignals›
Parameters:
| Name | Type |
|---|---|
text | string |
Returns: QWidget‹QWidgetSignals›
▸ createTreeWidget(): QTreeWidget
Returns: QTreeWidget
▸ delay(ms: number): Promise‹void›
Parameters:
| Name | Type |
|---|---|
ms | number |
Returns: Promise‹void›
▸ handleButtonClick(): void
Returns: void
▸ main(): void
Returns: void
▸ nativeObjectFromVariantType(obj: QVariantType): any
Get the correct native object which should be passed down to the C++ wrapper from a QVariantType object.
Parameters:
| Name | Type |
|---|---|
obj | QVariantType |
Returns: any
▸ noop(): void
Returns: void
▸ prepareInlineStyleSheet‹Signals›(widget: QWidget‹Signals›, rawStyle: string): string
Type parameters:
▪ Signals: QWidgetSignals
Parameters:
| Name | Type |
|---|---|
widget | QWidget‹Signals› |
rawStyle | string |
Returns: string
▸ registerNativeWrapFunction(wrapperTypeName: string, jsWrapFunction: JsWrapFunction): void
Register a function to wrap a specific Node API wrapper objects with a JS object.
Parameters:
| Name | Type | Description |
|---|---|---|
wrapperTypeName | string | the C++ wrapper type name the wrap function applies to. |
jsWrapFunction | JsWrapFunction | function to wrap a native wrapper to a JS wrapper object. |
Returns: void
▸ setLogCreateQObject(on: boolean): void
Turn on/off logging when QObjects are created.
Parameters:
| Name | Type | Description |
|---|---|---|
on | boolean | When true, logging is written to console when QObjects are created by NodeGui. |
Returns: void
▸ setLogDestroyQObject(on: boolean): void
Turn on/off logging when QObjects are destoryed.
Parameters:
| Name | Type | Description |
|---|---|---|
on | boolean | When true, logging is written to console when QObjects are destroyed. |
Returns: void
▸ wrapNative(native: any): any
Try to wrap a native Node object with its JS wrapper.
Parameters:
| Name | Type | Description |
|---|---|---|
native | any | the native object to wrap |
Returns: any
the JS object wrapping the native object or the native object if it couldn't be wrapped or doesn't need to be wrapped.
▸ wrapWithActivateUvLoop‹T›(func: T): T
Type parameters:
▪ T: Function
Parameters:
| Name | Type |
|---|---|
func | T |
Returns: T