@nodegui/nodegui
Index
Enumerations
- AcceptMode
- AlignmentFlag
- AnchorPoint
- ApplicationAttribute
- ApplicationState
- ArrowType
- AspectRatioMode
- AutoFormattingFlag
- Axis
- BGMode
- BlurHint
- BrushStyle
- ButtonPosition
- ButtonRole
- ButtonSymbols
- CacheMode
- CaseSensitivity
- CheckState
- ChecksumType
- ClipOperation
- ColorDialogOption
- ColorGroup
- ColorRole
- ComponentFormattingOption
- CompositionMode
- ConnectionType
- ContextMenuPolicy
- CoordinateSystem
- Corner
- CorrectionMode
- CursorMoveStyle
- CursorShape
- DateFormat
- DayOfWeek
- DialogCode
- DialogLabel
- Direction
- DockWidgetArea
- DragDropMode
- DropAction
- EchoMode
- Edge
- EditTrigger
- EnterKeyType
- EventPriority
- FileMode
- FillRule
- FindChildOption
- Flow
- FocusPolicy
- FocusReason
- FontDialogOption
- GestureFlag
- GestureState
- GestureType
- GlobalColor
- HitTestAccuracy
- HorizontalHeaderFormat
- ImageConversionFlag
- ImageReaderError
- InputDialogOptions
- InputMethodHint
- InputMethodQuery
- InputMode
- InsertPolicy
- ItemDataRole
- ItemFlag
- ItemSelectionMode
- ItemSelectionOperation
- Key
- KeyboardModifier
- LayoutDirection
- LayoutMode
- LineWrapMode
- ListViewMode
- MaskMode
- MatchFlag
- Mode
- Modifier
- MouseButton
- MouseEventFlag
- MouseEventSource
- Movement
- MovieState
- NativeGestureType
- NavigationMode
- Option
- Orientation
- ParsingMode
- PenCapStyle
- PenStyle
- PointerType
- QAbstractItemViewSelectionBehavior
- QClipboardMode
- QFontCapitalization
- QFontStretch
- QFontWeight
- QHeaderViewResizeMode
- QIconMode
- QIconState
- QImageFormat
- QImageInvertMode
- QMessageBoxIcon
- QProgressBarDirection
- QSettingsFormat
- QSettingsScope
- QSizePolicyPolicy
- QSizePolicyPolicyFlag
- QStylePixelMetric
- QSystemTrayIconActivationReason
- QTextEditLineWrapMode
- QTextOptionWrapMode
- RenderHint
- ResizeMode
- ScreenOrientation
- ScrollBarPolicy
- ScrollHint
- ScrollMode
- ScrollPhase
- SegmentStyle
- SelectionBehavior
- SelectionFlag
- SelectionMode
- SequenceFormat
- SequenceMatch
- Shadow
- Shape
- ShortcutContext
- SizeAdjustPolicy
- SizeConstraint
- SizeHint
- SizeMode
- SliderAction
- SortOrder
- StackingMode
- StepType
- SystemFont
- TabBarShape
- TabFocusBehavior
- TabPosition
- TabletDevice
- TextElideMode
- TextFlag
- TextFormat
- TextInteractionFlag
- TickPosition
- TileRule
- TimeSpec
- TimerType
- ToolBarArea
- ToolButtonPopupMode
- ToolButtonStyle
- TouchPointState
- TransformationMode
- UIEffect
- UrlFormattingOption
- UserInputResolutionOption
- VerticalHeaderFormat
- ViewMode
- Visibility
- WhiteSpaceMode
- WidgetAttribute
- WidgetEventTypes
- WindowFrameSection
- WindowModality
- WindowState
- WindowType
- WrapMode
- WritingSystem
Classes
- CacheTestQObject
- Component
- EventWidget
- FlexLayout
- MyModel
- QAbstractButton
- QAbstractItemDelegate
- QAbstractItemModel
- QAbstractItemView
- QAbstractScrollArea
- QAbstractSlider
- QAbstractSpinBox
- QAbstractTableModel
- QAction
- QApplication
- QBoxLayout
- QBrush
- QButtonGroup
- QCalendarWidget
- QCheckBox
- QClipboard
- QColor
- QColorDialog
- QComboBox
- QCursor
- QDate
- QDateEdit
- QDateTime
- QDateTimeEdit
- QDial
- QDialog
- QDoubleSpinBox
- QDrag
- QDragEnterEvent
- QDragLeaveEvent
- QDragMoveEvent
- QDropEvent
- QErrorMessage
- QEvent
- QFileDialog
- QFont
- QFontDatabase
- QFontDialog
- QFontMetrics
- QFontMetricsF
- QFrame
- QGraphicsBlurEffect
- QGraphicsDropShadowEffect
- QGraphicsEffect
- QGridLayout
- QGroupBox
- QHeaderView
- QIcon
- QImage
- QInputDialog
- QInputEvent
- QInputMethodEvent
- QInputMethodQueryEvent
- QItemSelectionModel
- QKeyEvent
- QKeySequence
- QLCDNumber
- QLabel
- QLayout
- QLineEdit
- QListView
- QListWidget
- QListWidgetItem
- QMainWindow
- QMenu
- QMenuBar
- QMessageBox
- QMimeData
- QModelIndex
- QMouseEvent
- QMoveEvent
- QMovie
- QNativeGestureEvent
- QObject
- QPaintEvent
- QPainter
- QPainterPath
- QPalette
- QPen
- QPicture
- QPixmap
- QPlainTextEdit
- QPoint
- QPointF
- QProgressBar
- QProgressDialog
- QPushButton
- QRadioButton
- QRect
- QRectF
- QResizeEvent
- QScreen
- QScrollArea
- QScrollBar
- QSettings
- QShortcut
- QSize
- QSizeF
- QSlider
- QSpinBox
- QSplitter
- QStackedLayout
- QStackedWidget
- QStandardItem
- QStandardItemModel
- QStatusBar
- QStyle
- QStyleFactory
- QSvgWidget
- QSystemTrayIcon
- QTabBar
- QTabWidget
- QTableView
- QTableWidget
- QTableWidgetItem
- QTabletEvent
- QTextBrowser
- QTextEdit
- QTime
- QTimeEdit
- QTimerEvent
- QToolButton
- QTreeWidget
- QTreeWidgetItem
- QUrl
- QVariant
- QWheelEvent
- QWidget
- QWindow
- StyleSheet
- WrapperCache
- YogaWidget
Interfaces
- EventListenerOptions
- Margins
- QAbstractButtonSignals
- QAbstractItemViewSignals
- QAbstractSliderSignals
- QAbstractSpinBoxSignals
- QActionSignals
- QApplicationSignals
- QButtonGroupSignals
- QCalendarWidgetSignals
- QCheckBoxSignals
- QClipboardSignals
- QColorDialogSignals
- QComboBoxSignals
- QDateTimeEditSignals
- QDialogSignals
- QDoubleSpinBoxSignals
- QFileDialogSignals
- QFontDialogSignals
- QGraphicsBlurEffectSignals
- QGraphicsDropShadowEffectSignals
- QGraphicsEffectSignals
- QGroupBoxSignals
- QInputDialogSignals
- QLCDNumberSignals
- QLabelSignals
- QLineEditSignals
- QListWidgetSignals
- QMenuBarSignals
- QMenuSignals
- QMessageBoxSignals
- QMovieSignals
- QObjectSignals
- QPlainTextEditSignals
- QProgressBarSignals
- QProgressDialogSignals
- QScreenSignals
- QShortcutSignals
- QSpinBoxSignals
- QSplitterSignals
- QStackedLayoutSignals
- QStackedWidgetSignals
- QStandardItemModelSignals
- QStatusBarSignals
- QSystemTrayIconSignals
- QTabBarSignals
- QTabWidgetSignals
- QTableWidgetSignals
- QTextBrowserSignals
- QTextEditSignals
- QToolButtonSignals
- QTreeWidgetSignals
- QWidgetSignals
- QWindowSignals
- Range
Type aliases
- FlexLayoutSignals
- FlexNode
- ImageFormats
- JsWrapFunction
- NativeElement
- NativeRawPointer
- QAbstractItemSignals
- QAbstractScrollAreaSignals
- QBoxLayoutSignals
- QDialSignals
- QErrorMessageSignals
- QFrameSignals
- QGridLayoutSignals
- QHeaderViewSignals
- QItemSelectionModelSignals
- QLayoutSignals
- QListViewSignals
- QMainWindowSignals
- QPushButtonSignals
- QRadioButtonSignals
- QScrollAreaSignals
- QScrollBarSignals
- QSliderSignals
- QTableViewSignals
- QVariantType
- SupportedFormats
Variables
- COLS
- ROWS
- addon
- centralWidget
- combobox
- currentIndexLabel
- nativeWrapperRegistry
- rootLayout
- stackedLayout
- testImagePath
- win
- wrapperCache
Functions
- addDefaultErrorHandler
- checkIfNapiExternal
- checkIfNativeElement
- createPage
- createTreeWidget
- main
- nativeObjectFromVariantType
- noop
- prepareInlineStyleSheet
- registerNativeWrapFunction
- setLogCreateQObject
- setLogDestroyQObject
- wrapNative
- wrapWithActivateUvLoop
Type aliases
FlexLayoutSignals
Ƭ FlexLayoutSignals: QLayoutSignals
FlexNode
Ƭ FlexNode: NativeRawPointer‹"YGNodeRef"›
ImageFormats
Ƭ ImageFormats: "BMP" | "GIF" | "JPG" | "JPEG" | "PNG" | "PBM" | "PGM" | "PPM" | "XBM" | "XPM" | "SVG"
JsWrapFunction
Ƭ JsWrapFunction: function
Type declaration:
â–¸ (element: any): any
Parameters:
| Name | Type |
|---|---|
element | any |
NativeElement
Ƭ NativeElement: object
Type declaration:
[ key: string]: any
type: "native"
NativeRawPointer
Ƭ NativeRawPointer: Record‹T, unknown›
QAbstractItemSignals
Ƭ QAbstractItemSignals: QObjectSignals
QAbstractScrollAreaSignals
Ƭ QAbstractScrollAreaSignals: QFrameSignals
QBoxLayoutSignals
Ƭ QBoxLayoutSignals: QLayoutSignals
QDialSignals
Ƭ QDialSignals: QAbstractSliderSignals
QErrorMessageSignals
Ƭ QErrorMessageSignals: QDialogSignals
QFrameSignals
Ƭ QFrameSignals: QWidgetSignals
QGridLayoutSignals
Ƭ QGridLayoutSignals: QLayoutSignals
QHeaderViewSignals
Ƭ QHeaderViewSignals: QAbstractItemViewSignals
QItemSelectionModelSignals
Ƭ QItemSelectionModelSignals: QObjectSignals
QLayoutSignals
Ƭ QLayoutSignals: QObjectSignals
QListViewSignals
Ƭ QListViewSignals: QAbstractItemViewSignals
QMainWindowSignals
Ƭ QMainWindowSignals: QWidgetSignals
QPushButtonSignals
Ƭ QPushButtonSignals: QAbstractButtonSignals
QRadioButtonSignals
Ƭ QRadioButtonSignals: QAbstractButtonSignals
QScrollAreaSignals
Ƭ QScrollAreaSignals: QAbstractScrollAreaSignals
QScrollBarSignals
Ƭ QScrollBarSignals: QAbstractSliderSignals
QSliderSignals
Ƭ QSliderSignals: QAbstractSliderSignals
QTableViewSignals
Ƭ QTableViewSignals: QAbstractItemViewSignals
QVariantType
Ƭ QVariantType: NativeElement | string | string[] | number | boolean | QRect
SupportedFormats
Ƭ SupportedFormats: "gif" | "webp"
Variables
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 nativeWrapperRegistry
• nativeWrapperRegistry: Map‹string, function› = new Map<string, JsWrapFunction>()
Const rootLayout
• rootLayout: QBoxLayout‹› = new QBoxLayout(Direction.TopToBottom)
Const stackedLayout
• stackedLayout: QStackedLayout‹› = new QStackedLayout()
Const testImagePath
• testImagePath: string = path.resolve(__dirname, 'assets', 'nodegui.png')
Const win
• win: QMainWindow‹› = new QMainWindow()
Const wrapperCache
• wrapperCache: WrapperCache‹› = new WrapperCache()
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): 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
â–¸ createTreeWidget(): QTreeWidget
Returns: QTreeWidget
main
â–¸ main(): void
Returns: void
nativeObjectFromVariantType
â–¸ 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
â–¸ noop(): void
Returns: void
prepareInlineStyleSheet
▸ prepareInlineStyleSheet‹Signals›(widget: QWidget‹Signals›, rawStyle: string): string
Type parameters:
â–ª Signals: QWidgetSignals
Parameters:
| Name | Type |
|---|---|
widget | QWidget‹Signals› |
rawStyle | string |
Returns: string
registerNativeWrapFunction
â–¸ 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
â–¸ 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
â–¸ 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
â–¸ 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
▸ wrapWithActivateUvLoop‹T›(func: T): T
Type parameters:
â–ª T: Function
Parameters:
| Name | Type |
|---|---|
func | T |
Returns: T