From a0522ccce399cf92b455a3f0e2ee2d7109ce914f Mon Sep 17 00:00:00 2001 From: Atul R Date: Fri, 10 Jan 2020 12:11:00 +0530 Subject: [PATCH] Fixes spacing and doc generation (#343) --- src/lib/QtWidgets/QAbstractScrollArea.ts | 1 - src/lib/QtWidgets/QAbstractSlider.ts | 1 - src/lib/QtWidgets/QAbstractSpinBox.ts | 1 - src/lib/QtWidgets/QAction.ts | 1 - src/lib/QtWidgets/QCalendarWidget.ts | 1 - src/lib/QtWidgets/QCheckBox.ts | 1 - src/lib/QtWidgets/QComboBox.ts | 1 - src/lib/QtWidgets/QDateEdit.ts | 2 +- src/lib/QtWidgets/QDateTimeEdit.ts | 1 - src/lib/QtWidgets/QDial.ts | 1 - src/lib/QtWidgets/QDialog.ts | 1 - src/lib/QtWidgets/QGridLayout.ts | 1 - src/lib/QtWidgets/QGroupBox.ts | 4 ++-- src/lib/QtWidgets/QLabel.ts | 1 - src/lib/QtWidgets/QLayout.ts | 1 - src/lib/QtWidgets/QLineEdit.ts | 1 - src/lib/QtWidgets/QListWidget.ts | 1 - src/lib/QtWidgets/QMainWindow.ts | 1 - src/lib/QtWidgets/QMenu.ts | 1 - src/lib/QtWidgets/QMenuBar.ts | 1 - src/lib/QtWidgets/QPainter.ts | 1 - src/lib/QtWidgets/QPlainTextEdit.ts | 1 - src/lib/QtWidgets/QProgressBar.ts | 1 - src/lib/QtWidgets/QPushButton.ts | 1 - src/lib/QtWidgets/QRadioButton.ts | 1 - src/lib/QtWidgets/QScrollArea.ts | 1 - src/lib/QtWidgets/QShortcut.ts | 1 - src/lib/QtWidgets/QSpinBox.ts | 1 - src/lib/QtWidgets/QStackedWidget.ts | 1 - src/lib/QtWidgets/QSystemTrayIcon.ts | 1 - src/lib/QtWidgets/QTabWidget.ts | 1 - src/lib/QtWidgets/QTableWidget.ts | 1 - src/lib/QtWidgets/QTimeEdit.ts | 2 +- src/lib/QtWidgets/QTreeWidget.ts | 1 - website/docs/api/generated/classes/qdateedit.md | 2 +- website/docs/api/generated/classes/qgroupbox.md | 3 ++- website/docs/api/generated/classes/qtimeedit.md | 2 +- 37 files changed, 8 insertions(+), 38 deletions(-) diff --git a/src/lib/QtWidgets/QAbstractScrollArea.ts b/src/lib/QtWidgets/QAbstractScrollArea.ts index 55ac9a59f..1bfcd335f 100644 --- a/src/lib/QtWidgets/QAbstractScrollArea.ts +++ b/src/lib/QtWidgets/QAbstractScrollArea.ts @@ -14,7 +14,6 @@ import { ScrollBarPolicy } from '../QtEnums/ScrollBarPolicy'; QAbstractScrollArea will list all methods and properties that are common to all scrollable widgets in the NodeGui world. */ - export abstract class QAbstractScrollArea extends NodeWidget { viewportWidget?: NodeWidget; setViewport(widget: NodeWidget): void { diff --git a/src/lib/QtWidgets/QAbstractSlider.ts b/src/lib/QtWidgets/QAbstractSlider.ts index 406aed30a..90df52944 100644 --- a/src/lib/QtWidgets/QAbstractSlider.ts +++ b/src/lib/QtWidgets/QAbstractSlider.ts @@ -14,7 +14,6 @@ import { Orientation } from '../QtEnums'; QAbstractSlider will list all methods and properties that are common to all slider widgets in the NodeGui world. */ - export abstract class QAbstractSlider extends NodeWidget { setSingleStep(step: number): void { this.native.setSingleStep(step); diff --git a/src/lib/QtWidgets/QAbstractSpinBox.ts b/src/lib/QtWidgets/QAbstractSpinBox.ts index a50309bc1..8a8818d48 100644 --- a/src/lib/QtWidgets/QAbstractSpinBox.ts +++ b/src/lib/QtWidgets/QAbstractSpinBox.ts @@ -11,7 +11,6 @@ The QAbstractSpinBox class is an abstract class and therefore, technically, no f It is inherited by QDateTimeEdit and QSpinBox. (n/a QDoubleSpinBox) */ - export abstract class QAbstractSpinBox extends NodeWidget { selectAll(): void { this.native.selectAll(); diff --git a/src/lib/QtWidgets/QAction.ts b/src/lib/QtWidgets/QAction.ts index 21d6c00f2..af467a78e 100644 --- a/src/lib/QtWidgets/QAction.ts +++ b/src/lib/QtWidgets/QAction.ts @@ -29,7 +29,6 @@ menuAction.addEventListener("triggered", () => { menu.addAction(menuAction); ``` */ - export class QAction extends NodeObject { native: NativeElement; icon?: QIcon; diff --git a/src/lib/QtWidgets/QCalendarWidget.ts b/src/lib/QtWidgets/QCalendarWidget.ts index de9cf18cd..b8ef50dcf 100644 --- a/src/lib/QtWidgets/QCalendarWidget.ts +++ b/src/lib/QtWidgets/QCalendarWidget.ts @@ -21,7 +21,6 @@ const calendarWidget = new QCalendarWidget(); // more will follow when .selectedDate() et cetera are implemented ``` */ - export class QCalendarWidget extends NodeWidget { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QCheckBox.ts b/src/lib/QtWidgets/QCheckBox.ts index 554bb75ab..08e907fac 100644 --- a/src/lib/QtWidgets/QCheckBox.ts +++ b/src/lib/QtWidgets/QCheckBox.ts @@ -21,7 +21,6 @@ const checkbox = new QCheckBox(); checkbox.setText("Hello"); ``` */ - export class QCheckBox extends QAbstractButton { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QComboBox.ts b/src/lib/QtWidgets/QComboBox.ts index 8618d5e08..48f9d155e 100644 --- a/src/lib/QtWidgets/QComboBox.ts +++ b/src/lib/QtWidgets/QComboBox.ts @@ -33,7 +33,6 @@ comboBox.addEventListener('currentIndexChanged', (index) => { }); ``` */ - export class QComboBox extends NodeWidget { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QDateEdit.ts b/src/lib/QtWidgets/QDateEdit.ts index 9b786c8d6..6dba0d0c6 100644 --- a/src/lib/QtWidgets/QDateEdit.ts +++ b/src/lib/QtWidgets/QDateEdit.ts @@ -16,7 +16,7 @@ A `QDateEdit` provides a widget for editing dates based on the QDateTimeEdit wid ```javascript const { QDateEdit } = require("@nodegui/nodegui"); -const comboBox = new QDateEdit(); +const dateEdit = new QDateEdit(); // must be implemented ``` */ diff --git a/src/lib/QtWidgets/QDateTimeEdit.ts b/src/lib/QtWidgets/QDateTimeEdit.ts index 2bb0901c7..3520008ba 100644 --- a/src/lib/QtWidgets/QDateTimeEdit.ts +++ b/src/lib/QtWidgets/QDateTimeEdit.ts @@ -31,7 +31,6 @@ dateTimeEdit.setDate(date); dateTimeEdit.setTime(time); ``` */ - export class QDateTimeEdit extends QAbstractSpinBox { native: NativeElement; calendar?: QCalendarWidget; diff --git a/src/lib/QtWidgets/QDial.ts b/src/lib/QtWidgets/QDial.ts index bac8e9cf8..9de17921a 100644 --- a/src/lib/QtWidgets/QDial.ts +++ b/src/lib/QtWidgets/QDial.ts @@ -19,7 +19,6 @@ const { QDial } = require("@nodegui/nodegui"); const dial = new QDial(); ``` */ - export class QDial extends QAbstractSlider { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QDialog.ts b/src/lib/QtWidgets/QDialog.ts index ab0fe747a..9ddfdb4f4 100644 --- a/src/lib/QtWidgets/QDialog.ts +++ b/src/lib/QtWidgets/QDialog.ts @@ -41,7 +41,6 @@ export abstract class NodeDialog extends NodeWid It is inherited by QFileDialog and QMessageBox (n/a QColorDialog, QErrorMessage, QFontDialog, QInputDialog, QMessageBox, QProgressDialog, and QWizard) */ - export class QDialog extends NodeDialog { native: NativeElement; constructor(arg?: NodeDialog | NativeElement) { diff --git a/src/lib/QtWidgets/QGridLayout.ts b/src/lib/QtWidgets/QGridLayout.ts index e2cf9b6e5..7de0dbe53 100644 --- a/src/lib/QtWidgets/QGridLayout.ts +++ b/src/lib/QtWidgets/QGridLayout.ts @@ -28,7 +28,6 @@ layout.addWidget(label2); ``` */ - export class QGridLayout extends NodeLayout { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QGroupBox.ts b/src/lib/QtWidgets/QGroupBox.ts index 177bc4d99..cdf08445b 100644 --- a/src/lib/QtWidgets/QGroupBox.ts +++ b/src/lib/QtWidgets/QGroupBox.ts @@ -36,9 +36,9 @@ win.setCentralWidget(groupBox); win.resize(400, 400); win.show(); -(global as any).win = win;``` +(global as any).win = win; +``` */ - export class QGroupBox extends NodeWidget { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QLabel.ts b/src/lib/QtWidgets/QLabel.ts index f30e048b6..39be91d40 100644 --- a/src/lib/QtWidgets/QLabel.ts +++ b/src/lib/QtWidgets/QLabel.ts @@ -24,7 +24,6 @@ label.setText("Hello"); ``` */ - export class QLabel extends NodeWidget { native: NativeElement; private _pixmap?: QPixmap; diff --git a/src/lib/QtWidgets/QLayout.ts b/src/lib/QtWidgets/QLayout.ts index 8fd9589e2..d855a9e91 100644 --- a/src/lib/QtWidgets/QLayout.ts +++ b/src/lib/QtWidgets/QLayout.ts @@ -32,7 +32,6 @@ addChildToLayout(new FlexLayout(), new QPushButton()); addChildToLayout(new GridLayout(), new QWidget()); ``` */ - export abstract class NodeLayout extends NodeObject { type = 'layout'; abstract addWidget(childWidget: NodeWidget, ...args: any[]): void; diff --git a/src/lib/QtWidgets/QLineEdit.ts b/src/lib/QtWidgets/QLineEdit.ts index 2105edd25..60f66a23a 100644 --- a/src/lib/QtWidgets/QLineEdit.ts +++ b/src/lib/QtWidgets/QLineEdit.ts @@ -19,7 +19,6 @@ const lineEdit = new QLineEdit(); ``` */ - export class QLineEdit extends NodeWidget { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QListWidget.ts b/src/lib/QtWidgets/QListWidget.ts index 8877a474e..c0971058c 100644 --- a/src/lib/QtWidgets/QListWidget.ts +++ b/src/lib/QtWidgets/QListWidget.ts @@ -32,7 +32,6 @@ for (let i = 0; i < 30; i++) { } ``` */ - export class QListWidget extends QAbstractItemView { native: NativeElement; items: Set; diff --git a/src/lib/QtWidgets/QMainWindow.ts b/src/lib/QtWidgets/QMainWindow.ts index fcedad637..f802f81ff 100644 --- a/src/lib/QtWidgets/QMainWindow.ts +++ b/src/lib/QtWidgets/QMainWindow.ts @@ -30,7 +30,6 @@ global.win = win; // prevent's gc of win QMainWindow needs to have a central widget set before other widgets can be added as a children/nested children. Once a central widget is set you can add children/layout to the central widget. */ - export class QMainWindow extends NodeWidget { native: NativeElement; public centralWidget?: NodeWidget | null; diff --git a/src/lib/QtWidgets/QMenu.ts b/src/lib/QtWidgets/QMenu.ts index a75f6c846..6c3ad1f4c 100644 --- a/src/lib/QtWidgets/QMenu.ts +++ b/src/lib/QtWidgets/QMenu.ts @@ -17,7 +17,6 @@ const { QMenu } = require("@nodegui/nodegui"); const menu = new QMenu(); ``` */ - export class QMenu extends NodeWidget { native: NativeElement; actions: Set; diff --git a/src/lib/QtWidgets/QMenuBar.ts b/src/lib/QtWidgets/QMenuBar.ts index e77b82b70..8a5b620de 100644 --- a/src/lib/QtWidgets/QMenuBar.ts +++ b/src/lib/QtWidgets/QMenuBar.ts @@ -22,7 +22,6 @@ win.show(); global.win = win; ``` */ - export class QMenuBar extends NodeWidget { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QPainter.ts b/src/lib/QtWidgets/QPainter.ts index 5bd058d97..a8c617ec8 100644 --- a/src/lib/QtWidgets/QPainter.ts +++ b/src/lib/QtWidgets/QPainter.ts @@ -38,7 +38,6 @@ win.show(); https://github.com/nodegui/examples/blob/master/nodegui/custom-native-widget-qpainter */ - export class QPainter extends Component { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QPlainTextEdit.ts b/src/lib/QtWidgets/QPlainTextEdit.ts index f2ac9aae2..2db011c96 100644 --- a/src/lib/QtWidgets/QPlainTextEdit.ts +++ b/src/lib/QtWidgets/QPlainTextEdit.ts @@ -31,7 +31,6 @@ const { QPlainTextEdit } = require("@nodegui/nodegui"); const plainTextEdit = new QPlainTextEdit(); ``` */ - export class QPlainTextEdit extends QAbstractScrollArea { native: NativeElement; placeholderText?: string; diff --git a/src/lib/QtWidgets/QProgressBar.ts b/src/lib/QtWidgets/QProgressBar.ts index 6c5d4a875..4783c58cc 100644 --- a/src/lib/QtWidgets/QProgressBar.ts +++ b/src/lib/QtWidgets/QProgressBar.ts @@ -19,7 +19,6 @@ const { QProgressBar } = require("@nodegui/nodegui"); const progressBar = new QProgressBar(); ``` */ - export class QProgressBar extends NodeWidget { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QPushButton.ts b/src/lib/QtWidgets/QPushButton.ts index 869cba082..6db744f4a 100644 --- a/src/lib/QtWidgets/QPushButton.ts +++ b/src/lib/QtWidgets/QPushButton.ts @@ -21,7 +21,6 @@ const button = new QPushButton(); button.setText("Hello"); ``` */ - export class QPushButton extends QAbstractButton { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QRadioButton.ts b/src/lib/QtWidgets/QRadioButton.ts index ec0778cfa..1f7f332c0 100644 --- a/src/lib/QtWidgets/QRadioButton.ts +++ b/src/lib/QtWidgets/QRadioButton.ts @@ -22,7 +22,6 @@ radioButton.setText("Hello"); ``` */ - export class QRadioButton extends QAbstractButton { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QScrollArea.ts b/src/lib/QtWidgets/QScrollArea.ts index 05d9c9e33..f6b5397f3 100644 --- a/src/lib/QtWidgets/QScrollArea.ts +++ b/src/lib/QtWidgets/QScrollArea.ts @@ -26,7 +26,6 @@ imageLabel.setPixmap(pixmap); scrollArea.setWidget(imageLabel); ``` */ - export class QScrollArea extends QAbstractScrollArea { native: NativeElement; contentWidget?: NodeWidget | null; diff --git a/src/lib/QtWidgets/QShortcut.ts b/src/lib/QtWidgets/QShortcut.ts index 58f52a603..6e2ddbc4b 100644 --- a/src/lib/QtWidgets/QShortcut.ts +++ b/src/lib/QtWidgets/QShortcut.ts @@ -29,7 +29,6 @@ global.win = win; global.shortcut = shortcut; ``` */ - export class QShortcut extends NodeObject { native: NativeElement; constructor(parent: NodeWidget) { diff --git a/src/lib/QtWidgets/QSpinBox.ts b/src/lib/QtWidgets/QSpinBox.ts index f59b100d4..fb2a5476c 100644 --- a/src/lib/QtWidgets/QSpinBox.ts +++ b/src/lib/QtWidgets/QSpinBox.ts @@ -18,7 +18,6 @@ const { QSpinBox } = require("@nodegui/nodegui"); const spinBox = new QSpinBox(); ``` */ - export class QSpinBox extends NodeWidget { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QStackedWidget.ts b/src/lib/QtWidgets/QStackedWidget.ts index 2b3861b2d..cddfaaf19 100644 --- a/src/lib/QtWidgets/QStackedWidget.ts +++ b/src/lib/QtWidgets/QStackedWidget.ts @@ -43,7 +43,6 @@ win.show(); ``` */ - export class QStackedWidget extends NodeWidget { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QSystemTrayIcon.ts b/src/lib/QtWidgets/QSystemTrayIcon.ts index f246c1acf..4a2ad9c08 100644 --- a/src/lib/QtWidgets/QSystemTrayIcon.ts +++ b/src/lib/QtWidgets/QSystemTrayIcon.ts @@ -27,7 +27,6 @@ tray.show(); global.tray = tray; // prevents garbage collection of tray ``` */ - export class QSystemTrayIcon extends NodeObject { native: NativeElement; contextMenu?: QMenu; diff --git a/src/lib/QtWidgets/QTabWidget.ts b/src/lib/QtWidgets/QTabWidget.ts index f474b54d7..b99440946 100644 --- a/src/lib/QtWidgets/QTabWidget.ts +++ b/src/lib/QtWidgets/QTabWidget.ts @@ -24,7 +24,6 @@ tabWidget.addTab(new QCalendarWidget(), new QIcon(), 'Tab 1'); tabWidget.addTab(new QCalendarWidget(), new QIcon(), 'Tab 2'); ``` */ - export class QTabWidget extends NodeWidget { native: NativeElement; tabs: NodeWidget[]; diff --git a/src/lib/QtWidgets/QTableWidget.ts b/src/lib/QtWidgets/QTableWidget.ts index 1ed47baaf..85006ee0d 100644 --- a/src/lib/QtWidgets/QTableWidget.ts +++ b/src/lib/QtWidgets/QTableWidget.ts @@ -36,7 +36,6 @@ win.show(); ``` */ - export class QTableWidget extends QAbstractScrollArea { native: NativeElement; items: Set; diff --git a/src/lib/QtWidgets/QTimeEdit.ts b/src/lib/QtWidgets/QTimeEdit.ts index 4d3c9f454..d827dfdbe 100644 --- a/src/lib/QtWidgets/QTimeEdit.ts +++ b/src/lib/QtWidgets/QTimeEdit.ts @@ -16,7 +16,7 @@ A `QTimeEdit` a widget for editing times based on the QDateTimeEdit widget ```javascript const { QTimeEdit } = require("@nodegui/nodegui"); -const comboBox = new QTimeEdit(); +const timeEdit = new QTimeEdit(); // must be implemented ``` */ diff --git a/src/lib/QtWidgets/QTreeWidget.ts b/src/lib/QtWidgets/QTreeWidget.ts index 9a45b3c4a..47d0a11d6 100644 --- a/src/lib/QtWidgets/QTreeWidget.ts +++ b/src/lib/QtWidgets/QTreeWidget.ts @@ -42,7 +42,6 @@ win.show(); (global as any).win = win; ``` */ - export class QTreeWidget extends QAbstractScrollArea { native: NativeElement; topLevelItems: Set; diff --git a/website/docs/api/generated/classes/qdateedit.md b/website/docs/api/generated/classes/qdateedit.md index 2d13a6758..de8358b04 100644 --- a/website/docs/api/generated/classes/qdateedit.md +++ b/website/docs/api/generated/classes/qdateedit.md @@ -15,7 +15,7 @@ A `QDateEdit` provides a widget for editing dates based on the QDateTimeEdit wid ```javascript const { QDateEdit } = require("@nodegui/nodegui"); -const comboBox = new QDateEdit(); +const dateEdit = new QDateEdit(); // must be implemented ``` diff --git a/website/docs/api/generated/classes/qgroupbox.md b/website/docs/api/generated/classes/qgroupbox.md index 070f302aa..d700dbfd5 100644 --- a/website/docs/api/generated/classes/qgroupbox.md +++ b/website/docs/api/generated/classes/qgroupbox.md @@ -35,7 +35,8 @@ win.setCentralWidget(groupBox); win.resize(400, 400); win.show(); -(global as any).win = win;``` +(global as any).win = win; +``` ## Hierarchy diff --git a/website/docs/api/generated/classes/qtimeedit.md b/website/docs/api/generated/classes/qtimeedit.md index c75f6322a..284d2b053 100644 --- a/website/docs/api/generated/classes/qtimeedit.md +++ b/website/docs/api/generated/classes/qtimeedit.md @@ -15,7 +15,7 @@ A `QTimeEdit` a widget for editing times based on the QDateTimeEdit widget ```javascript const { QTimeEdit } = require("@nodegui/nodegui"); -const comboBox = new QTimeEdit(); +const timeEdit = new QTimeEdit(); // must be implemented ```