plastichub/nodeguy
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update docs 14 (#470)

Browse Source 
* Adds docs for handling events

* updates docs to latest version

* adds more text

* fixes docs

* upgrade yarn lock
This commit is contained in:
Atul R 2020-03-28 20:46:26 +01:00 committed by GitHub
parent 0ec2b3f2cb
commit 7b8a3b8088
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
50 changed files with 17331 additions and 586 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
src/demo.ts
View File

@ -1,57 +1,16 @@
import { QMainWindow, QWidget, FlexLayout, QTreeWidgetItem, QTreeWidget, QLineEdit, MatchFlag } from './index';
import { QMainWindow, QLabel, WidgetEventTypes, QMouseEvent } from './index';
const win = new QMainWindow();
const center = new QWidget();
center.setLayout(new FlexLayout());
win.setCentralWidget(center);
const label = new QLabel();
label.setText('Move your move here');
label.setMouseTracking(true);
const fruitTree = new QTreeWidget();
fruitTree.setSortingEnabled(true);
fruitTree.setHeaderLabels(['Fruit', 'Price']);
const fruitObj = [
{
fruit: 'Banana',
price: '2.5',
},
{
fruit: 'Apple',
price: '1.0',
},
{
fruit: 'Strawberry',
price: '2.5',
},
{
fruit: 'Orange',
price: '1.5',
},
];
const items = [];
for (const element of fruitObj) {
const fruitItem = new QTreeWidgetItem(fruitTree, [element.fruit, element.price]);
items.push(fruitItem);
}
fruitTree.addTopLevelItems(items);
const filterLineEdit = new QLineEdit();
filterLineEdit.setPlaceholderText('Filter...');
filterLineEdit.addEventListener('returnPressed', () => {
const filterText = filterLineEdit.text();
const foundItems = fruitTree
.findItems(filterText, MatchFlag.MatchContains, 0)
.concat(fruitTree.findItems(filterText, MatchFlag.MatchContains, 1));
fruitTree.topLevelItems.forEach(item => item.setHidden(true));
foundItems.forEach(item => item.setHidden(false));
label.addEventListener(WidgetEventTypes.MouseMove, nativeEvt => {
const mouseEvt = new QMouseEvent(nativeEvt as any);
console.log('mouseMoved at: ', { x: mouseEvt.x(), y: mouseEvt.y() });
});
center.layout?.addWidget(filterLineEdit);
center.layout?.addWidget(fruitTree);
win.setCentralWidget(label);
win.show();
(global as any).win = win;

4
src/lib/QtGui/QEvent/QKeyEvent.ts
View File

@ -1,9 +1,9 @@
import addon from '../../utils/addon';
import { NativeElement } from '../../core/Component';
import { NativeElement, NativeRawPointer } from '../../core/Component';
export class QKeyEvent {
native: NativeElement;
constructor(event: NativeElement) {
constructor(event: NativeRawPointer<'QEvent'>) {
this.native = new addon.QKeyEvent(event);
}
text(): string {

8
website/docs/api/generated/classes/component.md
View File

@ -29,6 +29,10 @@ Its the root base class in NodeGui world.
↳ [EventWidget](eventwidget.md)
↳ [QColor](qcolor.md)
↳ [QBrush](qbrush.md)
↳ [QKeySequence](qkeysequence.md)
↳ [QRect](qrect.md)
@ -55,14 +59,14 @@ Its the root base class in NodeGui world.
↳ [QDateTime](qdatetime.md)
↳ [QStandardItem](qstandarditem.md)
↳ [QListWidgetItem](qlistwidgetitem.md)
↳ [QTableWidgetItem](qtablewidgetitem.md)
↳ [QTreeWidgetItem](qtreewidgetitem.md)
↳ [QColor](qcolor.md)
↳ [QPainter](qpainter.md)
↳ [QUrl](qurl.md)

8
website/docs/api/generated/classes/nodedialog.md
View File

@ -16,8 +16,16 @@ sidebar_label: "NodeDialog"
↳ [QDialog](qdialog.md)
↳ [QColorDialog](qcolordialog.md)
↳ [QErrorMessage](qerrormessage.md)
↳ [QFileDialog](qfiledialog.md)
↳ [QFontDialog](qfontdialog.md)
↳ [QProgressDialog](qprogressdialog.md)
↳ [QMessageBox](qmessagebox.md)
↳ [QInputDialog](qinputdialog.md)

2208
website/docs/api/generated/classes/nodelistview.md Normal file
View File

File diff suppressed because it is too large Load Diff

2
website/docs/api/generated/classes/nodeobject.md
View File

@ -26,6 +26,8 @@ sidebar_label: "NodeObject"
↳ [QAction](qaction.md)
↳ [QStandardItemModel](qstandarditemmodel.md)
↳ [QButtonGroup](qbuttongroup.md)
↳ [QSystemTrayIcon](qsystemtrayicon.md)

4
website/docs/api/generated/classes/nodewidget.md
View File

@ -60,6 +60,8 @@ Implement all native QWidget methods here so that all widgets get access to thos
↳ [NodeDialog](nodedialog.md)
↳ [QLCDNumber](qlcdnumber.md)
↳ [QLineEdit](qlineedit.md)
↳ [QMenuBar](qmenubar.md)
@ -72,6 +74,8 @@ Implement all native QWidget methods here so that all widgets get access to thos
↳ [QComboBox](qcombobox.md)
↳ [QTabBar](qtabbar.md)
↳ [QTabWidget](qtabwidget.md)
↳ [QGroupBox](qgroupbox.md)

2
website/docs/api/generated/classes/qabstractitemview.md
View File

@ -21,7 +21,7 @@ It is inherited by QListWidget. (n/a QColumnView, QHeaderView, QListView, QTable
↳ **QAbstractItemView**
↳ [QListWidget](qlistwidget.md)
↳ [NodeListView](nodelistview.md)
↳ [NodeTableView](nodetableview.md)

2
website/docs/api/generated/classes/qabstractspinbox.md
View File

@ -23,6 +23,8 @@ It is inherited by QDateTimeEdit and QSpinBox. (n/a QDoubleSpinBox)
↳ [NodeDateTimeEdit](nodedatetimeedit.md)
↳ [QDoubleSpinBox](qdoublespinbox.md)
↳ [QSpinBox](qspinbox.md)
## Index

223
website/docs/api/generated/classes/qbrush.md Normal file
View File

@ -0,0 +1,223 @@
---
id: "qbrush"
title: "QBrush"
sidebar_label: "QBrush"
---
> The QBrush class defines the fill pattern of shapes drawn by QPainter.
**This class is a JS wrapper around Qt's [QBrush class](https://doc.qt.io/qt-5/qbrush.html)**
### Example
```javascript
const { QBrush } = require("@nodegui/nodegui");
const brush = new QBrush();
```
## Hierarchy
* [Component](component.md)
↳ **QBrush**
## Index
### Constructors
* [constructor](qbrush.md#constructor)
### Properties
* [native](qbrush.md#native)
* [nodeChildren](qbrush.md#nodechildren)
* [nodeParent](qbrush.md#optional-nodeparent)
### Methods
* [color](qbrush.md#color)
* [isOpaque](qbrush.md#isopaque)
* [setColor](qbrush.md#setcolor)
* [setNodeParent](qbrush.md#setnodeparent)
* [setStyle](qbrush.md#setstyle)
* [setTexture](qbrush.md#settexture)
* [style](qbrush.md#style)
* [texture](qbrush.md#texture)
* [fromQVariant](qbrush.md#static-fromqvariant)
## Constructors
### constructor
\+ **new QBrush**(): *[QBrush](qbrush.md)*
*Overrides [Component](component.md).[constructor](component.md#constructor)*
**Returns:** *[QBrush](qbrush.md)*
\+ **new QBrush**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QBrush](qbrush.md)*
*Overrides [Component](component.md).[constructor](component.md#constructor)*
**Parameters:**
Name | Type |
------ | ------ |
`nativeElement` | [NativeElement](../globals.md#nativeelement) |
**Returns:** *[QBrush](qbrush.md)*
\+ **new QBrush**(`color`: [GlobalColor](../enums/globalcolor.md), `style`: [BrushStyle](../enums/brushstyle.md)): *[QBrush](qbrush.md)*
*Overrides [Component](component.md).[constructor](component.md#constructor)*
**Parameters:**
Name | Type |
------ | ------ |
`color` | [GlobalColor](../enums/globalcolor.md) |
`style` | [BrushStyle](../enums/brushstyle.md) |
**Returns:** *[QBrush](qbrush.md)*
\+ **new QBrush**(`color`: [QColor](qcolor.md), `style`: [BrushStyle](../enums/brushstyle.md)): *[QBrush](qbrush.md)*
*Overrides [Component](component.md).[constructor](component.md#constructor)*
**Parameters:**
Name | Type |
------ | ------ |
`color` | [QColor](qcolor.md) |
`style` | [BrushStyle](../enums/brushstyle.md) |
**Returns:** *[QBrush](qbrush.md)*
## Properties
### native
• **native**: *[NativeElement](../globals.md#nativeelement)*
*Overrides [Component](component.md).[native](component.md#abstract-native)*
___
### nodeChildren
• **nodeChildren**: *Set‹[Component](component.md)›*
*Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)*
___
### `Optional` nodeParent
• **nodeParent**? : *[Component](component.md)*
*Inherited from [Component](component.md).[nodeParent](component.md#optional-nodeparent)*
## Methods
### color
▸ **color**(): *[QColor](qcolor.md)*
**Returns:** *[QColor](qcolor.md)*
___
### isOpaque
▸ **isOpaque**(): *boolean*
**Returns:** *boolean*
___
### setColor
▸ **setColor**(`color`: [QColor](qcolor.md) | [GlobalColor](../enums/globalcolor.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`color` | [QColor](qcolor.md) &#124; [GlobalColor](../enums/globalcolor.md) |
**Returns:** *void*
___
### setNodeParent
▸ **setNodeParent**(`parent?`: [Component](component.md)): *void*
*Inherited from [Component](component.md).[setNodeParent](component.md#setnodeparent)*
**Parameters:**
Name | Type |
------ | ------ |
`parent?` | [Component](component.md) |
**Returns:** *void*
___
### setStyle
▸ **setStyle**(`style`: [BrushStyle](../enums/brushstyle.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`style` | [BrushStyle](../enums/brushstyle.md) |
**Returns:** *void*
___
### setTexture
▸ **setTexture**(`pixmap`: [QPixmap](qpixmap.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`pixmap` | [QPixmap](qpixmap.md) |
**Returns:** *void*
___
### style
▸ **style**(): *[BrushStyle](../enums/brushstyle.md)*
**Returns:** *[BrushStyle](../enums/brushstyle.md)*
___
### texture
▸ **texture**(): *[QPixmap](qpixmap.md)*
**Returns:** *[QPixmap](qpixmap.md)*
___
### `Static` fromQVariant
▸ **fromQVariant**(`variant`: [QVariant](qvariant.md)): *[QBrush](qbrush.md)*
**Parameters:**
Name | Type |
------ | ------ |
`variant` | [QVariant](qvariant.md) |
**Returns:** *[QBrush](qbrush.md)*

1295
website/docs/api/generated/classes/qcolordialog.md Normal file
View File

File diff suppressed because it is too large Load Diff

30
website/docs/api/generated/classes/qcombobox.md
View File

@ -95,6 +95,7 @@ console.log('currentIndexChanged: ' + index);
* [setCurrentIndex](qcombobox.md#setcurrentindex)
* [setCurrentText](qcombobox.md#setcurrenttext)
* [setCursor](qcombobox.md#setcursor)
* [setEditText](qcombobox.md#setedittext)
* [setEditable](qcombobox.md#seteditable)
* [setEnabled](qcombobox.md#setenabled)
* [setFixedSize](qcombobox.md#setfixedsize)
@ -106,6 +107,7 @@ console.log('currentIndexChanged: ' + index);
* [setMaxVisibleItems](qcombobox.md#setmaxvisibleitems)
* [setMaximumSize](qcombobox.md#setmaximumsize)
* [setMinimumSize](qcombobox.md#setminimumsize)
* [setModel](qcombobox.md#setmodel)
* [setMouseTracking](qcombobox.md#setmousetracking)
* [setNodeParent](qcombobox.md#setnodeparent)
* [setObjectName](qcombobox.md#setobjectname)
@ -790,6 +792,20 @@ Name | Type |
___
### setEditText
▸ **setEditText**(`text`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`text` | string |
**Returns:** *void*
___
### setEditable
▸ **setEditable**(`editable`: boolean): *void*
@ -970,6 +986,20 @@ Name | Type |
___
### setModel
▸ **setModel**(`model`: [QStandardItemModel](qstandarditemmodel.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`model` | [QStandardItemModel](qstandarditemmodel.md) |
**Returns:** *void*
___
### setMouseTracking
▸ **setMouseTracking**(`isMouseTracked`: boolean): *void*

1606
website/docs/api/generated/classes/qdoublespinbox.md Normal file
View File

File diff suppressed because it is too large Load Diff

1146
website/docs/api/generated/classes/qerrormessage.md Normal file
View File

File diff suppressed because it is too large Load Diff

1222
website/docs/api/generated/classes/qfontdialog.md Normal file
View File

File diff suppressed because it is too large Load Diff

4
website/docs/api/generated/classes/qkeyevent.md
View File

@ -30,13 +30,13 @@ sidebar_label: "QKeyEvent"
### constructor
\+ **new QKeyEvent**(`event`: [NativeElement](../globals.md#nativeelement)): *[QKeyEvent](qkeyevent.md)*
\+ **new QKeyEvent**(`event`: [NativeRawPointer](../globals.md#nativerawpointer)‹"QEvent"›): *[QKeyEvent](qkeyevent.md)*
**Parameters:**
Name | Type |
------ | ------ |
`event` | [NativeElement](../globals.md#nativeelement) |
`event` | [NativeRawPointer](../globals.md#nativerawpointer)‹"QEvent"› |
**Returns:** *[QKeyEvent](qkeyevent.md)*

1205
website/docs/api/generated/classes/qlcdnumber.md Normal file
View File

File diff suppressed because it is too large Load Diff

2253
website/docs/api/generated/classes/qlistview.md Normal file
View File

File diff suppressed because it is too large Load Diff

107
website/docs/api/generated/classes/qlistwidget.md
View File

@ -29,7 +29,7 @@ listWidget.addItem(listWidgetItem);
## Hierarchy
↳ [QAbstractItemView](qabstractitemview.md)‹[QListWidgetSignals](../interfaces/qlistwidgetsignals.md)›
↳ [NodeListView](nodelistview.md)‹[QListWidgetSignals](../interfaces/qlistwidgetsignals.md)›
↳ **QListWidget**
@ -76,6 +76,7 @@ listWidget.addItem(listWidgetItem);
* [dragEnabled](qlistwidget.md#dragenabled)
* [editItem](qlistwidget.md#edititem)
* [editTriggers](qlistwidget.md#edittriggers)
* [findItems](qlistwidget.md#finditems)
* [flow](qlistwidget.md#flow)
* [font](qlistwidget.md#font)
* [frameRect](qlistwidget.md#framerect)
@ -130,6 +131,7 @@ listWidget.addItem(listWidgetItem);
* [scrollToBottom](qlistwidget.md#scrolltobottom)
* [scrollToItem](qlistwidget.md#scrolltoitem)
* [scrollToTop](qlistwidget.md#scrolltotop)
* [selectedItems](qlistwidget.md#selecteditems)
* [selectionBehavior](qlistwidget.md#selectionbehavior)
* [selectionMode](qlistwidget.md#selectionmode)
* [setAlternatingRowColors](qlistwidget.md#setalternatingrowcolors)
@ -464,6 +466,8 @@ ___
▸ **batchSize**(): *number*
*Inherited from [NodeListView](nodelistview.md).[batchSize](nodelistview.md#batchsize)*
**Returns:** *number*
___
@ -480,6 +484,8 @@ ___
▸ **clearPropertyFlags**(): *void*
*Inherited from [NodeListView](nodelistview.md).[clearPropertyFlags](nodelistview.md#clearpropertyflags)*
**Returns:** *void*
___
@ -606,10 +612,27 @@ ___
___
### findItems
▸ **findItems**(`text`: string, `flags`: [MatchFlag](../enums/matchflag.md)): *[QListWidgetItem](qlistwidgetitem.md)[]*
**Parameters:**
Name | Type |
------ | ------ |
`text` | string |
`flags` | [MatchFlag](../enums/matchflag.md) |
**Returns:** *[QListWidgetItem](qlistwidgetitem.md)[]*
___
### flow
▸ **flow**(): *[Flow](../enums/flow.md)*
*Inherited from [NodeListView](nodelistview.md).[flow](nodelistview.md#flow)*
**Returns:** *[Flow](../enums/flow.md)*
___
@ -698,6 +721,8 @@ ___
▸ **gridSize**(): *[QSize](qsize.md)*
*Inherited from [NodeListView](nodelistview.md).[gridSize](nodelistview.md#gridsize)*
**Returns:** *[QSize](qsize.md)*
___
@ -842,6 +867,8 @@ ___
▸ **isRowHidden**(`row`: number): *boolean*
*Inherited from [NodeListView](nodelistview.md).[isRowHidden](nodelistview.md#isrowhidden)*
**Parameters:**
Name | Type |
@ -856,6 +883,8 @@ ___
▸ **isSelectionRectVisible**(): *boolean*
*Inherited from [NodeListView](nodelistview.md).[isSelectionRectVisible](nodelistview.md#isselectionrectvisible)*
**Returns:** *boolean*
___
@ -882,6 +911,8 @@ ___
▸ **isWrapping**(): *boolean*
*Inherited from [NodeListView](nodelistview.md).[isWrapping](nodelistview.md#iswrapping)*
**Returns:** *boolean*
___
@ -904,6 +935,8 @@ ___
▸ **itemAlignment**(): *[AlignmentFlag](../enums/alignmentflag.md)*
*Inherited from [NodeListView](nodelistview.md).[itemAlignment](nodelistview.md#itemalignment)*
**Returns:** *[AlignmentFlag](../enums/alignmentflag.md)*
___
@ -941,6 +974,8 @@ ___
▸ **layoutMode**(): *[LayoutMode](../enums/layoutmode.md)*
*Inherited from [NodeListView](nodelistview.md).[layoutMode](nodelistview.md#layoutmode)*
**Returns:** *[LayoutMode](../enums/layoutmode.md)*
___
@ -979,6 +1014,8 @@ ___
▸ **modelColumn**(): *number*
*Inherited from [NodeListView](nodelistview.md).[modelColumn](nodelistview.md#modelcolumn)*
**Returns:** *number*
___
@ -1004,6 +1041,8 @@ ___
▸ **movement**(): *[Movement](../enums/movement.md)*
*Inherited from [NodeListView](nodelistview.md).[movement](nodelistview.md#movement)*
**Returns:** *[Movement](../enums/movement.md)*
___
@ -1188,6 +1227,8 @@ ___
▸ **resizeMode**(): *[ResizeMode](../enums/resizemode.md)*
*Inherited from [NodeListView](nodelistview.md).[resizeMode](nodelistview.md#resizemode)*
**Returns:** *[ResizeMode](../enums/resizemode.md)*
___
@ -1222,10 +1263,10 @@ ___
**Parameters:**
Name | Type |
------ | ------ |
`item` | [QListWidgetItem](qlistwidgetitem.md) |
`hint` | [ScrollHint](../enums/scrollhint.md) |
Name | Type | Default |
------ | ------ | ------ |
`item` | [QListWidgetItem](qlistwidgetitem.md) | - |
`hint` | [ScrollHint](../enums/scrollhint.md) | ScrollHint.EnsureVisible |
**Returns:** *void*
@ -1241,6 +1282,14 @@ ___
___
### selectedItems
▸ **selectedItems**(): *[QListWidgetItem](qlistwidgetitem.md)[]*
**Returns:** *[QListWidgetItem](qlistwidgetitem.md)[]*
___
### selectionBehavior
▸ **selectionBehavior**(): *[SelectionBehavior](../enums/selectionbehavior.md)*
@ -1330,6 +1379,8 @@ ___
▸ **setBatchSize**(`batchSize`: number): *void*
*Inherited from [NodeListView](nodelistview.md).[setBatchSize](nodelistview.md#setbatchsize)*
**Parameters:**
Name | Type |
@ -1567,6 +1618,8 @@ ___
▸ **setFlow**(`flow`: [Flow](../enums/flow.md)): *void*
*Inherited from [NodeListView](nodelistview.md).[setFlow](nodelistview.md#setflow)*
**Parameters:**
Name | Type |
@ -1680,6 +1733,8 @@ ___
▸ **setGridSize**(`size`: [QSize](qsize.md)): *void*
*Inherited from [NodeListView](nodelistview.md).[setGridSize](nodelistview.md#setgridsize)*
**Parameters:**
Name | Type |
@ -1775,6 +1830,8 @@ ___
▸ **setItemAlignment**(`alignment`: [AlignmentFlag](../enums/alignmentflag.md)): *void*
*Inherited from [NodeListView](nodelistview.md).[setItemAlignment](nodelistview.md#setitemalignment)*
**Parameters:**
Name | Type |
@ -1787,14 +1844,14 @@ ___
### setItemWidget
▸ **setItemWidget**(`item`: [QListWidgetItem](qlistwidgetitem.md), `widget`: [QWidget](qwidget.md)): *void*
▸ **setItemWidget**(`item`: [QListWidgetItem](qlistwidgetitem.md), `widget`: [NodeWidget](nodewidget.md)‹any›): *void*
**Parameters:**
Name | Type |
------ | ------ |
`item` | [QListWidgetItem](qlistwidgetitem.md) |
`widget` | [QWidget](qwidget.md) |
`widget` | [NodeWidget](nodewidget.md)‹any› |
**Returns:** *void*
@ -1820,6 +1877,8 @@ ___
▸ **setLayoutMode**(`mode`: [LayoutMode](../enums/layoutmode.md)): *void*
*Inherited from [NodeListView](nodelistview.md).[setLayoutMode](nodelistview.md#setlayoutmode)*
**Parameters:**
Name | Type |
@ -1900,6 +1959,8 @@ ___
▸ **setModelColumn**(`column`: number): *void*
*Inherited from [NodeListView](nodelistview.md).[setModelColumn](nodelistview.md#setmodelcolumn)*
**Parameters:**
Name | Type |
@ -1930,6 +1991,8 @@ ___
▸ **setMovement**(`movement`: [Movement](../enums/movement.md)): *void*
*Inherited from [NodeListView](nodelistview.md).[setMovement](nodelistview.md#setmovement)*
**Parameters:**
Name | Type |
@ -1995,6 +2058,8 @@ ___
▸ **setResizeMode**(`mode`: [ResizeMode](../enums/resizemode.md)): *void*
*Inherited from [NodeListView](nodelistview.md).[setResizeMode](nodelistview.md#setresizemode)*
**Parameters:**
Name | Type |
@ -2009,6 +2074,8 @@ ___
▸ **setRowHidden**(`row`: number, `hide`: boolean): *void*
*Inherited from [NodeListView](nodelistview.md).[setRowHidden](nodelistview.md#setrowhidden)*
**Parameters:**
Name | Type |
@ -2056,6 +2123,8 @@ ___
▸ **setSelectionRectVisible**(`show`: boolean): *void*
*Inherited from [NodeListView](nodelistview.md).[setSelectionRectVisible](nodelistview.md#setselectionrectvisible)*
**Parameters:**
Name | Type |
@ -2084,6 +2153,8 @@ ___
▸ **setSpacing**(`space`: number): *void*
*Inherited from [NodeListView](nodelistview.md).[setSpacing](nodelistview.md#setspacing)*
**Parameters:**
Name | Type |
@ -2146,6 +2217,8 @@ ___
▸ **setUniformItemSizes**(`enable`: boolean): *void*
*Inherited from [NodeListView](nodelistview.md).[setUniformItemSizes](nodelistview.md#setuniformitemsizes)*
**Parameters:**
Name | Type |
@ -2192,6 +2265,8 @@ ___
▸ **setViewMode**(`mode`: ViewMode): *void*
*Inherited from [NodeListView](nodelistview.md).[setViewMode](nodelistview.md#setviewmode)*
**Parameters:**
Name | Type |
@ -2303,6 +2378,8 @@ ___
▸ **setWordWrap**(`on`: boolean): *void*
*Inherited from [NodeListView](nodelistview.md).[setWordWrap](nodelistview.md#setwordwrap)*
**Parameters:**
Name | Type |
@ -2317,6 +2394,8 @@ ___
▸ **setWrapping**(`enable`: boolean): *void*
*Inherited from [NodeListView](nodelistview.md).[setWrapping](nodelistview.md#setwrapping)*
**Parameters:**
Name | Type |
@ -2403,9 +2482,9 @@ ___
**Parameters:**
Name | Type |
------ | ------ |
`order` | [SortOrder](../enums/sortorder.md) |
Name | Type | Default |
------ | ------ | ------ |
`order` | [SortOrder](../enums/sortorder.md) | SortOrder.AscendingOrder |
**Returns:** *void*
@ -2415,6 +2494,8 @@ ___
▸ **spacing**(): *number*
*Inherited from [NodeListView](nodelistview.md).[spacing](nodelistview.md#spacing)*
**Returns:** *number*
___
@ -2483,6 +2564,8 @@ ___
▸ **uniformItemSizes**(): *boolean*
*Inherited from [NodeListView](nodelistview.md).[uniformItemSizes](nodelistview.md#uniformitemsizes)*
**Returns:** *boolean*
___
@ -2521,6 +2604,8 @@ ___
▸ **viewMode**(): *ViewMode*
*Inherited from [NodeListView](nodelistview.md).[viewMode](nodelistview.md#viewmode)*
**Returns:** *ViewMode*
___
@ -2583,4 +2668,6 @@ ___
▸ **wordWrap**(): *boolean*
*Inherited from [NodeListView](nodelistview.md).[wordWrap](nodelistview.md#wordwrap)*
**Returns:** *boolean*

131
website/docs/api/generated/classes/qlistwidgetitem.md
View File

@ -47,14 +47,21 @@ listWidget.addItem(listWidgetItem);
### Methods
* [background](qlistwidgetitem.md#background)
* [checkState](qlistwidgetitem.md#checkstate)
* [data](qlistwidgetitem.md#data)
* [flags](qlistwidgetitem.md#flags)
* [font](qlistwidgetitem.md#font)
* [foreground](qlistwidgetitem.md#foreground)
* [icon](qlistwidgetitem.md#icon)
* [isHidden](qlistwidgetitem.md#ishidden)
* [isSelected](qlistwidgetitem.md#isselected)
* [setBackground](qlistwidgetitem.md#setbackground)
* [setCheckState](qlistwidgetitem.md#setcheckstate)
* [setData](qlistwidgetitem.md#setdata)
* [setFlags](qlistwidgetitem.md#setflags)
* [setFont](qlistwidgetitem.md#setfont)
* [setForeground](qlistwidgetitem.md#setforeground)
* [setHidden](qlistwidgetitem.md#sethidden)
* [setIcon](qlistwidgetitem.md#seticon)
* [setNodeParent](qlistwidgetitem.md#setnodeparent)
@ -70,13 +77,20 @@ listWidget.addItem(listWidgetItem);
* [text](qlistwidgetitem.md#text)
* [textAlignment](qlistwidgetitem.md#textalignment)
* [toolTip](qlistwidgetitem.md#tooltip)
* [type](qlistwidgetitem.md#type)
* [whatsThis](qlistwidgetitem.md#whatsthis)
## Constructors
### constructor
\+ **new QListWidgetItem**(`arg?`: arg): *[QListWidgetItem](qlistwidgetitem.md)*
\+ **new QListWidgetItem**(): *[QListWidgetItem](qlistwidgetitem.md)*
*Overrides [Component](component.md).[constructor](component.md#constructor)*
**Returns:** *[QListWidgetItem](qlistwidgetitem.md)*
\+ **new QListWidgetItem**(`other`: [QListWidgetItem](qlistwidgetitem.md)): *[QListWidgetItem](qlistwidgetitem.md)*
*Overrides [Component](component.md).[constructor](component.md#constructor)*
@ -84,7 +98,31 @@ listWidget.addItem(listWidgetItem);
Name | Type |
------ | ------ |
`arg?` | arg |
`other` | [QListWidgetItem](qlistwidgetitem.md) |
**Returns:** *[QListWidgetItem](qlistwidgetitem.md)*
\+ **new QListWidgetItem**(`native`: [NativeElement](../globals.md#nativeelement)): *[QListWidgetItem](qlistwidgetitem.md)*
*Overrides [Component](component.md).[constructor](component.md#constructor)*
**Parameters:**
Name | Type |
------ | ------ |
`native` | [NativeElement](../globals.md#nativeelement) |
**Returns:** *[QListWidgetItem](qlistwidgetitem.md)*
\+ **new QListWidgetItem**(`text`: string): *[QListWidgetItem](qlistwidgetitem.md)*
*Overrides [Component](component.md).[constructor](component.md#constructor)*
**Parameters:**
Name | Type |
------ | ------ |
`text` | string |
**Returns:** *[QListWidgetItem](qlistwidgetitem.md)*
@ -114,6 +152,14 @@ ___
## Methods
### background
▸ **background**(): *[QBrush](qbrush.md)*
**Returns:** *[QBrush](qbrush.md)*
___
### checkState
▸ **checkState**(): *[CheckState](../enums/checkstate.md)*
@ -144,6 +190,22 @@ ___
___
### font
▸ **font**(): *[QFont](qfont.md)*
**Returns:** *[QFont](qfont.md)*
___
### foreground
▸ **foreground**(): *[QBrush](qbrush.md)*
**Returns:** *[QBrush](qbrush.md)*
___
### icon
▸ **icon**(): *[QIcon](qicon.md)*
@ -168,6 +230,20 @@ ___
___
### setBackground
▸ **setBackground**(`brush`: [QBrush](qbrush.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`brush` | [QBrush](qbrush.md) |
**Returns:** *void*
___
### setCheckState
▸ **setCheckState**(`state`: [CheckState](../enums/checkstate.md)): *void*
@ -182,6 +258,21 @@ Name | Type |
___
### setData
▸ **setData**(`role`: number, `value`: [QVariant](qvariant.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`role` | number |
`value` | [QVariant](qvariant.md) |
**Returns:** *void*
___
### setFlags
▸ **setFlags**(`flags`: [ItemFlag](../enums/itemflag.md)): *void*
@ -196,6 +287,34 @@ Name | Type |
___
### setFont
▸ **setFont**(`font`: [QFont](qfont.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`font` | [QFont](qfont.md) |
**Returns:** *void*
___
### setForeground
▸ **setForeground**(`brush`: [QBrush](qbrush.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`brush` | [QBrush](qbrush.md) |
**Returns:** *void*
___
### setHidden
▸ **setHidden**(`hide`: boolean): *void*
@ -378,6 +497,14 @@ ___
___
### type
▸ **type**(): *number*
**Returns:** *number*
___
### whatsThis
▸ **whatsThis**(): *string*

1357
website/docs/api/generated/classes/qprogressdialog.md Normal file
View File

File diff suppressed because it is too large Load Diff

157
website/docs/api/generated/classes/qstandarditem.md Normal file
View File

@ -0,0 +1,157 @@
---
id: "qstandarditem"
title: "QStandardItem"
sidebar_label: "QStandardItem"
---
## Hierarchy
* [Component](component.md)
↳ **QStandardItem**
## Index
### Constructors
* [constructor](qstandarditem.md#constructor)
### Properties
* [native](qstandarditem.md#native)
* [nodeChildren](qstandarditem.md#nodechildren)
* [nodeParent](qstandarditem.md#optional-nodeparent)
### Methods
* [checkState](qstandarditem.md#checkstate)
* [setCheckState](qstandarditem.md#setcheckstate)
* [setData](qstandarditem.md#setdata)
* [setFlags](qstandarditem.md#setflags)
* [setNodeParent](qstandarditem.md#setnodeparent)
## Constructors
### constructor
\+ **new QStandardItem**(): *[QStandardItem](qstandarditem.md)*
*Overrides [Component](component.md).[constructor](component.md#constructor)*
**Returns:** *[QStandardItem](qstandarditem.md)*
\+ **new QStandardItem**(`parent`: [QStandardItem](qstandarditem.md), `text?`: undefined | string): *[QStandardItem](qstandarditem.md)*
*Overrides [Component](component.md).[constructor](component.md#constructor)*
**Parameters:**
Name | Type |
------ | ------ |
`parent` | [QStandardItem](qstandarditem.md) |
`text?` | undefined &#124; string |
**Returns:** *[QStandardItem](qstandarditem.md)*
\+ **new QStandardItem**(`native`: [NativeElement](../globals.md#nativeelement)): *[QStandardItem](qstandarditem.md)*
*Overrides [Component](component.md).[constructor](component.md#constructor)*
**Parameters:**
Name | Type |
------ | ------ |
`native` | [NativeElement](../globals.md#nativeelement) |
**Returns:** *[QStandardItem](qstandarditem.md)*
## Properties
### native
• **native**: *[NativeElement](../globals.md#nativeelement)*
*Overrides [Component](component.md).[native](component.md#abstract-native)*
___
### nodeChildren
• **nodeChildren**: *Set‹[Component](component.md)›*
*Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)*
___
### `Optional` nodeParent
• **nodeParent**? : *[Component](component.md)*
*Inherited from [Component](component.md).[nodeParent](component.md#optional-nodeparent)*
## Methods
### checkState
▸ **checkState**(): *[CheckState](../enums/checkstate.md)*
**Returns:** *[CheckState](../enums/checkstate.md)*
___
### setCheckState
▸ **setCheckState**(`state`: [CheckState](../enums/checkstate.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`state` | [CheckState](../enums/checkstate.md) |
**Returns:** *void*
___
### setData
▸ **setData**(`value`: number, `role`: number): *void*
**Parameters:**
Name | Type |
------ | ------ |
`value` | number |
`role` | number |
**Returns:** *void*
___
### setFlags
▸ **setFlags**(`flags`: [ItemFlag](../enums/itemflag.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`flags` | [ItemFlag](../enums/itemflag.md) |
**Returns:** *void*
___
### setNodeParent
▸ **setNodeParent**(`parent?`: [Component](component.md)): *void*
*Inherited from [Component](component.md).[setNodeParent](component.md#setnodeparent)*
**Parameters:**
Name | Type |
------ | ------ |
`parent?` | [Component](component.md) |
**Returns:** *void*

284
website/docs/api/generated/classes/qstandarditemmodel.md Normal file
View File

@ -0,0 +1,284 @@
---
id: "qstandarditemmodel"
title: "QStandardItemModel"
sidebar_label: "QStandardItemModel"
---
## Hierarchy
↳ [NodeObject](nodeobject.md)‹any›
↳ **QStandardItemModel**
## Index
### Constructors
* [constructor](qstandarditemmodel.md#constructor)
### Properties
* [native](qstandarditemmodel.md#native)
* [nodeChildren](qstandarditemmodel.md#nodechildren)
* [nodeParent](qstandarditemmodel.md#optional-nodeparent)
### Methods
* [addEventListener](qstandarditemmodel.md#addeventlistener)
* [inherits](qstandarditemmodel.md#inherits)
* [item](qstandarditemmodel.md#item)
* [objectName](qstandarditemmodel.md#objectname)
* [property](qstandarditemmodel.md#property)
* [removeEventListener](qstandarditemmodel.md#removeeventlistener)
* [setNodeParent](qstandarditemmodel.md#setnodeparent)
* [setObjectName](qstandarditemmodel.md#setobjectname)
* [setProperty](qstandarditemmodel.md#setproperty)
## Constructors
### constructor
\+ **new QStandardItemModel**(): *[QStandardItemModel](qstandarditemmodel.md)*
*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)*
**Returns:** *[QStandardItemModel](qstandarditemmodel.md)*
\+ **new QStandardItemModel**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QStandardItemModel](qstandarditemmodel.md)*
*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)*
**Parameters:**
Name | Type |
------ | ------ |
`parent` | [NodeWidget](nodewidget.md)‹any› |
**Returns:** *[QStandardItemModel](qstandarditemmodel.md)*
## Properties
### native
• **native**: *[NativeElement](../globals.md#nativeelement)*
*Overrides [Component](component.md).[native](component.md#abstract-native)*
___
### nodeChildren
• **nodeChildren**: *Set‹[Component](component.md)›*
*Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)*
___
### `Optional` nodeParent
• **nodeParent**? : *[Component](component.md)*
*Inherited from [Component](component.md).[nodeParent](component.md#optional-nodeparent)*
## Methods
### addEventListener
▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: any[SignalType]): *void*
*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)*
**Type parameters:**
▪ **SignalType**: *keyof any*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signalType` | SignalType | SignalType is a signal from the widgets signals interface. |
`callback` | any[SignalType] | Corresponding callback for the signal as mentioned in the widget's signal interface |
**Returns:** *void*
void
For example in the case of QPushButton:
```js
const button = new QPushButton();
button.addEventListener('clicked',(checked)=>console.log("clicked"));
// here clicked is a value from QPushButtonSignals interface
```
▸ **addEventListener**(`eventType`: [WidgetEventTypes](../enums/widgeteventtypes.md), `callback`: function): *void*
*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)*
**Parameters:**
▪ **eventType**: *[WidgetEventTypes](../enums/widgeteventtypes.md)*
▪ **callback**: *function*
For example in the case of QPushButton:
```js
const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));
```
▸ (`event?`: [NativeRawPointer](../globals.md#nativerawpointer)‹"QEvent"›): *void*
**Parameters:**
Name | Type |
------ | ------ |
`event?` | [NativeRawPointer](../globals.md#nativerawpointer)‹"QEvent"› |
**Returns:** *void*
___
### inherits
▸ **inherits**(`className`: string): *boolean*
*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)*
**Parameters:**
Name | Type |
------ | ------ |
`className` | string |
**Returns:** *boolean*
___
### item
▸ **item**(`row`: number, `column`: number): *[QStandardItem](qstandarditem.md) | void*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`row` | number | - |
`column` | number | 0 |
**Returns:** *[QStandardItem](qstandarditem.md) | void*
___
### objectName
▸ **objectName**(): *string*
*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)*
**Returns:** *string*
___
### property
▸ **property**(`name`: string): *[QVariant](qvariant.md)*
*Inherited from [NodeObject](nodeobject.md).[property](nodeobject.md#property)*
**Parameters:**
Name | Type |
------ | ------ |
`name` | string |
**Returns:** *[QVariant](qvariant.md)*
___
### removeEventListener
▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: any[SignalType]): *void*
*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)*
**Type parameters:**
▪ **SignalType**: *keyof any*
**Parameters:**
Name | Type |
------ | ------ |
`signalType` | SignalType |
`callback` | any[SignalType] |
**Returns:** *void*
▸ **removeEventListener**(`eventType`: [WidgetEventTypes](../enums/widgeteventtypes.md), `callback`: function): *void*
*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)*
**Parameters:**
▪ **eventType**: *[WidgetEventTypes](../enums/widgeteventtypes.md)*
▪ **callback**: *function*
▸ (`event?`: [NativeRawPointer](../globals.md#nativerawpointer)‹"QEvent"›): *void*
**Parameters:**
Name | Type |
------ | ------ |
`event?` | [NativeRawPointer](../globals.md#nativerawpointer)‹"QEvent"› |
**Returns:** *void*
___
### setNodeParent
▸ **setNodeParent**(`parent?`: [Component](component.md)): *void*
*Inherited from [Component](component.md).[setNodeParent](component.md#setnodeparent)*
**Parameters:**
Name | Type |
------ | ------ |
`parent?` | [Component](component.md) |
**Returns:** *void*
___
### setObjectName
▸ **setObjectName**(`objectName`: string): *void*
*Inherited from [NodeObject](nodeobject.md).[setObjectName](nodeobject.md#setobjectname)*
**Parameters:**
Name | Type |
------ | ------ |
`objectName` | string |
**Returns:** *void*
___
### setProperty
▸ **setProperty**(`name`: string, `value`: [QVariantType](../globals.md#qvarianttype)): *boolean*
*Inherited from [NodeObject](nodeobject.md).[setProperty](nodeobject.md#setproperty)*
**Parameters:**
Name | Type |
------ | ------ |
`name` | string |
`value` | [QVariantType](../globals.md#qvarianttype) |
**Returns:** *boolean*

1705
website/docs/api/generated/classes/qtabbar.md Normal file
View File

File diff suppressed because it is too large Load Diff

18
website/docs/api/generated/classes/qtabwidget.md
View File

@ -61,6 +61,7 @@ tabWidget.addTab(new QCalendarWidget(), new QIcon(), 'Tab 2');
* [hide](qtabwidget.md#hide)
* [indexOf](qtabwidget.md#indexof)
* [inherits](qtabwidget.md#inherits)
* [insertTab](qtabwidget.md#inserttab)
* [isEnabled](qtabwidget.md#isenabled)
* [isVisible](qtabwidget.md#isvisible)
* [lower](qtabwidget.md#lower)
@ -407,6 +408,23 @@ Name | Type |
___
### insertTab
▸ **insertTab**(`index`: number, `page`: [NodeWidget](nodewidget.md)‹any›, `icon`: [QIcon](qicon.md), `label`: string): *number*
**Parameters:**
Name | Type |
------ | ------ |
`index` | number |
`page` | [NodeWidget](nodewidget.md)‹any› |
`icon` | [QIcon](qicon.md) |
`label` | string |
**Returns:** *number*
___
### isEnabled
▸ **isEnabled**(): *boolean*

95
website/docs/api/generated/classes/qtreewidget.md
View File

@ -23,10 +23,17 @@ const item2 = new QTreeWidgetItem();
item2.setText(0, `item-2`);
const item3 = new QTreeWidgetItem();
item3.setText(0, `item-3`);
const item4 = new QTreeWidgetItem();
item4.setText(0, `item-4`);
const item5 = new QTreeWidgetItem();
item5.setText(0, `item-5`);
const item6 = new QTreeWidgetItem();
item6.setText(0, `item-6`);
tree.addTopLevelItem(item1);
tree.addTopLevelItem(item2);
tree.addTopLevelItem(item3);
tree.insertTopLevelItems(0, [item2, item3]);
tree.addTopLevelItems([item4, item5]);
tree.insertTopLevelItem(2, item6);
// Add children to item1
const c1item1 = new QTreeWidgetItem(item1);
@ -36,8 +43,7 @@ c1item2.setText(0, `c1item1`);
win.setCentralWidget(tree);
win.show();
(global as any).win = win;
```
(global as any).win = win;```
## Hierarchy
@ -70,9 +76,11 @@ win.show();
* [addAction](qtreewidget.md#addaction)
* [addEventListener](qtreewidget.md#addeventlistener)
* [addTopLevelItem](qtreewidget.md#addtoplevelitem)
* [addTopLevelItems](qtreewidget.md#addtoplevelitems)
* [adjustSize](qtreewidget.md#adjustsize)
* [close](qtreewidget.md#close)
* [currentItem](qtreewidget.md#currentitem)
* [findItems](qtreewidget.md#finditems)
* [font](qtreewidget.md#font)
* [frameRect](qtreewidget.md#framerect)
* [frameShadow](qtreewidget.md#frameshadow)
@ -84,6 +92,8 @@ win.show();
* [hasMouseTracking](qtreewidget.md#hasmousetracking)
* [hide](qtreewidget.md#hide)
* [inherits](qtreewidget.md#inherits)
* [insertTopLevelItem](qtreewidget.md#inserttoplevelitem)
* [insertTopLevelItems](qtreewidget.md#inserttoplevelitems)
* [isEnabled](qtreewidget.md#isenabled)
* [isVisible](qtreewidget.md#isvisible)
* [lineWidth](qtreewidget.md#linewidth)
@ -127,6 +137,7 @@ win.show();
* [setNodeParent](qtreewidget.md#setnodeparent)
* [setObjectName](qtreewidget.md#setobjectname)
* [setProperty](qtreewidget.md#setproperty)
* [setSortingEnabled](qtreewidget.md#setsortingenabled)
* [setStyleSheet](qtreewidget.md#setstylesheet)
* [setVerticalScrollBarPolicy](qtreewidget.md#setverticalscrollbarpolicy)
* [setViewport](qtreewidget.md#setviewport)
@ -346,6 +357,20 @@ Name | Type |
___
### addTopLevelItems
▸ **addTopLevelItems**(`items`: [QTreeWidgetItem](qtreewidgetitem.md)[]): *void*
**Parameters:**
Name | Type |
------ | ------ |
`items` | [QTreeWidgetItem](qtreewidgetitem.md)[] |
**Returns:** *void*
___
### adjustSize
▸ **adjustSize**(): *void*
@ -376,6 +401,22 @@ Returns the current item in the tree widget.
___
### findItems
▸ **findItems**(`text`: string, `flags`: [MatchFlag](../enums/matchflag.md), `column`: number): *[QTreeWidgetItem](qtreewidgetitem.md)[]*
**Parameters:**
Name | Type |
------ | ------ |
`text` | string |
`flags` | [MatchFlag](../enums/matchflag.md) |
`column` | number |
**Returns:** *[QTreeWidgetItem](qtreewidgetitem.md)[]*
___
### font
▸ **font**(): *[QFont](qfont.md)*
@ -492,6 +533,36 @@ Name | Type |
___
### insertTopLevelItem
▸ **insertTopLevelItem**(`index`: number, `item`: [QTreeWidgetItem](qtreewidgetitem.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`index` | number |
`item` | [QTreeWidgetItem](qtreewidgetitem.md) |
**Returns:** *void*
___
### insertTopLevelItems
▸ **insertTopLevelItems**(`index`: number, `items`: [QTreeWidgetItem](qtreewidgetitem.md)[]): *void*
**Parameters:**
Name | Type |
------ | ------ |
`index` | number |
`items` | [QTreeWidgetItem](qtreewidgetitem.md)[] |
**Returns:** *void*
___
### isEnabled
▸ **isEnabled**(): *boolean*
@ -1155,6 +1226,22 @@ Name | Type |
___
### setSortingEnabled
▸ **setSortingEnabled**(`enable`: boolean): *void*
Sets if columns can be sorted by clicking on its header
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`enable` | boolean | Sorting enabled or disabled |
**Returns:** *void*
___
### setStyleSheet
▸ **setStyleSheet**(`styleSheet`: string): *void*

24
website/docs/api/generated/classes/qtreewidgetitem.md
View File

@ -66,11 +66,13 @@ win.show();
* [childCount](qtreewidgetitem.md#childcount)
* [data](qtreewidgetitem.md#data)
* [flags](qtreewidgetitem.md#flags)
* [isHidden](qtreewidgetitem.md#ishidden)
* [parent](qtreewidgetitem.md#parent)
* [setCheckState](qtreewidgetitem.md#setcheckstate)
* [setData](qtreewidgetitem.md#setdata)
* [setExpanded](qtreewidgetitem.md#setexpanded)
* [setFlags](qtreewidgetitem.md#setflags)
* [setHidden](qtreewidgetitem.md#sethidden)
* [setNodeParent](qtreewidgetitem.md#setnodeparent)
* [setSelected](qtreewidgetitem.md#setselected)
* [setText](qtreewidgetitem.md#settext)
@ -233,6 +235,14 @@ Returns the flags used to describe the item. These determine whether the item ca
___
### isHidden
▸ **isHidden**(): *boolean*
**Returns:** *boolean*
___
### parent
▸ **parent**(): *[QTreeWidgetItem](qtreewidgetitem.md) | undefined*
@ -308,6 +318,20 @@ Name | Type | Description |
___
### setHidden
▸ **setHidden**(`hide`: boolean): *void*
**Parameters:**
Name | Type |
------ | ------ |
`hide` | boolean |
**Returns:** *void*
___
### setNodeParent
▸ **setNodeParent**(`parent?`: [Component](component.md)): *void*

24
website/docs/api/generated/enums/buttonposition.md Normal file
View File

@ -0,0 +1,24 @@
---
id: "buttonposition"
title: "ButtonPosition"
sidebar_label: "ButtonPosition"
---
## Index
### Enumeration members
* [LeftSide](buttonposition.md#leftside)
* [RightSide](buttonposition.md#rightside)
## Enumeration members
### LeftSide
• **LeftSide**: = 0
___
### RightSide
• **RightSide**: = 1

31
website/docs/api/generated/enums/colordialogoption.md Normal file
View File

@ -0,0 +1,31 @@
---
id: "colordialogoption"
title: "ColorDialogOption"
sidebar_label: "ColorDialogOption"
---
## Index
### Enumeration members
* [DontUseNativeDialog](colordialogoption.md#dontusenativedialog)
* [NoButtons](colordialogoption.md#nobuttons)
* [ShowAlphaChannel](colordialogoption.md#showalphachannel)
## Enumeration members
### DontUseNativeDialog
• **DontUseNativeDialog**: = 4
___
### NoButtons
• **NoButtons**: = 2
___
### ShowAlphaChannel
• **ShowAlphaChannel**: = 1

52
website/docs/api/generated/enums/fontdialogoption.md Normal file
View File

@ -0,0 +1,52 @@
---
id: "fontdialogoption"
title: "FontDialogOption"
sidebar_label: "FontDialogOption"
---
## Index
### Enumeration members
* [DontUseNativeDialog](fontdialogoption.md#dontusenativedialog)
* [MonospacedFonts](fontdialogoption.md#monospacedfonts)
* [NoButtons](fontdialogoption.md#nobuttons)
* [NonScalableFonts](fontdialogoption.md#nonscalablefonts)
* [ProportionalFonts](fontdialogoption.md#proportionalfonts)
* [ScalableFonts](fontdialogoption.md#scalablefonts)
## Enumeration members
### DontUseNativeDialog
• **DontUseNativeDialog**: = 2
___
### MonospacedFonts
• **MonospacedFonts**: = 16
___
### NoButtons
• **NoButtons**: = 1
___
### NonScalableFonts
• **NonScalableFonts**: = 8
___
### ProportionalFonts
• **ProportionalFonts**: = 32
___
### ScalableFonts
• **ScalableFonts**: = 4

38
website/docs/api/generated/enums/mode.md Normal file
View File

@ -0,0 +1,38 @@
---
id: "mode"
title: "Mode"
sidebar_label: "Mode"
---
## Index
### Enumeration members
* [Bin](mode.md#bin)
* [Dec](mode.md#dec)
* [Hex](mode.md#hex)
* [Oct](mode.md#oct)
## Enumeration members
### Bin
• **Bin**:
___
### Dec
• **Dec**:
___
### Hex
• **Hex**:
___
### Oct
• **Oct**:

31
website/docs/api/generated/enums/segmentstyle.md Normal file
View File

@ -0,0 +1,31 @@
---
id: "segmentstyle"
title: "SegmentStyle"
sidebar_label: "SegmentStyle"
---
## Index
### Enumeration members
* [Filled](segmentstyle.md#filled)
* [Flat](segmentstyle.md#flat)
* [Outline](segmentstyle.md#outline)
## Enumeration members
### Filled
• **Filled**:
___
### Flat
• **Flat**:
___
### Outline
• **Outline**:

21
website/docs/api/generated/enums/selectionbehavior.md
View File

@ -10,6 +10,9 @@ sidebar_label: "SelectionBehavior"
* [SelectColumns](selectionbehavior.md#selectcolumns)
* [SelectItems](selectionbehavior.md#selectitems)
* [SelectLeftTab](selectionbehavior.md#selectlefttab)
* [SelectPreviousTab](selectionbehavior.md#selectprevioustab)
* [SelectRightTab](selectionbehavior.md#selectrighttab)
* [SelectRows](selectionbehavior.md#selectrows)
## Enumeration members
@ -26,6 +29,24 @@ ___
___
### SelectLeftTab
• **SelectLeftTab**: = 0
___
### SelectPreviousTab
• **SelectPreviousTab**: = 2
___
### SelectRightTab
• **SelectRightTab**: = 1
___
### SelectRows
• **SelectRows**:

66
website/docs/api/generated/enums/tabbarshape.md Normal file
View File

@ -0,0 +1,66 @@
---
id: "tabbarshape"
title: "TabBarShape"
sidebar_label: "TabBarShape"
---
## Index
### Enumeration members
* [RoundedEast](tabbarshape.md#roundedeast)
* [RoundedNorth](tabbarshape.md#roundednorth)
* [RoundedSouth](tabbarshape.md#roundedsouth)
* [RoundedWest](tabbarshape.md#roundedwest)
* [TriangularEast](tabbarshape.md#triangulareast)
* [TriangularNorth](tabbarshape.md#triangularnorth)
* [TriangularSouth](tabbarshape.md#triangularsouth)
* [TriangularWest](tabbarshape.md#triangularwest)
## Enumeration members
### RoundedEast
• **RoundedEast**: = 3
___
### RoundedNorth
• **RoundedNorth**: = 0
___
### RoundedSouth
• **RoundedSouth**: = 1
___
### RoundedWest
• **RoundedWest**: = 2
___
### TriangularEast
• **TriangularEast**: = 7
___
### TriangularNorth
• **TriangularNorth**: = 4
___
### TriangularSouth
• **TriangularSouth**: = 5
___
### TriangularWest
• **TriangularWest**: = 6

83
website/docs/api/generated/globals.md
View File

@ -18,6 +18,7 @@ sidebar_label: "Globals"
* [Axis](enums/axis.md)
* [BGMode](enums/bgmode.md)
* [BrushStyle](enums/brushstyle.md)
* [ButtonPosition](enums/buttonposition.md)
* [ButtonRole](enums/buttonrole.md)
* [ButtonSymbols](enums/buttonsymbols.md)
* [CacheMode](enums/cachemode.md)
@ -25,6 +26,7 @@ sidebar_label: "Globals"
* [CheckState](enums/checkstate.md)
* [ChecksumType](enums/checksumtype.md)
* [ClipOperation](enums/clipoperation.md)
* [ColorDialogOption](enums/colordialogoption.md)
* [ConnectionType](enums/connectiontype.md)
* [ContextMenuPolicy](enums/contextmenupolicy.md)
* [CoordinateSystem](enums/coordinatesystem.md)
@ -50,6 +52,7 @@ sidebar_label: "Globals"
* [Flow](enums/flow.md)
* [FocusPolicy](enums/focuspolicy.md)
* [FocusReason](enums/focusreason.md)
* [FontDialogOption](enums/fontdialogoption.md)
* [GestureFlag](enums/gestureflag.md)
* [GestureState](enums/gesturestate.md)
* [GestureType](enums/gesturetype.md)
@ -74,6 +77,7 @@ sidebar_label: "Globals"
* [LineWrapMode](enums/linewrapmode.md)
* [MaskMode](enums/maskmode.md)
* [MatchFlag](enums/matchflag.md)
* [Mode](enums/mode.md)
* [Modifier](enums/modifier.md)
* [MouseButton](enums/mousebutton.md)
* [MouseEventFlag](enums/mouseeventflag.md)
@ -106,6 +110,7 @@ sidebar_label: "Globals"
* [ScrollHint](enums/scrollhint.md)
* [ScrollMode](enums/scrollmode.md)
* [ScrollPhase](enums/scrollphase.md)
* [SegmentStyle](enums/segmentstyle.md)
* [SelectionBehavior](enums/selectionbehavior.md)
* [SelectionMode](enums/selectionmode.md)
* [SequenceFormat](enums/sequenceformat.md)
@ -120,6 +125,7 @@ sidebar_label: "Globals"
* [SortOrder](enums/sortorder.md)
* [StepType](enums/steptype.md)
* [SystemFont](enums/systemfont.md)
* [TabBarShape](enums/tabbarshape.md)
* [TabFocusBehavior](enums/tabfocusbehavior.md)
* [TabPosition](enums/tabposition.md)
* [TextElideMode](enums/textelidemode.md)
@ -156,6 +162,7 @@ sidebar_label: "Globals"
* [NodeDialog](classes/nodedialog.md)
* [NodeFrame](classes/nodeframe.md)
* [NodeLayout](classes/nodelayout.md)
* [NodeListView](classes/nodelistview.md)
* [NodeObject](classes/nodeobject.md)
* [NodeTableView](classes/nodetableview.md)
* [NodeWidget](classes/nodewidget.md)
@ -167,11 +174,13 @@ sidebar_label: "Globals"
* [QAction](classes/qaction.md)
* [QApplication](classes/qapplication.md)
* [QBoxLayout](classes/qboxlayout.md)
* [QBrush](classes/qbrush.md)
* [QButtonGroup](classes/qbuttongroup.md)
* [QCalendarWidget](classes/qcalendarwidget.md)
* [QCheckBox](classes/qcheckbox.md)
* [QClipboard](classes/qclipboard.md)
* [QColor](classes/qcolor.md)
* [QColorDialog](classes/qcolordialog.md)
* [QComboBox](classes/qcombobox.md)
* [QCursor](classes/qcursor.md)
* [QDate](classes/qdate.md)
@ -180,9 +189,12 @@ sidebar_label: "Globals"
* [QDateTimeEdit](classes/qdatetimeedit.md)
* [QDial](classes/qdial.md)
* [QDialog](classes/qdialog.md)
* [QDoubleSpinBox](classes/qdoublespinbox.md)
* [QErrorMessage](classes/qerrormessage.md)
* [QFileDialog](classes/qfiledialog.md)
* [QFont](classes/qfont.md)
* [QFontDatabase](classes/qfontdatabase.md)
* [QFontDialog](classes/qfontdialog.md)
* [QFrame](classes/qframe.md)
* [QGridLayout](classes/qgridlayout.md)
* [QGroupBox](classes/qgroupbox.md)
@ -190,8 +202,10 @@ sidebar_label: "Globals"
* [QInputDialog](classes/qinputdialog.md)
* [QKeyEvent](classes/qkeyevent.md)
* [QKeySequence](classes/qkeysequence.md)
* [QLCDNumber](classes/qlcdnumber.md)
* [QLabel](classes/qlabel.md)
* [QLineEdit](classes/qlineedit.md)
* [QListView](classes/qlistview.md)
* [QListWidget](classes/qlistwidget.md)
* [QListWidgetItem](classes/qlistwidgetitem.md)
* [QMainWindow](classes/qmainwindow.md)
@ -208,6 +222,7 @@ sidebar_label: "Globals"
* [QPlainTextEdit](classes/qplaintextedit.md)
* [QPoint](classes/qpoint.md)
* [QProgressBar](classes/qprogressbar.md)
* [QProgressDialog](classes/qprogressdialog.md)
* [QPushButton](classes/qpushbutton.md)
* [QRadioButton](classes/qradiobutton.md)
* [QRect](classes/qrect.md)
@ -219,9 +234,12 @@ sidebar_label: "Globals"
* [QSlider](classes/qslider.md)
* [QSpinBox](classes/qspinbox.md)
* [QStackedWidget](classes/qstackedwidget.md)
* [QStandardItem](classes/qstandarditem.md)
* [QStandardItemModel](classes/qstandarditemmodel.md)
* [QStatusBar](classes/qstatusbar.md)
* [QStyle](classes/qstyle.md)
* [QSystemTrayIcon](classes/qsystemtrayicon.md)
* [QTabBar](classes/qtabbar.md)
* [QTabWidget](classes/qtabwidget.md)
* [QTableView](classes/qtableview.md)
* [QTableWidget](classes/qtablewidget.md)
@ -247,12 +265,16 @@ sidebar_label: "Globals"
* [QButtonGroupSignals](interfaces/qbuttongroupsignals.md)
* [QCalendarWidgetSignals](interfaces/qcalendarwidgetsignals.md)
* [QCheckBoxSignals](interfaces/qcheckboxsignals.md)
* [QColorDialogSignals](interfaces/qcolordialogsignals.md)
* [QComboBoxSignals](interfaces/qcomboboxsignals.md)
* [QDateTimeEditSignals](interfaces/qdatetimeeditsignals.md)
* [QDialogSignals](interfaces/qdialogsignals.md)
* [QDoubleSpinBoxSignals](interfaces/qdoublespinboxsignals.md)
* [QFileDialogSignals](interfaces/qfiledialogsignals.md)
* [QFontDialogSignals](interfaces/qfontdialogsignals.md)
* [QGroupBoxSignals](interfaces/qgroupboxsignals.md)
* [QInputDialogSignals](interfaces/qinputdialogsignals.md)
* [QLCDNumberSignals](interfaces/qlcdnumbersignals.md)
* [QLabelSignals](interfaces/qlabelsignals.md)
* [QLineEditSignals](interfaces/qlineeditsignals.md)
* [QListWidgetSignals](interfaces/qlistwidgetsignals.md)
@ -261,11 +283,14 @@ sidebar_label: "Globals"
* [QObjectSignals](interfaces/qobjectsignals.md)
* [QPlainTextEditSignals](interfaces/qplaintexteditsignals.md)
* [QProgressBarSignals](interfaces/qprogressbarsignals.md)
* [QProgressDialogSignals](interfaces/qprogressdialogsignals.md)
* [QShortcutSignals](interfaces/qshortcutsignals.md)
* [QSpinBoxSignals](interfaces/qspinboxsignals.md)
* [QStackedWidgetSignals](interfaces/qstackedwidgetsignals.md)
* [QStandardItemModelSignals](interfaces/qstandarditemmodelsignals.md)
* [QStatusBarSignals](interfaces/qstatusbarsignals.md)
* [QSystemTrayIconSignals](interfaces/qsystemtrayiconsignals.md)
* [QTabBarSignals](interfaces/qtabbarsignals.md)
* [QTabWidgetSignals](interfaces/qtabwidgetsignals.md)
* [QTableWidgetSignals](interfaces/qtablewidgetsignals.md)
* [QToolButtonSignals](interfaces/qtoolbuttonsignals.md)
@ -284,9 +309,11 @@ sidebar_label: "Globals"
* [QApplicationSignals](globals.md#qapplicationsignals)
* [QBoxLayoutSignals](globals.md#qboxlayoutsignals)
* [QDialSignals](globals.md#qdialsignals)
* [QErrorMessageSignals](globals.md#qerrormessagesignals)
* [QFrameSignals](globals.md#qframesignals)
* [QGridLayoutSignals](globals.md#qgridlayoutsignals)
* [QLayoutSignals](globals.md#qlayoutsignals)
* [QListViewSignals](globals.md#qlistviewsignals)
* [QMainWindowSignals](globals.md#qmainwindowsignals)
* [QMenuBarSignals](globals.md#qmenubarsignals)
* [QMenuSignals](globals.md#qmenusignals)
@ -298,17 +325,12 @@ sidebar_label: "Globals"
* [QTableViewSignals](globals.md#qtableviewsignals)
* [QVariantType](globals.md#qvarianttype)
* [SupportedFormats](globals.md#supportedformats)
* [arg](globals.md#arg)
### Variables
* [addon](globals.md#const-addon)
* [center](globals.md#const-center)
* [getBtn](globals.md#const-getbtn)
* [label](globals.md#const-label)
* [setBtn](globals.md#const-setbtn)
* [testImagePath](globals.md#const-testimagepath)
* [textInput](globals.md#const-textinput)
* [win](globals.md#const-win)
### Functions
@ -317,7 +339,6 @@ sidebar_label: "Globals"
* [checkIfNapiExternal](globals.md#checkifnapiexternal)
* [checkIfNativeElement](globals.md#checkifnativeelement)
* [main](globals.md#main)
* [noop](globals.md#noop)
* [prepareInlineStyleSheet](globals.md#prepareinlinestylesheet)
* [wrapWithActivateUvLoop](globals.md#const-wrapwithactivateuvloop)
@ -385,6 +406,12 @@ ___
___
### QErrorMessageSignals
Ƭ **QErrorMessageSignals**: *[QDialogSignals](interfaces/qdialogsignals.md)*
___
### QFrameSignals
Ƭ **QFrameSignals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)*
@ -403,6 +430,12 @@ ___
___
### QListViewSignals
Ƭ **QListViewSignals**: *[QAbstractItemViewSignals](interfaces/qabstractitemviewsignals.md)*
___
### QMainWindowSignals
Ƭ **QMainWindowSignals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)*
@ -467,12 +500,6 @@ ___
Ƭ **SupportedFormats**: *"gif" | "webp"*
___
### arg
Ƭ **arg**: *string | [NativeElement](globals.md#nativeelement)*
## Variables
### `Const` addon
@ -481,42 +508,18 @@ ___
___
### `Const` center
• **center**: *[QWidget](classes/qwidget.md)‹›* = new QWidget()
___
### `Const` getBtn
• **getBtn**: *[QPushButton](classes/qpushbutton.md)‹›* = new QPushButton()
___
### `Const` label
• **label**: *[QLabel](classes/qlabel.md)‹›* = new QLabel()
___
### `Const` setBtn
• **setBtn**: *[QPushButton](classes/qpushbutton.md)‹›* = new QPushButton()
___
### `Const` testImagePath
• **testImagePath**: *string* = path.resolve(__dirname, 'assets', 'nodegui.png')
___
### `Const` textInput
• **textInput**: *[QLineEdit](classes/qlineedit.md)‹›* = new QLineEdit()
___
### `Const` win
• **win**: *[QMainWindow](classes/qmainwindow.md)‹›* = new QMainWindow()
@ -574,14 +577,6 @@ ___
___
### noop
▸ **noop**(): *void*
**Returns:** *void*
___
### prepareInlineStyleSheet
▸ **prepareInlineStyleSheet**<**Signals**>(`widget`: [NodeWidget](classes/nodewidget.md)‹Signals›, `rawStyle`: string): *string*

2
website/docs/api/generated/interfaces/qabstractspinboxsignals.md
View File

@ -12,6 +12,8 @@ sidebar_label: "QAbstractSpinBoxSignals"
↳ [QDateTimeEditSignals](qdatetimeeditsignals.md)
↳ [QDoubleSpinBoxSignals](qdoublespinboxsignals.md)
↳ [QSpinBoxSignals](qspinboxsignals.md)
## Index

174
website/docs/api/generated/interfaces/qcolordialogsignals.md Normal file
View File

@ -0,0 +1,174 @@
---
id: "qcolordialogsignals"
title: "QColorDialogSignals"
sidebar_label: "QColorDialogSignals"
---
## Hierarchy
↳ [QDialogSignals](qdialogsignals.md)
↳ **QColorDialogSignals**
## Index
### Properties
* [accepted](qcolordialogsignals.md#accepted)
* [colorSelected](qcolordialogsignals.md#colorselected)
* [currentColorChanged](qcolordialogsignals.md#currentcolorchanged)
* [customContextMenuRequested](qcolordialogsignals.md#customcontextmenurequested)
* [finished](qcolordialogsignals.md#finished)
* [objectNameChanged](qcolordialogsignals.md#objectnamechanged)
* [rejected](qcolordialogsignals.md#rejected)
* [windowIconChanged](qcolordialogsignals.md#windowiconchanged)
* [windowTitleChanged](qcolordialogsignals.md#windowtitlechanged)
## Properties
### accepted
• **accepted**: *function*
*Inherited from [QDialogSignals](qdialogsignals.md).[accepted](qdialogsignals.md#accepted)*
#### Type declaration:
▸ (): *void*
___
### colorSelected
• **colorSelected**: *function*
#### Type declaration:
▸ (`color`: [QColor](../classes/qcolor.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`color` | [QColor](../classes/qcolor.md) |
___
### currentColorChanged
• **currentColorChanged**: *function*
#### Type declaration:
▸ (`color`: [QColor](../classes/qcolor.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`color` | [QColor](../classes/qcolor.md) |
___
### customContextMenuRequested
• **customContextMenuRequested**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)*
#### Type declaration:
▸ (`pos`: object): *void*
**Parameters:**
▪ **pos**: *object*
Name | Type |
------ | ------ |
`x` | number |
`y` | number |
___
### finished
• **finished**: *function*
*Inherited from [QDialogSignals](qdialogsignals.md).[finished](qdialogsignals.md#finished)*
#### Type declaration:
▸ (`result`: number): *void*
**Parameters:**
Name | Type |
------ | ------ |
`result` | number |
___
### objectNameChanged
• **objectNameChanged**: *function*
*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)*
#### Type declaration:
▸ (`objectName`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`objectName` | string |
___
### rejected
• **rejected**: *function*
*Inherited from [QDialogSignals](qdialogsignals.md).[rejected](qdialogsignals.md#rejected)*
#### Type declaration:
▸ (): *void*
___
### windowIconChanged
• **windowIconChanged**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[windowIconChanged](qwidgetsignals.md#windowiconchanged)*
#### Type declaration:
▸ (`iconNative`: [NativeElement](../globals.md#nativeelement)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`iconNative` | [NativeElement](../globals.md#nativeelement) |
___
### windowTitleChanged
• **windowTitleChanged**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[windowTitleChanged](qwidgetsignals.md#windowtitlechanged)*
#### Type declaration:
▸ (`title`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`title` | string |

6
website/docs/api/generated/interfaces/qdialogsignals.md
View File

@ -10,8 +10,14 @@ sidebar_label: "QDialogSignals"
↳ **QDialogSignals**
↳ [QColorDialogSignals](qcolordialogsignals.md)
↳ [QFileDialogSignals](qfiledialogsignals.md)
↳ [QFontDialogSignals](qfontdialogsignals.md)
↳ [QProgressDialogSignals](qprogressdialogsignals.md)
↳ [QMessageBoxSignals](qmessageboxsignals.md)
↳ [QInputDialogSignals](qinputdialogsignals.md)

125
website/docs/api/generated/interfaces/qdoublespinboxsignals.md Normal file
View File

@ -0,0 +1,125 @@
---
id: "qdoublespinboxsignals"
title: "QDoubleSpinBoxSignals"
sidebar_label: "QDoubleSpinBoxSignals"
---
## Hierarchy
↳ [QAbstractSpinBoxSignals](qabstractspinboxsignals.md)
↳ **QDoubleSpinBoxSignals**
## Index
### Properties
* [customContextMenuRequested](qdoublespinboxsignals.md#customcontextmenurequested)
* [editingFinished](qdoublespinboxsignals.md#editingfinished)
* [objectNameChanged](qdoublespinboxsignals.md#objectnamechanged)
* [valueChanged](qdoublespinboxsignals.md#valuechanged)
* [windowIconChanged](qdoublespinboxsignals.md#windowiconchanged)
* [windowTitleChanged](qdoublespinboxsignals.md#windowtitlechanged)
## Properties
### customContextMenuRequested
• **customContextMenuRequested**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)*
#### Type declaration:
▸ (`pos`: object): *void*
**Parameters:**
▪ **pos**: *object*
Name | Type |
------ | ------ |
`x` | number |
`y` | number |
___
### editingFinished
• **editingFinished**: *function*
*Inherited from [QAbstractSpinBoxSignals](qabstractspinboxsignals.md).[editingFinished](qabstractspinboxsignals.md#editingfinished)*
#### Type declaration:
▸ (): *void*
___
### objectNameChanged
• **objectNameChanged**: *function*
*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)*
#### Type declaration:
▸ (`objectName`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`objectName` | string |
___
### valueChanged
• **valueChanged**: *function*
#### Type declaration:
▸ (`value`: number): *void*
**Parameters:**
Name | Type |
------ | ------ |
`value` | number |
___
### windowIconChanged
• **windowIconChanged**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[windowIconChanged](qwidgetsignals.md#windowiconchanged)*
#### Type declaration:
▸ (`iconNative`: [NativeElement](../globals.md#nativeelement)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`iconNative` | [NativeElement](../globals.md#nativeelement) |
___
### windowTitleChanged
• **windowTitleChanged**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[windowTitleChanged](qwidgetsignals.md#windowtitlechanged)*
#### Type declaration:
▸ (`title`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`title` | string |

174
website/docs/api/generated/interfaces/qfontdialogsignals.md Normal file
View File

@ -0,0 +1,174 @@
---
id: "qfontdialogsignals"
title: "QFontDialogSignals"
sidebar_label: "QFontDialogSignals"
---
## Hierarchy
↳ [QDialogSignals](qdialogsignals.md)
↳ **QFontDialogSignals**
## Index
### Properties
* [accepted](qfontdialogsignals.md#accepted)
* [currentFontChanged](qfontdialogsignals.md#currentfontchanged)
* [customContextMenuRequested](qfontdialogsignals.md#customcontextmenurequested)
* [finished](qfontdialogsignals.md#finished)
* [fontSelected](qfontdialogsignals.md#fontselected)
* [objectNameChanged](qfontdialogsignals.md#objectnamechanged)
* [rejected](qfontdialogsignals.md#rejected)
* [windowIconChanged](qfontdialogsignals.md#windowiconchanged)
* [windowTitleChanged](qfontdialogsignals.md#windowtitlechanged)
## Properties
### accepted
• **accepted**: *function*
*Inherited from [QDialogSignals](qdialogsignals.md).[accepted](qdialogsignals.md#accepted)*
#### Type declaration:
▸ (): *void*
___
### currentFontChanged
• **currentFontChanged**: *function*
#### Type declaration:
▸ (`font`: [QFont](../classes/qfont.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`font` | [QFont](../classes/qfont.md) |
___
### customContextMenuRequested
• **customContextMenuRequested**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)*
#### Type declaration:
▸ (`pos`: object): *void*
**Parameters:**
▪ **pos**: *object*
Name | Type |
------ | ------ |
`x` | number |
`y` | number |
___
### finished
• **finished**: *function*
*Inherited from [QDialogSignals](qdialogsignals.md).[finished](qdialogsignals.md#finished)*
#### Type declaration:
▸ (`result`: number): *void*
**Parameters:**
Name | Type |
------ | ------ |
`result` | number |
___
### fontSelected
• **fontSelected**: *function*
#### Type declaration:
▸ (`font`: [QFont](../classes/qfont.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`font` | [QFont](../classes/qfont.md) |
___
### objectNameChanged
• **objectNameChanged**: *function*
*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)*
#### Type declaration:
▸ (`objectName`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`objectName` | string |
___
### rejected
• **rejected**: *function*
*Inherited from [QDialogSignals](qdialogsignals.md).[rejected](qdialogsignals.md#rejected)*
#### Type declaration:
▸ (): *void*
___
### windowIconChanged
• **windowIconChanged**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[windowIconChanged](qwidgetsignals.md#windowiconchanged)*
#### Type declaration:
▸ (`iconNative`: [NativeElement](../globals.md#nativeelement)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`iconNative` | [NativeElement](../globals.md#nativeelement) |
___
### windowTitleChanged
• **windowTitleChanged**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[windowTitleChanged](qwidgetsignals.md#windowtitlechanged)*
#### Type declaration:
▸ (`title`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`title` | string |

106
website/docs/api/generated/interfaces/qlcdnumbersignals.md Normal file
View File

@ -0,0 +1,106 @@
---
id: "qlcdnumbersignals"
title: "QLCDNumberSignals"
sidebar_label: "QLCDNumberSignals"
---
## Hierarchy
↳ [QWidgetSignals](qwidgetsignals.md)
↳ **QLCDNumberSignals**
## Index
### Properties
* [customContextMenuRequested](qlcdnumbersignals.md#customcontextmenurequested)
* [objectNameChanged](qlcdnumbersignals.md#objectnamechanged)
* [overflow](qlcdnumbersignals.md#overflow)
* [windowIconChanged](qlcdnumbersignals.md#windowiconchanged)
* [windowTitleChanged](qlcdnumbersignals.md#windowtitlechanged)
## Properties
### customContextMenuRequested
• **customContextMenuRequested**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)*
#### Type declaration:
▸ (`pos`: object): *void*
**Parameters:**
▪ **pos**: *object*
Name | Type |
------ | ------ |
`x` | number |
`y` | number |
___
### objectNameChanged
• **objectNameChanged**: *function*
*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)*
#### Type declaration:
▸ (`objectName`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`objectName` | string |
___
### overflow
• **overflow**: *function*
#### Type declaration:
▸ (): *void*
___
### windowIconChanged
• **windowIconChanged**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[windowIconChanged](qwidgetsignals.md#windowiconchanged)*
#### Type declaration:
▸ (`iconNative`: [NativeElement](../globals.md#nativeelement)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`iconNative` | [NativeElement](../globals.md#nativeelement) |
___
### windowTitleChanged
• **windowTitleChanged**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[windowTitleChanged](qwidgetsignals.md#windowtitlechanged)*
#### Type declaration:
▸ (`title`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`title` | string |

120
website/docs/api/generated/interfaces/qlistwidgetsignals.md
View File

@ -14,9 +14,16 @@ sidebar_label: "QListWidgetSignals"
### Properties
* [currentItemChanged](qlistwidgetsignals.md#currentitemchanged)
* [currentRowChanged](qlistwidgetsignals.md#currentrowchanged)
* [currentTextChanged](qlistwidgetsignals.md#currenttextchanged)
* [customContextMenuRequested](qlistwidgetsignals.md#customcontextmenurequested)
* [itemActivated](qlistwidgetsignals.md#itemactivated)
* [itemChanged](qlistwidgetsignals.md#itemchanged)
* [itemClicked](qlistwidgetsignals.md#itemclicked)
* [itemDoubleClicked](qlistwidgetsignals.md#itemdoubleclicked)
* [itemEntered](qlistwidgetsignals.md#itementered)
* [itemPressed](qlistwidgetsignals.md#itempressed)
* [itemSelectionChanged](qlistwidgetsignals.md#itemselectionchanged)
* [objectNameChanged](qlistwidgetsignals.md#objectnamechanged)
* [viewportEntered](qlistwidgetsignals.md#viewportentered)
@ -25,6 +32,23 @@ sidebar_label: "QListWidgetSignals"
## Properties
### currentItemChanged
• **currentItemChanged**: *function*
#### Type declaration:
▸ (`current`: [QListWidgetItem](../classes/qlistwidgetitem.md), `previous`: [QListWidgetItem](../classes/qlistwidgetitem.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`current` | [QListWidgetItem](../classes/qlistwidgetitem.md) |
`previous` | [QListWidgetItem](../classes/qlistwidgetitem.md) |
___
### currentRowChanged
• **currentRowChanged**: *function*
@ -78,6 +102,102 @@ Name | Type |
___
### itemActivated
• **itemActivated**: *function*
#### Type declaration:
▸ (`item`: [QListWidgetItem](../classes/qlistwidgetitem.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`item` | [QListWidgetItem](../classes/qlistwidgetitem.md) |
___
### itemChanged
• **itemChanged**: *function*
#### Type declaration:
▸ (`item`: [QListWidgetItem](../classes/qlistwidgetitem.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`item` | [QListWidgetItem](../classes/qlistwidgetitem.md) |
___
### itemClicked
• **itemClicked**: *function*
#### Type declaration:
▸ (`item`: [QListWidgetItem](../classes/qlistwidgetitem.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`item` | [QListWidgetItem](../classes/qlistwidgetitem.md) |
___
### itemDoubleClicked
• **itemDoubleClicked**: *function*
#### Type declaration:
▸ (`item`: [QListWidgetItem](../classes/qlistwidgetitem.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`item` | [QListWidgetItem](../classes/qlistwidgetitem.md) |
___
### itemEntered
• **itemEntered**: *function*
#### Type declaration:
▸ (`item`: [QListWidgetItem](../classes/qlistwidgetitem.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`item` | [QListWidgetItem](../classes/qlistwidgetitem.md) |
___
### itemPressed
• **itemPressed**: *function*
#### Type declaration:
▸ (`item`: [QListWidgetItem](../classes/qlistwidgetitem.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`item` | [QListWidgetItem](../classes/qlistwidgetitem.md) |
___
### itemSelectionChanged
• **itemSelectionChanged**: *function*

2
website/docs/api/generated/interfaces/qobjectsignals.md
View File

@ -14,6 +14,8 @@ sidebar_label: "QObjectSignals"
↳ [QWidgetSignals](qwidgetsignals.md)
↳ [QStandardItemModelSignals](qstandarditemmodelsignals.md)
↳ [QButtonGroupSignals](qbuttongroupsignals.md)
↳ [QSystemTrayIconSignals](qsystemtrayiconsignals.md)

151
website/docs/api/generated/interfaces/qprogressdialogsignals.md Normal file
View File

@ -0,0 +1,151 @@
---
id: "qprogressdialogsignals"
title: "QProgressDialogSignals"
sidebar_label: "QProgressDialogSignals"
---
## Hierarchy
↳ [QDialogSignals](qdialogsignals.md)
↳ **QProgressDialogSignals**
## Index
### Properties
* [accepted](qprogressdialogsignals.md#accepted)
* [canceled](qprogressdialogsignals.md#canceled)
* [customContextMenuRequested](qprogressdialogsignals.md#customcontextmenurequested)
* [finished](qprogressdialogsignals.md#finished)
* [objectNameChanged](qprogressdialogsignals.md#objectnamechanged)
* [rejected](qprogressdialogsignals.md#rejected)
* [windowIconChanged](qprogressdialogsignals.md#windowiconchanged)
* [windowTitleChanged](qprogressdialogsignals.md#windowtitlechanged)
## Properties
### accepted
• **accepted**: *function*
*Inherited from [QDialogSignals](qdialogsignals.md).[accepted](qdialogsignals.md#accepted)*
#### Type declaration:
▸ (): *void*
___
### canceled
• **canceled**: *function*
#### Type declaration:
▸ (): *void*
___
### customContextMenuRequested
• **customContextMenuRequested**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)*
#### Type declaration:
▸ (`pos`: object): *void*
**Parameters:**
▪ **pos**: *object*
Name | Type |
------ | ------ |
`x` | number |
`y` | number |
___
### finished
• **finished**: *function*
*Inherited from [QDialogSignals](qdialogsignals.md).[finished](qdialogsignals.md#finished)*
#### Type declaration:
▸ (`result`: number): *void*
**Parameters:**
Name | Type |
------ | ------ |
`result` | number |
___
### objectNameChanged
• **objectNameChanged**: *function*
*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)*
#### Type declaration:
▸ (`objectName`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`objectName` | string |
___
### rejected
• **rejected**: *function*
*Inherited from [QDialogSignals](qdialogsignals.md).[rejected](qdialogsignals.md#rejected)*
#### Type declaration:
▸ (): *void*
___
### windowIconChanged
• **windowIconChanged**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[windowIconChanged](qwidgetsignals.md#windowiconchanged)*
#### Type declaration:
▸ (`iconNative`: [NativeElement](../globals.md#nativeelement)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`iconNative` | [NativeElement](../globals.md#nativeelement) |
___
### windowTitleChanged
• **windowTitleChanged**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[windowTitleChanged](qwidgetsignals.md#windowtitlechanged)*
#### Type declaration:
▸ (`title`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`title` | string |

52
website/docs/api/generated/interfaces/qstandarditemmodelsignals.md Normal file
View File

@ -0,0 +1,52 @@
---
id: "qstandarditemmodelsignals"
title: "QStandardItemModelSignals"
sidebar_label: "QStandardItemModelSignals"
---
## Hierarchy
* [QObjectSignals](qobjectsignals.md)
↳ **QStandardItemModelSignals**
## Index
### Properties
* [itemChanged](qstandarditemmodelsignals.md#itemchanged)
* [objectNameChanged](qstandarditemmodelsignals.md#objectnamechanged)
## Properties
### itemChanged
• **itemChanged**: *function*
#### Type declaration:
▸ (`item`: [QStandardItem](../classes/qstandarditem.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`item` | [QStandardItem](../classes/qstandarditem.md) |
___
### objectNameChanged
• **objectNameChanged**: *function*
*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)*
#### Type declaration:
▸ (`objectName`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`objectName` | string |

181
website/docs/api/generated/interfaces/qtabbarsignals.md Normal file
View File

@ -0,0 +1,181 @@
---
id: "qtabbarsignals"
title: "QTabBarSignals"
sidebar_label: "QTabBarSignals"
---
## Hierarchy
↳ [QWidgetSignals](qwidgetsignals.md)
↳ **QTabBarSignals**
## Index
### Properties
* [currentChanged](qtabbarsignals.md#currentchanged)
* [customContextMenuRequested](qtabbarsignals.md#customcontextmenurequested)
* [objectNameChanged](qtabbarsignals.md#objectnamechanged)
* [tabBarClicked](qtabbarsignals.md#tabbarclicked)
* [tabBarDoubleClicked](qtabbarsignals.md#tabbardoubleclicked)
* [tabCloseRequested](qtabbarsignals.md#tabcloserequested)
* [tabMoved](qtabbarsignals.md#tabmoved)
* [windowIconChanged](qtabbarsignals.md#windowiconchanged)
* [windowTitleChanged](qtabbarsignals.md#windowtitlechanged)
## Properties
### currentChanged
• **currentChanged**: *function*
#### Type declaration:
▸ (`index`: number): *void*
**Parameters:**
Name | Type |
------ | ------ |
`index` | number |
___
### customContextMenuRequested
• **customContextMenuRequested**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)*
#### Type declaration:
▸ (`pos`: object): *void*
**Parameters:**
▪ **pos**: *object*
Name | Type |
------ | ------ |
`x` | number |
`y` | number |
___
### objectNameChanged
• **objectNameChanged**: *function*
*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)*
#### Type declaration:
▸ (`objectName`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`objectName` | string |
___
### tabBarClicked
• **tabBarClicked**: *function*
#### Type declaration:
▸ (`index`: number): *void*
**Parameters:**
Name | Type |
------ | ------ |
`index` | number |
___
### tabBarDoubleClicked
• **tabBarDoubleClicked**: *function*
#### Type declaration:
▸ (`index`: number): *void*
**Parameters:**
Name | Type |
------ | ------ |
`index` | number |
___
### tabCloseRequested
• **tabCloseRequested**: *function*
#### Type declaration:
▸ (`index`: number): *void*
**Parameters:**
Name | Type |
------ | ------ |
`index` | number |
___
### tabMoved
• **tabMoved**: *function*
#### Type declaration:
▸ (`from`: number, `to`: number): *void*
**Parameters:**
Name | Type |
------ | ------ |
`from` | number |
`to` | number |
___
### windowIconChanged
• **windowIconChanged**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[windowIconChanged](qwidgetsignals.md#windowiconchanged)*
#### Type declaration:
▸ (`iconNative`: [NativeElement](../globals.md#nativeelement)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`iconNative` | [NativeElement](../globals.md#nativeelement) |
___
### windowTitleChanged
• **windowTitleChanged**: *function*
*Inherited from [QWidgetSignals](qwidgetsignals.md).[windowTitleChanged](qwidgetsignals.md#windowtitlechanged)*
#### Type declaration:
▸ (`title`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`title` | string |

6
website/docs/api/generated/interfaces/qwidgetsignals.md
View File

@ -20,9 +20,11 @@ sidebar_label: "QWidgetSignals"
↳ [QCalendarWidgetSignals](qcalendarwidgetsignals.md)
↳ [QDialogSignals](qdialogsignals.md)
↳ [QLabelSignals](qlabelsignals.md)
↳ [QDialogSignals](qdialogsignals.md)
↳ [QLCDNumberSignals](qlcdnumbersignals.md)
↳ [QLineEditSignals](qlineeditsignals.md)
@ -34,6 +36,8 @@ sidebar_label: "QWidgetSignals"
↳ [QStackedWidgetSignals](qstackedwidgetsignals.md)
↳ [QTabBarSignals](qtabbarsignals.md)
↳ [QTabWidgetSignals](qtabwidgetsignals.md)
↳ [QTableWidgetSignals](qtablewidgetsignals.md)

25
website/docs/api/sidebar-gen.js
View File

@ -8,6 +8,7 @@ module.exports = {
"api/generated/classes/nodedialog",
"api/generated/classes/nodeframe",
"api/generated/classes/nodelayout",
"api/generated/classes/nodelistview",
"api/generated/classes/nodeobject",
"api/generated/classes/nodetableview",
"api/generated/classes/nodewidget",
@ -19,11 +20,13 @@ module.exports = {
"api/generated/classes/qaction",
"api/generated/classes/qapplication",
"api/generated/classes/qboxlayout",
"api/generated/classes/qbrush",
"api/generated/classes/qbuttongroup",
"api/generated/classes/qcalendarwidget",
"api/generated/classes/qcheckbox",
"api/generated/classes/qclipboard",
"api/generated/classes/qcolor",
"api/generated/classes/qcolordialog",
"api/generated/classes/qcombobox",
"api/generated/classes/qcursor",
"api/generated/classes/qdate",
@ -32,9 +35,12 @@ module.exports = {
"api/generated/classes/qdatetimeedit",
"api/generated/classes/qdial",
"api/generated/classes/qdialog",
"api/generated/classes/qdoublespinbox",
"api/generated/classes/qerrormessage",
"api/generated/classes/qfiledialog",
"api/generated/classes/qfont",
"api/generated/classes/qfontdatabase",
"api/generated/classes/qfontdialog",
"api/generated/classes/qframe",
"api/generated/classes/qgridlayout",
"api/generated/classes/qgroupbox",
@ -42,8 +48,10 @@ module.exports = {
"api/generated/classes/qinputdialog",
"api/generated/classes/qkeyevent",
"api/generated/classes/qkeysequence",
"api/generated/classes/qlcdnumber",
"api/generated/classes/qlabel",
"api/generated/classes/qlineedit",
"api/generated/classes/qlistview",
"api/generated/classes/qlistwidget",
"api/generated/classes/qlistwidgetitem",
"api/generated/classes/qmainwindow",
@ -60,6 +68,7 @@ module.exports = {
"api/generated/classes/qplaintextedit",
"api/generated/classes/qpoint",
"api/generated/classes/qprogressbar",
"api/generated/classes/qprogressdialog",
"api/generated/classes/qpushbutton",
"api/generated/classes/qradiobutton",
"api/generated/classes/qrect",
@ -71,9 +80,12 @@ module.exports = {
"api/generated/classes/qslider",
"api/generated/classes/qspinbox",
"api/generated/classes/qstackedwidget",
"api/generated/classes/qstandarditem",
"api/generated/classes/qstandarditemmodel",
"api/generated/classes/qstatusbar",
"api/generated/classes/qstyle",
"api/generated/classes/qsystemtrayicon",
"api/generated/classes/qtabbar",
"api/generated/classes/qtabwidget",
"api/generated/classes/qtableview",
"api/generated/classes/qtablewidget",
@ -100,6 +112,7 @@ module.exports = {
"api/generated/enums/axis",
"api/generated/enums/bgmode",
"api/generated/enums/brushstyle",
"api/generated/enums/buttonposition",
"api/generated/enums/buttonrole",
"api/generated/enums/buttonsymbols",
"api/generated/enums/cachemode",
@ -107,6 +120,7 @@ module.exports = {
"api/generated/enums/checkstate",
"api/generated/enums/checksumtype",
"api/generated/enums/clipoperation",
"api/generated/enums/colordialogoption",
"api/generated/enums/connectiontype",
"api/generated/enums/contextmenupolicy",
"api/generated/enums/coordinatesystem",
@ -132,6 +146,7 @@ module.exports = {
"api/generated/enums/flow",
"api/generated/enums/focuspolicy",
"api/generated/enums/focusreason",
"api/generated/enums/fontdialogoption",
"api/generated/enums/gestureflag",
"api/generated/enums/gesturestate",
"api/generated/enums/gesturetype",
@ -156,6 +171,7 @@ module.exports = {
"api/generated/enums/linewrapmode",
"api/generated/enums/maskmode",
"api/generated/enums/matchflag",
"api/generated/enums/mode",
"api/generated/enums/modifier",
"api/generated/enums/mousebutton",
"api/generated/enums/mouseeventflag",
@ -188,6 +204,7 @@ module.exports = {
"api/generated/enums/scrollhint",
"api/generated/enums/scrollmode",
"api/generated/enums/scrollphase",
"api/generated/enums/segmentstyle",
"api/generated/enums/selectionbehavior",
"api/generated/enums/selectionmode",
"api/generated/enums/sequenceformat",
@ -202,6 +219,7 @@ module.exports = {
"api/generated/enums/sortorder",
"api/generated/enums/steptype",
"api/generated/enums/systemfont",
"api/generated/enums/tabbarshape",
"api/generated/enums/tabfocusbehavior",
"api/generated/enums/tabposition",
"api/generated/enums/textelidemode",
@ -238,12 +256,16 @@ module.exports = {
"api/generated/interfaces/qbuttongroupsignals",
"api/generated/interfaces/qcalendarwidgetsignals",
"api/generated/interfaces/qcheckboxsignals",
"api/generated/interfaces/qcolordialogsignals",
"api/generated/interfaces/qcomboboxsignals",
"api/generated/interfaces/qdatetimeeditsignals",
"api/generated/interfaces/qdialogsignals",
"api/generated/interfaces/qdoublespinboxsignals",
"api/generated/interfaces/qfiledialogsignals",
"api/generated/interfaces/qfontdialogsignals",
"api/generated/interfaces/qgroupboxsignals",
"api/generated/interfaces/qinputdialogsignals",
"api/generated/interfaces/qlcdnumbersignals",
"api/generated/interfaces/qlabelsignals",
"api/generated/interfaces/qlineeditsignals",
"api/generated/interfaces/qlistwidgetsignals",
@ -252,11 +274,14 @@ module.exports = {
"api/generated/interfaces/qobjectsignals",
"api/generated/interfaces/qplaintexteditsignals",
"api/generated/interfaces/qprogressbarsignals",
"api/generated/interfaces/qprogressdialogsignals",
"api/generated/interfaces/qshortcutsignals",
"api/generated/interfaces/qspinboxsignals",
"api/generated/interfaces/qstackedwidgetsignals",
"api/generated/interfaces/qstandarditemmodelsignals",
"api/generated/interfaces/qstatusbarsignals",
"api/generated/interfaces/qsystemtrayiconsignals",
"api/generated/interfaces/qtabbarsignals",
"api/generated/interfaces/qtabwidgetsignals",
"api/generated/interfaces/qtablewidgetsignals",
"api/generated/interfaces/qtoolbuttonsignals",

98
website/docs/guides/handle-events.md
View File

@ -3,4 +3,100 @@ sidebar_label: Handle Events
title: Handle Events
---
WIP
NodeGui allows you to listen to various events that might originate from the underlying Qt widgets. These events can either be a simple button click or a text change on a lineedit or even something like window being hidden and shown.
In order to do this we need to attach an event listener to the respective widget.
Technically, the event listener is a NodeJs [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) instance that listens to events from the underlying Qt widget. The native Qt widget would send all the events to the event emitter in NodeGui world and the user can essentially subscribe to it.
Lets see an example to see how this looks in practice.
## Event handling
The following example demonstrates how to add an event listener to a button widget.
<img src="https://github.com/nodegui/nodegui/releases/download/assets/event-example.gif" alt="event example" style={{width: '100%', maxWidth: 400}}/>
```javascript
const { QMainWindow, QPushButton } = require('@nodegui/nodegui');
const win = new QMainWindow();
const button = new QPushButton();
button.setText('Click me');
button.addEventListener('clicked', () => {
console.log('the button was clicked');
});
win.setCentralWidget(button);
win.show();
global.win = win;
```
The addEventListener function accepts an event type, followed by a handler for the event. You can register multiple handlers for the same event by calling addEventListener multiple times.
Internally, Qt widgets in nodegui has two types of events.:
- Signals: In short these are basically different for different widgets. So a button maybe have `clicked`, `pressed` signal, while a linedit may have `textChanged` signal.
- QEvents: These are common set of events for all the widgets/qobjects in NodeGui world. These are also helpful at times but typically you would end up using signals more than these common events.
In NodeGui you can listen to both Signals and QEvents using the same addEventListener function.
### How do I know which events are supported ?
In order to find all the supported events for a widget you can take a look at
#### All Signals for the widgets:
- [https://docs.nodegui.org/docs/api/generated/globals/#interfaces](https://docs.nodegui.org/docs/api/generated/globals/#interfaces)
- [https://docs.nodegui.org/docs/api/generated/globals/#type-aliases](https://docs.nodegui.org/docs/api/generated/globals/#type-aliases)
You can subscribe to a signal like so:
```javascript
const { QMainWindow, QCheckBox } = require('@nodegui/nodegui');
const win = new QMainWindow();
const checkbox = new QCheckBox();
checkbox.setText('Check/Uncheck me');
checkbox.addEventListener('clicked', checked => {
console.log('was checked', checked);
});
win.setCentralWidget(checkbox);
win.show();
global.win = win;
```
The value you receive in the callback depends on the signal. Refer to respective signal docs for more details. All the handlers are also typed. So if you are using typescript you should get correct autocomplete for it.
#### All common QEvents for the widgets
In nodegui all these common QEvents are represented under an enum type: [WidgetEventTypes](https://docs.nodegui.org/docs/api/generated/enums/widgeteventtypes)
You can subscribe to a QEvent like so:
```javascript
const { QMainWindow, QLabel, WidgetEventTypes, QMouseEvent } = require('@nodegui/nodegui');
const win = new QMainWindow();
const label = new QLabel();
label.setText('Move your move here');
label.setMouseTracking(true);
label.addEventListener(WidgetEventTypes.MouseMove, nativeEvt => {
const mouseEvt = new QMouseEvent(nativeEvt);
console.log('mouseMoved at: ', { x: mouseEvt.x(), y: mouseEvt.y() });
});
win.setCentralWidget(label);
win.show();
global.win = win;
```
<img src="https://github.com/nodegui/nodegui/releases/download/assets/mouseevent.gif" alt="mouse event listener" style={{width: '100%', maxWidth: 400}}/>
Note here that every QEvent handler gives a reference to native QEvent in the handler callback.
Not all native QEvent wrappers are implemented yet and we might need your help regarding those. Feel free to jump in and contribute to the nodegui core.

1192
website/yarn.lock
View File

File diff suppressed because it is too large Load Diff