392aa3cd4c
* adds basic typedoc * backup * Adds all docs to source code * Adds autogenerated docs * Fixes doc links * Updates docs
377 lines
11 KiB
Markdown
377 lines
11 KiB
Markdown
---
|
||
id: "globals"
|
||
title: "@nodegui/nodegui"
|
||
sidebar_label: "Globals"
|
||
---
|
||
|
||
## Index
|
||
|
||
### Enumerations
|
||
|
||
* [AcceptMode](enums/acceptmode.md)
|
||
* [AlignmentFlag](enums/alignmentflag.md)
|
||
* [AnchorPoint](enums/anchorpoint.md)
|
||
* [ApplicationAttribute](enums/applicationattribute.md)
|
||
* [ApplicationState](enums/applicationstate.md)
|
||
* [ArrowType](enums/arrowtype.md)
|
||
* [AspectRatioMode](enums/aspectratiomode.md)
|
||
* [Axis](enums/axis.md)
|
||
* [BGMode](enums/bgmode.md)
|
||
* [BrushStyle](enums/brushstyle.md)
|
||
* [CacheMode](enums/cachemode.md)
|
||
* [CaseSensitivity](enums/casesensitivity.md)
|
||
* [CheckState](enums/checkstate.md)
|
||
* [ChecksumType](enums/checksumtype.md)
|
||
* [ClipOperation](enums/clipoperation.md)
|
||
* [ConnectionType](enums/connectiontype.md)
|
||
* [ContextMenuPolicy](enums/contextmenupolicy.md)
|
||
* [CoordinateSystem](enums/coordinatesystem.md)
|
||
* [Corner](enums/corner.md)
|
||
* [CursorMoveStyle](enums/cursormovestyle.md)
|
||
* [CursorShape](enums/cursorshape.md)
|
||
* [DateFormat](enums/dateformat.md)
|
||
* [DayOfWeek](enums/dayofweek.md)
|
||
* [DialogLabel](enums/dialoglabel.md)
|
||
* [Direction](enums/direction.md)
|
||
* [DockWidgetArea](enums/dockwidgetarea.md)
|
||
* [DropAction](enums/dropaction.md)
|
||
* [EchoMode](enums/echomode.md)
|
||
* [Edge](enums/edge.md)
|
||
* [EnterKeyType](enums/enterkeytype.md)
|
||
* [EventPriority](enums/eventpriority.md)
|
||
* [FileMode](enums/filemode.md)
|
||
* [FillRule](enums/fillrule.md)
|
||
* [FindChildOption](enums/findchildoption.md)
|
||
* [FocusPolicy](enums/focuspolicy.md)
|
||
* [FocusReason](enums/focusreason.md)
|
||
* [GestureFlag](enums/gestureflag.md)
|
||
* [GestureState](enums/gesturestate.md)
|
||
* [GestureType](enums/gesturetype.md)
|
||
* [GlobalColor](enums/globalcolor.md)
|
||
* [HitTestAccuracy](enums/hittestaccuracy.md)
|
||
* [ImageConversionFlag](enums/imageconversionflag.md)
|
||
* [ImageReaderError](enums/imagereadererror.md)
|
||
* [InputMethodHint](enums/inputmethodhint.md)
|
||
* [InputMethodQuery](enums/inputmethodquery.md)
|
||
* [InsertPolicy](enums/insertpolicy.md)
|
||
* [ItemDataRole](enums/itemdatarole.md)
|
||
* [ItemFlag](enums/itemflag.md)
|
||
* [ItemSelectionMode](enums/itemselectionmode.md)
|
||
* [ItemSelectionOperation](enums/itemselectionoperation.md)
|
||
* [Key](enums/key.md)
|
||
* [KeyboardModifier](enums/keyboardmodifier.md)
|
||
* [LayoutDirection](enums/layoutdirection.md)
|
||
* [LineWrapMode](enums/linewrapmode.md)
|
||
* [MaskMode](enums/maskmode.md)
|
||
* [MatchFlag](enums/matchflag.md)
|
||
* [Modifier](enums/modifier.md)
|
||
* [MouseButton](enums/mousebutton.md)
|
||
* [MouseEventFlag](enums/mouseeventflag.md)
|
||
* [MouseEventSource](enums/mouseeventsource.md)
|
||
* [MovieState](enums/moviestate.md)
|
||
* [NativeGestureType](enums/nativegesturetype.md)
|
||
* [NavigationMode](enums/navigationmode.md)
|
||
* [Option](enums/option.md)
|
||
* [Orientation](enums/orientation.md)
|
||
* [ParsingMode](enums/parsingmode.md)
|
||
* [PenStyle](enums/penstyle.md)
|
||
* [QClipboardMode](enums/qclipboardmode.md)
|
||
* [QIconMode](enums/qiconmode.md)
|
||
* [QIconState](enums/qiconstate.md)
|
||
* [QStylePixelMetric](enums/qstylepixelmetric.md)
|
||
* [QSystemTrayIconActivationReason](enums/qsystemtrayiconactivationreason.md)
|
||
* [QTextOptionWrapMode](enums/qtextoptionwrapmode.md)
|
||
* [RenderHint](enums/renderhint.md)
|
||
* [ScreenOrientation](enums/screenorientation.md)
|
||
* [ScrollBarPolicy](enums/scrollbarpolicy.md)
|
||
* [ScrollHint](enums/scrollhint.md)
|
||
* [ScrollPhase](enums/scrollphase.md)
|
||
* [ShortcutContext](enums/shortcutcontext.md)
|
||
* [SizeAdjustPolicy](enums/sizeadjustpolicy.md)
|
||
* [SizeHint](enums/sizehint.md)
|
||
* [SizeMode](enums/sizemode.md)
|
||
* [SortOrder](enums/sortorder.md)
|
||
* [SystemFont](enums/systemfont.md)
|
||
* [TabFocusBehavior](enums/tabfocusbehavior.md)
|
||
* [TabPosition](enums/tabposition.md)
|
||
* [TextElideMode](enums/textelidemode.md)
|
||
* [TextFlag](enums/textflag.md)
|
||
* [TextFormat](enums/textformat.md)
|
||
* [TextInteractionFlag](enums/textinteractionflag.md)
|
||
* [TileRule](enums/tilerule.md)
|
||
* [TimeSpec](enums/timespec.md)
|
||
* [TimerType](enums/timertype.md)
|
||
* [ToolBarArea](enums/toolbararea.md)
|
||
* [ToolButtonPopupMode](enums/toolbuttonpopupmode.md)
|
||
* [ToolButtonStyle](enums/toolbuttonstyle.md)
|
||
* [TouchPointState](enums/touchpointstate.md)
|
||
* [TransformationMode](enums/transformationmode.md)
|
||
* [UIEffect](enums/uieffect.md)
|
||
* [ViewMode](enums/viewmode.md)
|
||
* [WhiteSpaceMode](enums/whitespacemode.md)
|
||
* [WidgetAttribute](enums/widgetattribute.md)
|
||
* [WidgetEventTypes](enums/widgeteventtypes.md)
|
||
* [WindowFrameSection](enums/windowframesection.md)
|
||
* [WindowModality](enums/windowmodality.md)
|
||
* [WindowState](enums/windowstate.md)
|
||
* [WindowType](enums/windowtype.md)
|
||
* [WritingSystem](enums/writingsystem.md)
|
||
|
||
### Classes
|
||
|
||
* [Component](classes/component.md)
|
||
* [EventWidget](classes/eventwidget.md)
|
||
* [FlexLayout](classes/flexlayout.md)
|
||
* [NodeLayout](classes/nodelayout.md)
|
||
* [NodeObject](classes/nodeobject.md)
|
||
* [NodeWidget](classes/nodewidget.md)
|
||
* [QAbstractButton](classes/qabstractbutton.md)
|
||
* [QAbstractScrollArea](classes/qabstractscrollarea.md)
|
||
* [QAbstractSlider](classes/qabstractslider.md)
|
||
* [QAction](classes/qaction.md)
|
||
* [QApplication](classes/qapplication.md)
|
||
* [QBoxLayout](classes/qboxlayout.md)
|
||
* [QCheckBox](classes/qcheckbox.md)
|
||
* [QClipboard](classes/qclipboard.md)
|
||
* [QColor](classes/qcolor.md)
|
||
* [QComboBox](classes/qcombobox.md)
|
||
* [QCursor](classes/qcursor.md)
|
||
* [QDial](classes/qdial.md)
|
||
* [QFileDialog](classes/qfiledialog.md)
|
||
* [QFontDatabase](classes/qfontdatabase.md)
|
||
* [QGridLayout](classes/qgridlayout.md)
|
||
* [QGroupBox](classes/qgroupbox.md)
|
||
* [QIcon](classes/qicon.md)
|
||
* [QKeyEvent](classes/qkeyevent.md)
|
||
* [QKeySequence](classes/qkeysequence.md)
|
||
* [QLabel](classes/qlabel.md)
|
||
* [QLineEdit](classes/qlineedit.md)
|
||
* [QMainWindow](classes/qmainwindow.md)
|
||
* [QMenu](classes/qmenu.md)
|
||
* [QMenuBar](classes/qmenubar.md)
|
||
* [QMouseEvent](classes/qmouseevent.md)
|
||
* [QMovie](classes/qmovie.md)
|
||
* [QObject](classes/qobject.md)
|
||
* [QPainter](classes/qpainter.md)
|
||
* [QPixmap](classes/qpixmap.md)
|
||
* [QPlainTextEdit](classes/qplaintextedit.md)
|
||
* [QPoint](classes/qpoint.md)
|
||
* [QProgressBar](classes/qprogressbar.md)
|
||
* [QPushButton](classes/qpushbutton.md)
|
||
* [QRadioButton](classes/qradiobutton.md)
|
||
* [QRect](classes/qrect.md)
|
||
* [QScrollArea](classes/qscrollarea.md)
|
||
* [QShortcut](classes/qshortcut.md)
|
||
* [QSize](classes/qsize.md)
|
||
* [QSpinBox](classes/qspinbox.md)
|
||
* [QStackedWidget](classes/qstackedwidget.md)
|
||
* [QStyle](classes/qstyle.md)
|
||
* [QSystemTrayIcon](classes/qsystemtrayicon.md)
|
||
* [QTabWidget](classes/qtabwidget.md)
|
||
* [QTableWidget](classes/qtablewidget.md)
|
||
* [QTableWidgetItem](classes/qtablewidgetitem.md)
|
||
* [QToolButton](classes/qtoolbutton.md)
|
||
* [QTreeWidget](classes/qtreewidget.md)
|
||
* [QTreeWidgetItem](classes/qtreewidgetitem.md)
|
||
* [QUrl](classes/qurl.md)
|
||
* [QVariant](classes/qvariant.md)
|
||
* [QWidget](classes/qwidget.md)
|
||
* [StyleSheet](classes/stylesheet.md)
|
||
* [YogaWidget](classes/yogawidget.md)
|
||
|
||
### Interfaces
|
||
|
||
* [QAbstractButtonSignals](interfaces/qabstractbuttonsignals.md)
|
||
* [QAbstractSliderSignals](interfaces/qabstractslidersignals.md)
|
||
* [QActionSignals](interfaces/qactionsignals.md)
|
||
* [QComboBoxSignals](interfaces/qcomboboxsignals.md)
|
||
* [QFileDialogSignals](interfaces/qfiledialogsignals.md)
|
||
* [QGroupBoxSignals](interfaces/qgroupboxsignals.md)
|
||
* [QLineEditSignals](interfaces/qlineeditsignals.md)
|
||
* [QMovieSignals](interfaces/qmoviesignals.md)
|
||
* [QObjectSignals](interfaces/qobjectsignals.md)
|
||
* [QPlainTextEditSignals](interfaces/qplaintexteditsignals.md)
|
||
* [QProgressBarSignals](interfaces/qprogressbarsignals.md)
|
||
* [QShortcutSignals](interfaces/qshortcutsignals.md)
|
||
* [QSpinBoxSignals](interfaces/qspinboxsignals.md)
|
||
* [QStackedWidgetSignals](interfaces/qstackedwidgetsignals.md)
|
||
* [QSystemTrayIconSignals](interfaces/qsystemtrayiconsignals.md)
|
||
* [QTabWidgetSignals](interfaces/qtabwidgetsignals.md)
|
||
* [QTableWidgetSignals](interfaces/qtablewidgetsignals.md)
|
||
* [QToolButtonSignals](interfaces/qtoolbuttonsignals.md)
|
||
* [QTreeWidgetSignals](interfaces/qtreewidgetsignals.md)
|
||
* [QWidgetSignals](interfaces/qwidgetsignals.md)
|
||
|
||
### Type aliases
|
||
|
||
* [FlexLayoutSignals](globals.md#flexlayoutsignals)
|
||
* [FlexNode](globals.md#flexnode)
|
||
* [ImageFormats](globals.md#imageformats)
|
||
* [NativeElement](globals.md#nativeelement)
|
||
* [QAbstractScrollAreaSignals](globals.md#qabstractscrollareasignals)
|
||
* [QBoxLayoutSignals](globals.md#qboxlayoutsignals)
|
||
* [QCheckBoxSignals](globals.md#qcheckboxsignals)
|
||
* [QDialSignals](globals.md#qdialsignals)
|
||
* [QGridLayoutSignals](globals.md#qgridlayoutsignals)
|
||
* [QLabelSignals](globals.md#qlabelsignals)
|
||
* [QLayoutSignals](globals.md#qlayoutsignals)
|
||
* [QMainWindowSignals](globals.md#qmainwindowsignals)
|
||
* [QMenuBarSignals](globals.md#qmenubarsignals)
|
||
* [QMenuSignals](globals.md#qmenusignals)
|
||
* [QPushButtonSignals](globals.md#qpushbuttonsignals)
|
||
* [QRadioButtonSignals](globals.md#qradiobuttonsignals)
|
||
* [QScrollAreaSignals](globals.md#qscrollareasignals)
|
||
* [QVariantType](globals.md#qvarianttype)
|
||
|
||
### Functions
|
||
|
||
* [checkIfNativeElement](globals.md#checkifnativeelement)
|
||
* [prepareInlineStyleSheet](globals.md#prepareinlinestylesheet)
|
||
|
||
## Type aliases
|
||
|
||
### FlexLayoutSignals
|
||
|
||
Ƭ **FlexLayoutSignals**: *[QLayoutSignals](globals.md#qlayoutsignals)*
|
||
|
||
___
|
||
|
||
### FlexNode
|
||
|
||
Ƭ **FlexNode**: *object*
|
||
|
||
#### Type declaration:
|
||
|
||
___
|
||
|
||
### ImageFormats
|
||
|
||
Ƭ **ImageFormats**: *"BMP" | "GIF" | "JPG" | "JPEG" | "PNG" | "PBM" | "PGM" | "PPM" | "XBM" | "XPM" | "SVG"*
|
||
|
||
___
|
||
|
||
### NativeElement
|
||
|
||
Ƭ **NativeElement**: *object*
|
||
|
||
#### Type declaration:
|
||
|
||
* \[ **key**: *string*\]: any
|
||
|
||
___
|
||
|
||
### QAbstractScrollAreaSignals
|
||
|
||
Ƭ **QAbstractScrollAreaSignals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)*
|
||
|
||
___
|
||
|
||
### QBoxLayoutSignals
|
||
|
||
Ƭ **QBoxLayoutSignals**: *[QLayoutSignals](globals.md#qlayoutsignals)*
|
||
|
||
___
|
||
|
||
### QCheckBoxSignals
|
||
|
||
Ƭ **QCheckBoxSignals**: *[QAbstractButtonSignals](interfaces/qabstractbuttonsignals.md)*
|
||
|
||
___
|
||
|
||
### QDialSignals
|
||
|
||
Ƭ **QDialSignals**: *[QAbstractSliderSignals](interfaces/qabstractslidersignals.md)*
|
||
|
||
___
|
||
|
||
### QGridLayoutSignals
|
||
|
||
Ƭ **QGridLayoutSignals**: *[QLayoutSignals](globals.md#qlayoutsignals)*
|
||
|
||
___
|
||
|
||
### QLabelSignals
|
||
|
||
Ƭ **QLabelSignals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)*
|
||
|
||
___
|
||
|
||
### QLayoutSignals
|
||
|
||
Ƭ **QLayoutSignals**: *[QObjectSignals](interfaces/qobjectsignals.md)*
|
||
|
||
___
|
||
|
||
### QMainWindowSignals
|
||
|
||
Ƭ **QMainWindowSignals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)*
|
||
|
||
___
|
||
|
||
### QMenuBarSignals
|
||
|
||
Ƭ **QMenuBarSignals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)*
|
||
|
||
___
|
||
|
||
### QMenuSignals
|
||
|
||
Ƭ **QMenuSignals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)*
|
||
|
||
___
|
||
|
||
### QPushButtonSignals
|
||
|
||
Ƭ **QPushButtonSignals**: *[QAbstractButtonSignals](interfaces/qabstractbuttonsignals.md)*
|
||
|
||
___
|
||
|
||
### QRadioButtonSignals
|
||
|
||
Ƭ **QRadioButtonSignals**: *[QAbstractButtonSignals](interfaces/qabstractbuttonsignals.md)*
|
||
|
||
___
|
||
|
||
### QScrollAreaSignals
|
||
|
||
Ƭ **QScrollAreaSignals**: *[QAbstractScrollAreaSignals](globals.md#qabstractscrollareasignals)*
|
||
|
||
___
|
||
|
||
### QVariantType
|
||
|
||
Ƭ **QVariantType**: *[NativeElement](globals.md#nativeelement) | string | number | boolean*
|
||
|
||
## Functions
|
||
|
||
### checkIfNativeElement
|
||
|
||
▸ **checkIfNativeElement**(`arg`: any): *boolean*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`arg` | any |
|
||
|
||
**Returns:** *boolean*
|
||
|
||
___
|
||
|
||
### prepareInlineStyleSheet
|
||
|
||
▸ **prepareInlineStyleSheet**<**Signals**>(`widget`: [NodeWidget](classes/nodewidget.md)‹Signals›, `rawStyle`: string): *string*
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **Signals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`widget` | [NodeWidget](classes/nodewidget.md)‹Signals› |
|
||
`rawStyle` | string |
|
||
|
||
**Returns:** *string*
|