From 47d92c57ad0cec39f4a0780b7377d876bcf76c73 Mon Sep 17 00:00:00 2001 From: Atul R Date: Fri, 10 Jan 2020 11:16:42 +0530 Subject: [PATCH] updates docs (#342) --- .../docs/api/generated/classes/nodeobject.md | 2 + .../api/generated/classes/qabstractbutton.md | 7 + .../generated/classes/qabstractitemview.md | 7 + .../api/generated/classes/qabstractspinbox.md | 7 + .../docs/api/generated/classes/qboxlayout.md | 19 + .../api/generated/classes/qbuttongroup.md | 396 ++++++++++++++++++ .../api/generated/classes/qcalendarwidget.md | 15 + .../docs/api/generated/classes/qcombobox.md | 26 ++ .../docs/api/generated/classes/qdateedit.md | 15 + .../api/generated/classes/qdatetimeedit.md | 21 + website/docs/api/generated/classes/qdialog.md | 6 + .../docs/api/generated/classes/qfiledialog.md | 45 ++ .../docs/api/generated/classes/qgroupbox.md | 33 ++ .../docs/api/generated/classes/qlistwidget.md | 23 + .../api/generated/classes/qlistwidgetitem.md | 23 + .../docs/api/generated/classes/qmessagebox.md | 19 + .../docs/api/generated/classes/qpainter.md | 32 ++ .../api/generated/classes/qstackedwidget.md | 38 ++ .../api/generated/classes/qtablewidget.md | 29 ++ .../api/generated/classes/qtablewidgetitem.md | 29 ++ .../docs/api/generated/classes/qtabwidget.md | 18 + .../docs/api/generated/classes/qtimeedit.md | 15 + .../docs/api/generated/classes/qtoolbutton.md | 15 + .../docs/api/generated/classes/qtreewidget.md | 36 ++ .../api/generated/classes/qtreewidgetitem.md | 36 ++ website/docs/api/generated/globals.md | 2 + .../interfaces/qbuttongroupsignals.md | 52 +++ .../generated/interfaces/qobjectsignals.md | 2 + website/docs/api/sidebar-gen.js | 2 + 29 files changed, 970 insertions(+) create mode 100644 website/docs/api/generated/classes/qbuttongroup.md create mode 100644 website/docs/api/generated/interfaces/qbuttongroupsignals.md diff --git a/website/docs/api/generated/classes/nodeobject.md b/website/docs/api/generated/classes/nodeobject.md index 267eb8c08..ff67bb2aa 100644 --- a/website/docs/api/generated/classes/nodeobject.md +++ b/website/docs/api/generated/classes/nodeobject.md @@ -24,6 +24,8 @@ sidebar_label: "NodeObject" ↳ [QAction](qaction.md) + ↳ [QButtonGroup](qbuttongroup.md) + ↳ [QSystemTrayIcon](qsystemtrayicon.md) ↳ [QShortcut](qshortcut.md) diff --git a/website/docs/api/generated/classes/qabstractbutton.md b/website/docs/api/generated/classes/qabstractbutton.md index 030c2f7e3..c0add3bbc 100644 --- a/website/docs/api/generated/classes/qabstractbutton.md +++ b/website/docs/api/generated/classes/qabstractbutton.md @@ -4,6 +4,13 @@ title: "QAbstractButton" sidebar_label: "QAbstractButton" --- +> This is the abstract base class of button widgets, providing their functionality. + +**This class is a JS wrapper around Qt's [QAbstractButton class](https://doc.qt.io/qt-5/qabstractbutton.html)** + +The QAbstractButton class is an abstract class and therefore, technically, no further instances actually have to be created. +It is inherited by QCheckBox, QPushButton, QRadioButton, and QToolButton. + ## Type parameters ▪ **Signals**: *[QAbstractButtonSignals](../interfaces/qabstractbuttonsignals.md)* diff --git a/website/docs/api/generated/classes/qabstractitemview.md b/website/docs/api/generated/classes/qabstractitemview.md index 2b4e71e2b..5d84adcf8 100644 --- a/website/docs/api/generated/classes/qabstractitemview.md +++ b/website/docs/api/generated/classes/qabstractitemview.md @@ -4,6 +4,13 @@ title: "QAbstractItemView" sidebar_label: "QAbstractItemView" --- +> This is the abstract base class of button widgets, providing their functionality. + +**This class is a JS wrapper around Qt's [QAbstractItemView class](https://doc.qt.io/qt-5/qabstractitemview.html)** + +The QAbstractItemView class is an abstract class and therefore, technically, no further instances actually have to be created. +It is inherited by QListWidget. (n/a QColumnView, QHeaderView, QListView, QTableView, and QTreeView) + ## Type parameters ▪ **Signals**: *[QAbstractItemViewSignals](../interfaces/qabstractitemviewsignals.md)* diff --git a/website/docs/api/generated/classes/qabstractspinbox.md b/website/docs/api/generated/classes/qabstractspinbox.md index 82d12c12a..80e5ca9b4 100644 --- a/website/docs/api/generated/classes/qabstractspinbox.md +++ b/website/docs/api/generated/classes/qabstractspinbox.md @@ -4,6 +4,13 @@ title: "QAbstractSpinBox" sidebar_label: "QAbstractSpinBox" --- +> This is the abstract base class of button widgets, providing their functionality. + +**This class is a JS wrapper around Qt's [QAbstractSpinBox class](https://doc.qt.io/qt-5/qabstractspinbox.html)** + +The QAbstractSpinBox class is an abstract class and therefore, technically, no further instances actually have to be created. +It is inherited by QDateTimeEdit and QSpinBox. (n/a QDoubleSpinBox) + ## Type parameters ▪ **Signals**: *[QAbstractSpinBoxSignals](../interfaces/qabstractspinboxsignals.md)* diff --git a/website/docs/api/generated/classes/qboxlayout.md b/website/docs/api/generated/classes/qboxlayout.md index 2e4e1ab3f..28e90d2ba 100644 --- a/website/docs/api/generated/classes/qboxlayout.md +++ b/website/docs/api/generated/classes/qboxlayout.md @@ -4,6 +4,25 @@ title: "QBoxLayout" sidebar_label: "QBoxLayout" --- +> Lines up child widgets horizontally or vertically. + +**This class is a JS wrapper around Qt's [QBoxLayout class](https://doc.qt.io/qt-5/qboxlayout.html)** + +### Example + +```javascript +// This example arranges two calendars horizontally. + +const { QBoxLayout, QCalendarWidget } = require("@nodegui/nodegui"); + +const centralWidget = new QWidget(); +const boxLayout = new QBoxLayout(0); + +boxLayout.addWidget(new QCalendarWidget()); +boxLayout.addWidget(new QCalendarWidget()); +centralWidget.setLayout(boxLayout); +``` + ## Hierarchy ↳ [NodeLayout](nodelayout.md)‹[QBoxLayoutSignals](../globals.md#qboxlayoutsignals)› diff --git a/website/docs/api/generated/classes/qbuttongroup.md b/website/docs/api/generated/classes/qbuttongroup.md new file mode 100644 index 000000000..c827f097c --- /dev/null +++ b/website/docs/api/generated/classes/qbuttongroup.md @@ -0,0 +1,396 @@ +--- +id: "qbuttongroup" +title: "QButtonGroup" +sidebar_label: "QButtonGroup" +--- + +## Hierarchy + + ↳ [NodeObject](nodeobject.md)‹any› + + ↳ **QButtonGroup** + +## Index + +### Constructors + +* [constructor](qbuttongroup.md#constructor) + +### Properties + +* [native](qbuttongroup.md#native) +* [nodeChildren](qbuttongroup.md#nodechildren) +* [nodeParent](qbuttongroup.md#optional-nodeparent) + +### Methods + +* [addButton](qbuttongroup.md#addbutton) +* [addEventListener](qbuttongroup.md#addeventlistener) +* [button](qbuttongroup.md#button) +* [buttons](qbuttongroup.md#buttons) +* [checkedButton](qbuttongroup.md#checkedbutton) +* [checkedId](qbuttongroup.md#checkedid) +* [exclusive](qbuttongroup.md#exclusive) +* [id](qbuttongroup.md#id) +* [inherits](qbuttongroup.md#inherits) +* [objectName](qbuttongroup.md#objectname) +* [property](qbuttongroup.md#property) +* [removeButton](qbuttongroup.md#removebutton) +* [removeEventListener](qbuttongroup.md#removeeventlistener) +* [setExclusive](qbuttongroup.md#setexclusive) +* [setId](qbuttongroup.md#setid) +* [setNodeParent](qbuttongroup.md#setnodeparent) +* [setObjectName](qbuttongroup.md#setobjectname) +* [setProperty](qbuttongroup.md#setproperty) + +## Constructors + +### constructor + +\+ **new QButtonGroup**(): *[QButtonGroup](qbuttongroup.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QButtonGroup](qbuttongroup.md)* + +\+ **new QButtonGroup**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QButtonGroup](qbuttongroup.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QButtonGroup](qbuttongroup.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 + +### addButton + +▸ **addButton**(`button`: [QAbstractButton](qabstractbutton.md)‹[QAbstractButtonSignals](../interfaces/qabstractbuttonsignals.md)›, `id`: number): *void* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`button` | [QAbstractButton](qabstractbutton.md)‹[QAbstractButtonSignals](../interfaces/qabstractbuttonsignals.md)› | - | +`id` | number | -1 | + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[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` | Signals[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* + +___ + +### button + +▸ **button**(`id`: number): *[NativeRawPointer](../globals.md#nativerawpointer)‹"QAbstractButton*"›* + +**Parameters:** + +Name | Type | +------ | ------ | +`id` | number | + +**Returns:** *[NativeRawPointer](../globals.md#nativerawpointer)‹"QAbstractButton*"›* + +___ + +### buttons + +▸ **buttons**(): *[QAbstractButton](qabstractbutton.md)‹[QAbstractButtonSignals](../interfaces/qabstractbuttonsignals.md)›[]* + +**Returns:** *[QAbstractButton](qabstractbutton.md)‹[QAbstractButtonSignals](../interfaces/qabstractbuttonsignals.md)›[]* + +___ + +### checkedButton + +▸ **checkedButton**(): *[NativeRawPointer](../globals.md#nativerawpointer)‹"QAbstractButton*"›* + +**Returns:** *[NativeRawPointer](../globals.md#nativerawpointer)‹"QAbstractButton*"›* + +___ + +### checkedId + +▸ **checkedId**(): *number* + +**Returns:** *number* + +___ + +### exclusive + +▸ **exclusive**(): *boolean* + +**Returns:** *boolean* + +___ + +### id + +▸ **id**(`button`: [QAbstractButton](qabstractbutton.md)‹[QAbstractButtonSignals](../interfaces/qabstractbuttonsignals.md)›): *number* + +**Parameters:** + +Name | Type | +------ | ------ | +`button` | [QAbstractButton](qabstractbutton.md)‹[QAbstractButtonSignals](../interfaces/qabstractbuttonsignals.md)› | + +**Returns:** *number* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### 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)* + +___ + +### removeButton + +▸ **removeButton**(`button`: [QAbstractButton](qabstractbutton.md)‹[QAbstractButtonSignals](../interfaces/qabstractbuttonsignals.md)›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`button` | [QAbstractButton](qabstractbutton.md)‹[QAbstractButtonSignals](../interfaces/qabstractbuttonsignals.md)› | + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof any* + +**Parameters:** + +Name | Type | +------ | ------ | +`signalType` | SignalType | +`callback` | Signals[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* + +___ + +### setExclusive + +▸ **setExclusive**(`exculsive`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`exculsive` | boolean | + +**Returns:** *void* + +___ + +### setId + +▸ **setId**(`button`: [QAbstractButton](qabstractbutton.md)‹[QAbstractButtonSignals](../interfaces/qabstractbuttonsignals.md)›, `id`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`button` | [QAbstractButton](qabstractbutton.md)‹[QAbstractButtonSignals](../interfaces/qabstractbuttonsignals.md)› | +`id` | number | + +**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* diff --git a/website/docs/api/generated/classes/qcalendarwidget.md b/website/docs/api/generated/classes/qcalendarwidget.md index 759203d11..d5d33760f 100644 --- a/website/docs/api/generated/classes/qcalendarwidget.md +++ b/website/docs/api/generated/classes/qcalendarwidget.md @@ -4,6 +4,21 @@ title: "QCalendarWidget" sidebar_label: "QCalendarWidget" --- +> Create and control a selectable monthly calendar. + +**This class is a JS wrapper around Qt's [QCalendarWidget class](https://doc.qt.io/qt-5/qcalendarwidget.html)** + +A `QCalendarWidget` provides a monthly based calendar widget allowing the user to select a date. + +### Example + +```javascript +const { QCalendarWidget } = require("@nodegui/nodegui"); + +const calendarWidget = new QCalendarWidget(); +// more will follow when .selectedDate() et cetera are implemented +``` + ## Hierarchy ↳ [NodeWidget](nodewidget.md)‹[QCalendarWidgetSignals](../interfaces/qcalendarwidgetsignals.md)› diff --git a/website/docs/api/generated/classes/qcombobox.md b/website/docs/api/generated/classes/qcombobox.md index 3b5873f70..d13baca13 100644 --- a/website/docs/api/generated/classes/qcombobox.md +++ b/website/docs/api/generated/classes/qcombobox.md @@ -4,6 +4,32 @@ title: "QComboBox" sidebar_label: "QComboBox" --- +> Create and control a selectable drop down menu. + +**This class is a JS wrapper around Qt's [QComboBox class](https://doc.qt.io/qt-5/qcombobox.html)** + +A `QComboBox` provides a means of presenting a list of options to the user. + +### Example + +```javascript +const { QComboBox } = require("@nodegui/nodegui"); + +const comboBox = new QComboBox(); +comboBox.addItem(undefined, 'comboBox item 0'); +comboBox.addItem(undefined, 'comboBox item 1'); +comboBox.addItem(undefined, 'comboBox item 2'); +comboBox.addItem(undefined, 'comboBox item 3'); + +comboBox.addEventListener('currentTextChanged', (text) => { +console.log('currentTextChanged: ' + text); +}); + +comboBox.addEventListener('currentIndexChanged', (index) => { +console.log('currentIndexChanged: ' + index); +}); +``` + ## Hierarchy ↳ [NodeWidget](nodewidget.md)‹[QComboBoxSignals](../interfaces/qcomboboxsignals.md)› diff --git a/website/docs/api/generated/classes/qdateedit.md b/website/docs/api/generated/classes/qdateedit.md index f91a9fdda..2d13a6758 100644 --- a/website/docs/api/generated/classes/qdateedit.md +++ b/website/docs/api/generated/classes/qdateedit.md @@ -4,6 +4,21 @@ title: "QDateEdit" sidebar_label: "QDateEdit" --- +> Creates a widget to edit dates with spin box layout. WIP! + +**This class is a JS wrapper around Qt's [QDateEdit class](https://doc.qt.io/qt-5/qdateedit.html)** + +A `QDateEdit` provides a widget for editing dates based on the QDateTimeEdit widget. + +### Example + +```javascript +const { QDateEdit } = require("@nodegui/nodegui"); + +const comboBox = new QDateEdit(); +// must be implemented +``` + ## Hierarchy ↳ [QDateTimeEdit](qdatetimeedit.md) diff --git a/website/docs/api/generated/classes/qdatetimeedit.md b/website/docs/api/generated/classes/qdatetimeedit.md index 7bd659579..d58005080 100644 --- a/website/docs/api/generated/classes/qdatetimeedit.md +++ b/website/docs/api/generated/classes/qdatetimeedit.md @@ -4,6 +4,27 @@ title: "QDateTimeEdit" sidebar_label: "QDateTimeEdit" --- +> Creates and controls a widget for editing dates and times with spin box layout. + +**This class is a JS wrapper around Qt's [QDateTimeEdit class](https://doc.qt.io/qt-5/qdatetimeedit.html)** + +### Example + +```javascript +const { QDateTimeEdit, QDate, QTime } = require("@nodegui/nodegui"); + +const dateTimeEdit = new QDateTimeEdit(); + +let date = new QDate(); +date.setDate(2020, 1, 1); + +let time = new QTime(); +time.setHMS(16, 30, 0); + +dateTimeEdit.setDate(date); +dateTimeEdit.setTime(time); +``` + ## Hierarchy ↳ [QAbstractSpinBox](qabstractspinbox.md)‹[QDateTimeEditSignals](../interfaces/qdatetimeeditsignals.md)› diff --git a/website/docs/api/generated/classes/qdialog.md b/website/docs/api/generated/classes/qdialog.md index 97454c797..daa4c08ce 100644 --- a/website/docs/api/generated/classes/qdialog.md +++ b/website/docs/api/generated/classes/qdialog.md @@ -4,6 +4,12 @@ title: "QDialog" sidebar_label: "QDialog" --- +> This is the base class of dialog windows. + +**This class is a JS wrapper around Qt's [QDialog class](https://doc.qt.io/qt-5/qdialog.html)** + +It is inherited by QFileDialog and QMessageBox (n/a QColorDialog, QErrorMessage, QFontDialog, QInputDialog, QMessageBox, QProgressDialog, and QWizard) + ## Hierarchy ↳ [NodeDialog](nodedialog.md)‹[QDialogSignals](../interfaces/qdialogsignals.md)› diff --git a/website/docs/api/generated/classes/qfiledialog.md b/website/docs/api/generated/classes/qfiledialog.md index 811e4bbf4..467a9c53b 100644 --- a/website/docs/api/generated/classes/qfiledialog.md +++ b/website/docs/api/generated/classes/qfiledialog.md @@ -4,6 +4,27 @@ title: "QFileDialog" sidebar_label: "QFileDialog" --- +> Create and control file dialogs. + +**This class is a JS wrapper around Qt's [QFileDialog class](https://doc.qt.io/qt-5/qfiledialog.html)** + +A `QFileDialog` class provides a dialog that allow users to select files or directories. + +### Example + +```javascript +const { QFileDialog } = require("@nodegui/nodegui"); + +const fileDialog = new QFileDialog(); +fileDialog.setFileMode(FileMode.AnyFile); +fileDialog.setNameFilter('Images (*.png *.xpm *.jpg)'); +fileDialog.exec(); + +const selectedFiles = fileDialog.selectedFiles(); +console.log(selectedFiles); + +``` + ## Hierarchy ↳ [NodeDialog](nodedialog.md)‹[QFileDialogSignals](../interfaces/qfiledialogsignals.md)› @@ -58,6 +79,7 @@ sidebar_label: "QFileDialog" * [repaint](qfiledialog.md#repaint) * [resize](qfiledialog.md#resize) * [result](qfiledialog.md#result) +* [selectedFiles](qfiledialog.md#selectedfiles) * [setAcceptMode](qfiledialog.md#setacceptmode) * [setAttribute](qfiledialog.md#setattribute) * [setContextMenuPolicy](qfiledialog.md#setcontextmenupolicy) @@ -76,6 +98,7 @@ sidebar_label: "QFileDialog" * [setMinimumSize](qfiledialog.md#setminimumsize) * [setModal](qfiledialog.md#setmodal) * [setMouseTracking](qfiledialog.md#setmousetracking) +* [setNameFilter](qfiledialog.md#setnamefilter) * [setNodeParent](qfiledialog.md#setnodeparent) * [setObjectName](qfiledialog.md#setobjectname) * [setOption](qfiledialog.md#setoption) @@ -590,6 +613,14 @@ ___ ___ +### selectedFiles + +▸ **selectedFiles**(): *string[]* + +**Returns:** *string[]* + +___ + ### setAcceptMode ▸ **setAcceptMode**(`acceptMode`: [AcceptMode](../enums/acceptmode.md)): *void* @@ -880,6 +911,20 @@ Name | Type | ___ +### setNameFilter + +▸ **setNameFilter**(`filter`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`filter` | string | + +**Returns:** *void* + +___ + ### setNodeParent ▸ **setNodeParent**(`parent?`: [Component](component.md)): *void* diff --git a/website/docs/api/generated/classes/qgroupbox.md b/website/docs/api/generated/classes/qgroupbox.md index 45beaefbc..070f302aa 100644 --- a/website/docs/api/generated/classes/qgroupbox.md +++ b/website/docs/api/generated/classes/qgroupbox.md @@ -4,6 +4,39 @@ title: "QGroupBox" sidebar_label: "QGroupBox" --- +> Create and control a group of checkboxes including a title. + +**This class is a JS wrapper around Qt's [QGroupBox class](https://doc.qt.io/qt-5/qgroupbox.html)** + +A `QGroupBox` widget provides a group box frame with a title. + +### Example + +```javascript +import { FlexLayout, QGroupBox, QRadioButton, QMainWindow } from '@nodegui/nodegui'; + +const win = new QMainWindow(); + +const r1 = new QRadioButton(); +r1.setText('R1'); +const r2 = new QRadioButton(); +r2.setText('R2'); +const r3 = new QRadioButton(); +r3.setText('R3'); + +const groupBoxLayout = new FlexLayout(); +const groupBox = new QGroupBox(); +groupBox.setLayout(groupBoxLayout); +groupBoxLayout.addWidget(r1); +groupBoxLayout.addWidget(r2); +groupBoxLayout.addWidget(r3); + +win.setCentralWidget(groupBox); +win.resize(400, 400); + +win.show(); +(global as any).win = win;``` + ## Hierarchy ↳ [NodeWidget](nodewidget.md)‹[QGroupBoxSignals](../interfaces/qgroupboxsignals.md)› diff --git a/website/docs/api/generated/classes/qlistwidget.md b/website/docs/api/generated/classes/qlistwidget.md index 564912d0c..c09f31f05 100644 --- a/website/docs/api/generated/classes/qlistwidget.md +++ b/website/docs/api/generated/classes/qlistwidget.md @@ -4,6 +4,29 @@ title: "QListWidget" sidebar_label: "QListWidget" --- +> Create and control a item-based list. + +**This class is a JS wrapper around Qt's [QListWidget class](https://doc.qt.io/qt-5/qlistwidget.html)** + +### Example + +```javascript +const { QListWidget, QListWidgetItem } = require("@nodegui/nodegui"); + +const listWidget = new QListWidget(); + +for (let i = 0; i < 30; i++) { +let listWidgetItem = new QListWidgetItem(); +listWidgetItem.setText('listWidgetItem ' + i); +if (i===3) { +listWidgetItem.setCheckState(2); +} else { +listWidgetItem.setCheckState(0); +} +listWidget.addItem(listWidgetItem); +} +``` + ## Hierarchy ↳ [QAbstractItemView](qabstractitemview.md)‹[QListWidgetSignals](../interfaces/qlistwidgetsignals.md)› diff --git a/website/docs/api/generated/classes/qlistwidgetitem.md b/website/docs/api/generated/classes/qlistwidgetitem.md index 7fef88c74..954dc26a1 100644 --- a/website/docs/api/generated/classes/qlistwidgetitem.md +++ b/website/docs/api/generated/classes/qlistwidgetitem.md @@ -4,6 +4,29 @@ title: "QListWidgetItem" sidebar_label: "QListWidgetItem" --- +> Creates an item for QListWidget. + +**This class is a JS wrapper around Qt's [QListWidgetItem class](https://doc.qt.io/qt-5/qlistwidgetitem.html)** + +### Example + +```javascript +const { QListWidget, QListWidgetItem } = require("@nodegui/nodegui"); + +const listWidget = new QListWidget(); + +for (let i = 0; i < 30; i++) { +let listWidgetItem = new QListWidgetItem(); +listWidgetItem.setText('listWidgetItem ' + i); +if (i===3) { +listWidgetItem.setCheckState(2); +} else { +listWidgetItem.setCheckState(0); +} +listWidget.addItem(listWidgetItem); +} +``` + ## Hierarchy * [Component](component.md) diff --git a/website/docs/api/generated/classes/qmessagebox.md b/website/docs/api/generated/classes/qmessagebox.md index c08b263cb..f0e793bfe 100644 --- a/website/docs/api/generated/classes/qmessagebox.md +++ b/website/docs/api/generated/classes/qmessagebox.md @@ -4,6 +4,25 @@ title: "QMessageBox" sidebar_label: "QMessageBox" --- +> Create and control classic modal dialogs. + +**This class is a JS wrapper around Qt's [QMessageBox class](https://doc.qt.io/qt-5/qmessagebox.html)** + +### Example + +```javascript + +import { QMessageBox, ButtonRole, QPushButton } from '@nodegui/nodegui'; + +const messageBox = new QMessageBox(); +messageBox.setText('Alert! This is a message'); +const accept = new QPushButton(); +accept.setText('Accept'); +messageBox.addButton(accept, ButtonRole.AcceptRole); +messageBox.exec(); + +``` + ## Hierarchy ↳ [NodeDialog](nodedialog.md)‹[QMessageBoxSignals](../interfaces/qmessageboxsignals.md)› diff --git a/website/docs/api/generated/classes/qpainter.md b/website/docs/api/generated/classes/qpainter.md index 2a6f2b5b3..82a114eec 100644 --- a/website/docs/api/generated/classes/qpainter.md +++ b/website/docs/api/generated/classes/qpainter.md @@ -4,6 +4,38 @@ title: "QPainter" sidebar_label: "QPainter" --- +> Lets you paint on widgets. + +**This class is a JS wrapper around Qt's [QPainter class](https://doc.qt.io/qt-5/qpainter.html)** + +Note: QPainter works only inside the paint event. + +### Example + +```javascript + +import { FlexLayout, WidgetEventTypes, QMainWindow, QPainter, QWidget } from '@nodegui/nodegui'; + +const win = new QMainWindow(); +const center = new QWidget(); +const layout = new FlexLayout(); +center.setLayout(layout); +win.resize(200, 200); + +win.addEventListener(WidgetEventTypes.Paint, () => { +const painter = new QPainter(win); +painter.drawText(20, 20, 'Hello'); +painter.end(); +}); +win.show(); +(global as any).win = win; + +``` + +## Advanced example: + +https://github.com/nodegui/examples/blob/master/nodegui/custom-native-widget-qpainter + ## Hierarchy * [Component](component.md) diff --git a/website/docs/api/generated/classes/qstackedwidget.md b/website/docs/api/generated/classes/qstackedwidget.md index 530b5c285..ad9c07c14 100644 --- a/website/docs/api/generated/classes/qstackedwidget.md +++ b/website/docs/api/generated/classes/qstackedwidget.md @@ -4,6 +4,44 @@ title: "QStackedWidget" sidebar_label: "QStackedWidget" --- +> Create and control stacked widgets where only one is visible at a time. + +**This class is a JS wrapper around Qt's [QStackedWidget class](https://doc.qt.io/qt-5/qstackedwidget.html)** + +### Example + +```javascript + +const { QMainWindow, QLabel, QStackedWidget } = require("@nodegui/nodegui"); + +const win = new QMainWindow(); +const stacked = new QStackedWidget(); + +const first = new QLabel(); +first.setText('First'); + +const second = new QLabel(); +second.setText('Second'); + +const third = new QLabel(); +third.setText('Third'); + +stacked.addWidget(first); +stacked.addWidget(second); +stacked.addWidget(third); + +stacked.setCurrentWidget(second); +//or +// stacked.setCurrentIndex(1); + +win.setCentralWidget(stacked); +win.resize(200, 200); + +win.show(); +(global as any).win = win; + +``` + ## Hierarchy ↳ [NodeWidget](nodewidget.md)‹[QStackedWidgetSignals](../interfaces/qstackedwidgetsignals.md)› diff --git a/website/docs/api/generated/classes/qtablewidget.md b/website/docs/api/generated/classes/qtablewidget.md index c50228cfa..e470c365b 100644 --- a/website/docs/api/generated/classes/qtablewidget.md +++ b/website/docs/api/generated/classes/qtablewidget.md @@ -4,6 +4,35 @@ title: "QTableWidget" sidebar_label: "QTableWidget" --- +> Creates and item-based table view. + +**This class is a JS wrapper around Qt's [QTableWidget class](https://doc.qt.io/qt-5/qtablewidget.html)** + +### Example + +```javascript +const { QTableWidget, QMainWindow, QTableWidgetItem } = require("@nodegui/nodegui"); + +const win = new QMainWindow(); +const table = new QTableWidget(2, 3); +table.setHorizontalHeaderLabels(['first', 'second', 'third']); + +const cell00 = new QTableWidgetItem('C00'); +const cell01 = new QTableWidgetItem('C01'); +const cell10 = new QTableWidgetItem('C10'); +const cell11 = new QTableWidgetItem('C11'); + +table.setItem(0, 0, cell00); +table.setItem(0, 1, cell01); +table.setItem(1, 0, cell10); +table.setItem(1, 1, cell11); + +win.setCentralWidget(table); +win.show(); +(global as any).win = win; + +``` + ## Hierarchy ↳ [QAbstractScrollArea](qabstractscrollarea.md)‹[QTableWidgetSignals](../interfaces/qtablewidgetsignals.md)› diff --git a/website/docs/api/generated/classes/qtablewidgetitem.md b/website/docs/api/generated/classes/qtablewidgetitem.md index 34622b899..79091c8c8 100644 --- a/website/docs/api/generated/classes/qtablewidgetitem.md +++ b/website/docs/api/generated/classes/qtablewidgetitem.md @@ -4,6 +4,35 @@ title: "QTableWidgetItem" sidebar_label: "QTableWidgetItem" --- +> Creates an item for QTableWidget. + +**This class is a JS wrapper around Qt's [QTableWidgetItem class](https://doc.qt.io/qt-5/qtablewidgetitem.html)** + +### Example + +```javascript +const { QTableWidget, QMainWindow, QTableWidgetItem } = require("@nodegui/nodegui"); + +const win = new QMainWindow(); +const table = new QTableWidget(2, 3); +table.setHorizontalHeaderLabels(['first', 'second', 'third']); + +const cell00 = new QTableWidgetItem('C00'); +const cell01 = new QTableWidgetItem('C01'); +const cell10 = new QTableWidgetItem('C10'); +const cell11 = new QTableWidgetItem('C11'); + +table.setItem(0, 0, cell00); +table.setItem(0, 1, cell01); +table.setItem(1, 0, cell10); +table.setItem(1, 1, cell11); + +win.setCentralWidget(table); +win.show(); +(global as any).win = win; + +``` + ## Hierarchy * [Component](component.md) diff --git a/website/docs/api/generated/classes/qtabwidget.md b/website/docs/api/generated/classes/qtabwidget.md index 059930a84..6c4b4c299 100644 --- a/website/docs/api/generated/classes/qtabwidget.md +++ b/website/docs/api/generated/classes/qtabwidget.md @@ -4,6 +4,24 @@ title: "QTabWidget" sidebar_label: "QTabWidget" --- +> Create and control a stack of tabbed widgets. + +**This class is a JS wrapper around Qt's [QTabWidget class](https://doc.qt.io/qt-5/qtabwidget.html)** + +A 'QTabWidget' provides a tab bar and a "page area" that is used to display pages related to each tab. + +### Example + +```javascript +// This example creates two tabs, each holding a separate calendar. +const { QTabWidget, QCalendarWidget, QIcon } = require("@nodegui/nodegui"); + +const tabWidget = new QTabWidget(); + +tabWidget.addTab(new QCalendarWidget(), new QIcon(), 'Tab 1'); +tabWidget.addTab(new QCalendarWidget(), new QIcon(), 'Tab 2'); +``` + ## Hierarchy ↳ [NodeWidget](nodewidget.md)‹[QTabWidgetSignals](../interfaces/qtabwidgetsignals.md)› diff --git a/website/docs/api/generated/classes/qtimeedit.md b/website/docs/api/generated/classes/qtimeedit.md index 77a68a4ad..c75f6322a 100644 --- a/website/docs/api/generated/classes/qtimeedit.md +++ b/website/docs/api/generated/classes/qtimeedit.md @@ -4,6 +4,21 @@ title: "QTimeEdit" sidebar_label: "QTimeEdit" --- +> Creates a widget to edit dates with spin box layout. WIP! + +**This class is a JS wrapper around Qt's [QTimeEdit class](https://doc.qt.io/qt-5/qtimeedit.html)** + +A `QTimeEdit` a widget for editing times based on the QDateTimeEdit widget + +### Example + +```javascript +const { QTimeEdit } = require("@nodegui/nodegui"); + +const comboBox = new QTimeEdit(); +// must be implemented +``` + ## Hierarchy ↳ [QDateTimeEdit](qdatetimeedit.md) diff --git a/website/docs/api/generated/classes/qtoolbutton.md b/website/docs/api/generated/classes/qtoolbutton.md index e55ee189e..f8319c5bc 100644 --- a/website/docs/api/generated/classes/qtoolbutton.md +++ b/website/docs/api/generated/classes/qtoolbutton.md @@ -4,6 +4,21 @@ title: "QToolButton" sidebar_label: "QToolButton" --- +> Create and control buttons to use inside a QToolBar. + +**This class is a JS wrapper around Qt's [QToolButton class](https://doc.qt.io/qt-5/qtoolbutton.html)** + +A QToolButton is a special button that provides quick-access to specific commands or options. + +### Example + +```javascript +const { QToolButton } = require("@nodegui/nodegui"); + +const tool = new QToolButton(); +tool.setText('Help'); +``` + ## Hierarchy ↳ [QAbstractButton](qabstractbutton.md)‹[QToolButtonSignals](../interfaces/qtoolbuttonsignals.md)› diff --git a/website/docs/api/generated/classes/qtreewidget.md b/website/docs/api/generated/classes/qtreewidget.md index f464dfc97..7ddef2593 100644 --- a/website/docs/api/generated/classes/qtreewidget.md +++ b/website/docs/api/generated/classes/qtreewidget.md @@ -4,6 +4,42 @@ title: "QTreeWidget" sidebar_label: "QTreeWidget" --- +> Creates a tree view that uses a predefined tree model. + +**This class is a JS wrapper around Qt's [QTreeWidget class](https://doc.qt.io/qt-5/qtreewidget.html)** + +### Example + +```javascript +const { QTreeWidget, QTreeWidgetItem } = require("@nodegui/nodegui"); + +const { QMainWindow, QTreeWidgetItem, QTreeWidget } = require("@nodegui/nodegui"); + +const win = new QMainWindow(); +const tree = new QTreeWidget(); + +const item1 = new QTreeWidgetItem(); +item1.setText(0, `item-1`); +const item2 = new QTreeWidgetItem(); +item2.setText(0, `item-2`); +const item3 = new QTreeWidgetItem(); +item3.setText(0, `item-3`); + +tree.addTopLevelItem(item1); +tree.addTopLevelItem(item2); +tree.addTopLevelItem(item3); + +// Add children to item1 +const c1item1 = new QTreeWidgetItem(item1); +c1item1.setText(0, `c1item1`); +const c1item2 = new QTreeWidgetItem(item1); +c1item2.setText(0, `c1item1`); + +win.setCentralWidget(tree); +win.show(); +(global as any).win = win; +``` + ## Hierarchy ↳ [QAbstractScrollArea](qabstractscrollarea.md)‹[QTreeWidgetSignals](../interfaces/qtreewidgetsignals.md)› diff --git a/website/docs/api/generated/classes/qtreewidgetitem.md b/website/docs/api/generated/classes/qtreewidgetitem.md index e86ef2e4c..d4983e3b2 100644 --- a/website/docs/api/generated/classes/qtreewidgetitem.md +++ b/website/docs/api/generated/classes/qtreewidgetitem.md @@ -4,6 +4,42 @@ title: "QTreeWidgetItem" sidebar_label: "QTreeWidgetItem" --- +> Creates an item for QTreeWidget. + +**This class is a JS wrapper around Qt's [QTreeWidgetItem class](https://doc.qt.io/qt-5/qtreewidgetitem.html)** + +### Example + +```javascript + +const { QMainWindow, QTreeWidgetItem, QTreeWidget } = require("@nodegui/nodegui"); + +const win = new QMainWindow(); +const tree = new QTreeWidget(); + +const item1 = new QTreeWidgetItem(); +item1.setText(0, `item-1`); +const item2 = new QTreeWidgetItem(); +item2.setText(0, `item-2`); +const item3 = new QTreeWidgetItem(); +item3.setText(0, `item-3`); + +tree.addTopLevelItem(item1); +tree.addTopLevelItem(item2); +tree.addTopLevelItem(item3); + +// Add children to item1 +const c1item1 = new QTreeWidgetItem(item1); +c1item1.setText(0, `c1item1`); +const c1item2 = new QTreeWidgetItem(item1); +c1item2.setText(0, `c1item1`); + +win.setCentralWidget(tree); +win.show(); +(global as any).win = win; + +``` + ## Hierarchy * [Component](component.md) diff --git a/website/docs/api/generated/globals.md b/website/docs/api/generated/globals.md index b6a7afcc4..b36fafe9b 100644 --- a/website/docs/api/generated/globals.md +++ b/website/docs/api/generated/globals.md @@ -153,6 +153,7 @@ sidebar_label: "Globals" * [QAction](classes/qaction.md) * [QApplication](classes/qapplication.md) * [QBoxLayout](classes/qboxlayout.md) +* [QButtonGroup](classes/qbuttongroup.md) * [QCalendarWidget](classes/qcalendarwidget.md) * [QCheckBox](classes/qcheckbox.md) * [QClipboard](classes/qclipboard.md) @@ -221,6 +222,7 @@ sidebar_label: "Globals" * [QAbstractSliderSignals](interfaces/qabstractslidersignals.md) * [QAbstractSpinBoxSignals](interfaces/qabstractspinboxsignals.md) * [QActionSignals](interfaces/qactionsignals.md) +* [QButtonGroupSignals](interfaces/qbuttongroupsignals.md) * [QCalendarWidgetSignals](interfaces/qcalendarwidgetsignals.md) * [QComboBoxSignals](interfaces/qcomboboxsignals.md) * [QDateTimeEditSignals](interfaces/qdatetimeeditsignals.md) diff --git a/website/docs/api/generated/interfaces/qbuttongroupsignals.md b/website/docs/api/generated/interfaces/qbuttongroupsignals.md new file mode 100644 index 000000000..e1b304c1a --- /dev/null +++ b/website/docs/api/generated/interfaces/qbuttongroupsignals.md @@ -0,0 +1,52 @@ +--- +id: "qbuttongroupsignals" +title: "QButtonGroupSignals" +sidebar_label: "QButtonGroupSignals" +--- + +## Hierarchy + +* [QObjectSignals](qobjectsignals.md) + + ↳ **QButtonGroupSignals** + +## Index + +### Properties + +* [buttonClicked](qbuttongroupsignals.md#buttonclicked) +* [objectNameChanged](qbuttongroupsignals.md#objectnamechanged) + +## Properties + +### buttonClicked + +• **buttonClicked**: *function* + +#### Type declaration: + +▸ (`id?`: undefined | number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`id?` | undefined | number | + +___ + +### objectNameChanged + +• **objectNameChanged**: *function* + +*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | diff --git a/website/docs/api/generated/interfaces/qobjectsignals.md b/website/docs/api/generated/interfaces/qobjectsignals.md index 0e4ddf600..5f51b7eaa 100644 --- a/website/docs/api/generated/interfaces/qobjectsignals.md +++ b/website/docs/api/generated/interfaces/qobjectsignals.md @@ -14,6 +14,8 @@ sidebar_label: "QObjectSignals" ↳ [QActionSignals](qactionsignals.md) + ↳ [QButtonGroupSignals](qbuttongroupsignals.md) + ↳ [QSystemTrayIconSignals](qsystemtrayiconsignals.md) ↳ [QShortcutSignals](qshortcutsignals.md) diff --git a/website/docs/api/sidebar-gen.js b/website/docs/api/sidebar-gen.js index 8e126f9f0..b13b40a71 100644 --- a/website/docs/api/sidebar-gen.js +++ b/website/docs/api/sidebar-gen.js @@ -16,6 +16,7 @@ module.exports = { "api/generated/classes/qaction", "api/generated/classes/qapplication", "api/generated/classes/qboxlayout", + "api/generated/classes/qbuttongroup", "api/generated/classes/qcalendarwidget", "api/generated/classes/qcheckbox", "api/generated/classes/qclipboard", @@ -212,6 +213,7 @@ module.exports = { "api/generated/interfaces/qabstractslidersignals", "api/generated/interfaces/qabstractspinboxsignals", "api/generated/interfaces/qactionsignals", + "api/generated/interfaces/qbuttongroupsignals", "api/generated/interfaces/qcalendarwidgetsignals", "api/generated/interfaces/qcomboboxsignals", "api/generated/interfaces/qdatetimeeditsignals",