diff --git a/package-lock.json b/package-lock.json index 84a4306c7..17c7e8c82 100644 --- a/package-lock.json +++ b/package-lock.json @@ -569,6 +569,12 @@ "integrity": "sha512-Il2DtDVRGDcqjDtE+rF8iqg1CArehSK84HZJCT7AMITlyXRBpuPhqGLDQMowraqqu1coEaimg4ZOqggt6L6L+A==", "dev": true }, + "@types/minimatch": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.3.tgz", + "integrity": "sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA==", + "dev": true + }, "@types/node": { "version": "12.12.21", "resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.21.tgz", @@ -984,6 +990,15 @@ "babel-plugin-jest-hoist": "^24.9.0" } }, + "backbone": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/backbone/-/backbone-1.4.0.tgz", + "integrity": "sha512-RLmDrRXkVdouTg38jcgHhyQ/2zjg7a8E6sz2zxfz21Hh17xDJYUHBZimVIt5fUyS8vbfpeSmTL3gUjTEvUV3qQ==", + "dev": true, + "requires": { + "underscore": ">=1.8.3" + } + }, "balanced-match": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", @@ -3215,6 +3230,15 @@ } } }, + "highlight.js": { + "version": "9.17.1", + "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-9.17.1.tgz", + "integrity": "sha512-TA2/doAur5Ol8+iM3Ov7qy3jYcr/QiJ2eDTdRF4dfbjG7AaaB99J5G+zSl11ljbl6cIcahgPY6SKb3sC3EJ0fw==", + "dev": true, + "requires": { + "handlebars": "^4.5.3" + } + }, "hosted-git-info": { "version": "2.8.5", "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.5.tgz", @@ -3451,6 +3475,12 @@ } } }, + "interpret": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.2.0.tgz", + "integrity": "sha512-mT34yGKMNceBQUoVn7iCDKDntA7SC6gycMAWzGx1z/CMCTV7b2AAtXlo3nRyHZ1FelRkQbQjprHSYGwzLtkVbw==", + "dev": true + }, "invariant": { "version": "2.2.4", "resolved": "https://registry.npmjs.org/invariant/-/invariant-2.2.4.tgz", @@ -4470,6 +4500,12 @@ "supports-color": "^6.1.0" } }, + "jquery": { + "version": "3.4.1", + "resolved": "https://registry.npmjs.org/jquery/-/jquery-3.4.1.tgz", + "integrity": "sha512-36+AdBzCL+y6qjw5Tx7HgzeGCzC81MDDgaUP8ld2zhx58HdqXGoBd+tHdrBMiyjGQs0Hxs/MLZTu/eHNJJuWPw==", + "dev": true + }, "js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", @@ -4741,6 +4777,12 @@ "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-1.0.1.tgz", "integrity": "sha512-G2Lj61tXDnVFFOi8VZds+SoQjtQC3dgokKdDG2mTm1tx4m50NUHBOZSBwQQHyy0V12A0JTG4icfZQH+xPyh8VA==" }, + "lunr": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.8.tgz", + "integrity": "sha512-oxMeX/Y35PNFuZoHp+jUj5OSEmLCaIH4KTFJh7a93cHBoFmpw2IoPs22VIz7vyO2YUnx2Tn9dzIwO2P/4quIRg==", + "dev": true + }, "make-dir": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-2.1.0.tgz", @@ -4795,6 +4837,12 @@ "object-visit": "^1.0.0" } }, + "marked": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-0.7.0.tgz", + "integrity": "sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==", + "dev": true + }, "memory-stream": { "version": "0.0.3", "resolved": "https://registry.npmjs.org/memory-stream/-/memory-stream-0.0.3.tgz", @@ -5634,6 +5682,15 @@ "util.promisify": "^1.0.0" } }, + "rechoir": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz", + "integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=", + "dev": true, + "requires": { + "resolve": "^1.1.6" + } + }, "regex-not": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/regex-not/-/regex-not-1.0.2.tgz", @@ -5937,6 +5994,17 @@ "integrity": "sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=", "dev": true }, + "shelljs": { + "version": "0.8.3", + "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.3.tgz", + "integrity": "sha512-fc0BKlAWiLpwZljmOvAOTE/gXawtCoNrP5oaY7KIaQbbyHeQVg01pSEuEGvGh3HEdBU4baCD7wQBwADmM/7f7A==", + "dev": true, + "requires": { + "glob": "^7.0.0", + "interpret": "^1.0.0", + "rechoir": "^0.6.2" + } + }, "shellwords": { "version": "0.1.1", "resolved": "https://registry.npmjs.org/shellwords/-/shellwords-0.1.1.tgz", @@ -6609,6 +6677,47 @@ "resolved": "https://registry.npmjs.org/typedarray/-/typedarray-0.0.6.tgz", "integrity": "sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=" }, + "typedoc": { + "version": "0.15.5", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.15.5.tgz", + "integrity": "sha512-AKXLtOUCLRlSTyfXQHYp3LFPy6RiFLnxnKS5z1jwQsYXmCPbHWuhmfgS264Es2hPMZjzvHqk/ZQDzCBpb49u6w==", + "dev": true, + "requires": { + "@types/minimatch": "3.0.3", + "fs-extra": "^8.1.0", + "handlebars": "^4.5.3", + "highlight.js": "^9.17.1", + "lodash": "^4.17.15", + "marked": "^0.7.0", + "minimatch": "^3.0.0", + "progress": "^2.0.3", + "shelljs": "^0.8.3", + "typedoc-default-themes": "^0.6.2", + "typescript": "3.7.x" + } + }, + "typedoc-default-themes": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.6.2.tgz", + "integrity": "sha512-+O+1aHjVIpDLsbkIDkZSNu+kutqmg7WdzahT+4KwBC/95mUgAb0xkbwdPpEJEpRX0ov1UJoCmvEPb1/VHxnTuw==", + "dev": true, + "requires": { + "backbone": "^1.4.0", + "jquery": "^3.4.1", + "lunr": "^2.3.8", + "underscore": "^1.9.1" + } + }, + "typedoc-plugin-markdown": { + "version": "2.2.14", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-2.2.14.tgz", + "integrity": "sha512-MukndnFdFWMc24HpzvCPDRKMX8Fx92arfMvlAVFhPv8ClXyK7aQVPygHLB1iWXvev6TzggUSQf6IM3LHvoknCw==", + "dev": true, + "requires": { + "fs-extra": "^8.1.0", + "handlebars": "^4.5.3" + } + }, "typescript": { "version": "3.7.4", "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.7.4.tgz", @@ -6626,6 +6735,12 @@ "source-map": "~0.6.1" } }, + "underscore": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.9.1.tgz", + "integrity": "sha512-5/4etnCkd9c8gwgowi5/om/mYO5ajCaOgdzj/oW+0eQV9WxKBDZw5+ycmKmeaTXjInS/W0BzpGLo2xR2aBwZdg==", + "dev": true + }, "union-value": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/union-value/-/union-value-1.0.1.tgz", diff --git a/package.json b/package.json index ef9b30cb1..b99a915ed 100644 --- a/package.json +++ b/package.json @@ -8,13 +8,14 @@ "license": "MIT", "private": false, "scripts": { - "dev": "npm run build && qode dist/demo.js", + "dev": "npm run build && qode dist/demo.js", "build": "tsc && npm run build:addon", "postinstall": "npm run build:addon", "build:addon": "cross-env CMAKE_BUILD_PARALLEL_LEVEL=8 cmake-js compile", "test": "qode ./node_modules/jest/bin/jest -i", "lint:cpp": "clang-format -i --glob=src/cpp/**/*.[h,c]*", - "lint:ts": "tsc --noEmit && cross-env eslint './src/**/*.{ts,tsx,js,jsx}' --fix" + "lint:ts": "tsc --noEmit && cross-env eslint './src/**/*.{ts,tsx,js,jsx}' --fix", + "docs": "typedoc && mv ./website/website/sidebars.js ./website/docs/api/sidebar-gen.js" }, "dependencies": { "@nodegui/qode": "^1.0.6", @@ -38,6 +39,8 @@ "jest": "^24.9.0", "prettier": "^1.18.2", "ts-jest": "^24.1.0", + "typedoc": "^0.15.5", + "typedoc-plugin-markdown": "^2.2.14", "typescript": "^3.7.3" }, "husky": { diff --git a/src/demo.ts b/src/demo.ts index fd3005019..e746cf25c 100644 --- a/src/demo.ts +++ b/src/demo.ts @@ -7,6 +7,7 @@ import { QAction } from './lib/QtWidgets/QAction'; const win = new QMainWindow(); const center = new QWidget(); const layout = new FlexLayout(); + const label = new QLabel(); const tray = new QSystemTrayIcon(); const menu = new QMenu(); diff --git a/src/lib/QtGui/QApplication.ts b/src/lib/QtGui/QApplication.ts index 7843812d8..a146c4226 100644 --- a/src/lib/QtGui/QApplication.ts +++ b/src/lib/QtGui/QApplication.ts @@ -4,6 +4,23 @@ import { checkIfNativeElement } from '../utils/helpers'; import { QClipboard } from './QClipboard'; import { QStyle } from './QStyle'; +/** + +> QApplication is the root object for the entire application. It manages app level settings. + +* **This class is a JS wrapper around Qt's [QApplication class](https://doc.qt.io/qt-5/qapplication.html)** + +The QApplication class manages the GUI application's control flow and main settings. In NodeGui you will never create an instance of it manually. NodeGui's internal runtime `Qode` does it for you on app start. You can access the initialised QApplication though if needed. + +### Example + +```js +const { QApplication } = require("@nodegui/nodegui"); + +const qApp = QApplication.instance(); +qApp.quit(); +``` + */ export class QApplication extends Component { native: NativeElement; constructor(); diff --git a/src/lib/QtGui/QClipboard.ts b/src/lib/QtGui/QClipboard.ts index 65ce05402..e85e02600 100644 --- a/src/lib/QtGui/QClipboard.ts +++ b/src/lib/QtGui/QClipboard.ts @@ -1,6 +1,25 @@ import { Component, NativeElement } from '../core/Component'; import { checkIfNativeElement } from '../utils/helpers'; +/** + +> The QClipboard class provides access to the window system clipboard. + +* **This class is a JS wrapper around Qt's [QClipboard class](https://doc.qt.io/qt-5/QClipboard.html)** + +### Example + +```javascript +const { + QClipboard, + QClipboardMode, + QApplication +} = require("@nodegui/nodegui"); + +const clipboard = QApplication.clipboard(); +const text = clipboard.text(QClipboardMode.Clipboard); +``` + */ export class QClipboard extends Component { native: NativeElement; constructor(native: NativeElement) { diff --git a/src/lib/QtGui/QCursor.ts b/src/lib/QtGui/QCursor.ts index 85592d9b9..331b2f6b2 100644 --- a/src/lib/QtGui/QCursor.ts +++ b/src/lib/QtGui/QCursor.ts @@ -1,6 +1,21 @@ import addon from '../utils/addon'; import { Component, NativeElement } from '../core/Component'; import { CursorShape } from '../QtEnums'; + +/** + +> The QCursor class provides scalable icons in different modes and states. + +* **This class is a JS wrapper around Qt's [QCursor class](https://doc.qt.io/qt-5/qcursor.html)** + +### Example + +```javascript +const { QCursor } = require("@nodegui/nodegui"); + +const cursor = new QCursor(); +``` + */ export class QCursor extends Component { native: NativeElement; constructor(); diff --git a/src/lib/QtGui/QIcon.ts b/src/lib/QtGui/QIcon.ts index 5b498d9e5..13cb4ab48 100644 --- a/src/lib/QtGui/QIcon.ts +++ b/src/lib/QtGui/QIcon.ts @@ -15,6 +15,21 @@ export enum QIconState { On, } +/** + +> The QIcon class provides scalable icons in different modes and states. + +* **This class is a JS wrapper around Qt's [QIcon class](https://doc.qt.io/qt-5/qicon.html)** + +### Example + +```javascript +const { QIcon } = require("@nodegui/nodegui"); + +const imageUrl = "path/to/png"; +const icon = new QIcon(imageUrl); +``` + */ export class QIcon extends Component { native: NativeElement; constructor(); diff --git a/src/lib/QtGui/QKeySequence.ts b/src/lib/QtGui/QKeySequence.ts index 6e15adede..f505bf277 100644 --- a/src/lib/QtGui/QKeySequence.ts +++ b/src/lib/QtGui/QKeySequence.ts @@ -1,6 +1,20 @@ import addon from '../utils/addon'; import { Component, NativeElement } from '../core/Component'; +/** + +> The QKeySequence class encapsulates a key sequence as used by shortcuts. . + +* **This class is a JS wrapper around Qt's [QKeySequence class](https://doc.qt.io/qt-5/qkeysequence.html)** + +### Example + +```javascript +const { QKeySequence } = require("@nodegui/nodegui"); + +const keySequence = new QKeySequence(`Ctrl+L`); +``` + */ export class QKeySequence extends Component { native: NativeElement; constructor(); diff --git a/src/lib/QtGui/QPixmap.ts b/src/lib/QtGui/QPixmap.ts index d97406a08..845e9a587 100644 --- a/src/lib/QtGui/QPixmap.ts +++ b/src/lib/QtGui/QPixmap.ts @@ -6,6 +6,23 @@ import { QVariant } from '../QtCore/QVariant'; export type ImageFormats = 'BMP' | 'GIF' | 'JPG' | 'JPEG' | 'PNG' | 'PBM' | 'PGM' | 'PPM' | 'XBM' | 'XPM' | 'SVG'; +/** + +> The QPixmap class helps hold an image in the form of off-screen image representation. + +* **This class is a JS wrapper around Qt's [QPixmap class](https://doc.qt.io/qt-5/qpixmap.html)** + +A `QPixmap` provides ability to store an image in the memory. + +### Example + +```javascript +const { QPixmap } = require("@nodegui/nodegui"); + +const imageUrl = "path/to/png"; +const pixMap = new QPixmap(imageUrl); +``` + */ export class QPixmap extends Component { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QAbstractScrollArea.ts b/src/lib/QtWidgets/QAbstractScrollArea.ts index bad6950cb..51be8cfbb 100644 --- a/src/lib/QtWidgets/QAbstractScrollArea.ts +++ b/src/lib/QtWidgets/QAbstractScrollArea.ts @@ -2,6 +2,20 @@ import { NodeWidget, QWidget, QWidgetSignals } from './QWidget'; import { ScrollBarPolicy } from '../QtEnums/ScrollBarPolicy'; export type QAbstractScrollAreaSignals = QWidgetSignals; + +/** + +> Abstract class to add functionalities common to all scrollarea based widgets. + +**This class implements all methods, properties of Qt's [QAbstractScrollArea class](https://doc.qt.io/qt-5/qabstractscrollarea.html) so that it can be inherited by all scroll based widgets** + +`QAbstractScrollArea` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all scrollable widget's easily. If you wish to create a scrollarea use [QScrollArea](api/QScrollArea.md) instead. + +**QAbstractScrollArea is the base class for all widgets.** + +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 37eb52e03..e0b6867c8 100644 --- a/src/lib/QtWidgets/QAbstractSlider.ts +++ b/src/lib/QtWidgets/QAbstractSlider.ts @@ -9,6 +9,20 @@ export interface QAbstractSliderSignals extends QWidgetSignals { sliderReleased: () => void; valueChanged: (value: number) => void; } + +/** + +> Abstract class to add functionalities common to all slider based widgets. + +**This class implements all methods, properties of Qt's [QAbstractSlider class](https://doc.qt.io/qt-5/qabstractslider.html) so that it can be inherited by all slider based widgets** + +`QAbstractSlider` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all slider widget's easily. If you wish to create a slider use [QDial](api/QDial.md) instead. + +**QAbstractSlider is the base class for all slider widgets.** + +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/QAction.ts b/src/lib/QtWidgets/QAction.ts index 7aba67a63..9568786c0 100644 --- a/src/lib/QtWidgets/QAction.ts +++ b/src/lib/QtWidgets/QAction.ts @@ -15,6 +15,26 @@ export interface QActionSignals extends QObjectSignals { toggled: (checked: boolean) => void; } +/** + +> The QAction class provides an abstract user interface action that can be inserted into widgets. + +* **This class is a JS wrapper around Qt's [QAction class](https://doc.qt.io/qt-5/qaction.html)** + +### Example + +```javascript +const { QAction, QMenu } = require("@nodegui/nodegui"); + +const menu = new QMenu(); +const menuAction = new QAction(); +menuAction.setText("subAction"); +menuAction.addEventListener("triggered", () => { + console.log("Action clicked"); +}); +menu.addAction(menuAction); +``` + */ export class QAction extends NodeObject { native: NativeElement; icon?: QIcon; diff --git a/src/lib/QtWidgets/QCheckBox.ts b/src/lib/QtWidgets/QCheckBox.ts index 1fa1c6464..5d21a9238 100644 --- a/src/lib/QtWidgets/QCheckBox.ts +++ b/src/lib/QtWidgets/QCheckBox.ts @@ -5,6 +5,23 @@ import { QAbstractButton, QAbstractButtonSignals } from './QAbstractButton'; export type QCheckBoxSignals = QAbstractButtonSignals; +/** + +> Create and control checkbox. + +* **This class is a JS wrapper around Qt's [QCheckBox class](https://doc.qt.io/qt-5/qcheckbox.html)** + +A `QCheckBox` provides ability to add and manipulate native checkbox widgets. + +### Example + +```javascript +const { QCheckBox } = require("@nodegui/nodegui"); + +const checkbox = new QCheckBox(); +checkbox.setText("Hello"); +``` + */ export class QCheckBox extends QAbstractButton { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QDial.ts b/src/lib/QtWidgets/QDial.ts index e2f10b0a2..941a29f4e 100644 --- a/src/lib/QtWidgets/QDial.ts +++ b/src/lib/QtWidgets/QDial.ts @@ -4,6 +4,23 @@ import { NativeElement } from '../core/Component'; import { QAbstractSlider, QAbstractSliderSignals } from './QAbstractSlider'; export type QDialSignals = QAbstractSliderSignals; + +/** + +> Create and control dial slider widgets. + +* **This class is a JS wrapper around Qt's [QDial class](https://doc.qt.io/qt-5/qdial.html)** + +A `QDial` provides ability to add and manipulate native dial slider widgets. + +### Example + +```javascript +const { QDial } = require("@nodegui/nodegui"); + +const dial = new QDial(); +``` + */ export class QDial extends QAbstractSlider { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QGridLayout.ts b/src/lib/QtWidgets/QGridLayout.ts index d87c9dacd..c1f411049 100644 --- a/src/lib/QtWidgets/QGridLayout.ts +++ b/src/lib/QtWidgets/QGridLayout.ts @@ -5,6 +5,31 @@ import { NativeElement } from '../core/Component'; export type QGridLayoutSignals = QLayoutSignals; +/** + +> The QGridLayout class lays out widgets in a grid. + +* **This class is a JS wrapper around Qt's [QGridLayout](https://doc.qt.io/qt-5/qgridlayout.html)** + +### Example + +```javascript +const { QGridLayout, QWidget, QLabel } = require("@nodegui/nodegui"); + +const view = new QWidget(); +const layout = new QGridLayout(); +view.setLayout(layout); + +const label = new QLabel(); +label.setText("label1"); +const label2 = new QLabel(); +label2.setText("label2"); + +layout.addWidget(label); +layout.addWidget(label2); +``` + + */ export class QGridLayout extends NodeLayout { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QLabel.ts b/src/lib/QtWidgets/QLabel.ts index 8833c0352..a21d40acd 100644 --- a/src/lib/QtWidgets/QLabel.ts +++ b/src/lib/QtWidgets/QLabel.ts @@ -7,6 +7,24 @@ import { AlignmentFlag } from '../QtEnums/AlignmentFlag'; import { TextFormat } from '../QtEnums/TextFormat'; export type QLabelSignals = QWidgetSignals; +/** + +> Create and control text. + +* **This class is a JS wrapper around Qt's [QLabel class](https://doc.qt.io/qt-5/qlabel.html)** + +A `QLabel` provides ability to add and manipulate text. + +### Example + +```javascript +const { QLabel } = require("@nodegui/nodegui"); + +const label = new QLabel(); +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 fc626d550..2832feb7a 100644 --- a/src/lib/QtWidgets/QLayout.ts +++ b/src/lib/QtWidgets/QLayout.ts @@ -4,6 +4,35 @@ import { NodeObject, QObjectSignals } from '../QtCore/QObject'; // All Layouts should extend this abstract class. export type QLayoutSignals = QObjectSignals; +/** + +> Abstract class to add functionalities common to all Layout. + +**This class implements all methods, properties of Qt's [QLayout class](https://doc.qt.io/qt-5/qlayout.html) so that it can be inherited by all layouts** + +`NodeLayout` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all layout's easily. Additionally it helps in typechecking process. + +### Example + +```javascript +const { + NodeLayout, + NodeWidget, + FlexLayout, + GridLayout, + QPushButton, + QWidget +} = require("@nodegui/nodegui"); + +// addChildToLayout can accept any layout since it expects NodeLayout +const addChildToLayout = (layout: NodeLayout, widget: NodeWidget) => { + layout.addWidget(widget); +}; + +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 9ad2cc99c..d78ff6c56 100644 --- a/src/lib/QtWidgets/QLineEdit.ts +++ b/src/lib/QtWidgets/QLineEdit.ts @@ -17,6 +17,23 @@ export interface QLineEditSignals extends QWidgetSignals { textChanged: (text: string) => void; textEdited: (text: string) => void; } +/** + +> Create and control editable text field. + +* **This class is a JS wrapper around Qt's [QLineEdit class](https://doc.qt.io/qt-5/qlineedit.html)** + +A `QLineEdit` provides ability to add and manipulate native editable text field widgets. + +### Example + +```javascript +const { QLineEdit } = require("@nodegui/nodegui"); + +const lineEdit = new QLineEdit(); +``` + + */ export class QLineEdit extends NodeWidget { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QMainWindow.ts b/src/lib/QtWidgets/QMainWindow.ts index 7b7e4a14b..34697f810 100644 --- a/src/lib/QtWidgets/QMainWindow.ts +++ b/src/lib/QtWidgets/QMainWindow.ts @@ -5,6 +5,33 @@ import { NodeLayout } from './QLayout'; import { QMenuBar } from './QMenuBar'; export type QMainWindowSignals = QWidgetSignals; + +/** + +> Create and control windows. + +* **This class is a JS wrapper around Qt's [QMainWindow class](https://doc.qt.io/qt-5/qmainwindow.html)** + +A `QMainWindow` provides a main application window. Every widget in NodeGui should be a child/nested child of QMainWindow. QMainWindow in NodeGui is also responsible for FlexLayout calculations of its children. + +### Example + +```javascript +const { QMainWindow, QWidget } = require("@nodegui/nodegui"); + +const win = new QMainWindow(); + +const centralWidget = new QWidget(); +win.setCentralWidget(centralWidget); + +win.show(); + +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 e732da30d..6c4daa93f 100644 --- a/src/lib/QtWidgets/QMenu.ts +++ b/src/lib/QtWidgets/QMenu.ts @@ -4,6 +4,21 @@ import addon from '../utils/addon'; import { QAction } from './QAction'; export type QMenuSignals = QWidgetSignals; + +/** + +> The QMenu class provides a menu widget for use in menu bars, context menus, and other popup menus. + +* **This class is a JS wrapper around Qt's [QMenu class](https://doc.qt.io/qt-5/qmenu.html)** + +### Example + +```javascript +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 0b266877a..60a6b2ff8 100644 --- a/src/lib/QtWidgets/QMenuBar.ts +++ b/src/lib/QtWidgets/QMenuBar.ts @@ -6,6 +6,24 @@ import { checkIfNativeElement } from '../utils/helpers'; export type QMenuBarSignals = QWidgetSignals; +/** + +> The QMenuBar class provides a menu widget for use in menu bars, context menus, and other popup menus. + +* **This class is a JS wrapper around Qt's [QMenuBar class](https://doc.qt.io/qt-5/qmenu.html)** + +### Example + +```javascript +const { QMenuBar, QMainWindow } = require("@nodegui/nodegui"); +const win = new QMainWindow(); +const menu = new QMenuBar(); +const menuBar = new QMenuBar(); +win.setMenuBar(menuBar); +win.show(); +global.win = win; +``` + */ export class QMenuBar extends NodeWidget { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QPlainTextEdit.ts b/src/lib/QtWidgets/QPlainTextEdit.ts index d7e726794..47f2f9603 100644 --- a/src/lib/QtWidgets/QPlainTextEdit.ts +++ b/src/lib/QtWidgets/QPlainTextEdit.ts @@ -19,6 +19,23 @@ export enum LineWrapMode { NoWrap, WidgetWidth, } + +/** + +> Used to edit and display plain text. + +* **This class is a JS wrapper around Qt's [QPlainTextEdit class](https://doc.qt.io/qt-5/qplaintextedit.html)** + +A `QPlainTextEdit` provides ability to add and manipulate native editable text field widgets. + +### Example + +```javascript +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 ef6de8421..97f48c556 100644 --- a/src/lib/QtWidgets/QProgressBar.ts +++ b/src/lib/QtWidgets/QProgressBar.ts @@ -6,6 +6,22 @@ import { Orientation } from '../QtEnums'; export interface QProgressBarSignals extends QWidgetSignals { valueChanged: (value: number) => void; } +/** + +> Create and control progress bar widgets. + +* **This class is a JS wrapper around Qt's [QProgressBar class](https://doc.qt.io/qt-5/qprogressbar.html)** + +A `QProgressBar` provides ability to add and manipulate native progress bar widgets. + +### Example + +```javascript +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 39a693b6e..21531d4ef 100644 --- a/src/lib/QtWidgets/QPushButton.ts +++ b/src/lib/QtWidgets/QPushButton.ts @@ -4,7 +4,23 @@ import { NativeElement } from '../core/Component'; import { QAbstractButton, QAbstractButtonSignals } from './QAbstractButton'; export type QPushButtonSignals = QAbstractButtonSignals; +/** + +> Create and control buttons. +* **This class is a JS wrapper around Qt's [QPushButton class](https://doc.qt.io/qt-5/qpushbutton.html)** + +A `QPushButton` provides ability to add and manipulate native button widgets. + +### Example + +```javascript +const { QPushButton } = require("@nodegui/nodegui"); + +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 5eac5c5a2..e554a3de7 100644 --- a/src/lib/QtWidgets/QRadioButton.ts +++ b/src/lib/QtWidgets/QRadioButton.ts @@ -4,6 +4,25 @@ import { NativeElement } from '../core/Component'; import { QAbstractButton, QAbstractButtonSignals } from './QAbstractButton'; export type QRadioButtonSignals = QAbstractButtonSignals; + +/** + +> Create and control radio button. + +* **This class is a JS wrapper around Qt's [QRadioButton class](https://doc.qt.io/qt-5/qradiobutton.html)** + +A `QRadioButton` provides ability to add and manipulate native radio button widgets. + +### Example + +```javascript +const { QRadioButton } = require("@nodegui/nodegui"); + +const radioButton = new QRadioButton(); +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 1fc6836bc..7d43884a6 100644 --- a/src/lib/QtWidgets/QScrollArea.ts +++ b/src/lib/QtWidgets/QScrollArea.ts @@ -4,6 +4,30 @@ import { NativeElement } from '../core/Component'; import { QAbstractScrollArea, QAbstractScrollAreaSignals } from './QAbstractScrollArea'; export type QScrollAreaSignals = QAbstractScrollAreaSignals; + +/** + +> A `QScrollArea` provides a scrolling view onto another widget. + +* **This class is a JS wrapper around Qt's [QScrollArea class](https://doc.qt.io/qt-5/qscrollarea.html)** + +### Example + +```javascript +const { QScrollArea } = require("@nodegui/nodegui"); + +const scrollArea = new QScrollArea(); +scrollArea.setInlineStyle("flex: 1; width:'100%';"); + +const imageLabel = new QLabel(); +const pixmap = new QPixmap( + path.resolve(__dirname, "../extras/assets/kitchen.png") +); +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 85f5576d1..b4648eed0 100644 --- a/src/lib/QtWidgets/QShortcut.ts +++ b/src/lib/QtWidgets/QShortcut.ts @@ -10,6 +10,30 @@ export interface QShortcutSignals extends QObjectSignals { activatedAmbiguously: () => void; } +/** + +> The QShortcut class is used to create keyboard shortcuts. + +* **This class is a JS wrapper around Qt's [QShortcut class](https://doc.qt.io/qt-5/qshortcut.html)** + +### Example + +```javascript +const { QShortcut, QKeySequence, QMainWindow } = require("@nodegui/nodegui"); + +const win = new QMainWindow(); +const shortcut = new QShortcut(win); +shortcut.setKey(new QKeySequence("Ctrl+M")); +shortcut.setEnabled(true); +shortcut.addEventListener(QShortcutEvents.activated, () => { + console.log("Shortcut Activated"); +}); + +win.show(); +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 56950f797..74252fa69 100644 --- a/src/lib/QtWidgets/QSpinBox.ts +++ b/src/lib/QtWidgets/QSpinBox.ts @@ -6,6 +6,22 @@ export interface QSpinBoxSignals extends QWidgetSignals { valueChanged: (value: number) => void; } +/** + +> Create and control spin box widgets. + +* **This class is a JS wrapper around Qt's [QSpinBox class](https://doc.qt.io/qt-5/qspinbox.html)** + +A `QSpinBox` provides ability to add and manipulate native spin box widgets. + +### Example + +```javascript +const { QSpinBox } = require("@nodegui/nodegui"); + +const spinBox = new QSpinBox(); +``` + */ export class QSpinBox extends NodeWidget { native: NativeElement; constructor(); diff --git a/src/lib/QtWidgets/QSystemTrayIcon.ts b/src/lib/QtWidgets/QSystemTrayIcon.ts index c0a0345a0..89bb77ab9 100644 --- a/src/lib/QtWidgets/QSystemTrayIcon.ts +++ b/src/lib/QtWidgets/QSystemTrayIcon.ts @@ -10,6 +10,28 @@ export interface QSystemTrayIconSignals extends QObjectSignals { messageClicked: () => void; } +/** + +> Create and control system tray icon. + +* **This class is a JS wrapper around Qt's [QSystemTrayIcon class](https://doc.qt.io/qt-5/qsystemtrayicon.html)** + +A `QSystemTrayIcon` provides ability to add and manipulate native system tray icon. + + +### Example + +```javascript +const { QSystemTrayIcon, QIcon } = require("@nodegui/nodegui"); +const trayIcon = new QIcon( + resolve(__dirname, "some/image/file.png"); +); +const tray = new QSystemTrayIcon(); +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/QWidget.ts b/src/lib/QtWidgets/QWidget.ts index 655a222f7..eed1056fd 100644 --- a/src/lib/QtWidgets/QWidget.ts +++ b/src/lib/QtWidgets/QWidget.ts @@ -12,8 +12,40 @@ import { YogaWidget } from '../core/YogaWidget'; import { QSize } from '../QtCore/QSize'; import { QRect } from '../QtCore/QRect'; import { QObjectSignals } from '../QtCore/QObject'; -// All Widgets should extend from NodeWidget -// Implement all native QWidget methods here so that all widgets get access to those aswell + +/** + +> Abstract class to add functionalities common to all Widgets. + +**This class implements all methods, properties of Qt's [QWidget class](https://doc.qt.io/qt-5/qwidget.html) so that it can be inherited by all widgets** + +`NodeWidget` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all widget's easily. Additionally it helps in type checking process. If you wish to create a `div` like widget use [QWidget](api/QWidget.md) instead. + +**NodeWidget is the base class for all widgets.** + +### Example + +```javascript +const { + NodeWidget, + QPushButton, + QWidget, + QRadioButton +} = require("@nodegui/nodegui"); + +// showWidget can accept any widget since it expects NodeWidget +const showWidget = (widget: NodeWidget) => { + widget.show(); +}; + +showWidget(new QPushButton()); +showWidget(new QWidget()); +showWidget(new QRadioButton()); +``` +All Widgets should extend from NodeWidget +Implement all native QWidget methods here so that all widgets get access to those aswell + + */ export abstract class NodeWidget extends YogaWidget { layout?: NodeLayout; _rawInlineStyle = ''; @@ -180,6 +212,25 @@ export interface QWidgetSignals extends QObjectSignals { windowIconChanged: (iconNative: NativeElement) => void; customContextMenuRequested: (pos: { x: number; y: number }) => void; } + +/** + > Create and control views. + +* **This class is a JS wrapper around Qt's [QWidget class](https://doc.qt.io/qt-5/qwidget.html)** + +A `QWidget` can be used to encapsulate other widgets and provide structure. It functions similar to a `div` in the web world. + + +### Example + +```javascript +const { QWidget } = require("@nodegui/nodegui"); + +const view = new QWidget(); +view.setObjectName("container"); //Similar to setting `id` on the web +view.setLayout(new FlexLayout()); +``` + */ export class QWidget extends NodeWidget { native: NativeElement; constructor(arg?: NodeWidget | NativeElement) { diff --git a/src/lib/core/Component.ts b/src/lib/core/Component.ts index 49ee1cd44..dcbf4a15b 100644 --- a/src/lib/core/Component.ts +++ b/src/lib/core/Component.ts @@ -1,6 +1,22 @@ export type NativeElement = { type: 'native'; [key: string]: any }; + +/** + +> Abstract class that is root most base class for all widgets and layouts in the NodeGui World. + +**This class is used to add core properties to all widgets, layouts etc in NodeGui world. + Currently it helps us maintain references to the native C++ instance of the widget or layout. + It also helps in preventing gc of child elements of a layout or widget** + +`Component` is an abstract class and hence no instances of the same should be created. +It exists so that we can add core functionalities to all widgets and layouts easily. This is an internal class. + +Its the root base class in NodeGui world. + +*/ + export abstract class Component { - nodeChildren = new Set(); + nodeChildren = new Set(); nodeParent?: Component; setNodeParent(parent?: Component): void { this.nodeParent = parent; diff --git a/src/lib/core/EventWidget.ts b/src/lib/core/EventWidget.ts index 1eaf936bc..6531c1467 100644 --- a/src/lib/core/EventWidget.ts +++ b/src/lib/core/EventWidget.ts @@ -1,5 +1,32 @@ import { EventEmitter } from 'events'; import { NativeElement, Component } from './Component'; + +/** + +> Abstract class that adds event handling support to all widgets. + +**This class implements an event emitter and merges it with Qt's event and signal system. It allows us to register and unregister event and signal listener at will from javascript** + +`EventWidget` is an abstract class and hence no instances of the same should be created. It exists so that we can add event handling functionalities to all widget's easily. This is an internal class. + +### Example + +```javascript +const { QWidget, QWidgetSignals, WidgetEventTypes } = require("@nodegui/nodegui"); + +const view = new QWidget(); +// You either listen for a widget's signal +view.addEventListener('windowTitleChanged', () => { + console.log("window title changed"); +}); + +// or you can listen for an event + +view.addEventListener(WidgetEventTypes.MouseMove, () => { + console.log("mouse moved"); +}); +``` + */ export abstract class EventWidget extends Component { private emitter: EventEmitter; constructor(native: NativeElement) { @@ -12,7 +39,32 @@ export abstract class EventWidget extends Component { } } + /** + * + @param signalType SignalType is a signal from the widgets signals interface. + @param callback Corresponding callback for the signal as mentioned in the widget's signal interface + @returns 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(signalType: SignalType, callback: Signals[SignalType]): void; + + /** + + @param eventType + @param callback + + For example in the case of QPushButton: + ```js + const button = new QPushButton(); + button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered")); + ``` + */ addEventListener(eventType: WidgetEventTypes, callback: (event?: NativeElement) => void): void; addEventListener(eventOrSignalType: string, callback: (...payloads: any[]) => void): void { this.native.subscribeToQtEvent(eventOrSignalType); diff --git a/src/lib/core/FlexLayout.ts b/src/lib/core/FlexLayout.ts index efa537191..0749caf28 100644 --- a/src/lib/core/FlexLayout.ts +++ b/src/lib/core/FlexLayout.ts @@ -5,6 +5,33 @@ import { FlexNode } from './YogaWidget'; import { NativeElement } from './Component'; export type FlexLayoutSignals = QLayoutSignals; + +/** + +> Custom layout to help layout child widgets using flex layout. + +* **This class is a JS wrapper around custom Qt layout implemented using [Yoga](https://github.com/facebook/yoga)** + +A `FlexLayout` can be used to layout all child NodeGui widgets using flex. + +### Example + +```javascript +const { FlexLayout, QWidget, QLabel } = require("@nodegui/nodegui"); + +const view = new QWidget(); +const layout = new FlexLayout(); +view.setLayout(layout); + +const label = new QLabel(); +label.setText("label1"); +const label2 = new QLabel(); +label2.setText("label2"); + +layout.addWidget(label); +layout.addWidget(label2); +``` + */ export class FlexLayout extends NodeLayout { native: NativeElement; protected flexNode?: FlexNode; diff --git a/src/lib/core/YogaWidget.ts b/src/lib/core/YogaWidget.ts index 748c1ba84..bbed07fa7 100644 --- a/src/lib/core/YogaWidget.ts +++ b/src/lib/core/YogaWidget.ts @@ -1,10 +1,34 @@ import { NodeObject, QObjectSignals } from '../QtCore/QObject'; export type FlexNode = {}; + +/** + +> Abstract class to add common functionality related to Flex layout to all Widgets. + +**This class implements methods related to flex layout required to be present in all widgets** + +`YogaWidget` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities related to flex layout to all widget's easily. We implement flex layout using a library called [Yoga](https://github.com/facebook/yoga). As part of yoga every widget needs to store its own flex properties such as alignItems, flexDirection etc. This is done with the help of YogaWidget. + + +```javascript +const { QWidget } = require("@nodegui/nodegui"); + +const view = new QWidget(); +// getFlexNode is a method from YogaWidget +const flexNode = view.getFlexNode(); +``` + +YogaWidget helps in storing all flex properties of a widget. + */ export abstract class YogaWidget extends NodeObject { getFlexNode(): FlexNode { return this.native.getFlexNode(); } + /** + * sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + * @param isSizeControlled + */ setFlexNodeSizeControlled(isSizeControlled: boolean): void { this.native.setFlexNodeSizeControlled(isSizeControlled); } diff --git a/tsconfig.json b/tsconfig.json index 3f37a638d..5d65b5e7a 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -10,5 +10,19 @@ "esModuleInterop": true, "resolveJsonModule": true }, - "include": ["src"] + "include": ["src"], + "typedocOptions": { + "mode": "file", + "out": "website/docs/api/generated", + "plugin": ["typedoc-plugin-markdown"], + "exclude": ["demo.ts"], + "excludeExternals": true, + "excludeNotExported": true, + "excludePrivate": true, + "excludeProtected": true, + "includeDeclarations": true, + "hideBreadcrumbs": true, + "hideSources": true, + "theme": "docusaurus2" + } } diff --git a/website/docs/api/Component.md b/website/docs/api/Component.md deleted file mode 100644 index 12540e5ae..000000000 --- a/website/docs/api/Component.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -sidebar_label: Component -title: Component ---- - -> Abstract class that is root most base class for all widgets and layouts in the NodeGui World. - -**This class is used to add core properties to all widgets, layouts etc in NodeGui world. Currently it helps us maintain references to the native C++ instance of the widget or layout. It also helps in preventing gc of child elements of a layout or widget** - -`Component` is an abstract class and hence no instances of the same should be created. It exists so that we can add core functionalities to all widgets and layouts easily. This is an internal class. - -**Component is the base class for YogaWidget and NodeLayout which means all widgets and layouts inherit it aswell. Its the root base class in NodeGui world** - -To get a clearer picture you can take a look at the Component source code here: `src/lib/core/Component/index.ts` - -## Static Methods - -There are no public static methods for Component. - -## Instance Properties - -There are no public instance properties for Component. - -## Instance Methods - -There are no public instance methods for Component. diff --git a/website/docs/api/EventWidget.md b/website/docs/api/EventWidget.md deleted file mode 100644 index a711df870..000000000 --- a/website/docs/api/EventWidget.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_label: EventWidget -title: EventWidget ---- - -> Abstract class that adds event handling support to all widgets. - -**This class implements an event emitter and merges it with Qt's event and signal system. It allows us to register and unregister event and signal listener at will from javascript** - -`EventWidget` is an abstract class and hence no instances of the same should be created. It exists so that we can add event handling functionalities to all widget's easily. This is an internal class. - -**EventWidget is the base class for NodeWidget which means all widgets inherit it aswell. It inherits from another abstract class [YogaWidget](api/YogaWidget.md)** - -### Example - -```javascript -const { QWidget, QWidgetEvents } = require("@nodegui/nodegui"); - -const view = new QWidget(); -// addEventListener is a method from EventWidget -view.addEventListener("MouseMove", () => { - console.log("mouse moved"); -}); - -or; - -// addEventListener is a method from EventWidget -view.addEventListener(QWidgetEvents.MouseMove, () => { - console.log("mouse moved"); -}); -``` - -EventWidget will contain all methods and properties that are useful to handle events and signals of widgets in the NodeGui world. - -## Static Methods - -EventWidget can access all the static methods defined in [YogaWidget](api/YogaWidget.md) - -## Instance Properties - -EventWidget can access all the instance properties defined in [YogaWidget](api/YogaWidget.md) - -## Instance Methods - -EventWidget can access all the instance methods defined in [YogaWidget](api/YogaWidget.md) - -Additionally it also has the following instance methods: - -### `widget.addEventListener(eventType, callback)` - -Adds an event listener to the widget to listen to events that occur on a widget. - -- `eventType` string - The event or signal you wish to listen to for the widget. Every widget exports its own enum of all possible events and signal types it can take. For example: `QWidget` exports `QWidgetEvents`, `QPushButton` exports `QPushButtonEvents`. - -- `callback` (payload?: NativeEvent | any) => void - A callback function to invoke when an event occurs. Usually you receive a nativeEvent or a string as argument. - -### `widget.removeEventListener(eventType, callback?)` - -Removes the specified event listener from the widget. - -- `eventType` string - The event or signal for which you wish to remove the listener. - -- `callback` Function (_Optional_) - If specified the removeEventListener will remove the specified listener only, otherwise all eventlisteners of the eventType on the widget will be removed. diff --git a/website/docs/api/FlexLayout.md b/website/docs/api/FlexLayout.md deleted file mode 100644 index 282fd6871..000000000 --- a/website/docs/api/FlexLayout.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -sidebar_label: FlexLayout -title: FlexLayout ---- - -> Custom layout to help layout child widgets using flex layout. - -**This class is a JS wrapper around custom Qt layout implemented using [Yoga](https://github.com/facebook/yoga)** - -A `FlexLayout` can be used to layout all child NodeGui widgets using flex. - -**FlexLayout inherits from [NodeLayout](api/NodeLayout.md)** - -### Example - -```javascript -const { FlexLayout, QWidget, QLabel } = require("@nodegui/nodegui"); - -const view = new QWidget(); -const layout = new FlexLayout(); -view.setLayout(layout); - -const label = new QLabel(); -label.setText("label1"); -const label2 = new QLabel(); -label2.setText("label2"); - -layout.addWidget(label); -layout.addWidget(label2); -``` - -## Static Methods - -FlexLayout can access all the static methods defined in [NodeLayout](api/NodeLayout.md) - -## Instance Properties - -FlexLayout can access all the instance properties defined in [NodeLayout](api/NodeLayout.md) - -## Instance Methods - -FlexLayout can access all the instance methods defined in [NodeLayout](api/NodeLayout.md) - -Additionally it also has the following instance methods: - -### `layout.addWidget(childWidget, childFlexNode?)` - -Adds the childWidget to the layout. It calls the native method of custom FlexLayout. - -- `childWidget` NodeWidget - child widget that needs to be added to the layout. -- `childFlexNode` flexNode ref (_Optional_) - flexNode reference of the child widget. You can get this by calling `childWidget.getFlexNode()`. - -### `layout.insertChildBefore(childWidget, beforeChildWidget, childFlexNode?, beforeChildFlexNode?)` - -Adds the childWidget before another already set childWidget in the layout. It calls the native method of custom FlexLayout. - -- `childWidget` NodeWidget - child widget that needs to be added to the layout. -- `beforeChildWidget` NodeWidget - the widget before which the `childWidget` needs to be added in the layout. -- `childFlexNode` flexNode ref (_Optional_) - flexNode reference of the child widget. You can get this by calling `childWidget.getFlexNode()`. -- `beforeChildFlexNode` flexNode ref (_Optional_) - flexNode reference of the before child widget. You can get this by calling `beforeChildWidget.getFlexNode()`. - -### `layout.removeWidget(childWidget, childFlexNode?)` - -Removes the childWidget from the layout. It calls the native method of custom FlexLayout. - -- `childWidget` NodeWidget - child widget that needs to be added to the layout. -- `childFlexNode` flexNode ref (_Optional_) - flexNode reference of the child widget. You can get this by calling `childWidget.getFlexNode()`. - -### `layout.setFlexNode(flexNode)` - -A layout doesnt have its own flexNode. This method sets the flex Node to use for calculating position of the child widgets. Hence this should be always equal to the flex node of widget for which this layout is set. This is called internally by `widget.setLayout`. - -- `flexNode` flexNode ref - flexNode reference of the widget for which this layout is set. You can get this by calling `widget.getFlexNode()`. diff --git a/website/docs/api/NodeLayout.md b/website/docs/api/NodeLayout.md deleted file mode 100644 index 4986e9c7d..000000000 --- a/website/docs/api/NodeLayout.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_label: NodeLayout -title: NodeLayout ---- - -> Abstract class to add functionalities common to all Layout. - -**This class implements all methods, properties of Qt's [QLayout class](https://doc.qt.io/qt-5/qlayout.html) so that it can be inherited by all layouts** - -`NodeLayout` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all layout's easily. Additionally it helps in typechecking process. - -**NodeLayout is the base class for all layouts. It inherits from another abstract class [Component](api/Component.md)** - -### Example - -```javascript -const { - NodeLayout, - NodeWidget, - FlexLayout, - GridLayout, - QPushButton, - QWidget -} = require("@nodegui/nodegui"); - -// addChildToLayout can accept any layout since it expects NodeLayout -const addChildToLayout = (layout: NodeLayout, widget: NodeWidget) => { - layout.addWidget(widget); -}; - -addChildToLayout(new FlexLayout(), new QPushButton()); -addChildToLayout(new GridLayout(), new QWidget()); -``` - -NodeLayout will list all methods and properties that are common to all layouts in the NodeGui world. - -## Static Methods - -NodeLayout can access all the static methods defined in [Component](api/Component.md) - -## Instance Properties - -NodeLayout can access all the instance properties defined in [Component](api/Component.md) - -Additionally it also has the following instance properties: - -### `layout.type` - -This will return the string `layout` for all layouts. - -## Instance Methods - -NodeLayout can access all the instance methods defined in [Component](api/Component.md) - -Additionally it also has the following instance methods: - -### `layout.addWidget(childWidget, ...args)` - -This is an abstract method in NodeLayout class. All Layouts inheriting from NodeLayout should implement this method. - -- `childWidget` NodeWidget - Any widget in the NodeGui world. -- `...args` any[] - Additional params as required by the layout. - -### `layout.activate()` - -Redoes the layout for parent widget of this layout if necessary. Returns true if the layout was redone. - -### `layout.invalidate()` - -Invalidates any cached information in this layout. - -### `layout.update()` - -Updates the layout for parent widget of this layout. You should generally not need to call this because it is automatically called at the most appropriate times. diff --git a/website/docs/api/NodeWidget.md b/website/docs/api/NodeWidget.md deleted file mode 100644 index d1db1d833..000000000 --- a/website/docs/api/NodeWidget.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -sidebar_label: NodeWidget -title: NodeWidget ---- - -> Abstract class to add functionalities common to all Widgets. - -**This class implements all methods, properties of Qt's [QWidget class](https://doc.qt.io/qt-5/qwidget.html) so that it can be inherited by all widgets** - -`NodeWidget` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all widget's easily. Additionally it helps in type checking process. If you wish to create a `div` like widget use [QWidget](api/QWidget.md) instead. - -**NodeWidget is the base class for all widgets. It inherits from another abstract class [EventWidget](api/EventWidget.md)** - -### Example - -```javascript -const { - NodeWidget, - QPushButton, - QWidget, - QRadioButton -} = require("@nodegui/nodegui"); - -// showWidget can accept any widget since it expects NodeWidget -const showWidget = (widget: NodeWidget) => { - widget.show(); -}; - -showWidget(new QPushButton()); -showWidget(new QWidget()); -showWidget(new QRadioButton()); -``` - -NodeWidget will list all methods and properties that are common to all widgets in the NodeGui world. - -## Static Methods - -NodeWidget can access all the static methods defined in [EventWidget](api/EventWidget.md) - -## Instance Properties - -NodeWidget can access all the instance properties defined in [EventWidget](api/EventWidget.md) - -Additionally it also has the following instance properties: - -### `widget.layout` - -A `NodeLayout` representing current layout that is set on the widget. - -### `widget.type` - -This will return the string `widget` for all widgets. - -## Instance Methods - -NodeWidget can access all the instance methods defined in [EventWidget](api/EventWidget.md) - -Additionally it also has the following instance methods: - -### `widget.show()` - -Shows the widget and its children. It calls the native method [QWidget: show](https://doc.qt.io/qt-5/qwidget.html#show). - -### `widget.resize(width, height)` - -Resizes the widget. It calls the native method [QWidget: resize](https://doc.qt.io/qt-5/qwidget.html#resize-1). - -- `width` number - Pixels. -- `height` number - Pixels. - -### `widget.close()` - -Closes this widget. It calls the native method [QWidget: close](https://doc.qt.io/qt-5/qwidget.html#close). -Returns true if the widget was closed; otherwise returns false. - -### `widget.setLayout(layout)` - -Sets the layout manager for this widget to layout. It calls the native method [QWidget: setLayout](https://doc.qt.io/qt-5/qwidget.html#setLayout). - -- `layout` NodeLayout - Any layout that inherits from NodeLayout class. - -### `widget.setStyleSheet(styleSheet)` - -Sets the property that holds the widget's style sheet. It calls the native method [QWidget: styleSheet](https://doc.qt.io/qt-5/qwidget.html#styleSheet-prop). - -- `styleSheet` string - String which holds the widget's style sheet. Make sure you create this string using `StyleSheet.create()` - -### `widget.setCursor(cursor)` - -Sets the window mouse cursor. It calls the native method [QWidget: setCursor](https://doc.qt.io/qt-5/qwidget.html#cursor-prop). - -- `cursor` CursorShape - Specifies current cursor for the window [CursorShape is an enum from Qt](api/QtEnums.md) - -### `widget.setWindowIcon(icon)` - -Sets the window icon. It calls the native method [QWidget: setWindowIcon](https://doc.qt.io/qt-5/qwidget.html#windowIcon-prop). - -- `icon` QIcon - Specifies icon for the window. - -### `widget.setWindowState(state)` - -Sets the window state. It calls the native method [QWidget: setWindowState](https://doc.qt.io/qt-5/qwidget.html#setWindowState). - -- `state` WindowState - Specifies current state for the window [WindowState is an enum from Qt](api/QtEnums.md) - -### `widget.setWindowTitle(title)` - -Sets the window title property. It calls the native method [QWidget: setWindowTitle](https://doc.qt.io/qt-5/qwidget.html#windowTitle-prop). - -- `title` string - String which holds the windows title. - -### `widget.styleSheet()` - -Gets the property that holds the widget's style sheet. It calls the native method [QWidget: styleSheet](https://doc.qt.io/qt-5/qwidget.html#styleSheet-prop). - -### `widget.hide()` - -Hides the widget and its children. It calls the native method [QWidget: hide](https://doc.qt.io/qt-5/qwidget.html#hide). - -### `widget.move(x, y)` - -Sets the screen position of the widget. It calls the native method [QWidget: move](https://doc.qt.io/qt-5/qwidget.html#move-1). - -- `x` number - Pixels. -- `y` number - Pixels. - -### `widget.setObjectName(objectName)` - -Sets the object name of the widget in Qt. It calls the native method [QObject: setObjectName](https://doc.qt.io/qt-5/qobject.html#objectName-prop). Object name can be analogous to `id` of an element in the web world. Using the objectName of the widget one can reference it in the Qt's stylesheet much like what we do with id in the web world. - -- `objectName` string - String which holds the widget's object name. - -### `widget.objectName()` - -Gets the property that holds the widget's object name. It calls the native method [QObject: setObjectName](https://doc.qt.io/qt-5/qobject.html#objectName-prop). - -### `widget.setMouseTracking(isMouseTracked)` - -Sets the property that tells whether mouseTracking is enabled for the widget. It calls the native method [QWidget: mouseTracking](https://doc.qt.io/qt-5/qwidget.html#mouseTracking-prop). - -- `isMouseTracked` boolean - Set it to true to enable mouse tracking. - -### `widget.setEnabled(enabled)` - -Sets the property that tells whether the widget is enabled. It calls the native method [QWidget: enabled](https://doc.qt.io/qt-5/qwidget.html#enabled-prop). In general an enabled widget handles keyboard and mouse events; a disabled widget does not. - -- `enabled` boolean - Set it to true to enable the widget. - -### `widget.setFixedSize(width, height)` - -Sets both the minimum and maximum sizes of the widget. It calls the native method [QWidget: setFixedSize](https://doc.qt.io/qt-5/qwidget.html#setFixedSize). - -- `width` number - Pixels. -- `height` number - Pixels. - -### `widget.setGeometry(x, y, width, height)` - -Sets the screen position as well as size of the widget. It calls the native method [QWidget: setGeometry](https://doc.qt.io/qt-5/qwidget.html#setGeometry-1). - -- `x` number - Pixels. -- `y` number - Pixels. -- `width` number - Pixels. -- `height` number - Pixels. - -### `widget.setMaximumSize(width, height)` - -Sets the maximum size of the widget. It calls the native method [QWidget: setMaximumSize](https://doc.qt.io/qt-5/qwidget.html#setMaximumSize-1). - -- `width` number - Pixels. -- `height` number - Pixels. - -### `widget.setMinimumSize(width, height)` - -Sets the minimum size of the widget. It calls the native method [QWidget: setMinimumSize](https://doc.qt.io/qt-5/qwidget.html#setMinimumSize-1). - -- `width` number - Pixels. -- `height` number - Pixels. - -### `widget.repaint()` - -Repaints the widget. It calls the native method [QWidget: repaint](https://doc.qt.io/qt-5/qwidget.html#repaint). - -### `widget.update()` - -Updates the widget. It calls the native method [QWidget: update](https://doc.qt.io/qt-5/qwidget.html#update). - -### `widget.pos()` - -Returns the current widget position. It calls the native method [QWidget: pos](https://doc.qt.io/qt-5/qwidget.html#pos-prop). The returned size object contains x and y coordinates in pixels. - -### `widget.size()` - -Returns the current widget size. It calls the native method [QWidget: size](https://doc.qt.io/qt-5/qwidget.html#size-prop). The returned size object contains width and height in pixels. - -### `widget.updateGeometry()` - -Notifies the layout system that this widget has changed and may need to change geometry. - -### `widget.setAttribute(attributeName, switchOn)` - -Sets the attribute attribute on this widget if on is true; otherwise clears the attribute. It calls the native method [QWidget: setAttribute](https://doc.qt.io/qt-5/qwidget.html#setAttribute). - -- `attributeName` WidgetAttribute - Enum from WidgetAttribute. -- `switchOn` boolean - set it to true if you want to enable an attribute. - -### `widget.testAttribute(attributeName)` - -Returns true if attribute attribute is set on this widget; otherwise returns false. It calls the native method [QWidget: testAttribute](https://doc.qt.io/qt-5/qwidget.html#testAttribute). - -- `attributeName` WidgetAttribute - Enum from WidgetAttribute. - -#### `widget.inherits(className)` - -Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. A class is considered to inherit itself. Example: - -```ts -const progressBar = new QProgressBar(); -progressBar.inherits("QObject"); // returns true -progressBar.inherits("QProgressBar"); // returns true -progressBar.inherits("QTabWidget"); // returns false -``` - -- `className` string - Name of the class to get if this widget inherits from. diff --git a/website/docs/api/QAbstractScrollArea.md b/website/docs/api/QAbstractScrollArea.md deleted file mode 100644 index 4092f8e7e..000000000 --- a/website/docs/api/QAbstractScrollArea.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -sidebar_label: QAbstractScrollArea -title: QAbstractScrollArea ---- - -> Abstract class to add functionalities common to all scrollarea based widgets. - -**This class implements all methods, properties of Qt's [QAbstractScrollArea class](https://doc.qt.io/qt-5/qabstractscrollarea.html) so that it can be inherited by all scroll based widgets** - -`QAbstractScrollArea` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all scrollable widget's easily. If you wish to create a scrollarea use [QScrollArea](api/QScrollArea.md) instead. - -**QAbstractScrollArea is the base class for all widgets. It inherits from another abstract class [NodeWidget](api/NodeWidget.md)** - -QAbstractScrollArea will list all methods and properties that are common to all scrollable widgets in the NodeGui world. - -## Static Methods - -QAbstractScrollArea can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QAbstractScrollArea can access all the instance properties defined in [NodeWidget](api/NodeWidget.md) - -## Instance Methods - -QAbstractScrollArea can access all the instance methods defined in [NodeWidget](api/NodeWidget.md) - -Additionally it also has the following instance methods: - -### `widget.setViewport(widget)` - -Sets the viewport to be the given widget. It calls the native method [QAbstractScrollArea: setViewport](https://doc.qt.io/qt-5/qabstractscrollarea.html#setViewport). - -- `widget` NodeWidget. - -### `widget.viewport()` - -Returns the viewport widget (NodeWidget). It calls the native method [QAbstractScrollArea: viewport](https://doc.qt.io/qt-5/qabstractscrollarea.html#viewport). diff --git a/website/docs/api/QAbstractSlider.md b/website/docs/api/QAbstractSlider.md deleted file mode 100644 index 515318ec1..000000000 --- a/website/docs/api/QAbstractSlider.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_label: QAbstractSlider -title: QAbstractSlider ---- - -> Abstract class to add functionalities common to all slider based widgets. - -**This class implements all methods, properties of Qt's [QAbstractSlider class](https://doc.qt.io/qt-5/qabstractslider.html) so that it can be inherited by all slider based widgets** - -`QAbstractSlider` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all slider widget's easily. If you wish to create a slider use [QDial](api/QDial.md) instead. - -**QAbstractSlider is the base class for all widgets. It inherits from another abstract class [NodeWidget](api/NodeWidget.md)** - -QAbstractSlider will list all methods and properties that are common to all slider widgets in the NodeGui world. - -## Static Methods - -QAbstractSlider can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QAbstractSlider can access all the instance properties defined in [NodeWidget](api/NodeWidget.md) - -## Instance Methods - -QAbstractSlider can access all the instance methods defined in [NodeWidget](api/NodeWidget.md) - -Additionally it also has the following instance methods: - -### `widget.setSingleStep(step)` - -Sets the step value for user arrow key slider interaction. It calls the native method [QAbstractSlider: setSingleStep](https://doc.qt.io/qt-5/qabstractslider.html#singleStep-prop). - -- `step` number - Specified single step value. - -### `widget.setMaximum(maximum)` - -Sets the maximum value for slider. It calls the native method [QAbstractSlider: setMaximum](https://doc.qt.io/qt-5/qabstractslider.html#maximum-prop). - -- `maximum` number - Specified maximum slider value. - -### `widget.setMinimum(minimum)` - -Sets the minimum value for slider. It calls the native method [QAbstractSlider: setMinimum](https://doc.qt.io/qt-5/qabstractslider.html#minimum-prop). - -- `minimum` number - Specified minimum slider value. - -### `widget.setValue(value)` - -Sets the current value for slider. It calls the native method [QAbstractSlider: setValue](https://doc.qt.io/qt-5/qabstractslider.html#value-prop). - -- `value` number - Specified current slider value. - -### `widget.setOrientation(orientation)` - -Sets the current orientation for slider. It calls the native method [QAbstractSlider: setOrientation](https://doc.qt.io/qt-5/qabstractslider.html#orientation-prop). - -- `orientation` Orientation - Specifies visual orientation of the slider. [Orientation is an enum from Qt](api/QtEnums.md) - -### `slider.maximum()` - -Returns the maximum value (Number) of the slider. It calls the native method [QAbstractSlider: maximum](https://doc.qt.io/qt-5/qabstractslider.html#maximum-prop). - -### `slider.minimum()` - -Returns the minimum value (Number) of the slider. It calls the native method [QAbstractSlider: minimum](https://doc.qt.io/qt-5/qabstractslider.html#minimum-prop). - -### `slider.value()` - -Returns the current value (Number) of the slider. It calls the native method [QAbstractSlider: value](https://doc.qt.io/qt-5/qabstractslider.html#value-prop). diff --git a/website/docs/api/QAction.md b/website/docs/api/QAction.md deleted file mode 100644 index b378a5dab..000000000 --- a/website/docs/api/QAction.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -sidebar_label: QAction -title: QAction ---- - -> The QAction class provides an abstract user interface action that can be inserted into widgets. - -**This class is a JS wrapper around Qt's [QAction class](https://doc.qt.io/qt-5/qaction.html)** - -**QAction inherits from [EventWidget](api/EventWidget.md)** - -### Example - -```javascript -const { QAction, QMenu } = require("@nodegui/nodegui"); - -const menu = new QMenu(); -const menuAction = new QAction(); -menuAction.setText("subAction"); -menuAction.addEventListener("triggered", () => { - console.log("Action clicked"); -}); -menu.addAction(menuAction); -``` - -### `new QAction(parent?)` - -- `parent` NodeWidget. Constructs an action with parent. If parent is an action group the action will be automatically inserted into the group. - -## Static Methods - -QAction can access all the static methods defined in [EventWidget](api/EventWidget.md) - -## Instance Properties - -QAction can access all the instance properties defined in [EventWidget](api/EventWidget.md) - -## Instance Methods - -QAction can access all the instance methods defined in [EventWidget](api/EventWidget.md). Additionally it also has the following instance methods: - -### `action.setEnabled(enabled)` - -This property holds whether the action is enabled. It calls the native method [QAction: setEnabled](https://doc.qt.io/qt-5/qaction.html#enabled-prop). - -- `enabled` - Boolean - -### `action.setText(on)` - -This property holds the action's descriptive text. It calls the native method [QAction: setText](https://doc.qt.io/qt-5/qaction.html#text-prop). - -- `text` - string - -### `action.setIcon(icon)` - -Sets the icon of action. It calls the native method [QAction: setIcon](https://doc.qt.io/qt-5/qaction.html#icon-prop). - -- `icon` [QIcon](api/QIcon.md) - -### `action.setMenu(menu)` - -Sets the menu contained by this action to the specified menu. It calls the native method [QAction: setMenu](https://doc.qt.io/qt-5/qaction.html#setMenu). - -- `menu` [QMenu](api/QMenu.md) - -### `action.setShortcut(keySequence)` - -This property holds the action's key sequence. It calls the native method [QAction: setShortcut](https://doc.qt.io/qt-5/qaction.html#shortcut-prop). - -- `keySequence` [QKeySequence](api/QKeySequence.md) - -### `action.setShortcutContext(contextEnum)` - -This property holds the context in which the action is valid. It calls the native method [QAction: setShortcutContext](https://doc.qt.io/qt-5/qaction.html#shortcutContext-prop). - -- `contextEnum` - ShortcutContext enum. - -### `action.isCheckable()` - -Returns true if this action has been marked as checkable. It calls the native method [QAction: isCheckable](https://doc.qt.io/qt-5/qaction.html#checkable-prop). - -### `action.setCheckable(isCheckable)` - -Indicate that this action is checkable. - -A checkable action is one which has an on/off state. For example, in a word processor, a Bold toolbar button may be either on or off. An action which is not a toggle action is a command action; a command action is simply executed, e.g. file save. By default, this property is `false`. - - -It calls the native method [QAction: setCheckable](https://doc.qt.io/qt-5/qaction.html#checkable-prop). - -- `isCheckable`: boolean - -### `action.isChecked()` - -Returns true if this action has been marked as checked. It calls the native method [QAction: isChecked](https://doc.qt.io/qt-5/qaction.html#checked-prop). - -### `action.setChecked(isChecked)` - -Indicate that this action is checked. - -Only checkable actions can be checked. By default, this is false (the action is unchecked). - -It calls the native method [QAction: setChecked](https://doc.qt.io/qt-5/qaction.html#checkable-prop). - -- `isChecked`: boolean - -### `action.isSeparator()` - -Returns `true` if this action is a separator action; otherwise it returns `false`. It calls the native method [QAction: isSeparator](https://doc.qt.io/qt-5/qaction.html#isSeparator). - -### `action.setSeparator(isSeparator)` - -If `isSeparator` is `true` then this action will be considered a separator. - -How a separator is represented depends on the widget it is inserted into. Under most circumstances the text, submenu, and icon will be ignored for separator actions. - -It calls the native method [QAction: setSeparator](https://doc.qt.io/qt-5/qaction.html#setSeparator). - -- `isSeparator`: boolean diff --git a/website/docs/api/QApplication.md b/website/docs/api/QApplication.md deleted file mode 100644 index d79c76c9e..000000000 --- a/website/docs/api/QApplication.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_label: QApplication -title: QApplication ---- - -> QApplication is the root object for the entire application. It manages app level settings. - -**This class is a JS wrapper around Qt's [QApplication class](https://doc.qt.io/qt-5/qapplication.html)** - -The QApplication class manages the GUI application's control flow and main settings. In NodeGui you will never create an instance of it manually. NodeGui's internal runtime `Qode` does it for you on app start. You can access the initialised QApplication though if needed. - -**QApplication inherits from [Component](api/Component.md)** - -### Example - -```js -const { QApplication } = require("@nodegui/nodegui"); - -const qApp = QApplication.instance(); -qApp.quit(); -``` - -## Static Methods - -QApplication can access all the static methods defined in [Component](api/Component.md). Additionally it also has the following static methods. - -### `QApplication.instance()` - -Returns the already initialised QApplication instance. It calls the native method [QApplication: instance](https://doc.qt.io/qt-5/qcoreapplication.html#instance). - -### `QApplication.clipboard()` - -Returns the object for interacting with the clipboard. It calls the native method [QApplication: clipboard](https://doc.qt.io/qt-5/qguiapplication.html#clipboard). See QClipboard. - -## Instance Properties - -QApplication can access all the instance properties defined in [Component](api/Component.md) - -## Instance Methods - -QApplication can access all the instance methods defined in [Component](api/Component.md). Additionally it also has the following instance methods: - -### `qApp.quit()` - -Quits the entire app. It calls the native method [QApplication: quit](https://doc.qt.io/qt-5/qcoreapplication.html#quit). - -### `qApp.exit(returnCode)` - -Tells the application to exit with a return code. It calls the native method [QApplication: exit](https://doc.qt.io/qt-5/qcoreapplication.html#exit). - -- `returnCode` number - The exit code while quitting the app. - -### `qApp.processEvents()` - -Processes all pending events for the calling thread . It calls the native method [QApplication: processEvents](https://doc.qt.io/qt-5/qcoreapplication.html#processEvents). - -### `qApp.exec()` - -> We will never call this method in NodeGui, since Qode will execute this function for us. It exists for experiments only. - -Enters the main event loop and waits until exit() is called. Returns the value that was passed to exit() (which is 0 if exit() is called via quit()). It calls the native method [QApplication: exec](https://doc.qt.io/qt-5/qcoreapplication.html#exec). - -Returns the exit code after app exits. diff --git a/website/docs/api/QCheckBox.md b/website/docs/api/QCheckBox.md deleted file mode 100644 index 488a1a5a2..000000000 --- a/website/docs/api/QCheckBox.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_label: QCheckBox -title: QCheckBox ---- - -> Create and control checkbox. - -**This class is a JS wrapper around Qt's [QCheckBox class](https://doc.qt.io/qt-5/qcheckbox.html)** - -A `QCheckBox` provides ability to add and manipulate native checkbox widgets. - -**QCheckBox inherits from [NodeWidget](api/NodeWidget.md)** - -### Example - -```javascript -const { QCheckBox } = require("@nodegui/nodegui"); - -const checkbox = new QCheckBox(); -checkbox.setText("Hello"); -``` - -### `new QCheckBox(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QCheckBox can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QCheckBox can access all the instance properties defined in [NodeWidget](api/NodeWidget.md) - -## Instance Methods - -QCheckBox can access all the instance methods defined in [NodeWidget](api/NodeWidget.md) - -Additionally it also has the following instance methods: - -### `checkbox.setText(text)` - -Sets the given text to the checkbox. - -- `text` string - -### `checkbox.isChecked()` - -returns whether the checkbox is checked or not. It calls the native method [QAbstractButton: isChecked](https://doc.qt.io/qt-5/qabstractbutton.html#checked-prop). - -### `checkbox.setChecked(check)` - -This property holds whether the button is checked. It calls the native method [QAbstractButton: setChecked](https://doc.qt.io/qt-5/qabstractbutton.html#checked-prop). - -- `check` boolean diff --git a/website/docs/api/QClipboard.md b/website/docs/api/QClipboard.md deleted file mode 100644 index 863f4538d..000000000 --- a/website/docs/api/QClipboard.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_label: QClipboard -title: QClipboard ---- - -> The QClipboard class provides access to the window system clipboard. - -**This class is a JS wrapper around Qt's [QClipboard class](https://doc.qt.io/qt-5/QClipboard.html)** - -**QClipboard inherits from [Component](api/Component.md)** - -### Example - -```javascript -const { - QClipboard, - QClipboardMode, - QApplication -} = require("@nodegui/nodegui"); - -const clipboard = QApplication.clipboard(); -const text = clipboard.text(QClipboardMode.Clipboard); -``` - -## Static Methods - -QClipboard can access all the static methods defined in [Component](api/Component.md) - -## Instance Properties - -QClipboard can access all the instance properties defined in [Component](api/Component.md) - -## Instance Methods - -QClipboard can access all the instance methods defined in [Component](api/Component.md). Additionally it has: - -### `clipboard.clear(mode)` - -Clear the clipboard contents. It calls the native method [QClipboard: clear](https://doc.qt.io/qt-5/qclipboard.html#clear). - -- `mode` - This enum type is used to control which part of the system clipboard is used. See https://doc.qt.io/qt-5/qclipboard.html#Mode-enum - -### `clipboard.setText(text, mode)` - -Copies text into the clipboard as plain text. It calls the native method [QClipboard: setText](https://doc.qt.io/qt-5/qclipboard.html#setText). - -- `text` - The text you want to copy to clipboard. - -- `mode` - This enum type is used to control which part of the system clipboard is used. See https://doc.qt.io/qt-5/qclipboard.html#Mode-enum - -### `clipboard.text(mode)` - -Returns the clipboard text as plain text, or an empty string if the clipboard does not contain any text. It calls the native method [QClipboard: text](https://doc.qt.io/qt-5/qclipboard.html#text). - -- `mode` - This enum type is used to control which part of the system clipboard is used. See https://doc.qt.io/qt-5/qclipboard.html#Mode-enum diff --git a/website/docs/api/QCursor.md b/website/docs/api/QCursor.md deleted file mode 100644 index ff247ad39..000000000 --- a/website/docs/api/QCursor.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -sidebar_label: QCursor -title: QCursor ---- - -> The QCursor class provides scalable icons in different modes and states. - -**This class is a JS wrapper around Qt's [QCursor class](https://doc.qt.io/qt-5/qcursor.html)** - -### Example - -```javascript -const { QCursor } = require("@nodegui/nodegui"); - -const cursor = new QCursor(); -``` - -### `new QCursor(cursor)` - -- `cursor` CursorShape (_optional_). Defines shape for the cursor. [CursorShape is an enum from Qt](api/QtEnums.md) diff --git a/website/docs/api/QDial.md b/website/docs/api/QDial.md deleted file mode 100644 index 018529c74..000000000 --- a/website/docs/api/QDial.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_label: QDial -title: QDial ---- - -> Create and control dial slider widgets. - -**This class is a JS wrapper around Qt's [QDial class](https://doc.qt.io/qt-5/qdial.html)** - -A `QDial` provides ability to add and manipulate native dial slider widgets. - -**QDial inherits from [QAbstractSlider](api/QAbstractSlider.md)** - -### Example - -```javascript -const { QDial } = require("@nodegui/nodegui"); - -const dial = new QDial(); -``` - -### `new QDial(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QDial can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QDial can access all the instance properties defined in [NodeWidget](api/NodeWidget.md) - -## Instance Methods - -QDial can access all the instance methods defined in [NodeWidget](api/NodeWidget.md). Additionally it also has the following instance methods: - -### `dial.setNotchesVisible(visible)` - -Sets the visibility of notches drawn around the dial. It calls the native method [QDial: setNotchesVisible](https://doc.qt.io/qt-5/qdial.html#notchTarget-prop). - -- `visible` boolean - Set the value as current notch visibility. - -### `dial.setWrapping(on)` - -Sets the ability to wrap arrow around the dial instead of limiting it to upper part of the dial. It calls the native method [QDial: setWrapping](https://doc.qt.io/qt-5/qdial.html#wrapping-prop). - -- `on` boolean - Set the value as current wrapping setting. - -### `dial.setNotchTarget(target)` - -Sets the number of pixels between dial notches. It calls the native method [QDial: setNotchTarget](https://doc.qt.io/qt-5/qdial.html#notchTarget-prop). - -- `target` number - Specifies number of pixels between notches. - -### `dial.notchTarget()` - -Returns the current number of pixels between dial notches. It calls the native method [QDial: notchTarget](https://doc.qt.io/qt-5/qdial.html#notchTarget-prop). - -### `dial.notchesVisible()` - -Returns the visibility status (Boolean) of dial notches. It calls the native method [QDial: notchesVisible](https://doc.qt.io/qt-5/qdial.html#notchesVisible-prop). - -### `dial.notchesVisible()` - -Returns the visibility status (Boolean) of dial notches. It calls the native method [QDial: notchesVisible](https://doc.qt.io/qt-5/qdial.html#notchesVisible-prop). - -### `dial.wrapping()` - -Returns the current wrapping (Boolean) state of the dial. It calls the native method [QDial: wrapping](https://doc.qt.io/qt-5/qdial.html#wrapping-prop). diff --git a/website/docs/api/QGridLayout.md b/website/docs/api/QGridLayout.md deleted file mode 100644 index 6dc3b7f8c..000000000 --- a/website/docs/api/QGridLayout.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_label: QGridLayout -title: QGridLayout ---- - -> The QGridLayout class lays out widgets in a grid. - -**This class is a JS wrapper around Qt's [QGridLayout](https://doc.qt.io/qt-5/qgridlayout.html)** - -**QGridLayout inherits from [NodeLayout](api/NodeLayout.md)** - -### Example - -```javascript -const { QGridLayout, QWidget, QLabel } = require("@nodegui/nodegui"); - -const view = new QWidget(); -const layout = new QGridLayout(); -view.setLayout(layout); - -const label = new QLabel(); -label.setText("label1"); -const label2 = new QLabel(); -label2.setText("label2"); - -layout.addWidget(label); -layout.addWidget(label2); -``` - -## Static Methods - -QGridLayout can access all the static methods defined in [NodeLayout](api/NodeLayout.md) - -## Instance Properties - -QGridLayout can access all the instance properties defined in [NodeLayout](api/NodeLayout.md) - -## Instance Methods - -QGridLayout can access all the instance methods defined in [NodeLayout](api/NodeLayout.md) - -Additionally it also has the following instance methods: - -### `layout.addWidget(childWidget)` - -Adds the childWidget to the layout. It calls the native method QGridLayout [QGridLayout: addWidget](https://doc.qt.io/qt-5/qwidget.html#show). - -- `childWidget` NodeWidget - child widget that needs to be added to the layout. - -### `layout.removeWidget(childWidget)` - -Removes the childWidget from the layout. It calls the native method of custom QGridLayout. [QGridLayout: removeWidget](https://doc.qt.io/qt-5/qlayout.html#removeWidget). - -- `childWidget` NodeWidget - child widget that needs to be added to the layout. diff --git a/website/docs/api/QIcon.md b/website/docs/api/QIcon.md deleted file mode 100644 index ab21611c9..000000000 --- a/website/docs/api/QIcon.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_label: QIcon -title: QIcon ---- - -> The QIcon class provides scalable icons in different modes and states. - -**This class is a JS wrapper around Qt's [QIcon class](https://doc.qt.io/qt-5/qicon.html)** - -**QIcon inherits from [Component](api/Component.md)** - -### Example - -```javascript -const { QIcon } = require("@nodegui/nodegui"); - -const imageUrl = "path/to/png"; -const icon = new QIcon(imageUrl); -``` - -### `new QIcon(imageUrl?)` - -- `imageUrl` string (_optional_). Absolute path of the image that needs to be loaded in the memory. - -## Static Methods - -QIcon can access all the static methods defined in [Component](api/Component.md) - -## Instance Properties - -QIcon can access all the instance properties defined in [Component](api/Component.md) - -## Instance Methods - -QIcon can access all the instance methods defined in [Component](api/Component.md) -Additionally it also has the following instance methods: - -### `icon.pixmap(width, height, mode?, state?)` (v0.1.10 & up) - -Returns a pixmap with the requested size, mode, and state, generating one if necessary. The pixmap might be smaller than requested, but never larger. -. It calls the native method [QIcon: pixmap](https://doc.qt.io/qt-5/qicon.html#pixmap-3). - -- `width`: number, -- `height`: number -- `mode?`: QIconMode -- `state?`: QIconState - -### `icon.isMask()` - -Returns true if this icon has been marked as a mask image. It calls the native method [QIcon: isMask](https://doc.qt.io/qt-5/qicon.html#isMask). - -### `icon.setIsMask(isMask)` - -Indicate that this icon is a mask image, and hence can potentially be modified based on where it's displayed. It calls the native method [QIcon: setIsMask](https://doc.qt.io/qt-5/qicon.html#setIsMask). - -- `isMask`: boolean diff --git a/website/docs/api/QKeySequence.md b/website/docs/api/QKeySequence.md deleted file mode 100644 index d73f5c29b..000000000 --- a/website/docs/api/QKeySequence.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_label: QKeySequence -title: QKeySequence ---- - -> The QKeySequence class encapsulates a key sequence as used by shortcuts. . - -**This class is a JS wrapper around Qt's [QKeySequence class](https://doc.qt.io/qt-5/qkeysequence.html)** - -**QKeySequence inherits from [Component](api/Component.md)** - -### Example - -```javascript -const { QKeySequence } = require("@nodegui/nodegui"); - -const keySequence = new QKeySequence(`Ctrl+L`); -``` - -### `new QKeySequence(sequence?)` - -- `sequence` string (_optional_). String representation of the key sequence. For example: `Ctrl+M` - -## Static Methods - -QKeySequence can access all the static methods defined in [Component](api/Component.md) - -## Instance Properties - -QKeySequence can access all the instance properties defined in [Component](api/Component.md) - -## Instance Methods - -QKeySequence can access all the instance methods defined in [Component](api/Component.md) -Additionally it also has the following instance methods: - -### `keySequence.count()` - -Returns the number of keys in the key sequence. The maximum is 4. It calls the native method [QKeySequence: count](https://doc.qt.io/qt-5/QKeySequence.html#count). diff --git a/website/docs/api/QLabel.md b/website/docs/api/QLabel.md deleted file mode 100644 index 892d958e2..000000000 --- a/website/docs/api/QLabel.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_label: QLabel -title: QLabel ---- - -> Create and control text. - -**This class is a JS wrapper around Qt's [QLabel class](https://doc.qt.io/qt-5/qlabel.html)** - -A `QLabel` provides ability to add and manipulate text. - -**QLabel inherits from [NodeWidget](api/NodeWidget.md)** - -### Example - -```javascript -const { QLabel } = require("@nodegui/nodegui"); - -const label = new QLabel(); -label.setText("Hello"); -``` - -### `new QLabel(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QLabel can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QLabel can access all the instance properties defined in [NodeWidget](api/NodeWidget.md). Additionally it also has the following instance properties: - -### `label.pixmap` - -The pixmap currently set on this label. - -### `label.text` - -the current text set on the label. - -## Instance Methods - -QLabel can access all the instance methods defined in [NodeWidget](api/NodeWidget.md). Additionally it also has the following instance methods: - -### `label.setText(text)` - -Sets the given text to the label. - -- `text` string - -### `label.setWordWrap(on)` - -- `on` boolean - If true it sets wordwrap on the label - -### `label.setPixmap(pixMap)` - -Images in the form of a pixmap can be set as the label content - -- `pixMap` [QPixmap](api/QPixmap.md) - Allows to set image content in the form of a QPixmap on the label diff --git a/website/docs/api/QLineEdit.md b/website/docs/api/QLineEdit.md deleted file mode 100644 index ed440099a..000000000 --- a/website/docs/api/QLineEdit.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_label: QLineEdit -title: QLineEdit ---- - -> Create and control editable text field. - -**This class is a JS wrapper around Qt's [QLineEdit class](https://doc.qt.io/qt-5/qlineedit.html)** - -A `QLineEdit` provides ability to add and manipulate native editable text field widgets. - -**QLineEdit inherits from [NodeWidget](api/NodeWidget.md)** - -### Example - -```javascript -const { QLineEdit } = require("@nodegui/nodegui"); - -const lineEdit = new QLineEdit(); -``` - -### `new QLineEdit(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QLineEdit can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QLineEdit can access all the instance properties defined in [NodeWidget](api/NodeWidget.md). Additionally it also has the following instance properties: - -### `lineEdit.placeholderText` - -The placeholder text set on the lineEdit. - -## Instance Methods - -QLineEdit can access all the instance methods defined in [NodeWidget](api/NodeWidget.md). Additionally it also has the following instance methods: - -### `lineEdit.setText(text)` - -Sets the given text to the lineEdit. - -- `text` string - -### `lineEdit.setPlaceholderText(text)` - -Sets the given text to the lineEdit's placeholder. - -- `text` string - -### `lineEdit.text()` - -Returns the currently set text from native lineEdit widget. - -### `lineEdit.setReadOnly(isReadOnly)` - -Sets the lineEdit to be read only. lineEdit property holds whether the line edit is read only. - -- `isReadOnly` boolean - -### `lineEdit.setEchoMode(echoMode)` - -Sets the property that determines how the text entered in the line edit is displayed (or echoed) to the user. - -The widget's display and the ability to copy or drag the text is affected by this setting. - -- `echoMode` EchoMode - -### `lineEdit.clear()` - -Clears the lineEdit. diff --git a/website/docs/api/QMainWindow.md b/website/docs/api/QMainWindow.md deleted file mode 100644 index 3dda05df5..000000000 --- a/website/docs/api/QMainWindow.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_label: QMainWindow -title: QMainWindow ---- - -> Create and control windows. - -**This class is a JS wrapper around Qt's [QMainWindow class](https://doc.qt.io/qt-5/qmainwindow.html)** - -A `QMainWindow` provides a main application window. Every widget in NodeGui should be a child/nested child of QMainWindow. QMainWindow in NodeGui is also responsible for FlexLayout calculations of its children. - -**QMainWindow inherits from [NodeWidget](api/NodeWidget.md)** - -### Example - -```javascript -const { QMainWindow, QWidget } = require("@nodegui/nodegui"); - -const win = new QMainWindow(); - -const centralWidget = new QWidget(); -win.setCentralWidget(centralWidget); - -win.show(); - -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. - -## Static Methods - -QMainWindow can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QMainWindow can access all the instance properties defined in [NodeWidget](api/NodeWidget.md) - -Additionally it also has the following instance properties: - -### `win.layout` - -A `NodeLayout` representing current layout that is set on the window. If a centralWidget is set then the layout of central widget is returned. - -### `win.centralWidget` - -A `NodeWidget` representing currently set central widget on the window. - -## Instance Methods - -QMainWindow can access all the instance methods defined in [NodeWidget](api/NodeWidget.md) - -Additionally it also has the following instance methods: - -### `win.setCentralWidget(widget)` - -Sets the given widget to be the main window's central widget. - -- `widget` NodeWidget - Any widget that inherits from NodeWidget class. - -### `win.setMenuBar(menuBar)` - -Sets the given menuBar to be the window's menubar widget. - -- `menuBar` [QMenuBar](api/QMenuBar) - -### `win.setMenuWidget(menuWidget)` - -Sets the given widget to be the window's menubar widget. - -- `menuWidget` NodeWidget diff --git a/website/docs/api/QMenu.md b/website/docs/api/QMenu.md deleted file mode 100644 index c7c51bc01..000000000 --- a/website/docs/api/QMenu.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_label: QMenu -title: QMenu ---- - -> The QMenu class provides a menu widget for use in menu bars, context menus, and other popup menus. - -**This class is a JS wrapper around Qt's [QMenu class](https://doc.qt.io/qt-5/qmenu.html)** - -**QMenu inherits from [NodeWidget](api/NodeWidget.md)** - -### Example - -```javascript -const { QMenu } = require("@nodegui/nodegui"); - -const menu = new QMenu(); -``` - -### `new QMenu(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QMenu can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QMenu can access all the instance properties defined in [NodeWidget](api/NodeWidget.md) - -## Instance Methods - -QMenu can access all the instance methods defined in [NodeWidget](api/NodeWidget.md). Additionally it also has the following instance methods: - -### `menu.setTitle(title)` - -This property holds the title of the menu. It calls the native method [QMenu: setTitle](https://doc.qt.io/qt-5/qmenu.html#title-prop). - -- `title` string - -### `menu.addAction(action)` - -Appends the action action to this widget's list of actions. It calls the native method [QMenu: addAction](https://doc.qt.io/qt-5/qwidget.html#addAction). - -- `action` [QAction](api/QAction). diff --git a/website/docs/api/QMenuBar.md b/website/docs/api/QMenuBar.md deleted file mode 100644 index b5b64bbd9..000000000 --- a/website/docs/api/QMenuBar.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_label: QMenuBar -title: QMenuBar ---- - -> The QMenuBar class provides a menu widget for use in menu bars, context menus, and other popup menus. - -**This class is a JS wrapper around Qt's [QMenuBar class](https://doc.qt.io/qt-5/qmenu.html)** - -**QMenuBar inherits from [NodeWidget](api/NodeWidget.md)** - -### Example - -```javascript -const { QMenuBar, QMainWindow } = require("@nodegui/nodegui"); -const win = new QMainWindow(); -const menu = new QMenuBar(); -const menuBar = new QMenuBar(); -win.setMenuBar(menuBar); -win.show(); -global.win = win; -``` - -### `new QMenuBar(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QMenuBar can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QMenuBar can access all the instance properties defined in [NodeWidget](api/NodeWidget.md) - -## Instance Methods - -QMenuBar can access all the instance methods defined in [NodeWidget](api/NodeWidget.md). Additionally it also has the following instance methods: - -### `menu.addMenu(menu)` - -Appends menu to the menu bar. It calls the native method [QMenuBar: addMenu](https://doc.qt.io/qt-5/qmenubar.html#addMenu). - -- `menu` [QMenu](api/QMenu). - -### `menu.setNativeMenuBar(nativeMenuBar)` - -This property holds whether or not a menubar will be used as a native menubar on platforms that support it. It calls the native method [QMenuBar: setNativeMenuBar](https://doc.qt.io/qt-5/qmenubar.html#nativeMenuBar-prop). - -- `nativeMenuBar` Boolean. diff --git a/website/docs/api/QPixmap.md b/website/docs/api/QPixmap.md deleted file mode 100644 index 2760f962c..000000000 --- a/website/docs/api/QPixmap.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_label: QPixmap -title: QPixmap ---- - -> The QPixmap class helps hold an image in the form of off-screen image representation. - -**This class is a JS wrapper around Qt's [QPixmap class](https://doc.qt.io/qt-5/qpixmap.html)** - -A `QPixmap` provides ability to store an image in the memory. - -**QPixmap inherits from [Component](api/Component.md)** - -### Example - -```javascript -const { QPixmap } = require("@nodegui/nodegui"); - -const imageUrl = "path/to/png"; -const pixMap = new QPixmap(imageUrl); -``` - -### `new QPixmap(imageUrl?)` - -- `imageUrl` string (_optional_). Absolute path of the image that needs to be loaded in the memory. - -## Static Methods - -QPixmap can access all the static methods defined in [Component](api/Component.md) - -## Instance Properties - -QPixmap can access all the instance properties defined in [Component](api/Component.md) - -## Instance Methods - -QPixmap can access all the instance methods defined in [Component](api/Component.md) - -Additionally it also has the following instance methods: - -### `pixMap.load(imageUrl)` - -loads an image from the url into memory as a Pixmap. -returns true if load was successful otherwise returns false. - -- `imageUrl` string (_optional_). Absolute path of the image that needs to be loaded in the memory. - -#### `pixMap.save(fileName, format)` - -Saves the pixmap to the file with the given fileName using the specified image file format and quality factor. Returns `true` if successful; otherwise returns false. - -If format is 0, an image format will be chosen from fileName's suffix. - -See also [Reading and Writing Image Files.](https://doc.qt.io/qt-5/qpixmap.html#reading-and-writing-image-files). - -- `fileName` string. -- `format` string. (_optional_). - -#### `pixMap.scaled(width, height, aspectRatioMode?)` - -Scales the pixmap to provided height and width with respect to aspectRatioMode. -This method doesnt mutate this pixmap and rather returns a new pixmap with new height and width. - -- `width` number. Width in pixels for new pixmap. -- `height` number. Height in pixels for new pixmap. -- `aspectRatioMode` AspectRatioMode (_optional_). Specifies how scaling should happen. [AspectRatio is an enum from Qt](api/QtEnums.md) diff --git a/website/docs/api/QPlainTextEdit.md b/website/docs/api/QPlainTextEdit.md deleted file mode 100644 index 997e15700..000000000 --- a/website/docs/api/QPlainTextEdit.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_label: QPlainTextEdit -title: QPlainTextEdit ---- - -> Used to edit and display plain text. - -**This class is a JS wrapper around Qt's [QPlainTextEdit class](https://doc.qt.io/qt-5/qplaintextedit.html)** - -A `QPlainTextEdit` provides ability to add and manipulate native editable text field widgets. - -**QPlainTextEdit inherits from [NodeWidget](api/NodeWidget.md)** - -### Example - -```javascript -const { QPlainTextEdit } = require("@nodegui/nodegui"); - -const plainTextEdit = new QPlainTextEdit(); -``` - -### `new QPlainTextEdit(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QPlainTextEdit can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QPlainTextEdit can access all the instance properties defined in [NodeWidget](api/NodeWidget.md). - -### `plainTextEdit.placeholderText` - -The placeholder text set on the plainTextEdit. - -## Instance Methods - -QPlainTextEdit can access all the instance methods defined in [NodeWidget](api/NodeWidget.md). - -### `plainTextEdit.setPlainText(text)` - -Sets the given text to the plainTextEdit. It calls the native method [QPlainTextEdit: setPlainText](https://doc.qt.io/qt-5/qplaintextedit.html#setPlainText). - -- `text` string - -### `plainTextEdit.setPlaceholderText(text)` - -Sets the given text to the plainTextEdit's placeholder. - -- `text` string - -### `plainTextEdit.toPlainText()` - -Returns the text of the text edit as plain text. [QPlainTextEdit: toPlainText](https://doc.qt.io/qt-5/qplaintextedit.html#toPlainText). - -### `plainTextEdit.setReadOnly(isReadOnly)` - -Sets the plainTextEdit to be read only. [QPlainTextEdit: isReadOnly](https://doc.qt.io/qt-5/qplaintextedit.html#readOnly-prop). - -### `plainTextEdit.clear()` - -Deletes all the text in the text edit.[QPlainTextEdit: clear](https://doc.qt.io/qt-5/qplaintextedit.html#clear). - -### `plainTextEdit.setWordWrapMode(mode)` - -This property holds the mode QPlainTextEdit will use when wrapping text by words.[QPlainTextEdit: setWordWrapMode](https://doc.qt.io/qt-5/qplaintextedit.html#wordWrapMode-prop). - -- mode: QTextOptionWrapMode - -### `plainTextEdit.wordWrapMode()` - -returns word wrap mode. [QPlainTextEdit: wordWrapMode](https://doc.qt.io/qt-5/qplaintextedit.html#wordWrapMode-prop). - -### `plainTextEdit.setLineWrapMode(mode)` - -This property holds the line wrap mode. [QPlainTextEdit: setLineWrapMode](https://doc.qt.io/qt-5/qplaintextedit.html#lineWrapMode-prop). - -- mode: LineWrapMode - -### `plainTextEdit.lineWrapMode()` - -returns line wrap mode. [QPlainTextEdit: setLineWrapMode](https://doc.qt.io/qt-5/qplaintextedit.html#lineWrapMode-prop). diff --git a/website/docs/api/QProgressBar.md b/website/docs/api/QProgressBar.md deleted file mode 100644 index 36244e6d1..000000000 --- a/website/docs/api/QProgressBar.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_label: QProgressBar -title: QProgressBar ---- - -> Create and control progress bar widgets. - -**This class is a JS wrapper around Qt's [QProgressBar class](https://doc.qt.io/qt-5/qprogressbar.html)** - -A `QProgressBar` provides ability to add and manipulate native progress bar widgets. - -**QProgressBar inherits from [NodeWidget](api/NodeWidget.md)** - -### Example - -```javascript -const { QProgressBar } = require("@nodegui/nodegui"); - -const progressBar = new QProgressBar(); -``` - -### `new QProgressBar(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QProgressBar can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QProgressBar can access all the instance properties defined in [NodeWidget](api/NodeWidget.md) - -## Instance Methods - -QProgressBar can access all the instance methods defined in [NodeWidget](api/NodeWidget.md). Additionally it also has the following instance methods: - -### `progressBar.setValue(value)` - -Sets the current value of the progressBar. It calls the native method [QProgressBar: setValue](https://doc.qt.io/qt-5/qprogressbar.html#value-prop). - -- `value` number - Set the value as current value - -### `progressBar.setMaximum(max)` - -Sets the max value of the progressBar. It calls the native method [QProgressBar: setMaximum](https://doc.qt.io/qt-5/qprogressbar.html#maximum-prop). - -- `max` number - Set the value as max value of the progress bar. - -### `progressBar.setMinimum(min)` - -Sets the min value of the progressBar. It calls the native method [QProgressBar: setMinimum](https://doc.qt.io/qt-5/qprogressbar.html#minimum-prop). - -- `min` number - Set the value as min value of the progress bar. - -### `progressBar.setOrientation(orientation)` - -Sets the orientation of the progressBar. It calls the native method [QProgressBar: setOrientation](https://doc.qt.io/qt-5/qprogressbar.html#orientation-prop). - -- `orientation` Orientation - Specifies visual orientation of the progress bar. [Orientation is an enum from Qt](api/QtEnums.md) - -### `progressBar.value()` - -Returns the current value (Number) of the progressBar. It calls the native method [QProgressBar: value](https://doc.qt.io/qt-5/qprogressbar.html#value-prop). diff --git a/website/docs/api/QPushButton.md b/website/docs/api/QPushButton.md deleted file mode 100644 index e39159fda..000000000 --- a/website/docs/api/QPushButton.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_label: QPushButton -title: QPushButton ---- - -> Create and control buttons. - -**This class is a JS wrapper around Qt's [QPushButton class](https://doc.qt.io/qt-5/qpushbutton.html)** - -A `QPushButton` provides ability to add and manipulate native button widgets. - -**QPushButton inherits from [NodeWidget](api/NodeWidget.md)** - -### Example - -```javascript -const { QPushButton } = require("@nodegui/nodegui"); - -const button = new QPushButton(); -button.setText("Hello"); -``` - -### `new QPushButton(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QPushButton can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QPushButton can access all the instance properties defined in [NodeWidget](api/NodeWidget.md) - -## Instance Methods - -QPushButton can access all the instance methods defined in [NodeWidget](api/NodeWidget.md) - -Additionally it also has the following instance methods: - -### `button.setText(text)` - -Sets the given text to the button. - -- `text` string - -### `button.setFlat(isFlat)` - -Sets whether the button border is raised. - -- `isFlat` boolean - -### `button.setIcon(icon)` - -Sets an icon in the button. - -- `icon` QIcon diff --git a/website/docs/api/QRadioButton.md b/website/docs/api/QRadioButton.md deleted file mode 100644 index 42153393f..000000000 --- a/website/docs/api/QRadioButton.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_label: QRadioButton -title: QRadioButton ---- - -> Create and control radio button. - -**This class is a JS wrapper around Qt's [QRadioButton class](https://doc.qt.io/qt-5/qradiobutton.html)** - -A `QRadioButton` provides ability to add and manipulate native radio button widgets. - -**QRadioButton inherits from [NodeWidget](api/NodeWidget.md)** - -### Example - -```javascript -const { QRadioButton } = require("@nodegui/nodegui"); - -const radioButton = new QRadioButton(); -radioButton.setText("Hello"); -``` - -### `new QRadioButton(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QRadioButton can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QRadioButton can access all the instance properties defined in [NodeWidget](api/NodeWidget.md) - -## Instance Methods - -QRadioButton can access all the instance methods defined in [NodeWidget](api/NodeWidget.md) - -Additionally it also has the following instance methods: - -### `radioButton.setText(text)` - -Sets the given text to the radioButton. - -- `text` string diff --git a/website/docs/api/QScrollArea.md b/website/docs/api/QScrollArea.md deleted file mode 100644 index 1e5036833..000000000 --- a/website/docs/api/QScrollArea.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_label: QScrollArea -title: QScrollArea ---- - -> A `QScrollArea` provides a scrolling view onto another widget. - -**This class is a JS wrapper around Qt's [QScrollArea class](https://doc.qt.io/qt-5/qscrollarea.html)** - -**QScrollArea inherits from [QAbstractScrollArea](api/QAbstractScrollArea.md)** - -### Example - -```javascript -const { QScrollArea } = require("@nodegui/nodegui"); - -const scrollArea = new QScrollArea(); -scrollArea.setInlineStyle("flex: 1; width:'100%';"); - -const imageLabel = new QLabel(); -const pixmap = new QPixmap( - path.resolve(__dirname, "../extras/assets/kitchen.png") -); -imageLabel.setPixmap(pixmap); - -scrollArea.setWidget(imageLabel); -``` - -### `new QScrollArea(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QScrollArea can access all the static methods defined in [QAbstractScrollArea](api/QAbstractScrollArea.md) - -## Instance Properties - -QScrollArea can access all the instance properties defined in [QAbstractScrollArea](api/QAbstractScrollArea.md) - -## Instance Methods - -QScrollArea can access all the instance methods defined in [QAbstractScrollArea](api/QAbstractScrollArea.md). Additionally it also has the following instance methods: - -### `scrollArea.setWidget(widget)` - -Sets the scroll area's widget. It calls the native method [QScrollArea: setWidget](https://doc.qt.io/qt-5/qscrollarea.html#setWidget). - -- `widget` NodeWidget - Any widget you want to enclose in a scroll area. diff --git a/website/docs/api/QShortcut.md b/website/docs/api/QShortcut.md deleted file mode 100644 index c902b5dfc..000000000 --- a/website/docs/api/QShortcut.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_label: QShortcut -title: QShortcut ---- - -> The QShortcut class is used to create keyboard shortcuts. - -**This class is a JS wrapper around Qt's [QShortcut class](https://doc.qt.io/qt-5/qshortcut.html)** - -**QShortcut inherits from [EventWidget](api/EventWidget.md)** - -### Example - -```javascript -const { QShortcut, QKeySequence, QMainWindow } = require("@nodegui/nodegui"); - -const win = new QMainWindow(); -const shortcut = new QShortcut(win); -shortcut.setKey(new QKeySequence("Ctrl+M")); -shortcut.setEnabled(true); -shortcut.addEventListener(QShortcutEvents.activated, () => { - console.log("Shortcut Activated"); -}); - -win.show(); -global.win = win; -global.shortcut = shortcut; -``` - -### `new QShortcut(parent)` - -- `parent` NodeWidget. Any widget inheriting from NodeWidget can be passed as a parent. This will make this shortcut bind to the parent widget. - -## Static Methods - -QShortcut can access all the static methods defined in [EventWidget](api/EventWidget.md) - -## Instance Properties - -QShortcut can access all the instance properties defined in [EventWidget](api/EventWidget.md) - -## Instance Methods - -QShortcut can access all the instance methods defined in [EventWidget](api/EventWidget.md). Additionally it also has the following instance methods: - -### `shortcut.setEnabled(enabled)` - -This property holds whether the shortcut is enabled. It calls the native method [QShortcut: setEnabled](https://doc.qt.io/qt-5/qshortcut.html#enabled-prop). - -- `enabled` - Boolean - -### `shortcut.setAutoRepeat(on)` - -This property holds whether the shortcut can auto repeat. It calls the native method [QShortcut: setAutoRepeat](https://doc.qt.io/qt-5/qshortcut.html#autoRepeat-prop). - -- `on` - Boolean - -### `shortcut.setKey(keySequence)` - -This property holds the shortcut's key sequence. It calls the native method [QShortcut: setKey](https://doc.qt.io/qt-5/qshortcut.html#key-prop). - -- `keySequence` [QKeySequence](api/QKeySequence.md) - -### `shortcut.setContext(contextEnum)` - -This property holds the context in which the shortcut is valid. It calls the native method [QShortcut: setContext](https://doc.qt.io/qt-5/qshortcut.html#context-prop). - -- `contextEnum` - ShortcutContext enum. diff --git a/website/docs/api/QSpinBox.md b/website/docs/api/QSpinBox.md deleted file mode 100644 index c908bde47..000000000 --- a/website/docs/api/QSpinBox.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -sidebar_label: QSpinBox -title: QSpinBox ---- - -> Create and control spin box widgets. - -**This class is a JS wrapper around Qt's [QSpinBox class](https://doc.qt.io/qt-5/qspinbox.html)** - -A `QSpinBox` provides ability to add and manipulate native spin box widgets. - -**QSpinBox inherits from [NodeWidget](api/NodeWidget.md)** - -### Example - -```javascript -const { QSpinBox } = require("@nodegui/nodegui"); - -const spinBox = new QSpinBox(); -``` - -### `new QSpinBox(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QSpinBox can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QSpinBox can access all the instance properties defined in [NodeWidget](api/NodeWidget.md) - -## Instance Methods - -QSpinBox can access all the instance methods defined in [NodeWidget](api/NodeWidget.md). Additionally it also has the following instance methods: - -### `spinBox.setValue(val)` - -Sets the current value of the spinBox. It calls the native method [QSpinBox: setValue](https://doc.qt.io/qt-5/qspinbox.html#value-prop). - -- `val` number - Set the value as current value - -### `spinBox.setRange(minimum, maximum)` - -Sets the min/max value of the spinBox. It calls the native method [QSpinBox: setRange](https://doc.qt.io/qt-5/qspinbox.html#setRange). - -- `max` number - Set the value as max value of the progress bar. - -### `spinBox.setPrefix(prefix)` - -Sets the prefix of the spinBox. It calls the native method [QSpinBox: setPrefix](https://doc.qt.io/qt-5/qspinbox.html#prefix-prop). - -- `prefix` string - Specifies prefix content shows before the spinBox value. [Prefix is an enum from Qt](api/QtEnums.md) - -### `spinBox.setSuffix(suffix)` - -Sets the suffix of the spinBox. It calls the native method [QSpinBox: setSuffix](https://doc.qt.io/qt-5/qspinbox.html#suffix-prop). - -- `suffix` string - Specifies suffix content shows after the spinBox value. [Suffix is an enum from Qt](api/QtEnums.md) - -### `spinBox.setSingleStep(val)` - -Sets the single step value of the spinBox. It calls the native method [QSpinBox: setSingleStep](https://doc.qt.io/qt-5/qspinbox.html#singleStep-prop). - -- `val` number - Specifies amount value changes with each step. [Suffix is an enum from Qt](api/QtEnums.md) - -### `spinBox.cleanText()` - -Returns the text content (String) of the spinBox excluding any prefix, suffix, or leading or trailing whitespace. It calls the native method [QSpinBox: value](https://doc.qt.io/qt-5/qspinbox.html#minimum-prop). - -### `spinBox.minimum()` - -Returns the minimum value (Number) of the spinBox. It calls the native method [QSpinBox: value](https://doc.qt.io/qt-5/qspinbox.html#minimum-prop). - -### `spinBox.maximum()` - -Returns the maximum value (Number) of the spinBox. It calls the native method [QSpinBox: value](https://doc.qt.io/qt-5/qspinbox.html#maximum-prop). - -### `spinBox.value()` - -Returns the current value (Number) of the spinBox. It calls the native method [QSpinBox: value](https://doc.qt.io/qt-5/qspinbox.html#value-prop). diff --git a/website/docs/api/QSystemTrayIcon.md b/website/docs/api/QSystemTrayIcon.md deleted file mode 100644 index a2c274f60..000000000 --- a/website/docs/api/QSystemTrayIcon.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_label: QSystemTrayIcon -title: QSystemTrayIcon ---- - -> Create and control system tray icon. - -**This class is a JS wrapper around Qt's [QSystemTrayIcon class](https://doc.qt.io/qt-5/qsystemtrayicon.html)** - -A `QSystemTrayIcon` provides ability to add and manipulate native system tray icon. - -**QSystemTrayIcon inherits from [EventWidget](api/EventWidget.md)** - -### Example - -```javascript -const { QSystemTrayIcon, QIcon } = require("@nodegui/nodegui"); -const trayIcon = new QIcon( - resolve(__dirname, "some/image/file.png"); -); -const tray = new QSystemTrayIcon(); -tray.show(); - -global.tray = tray; // prevents garbage collection of tray -``` - -### `new QSystemTrayIcon(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QSystemTrayIcon can access all the static methods defined in [EventWidget](api/EventWidget.md) - -## Instance Properties - -QSystemTrayIcon can access all the instance properties defined in [EventWidget](api/EventWidget.md) - -## Instance Methods - -QSystemTrayIcon can access all the instance methods defined in [EventWidget](api/EventWidget.md). Additionally it also has the following instance methods: - -### `trayIcon.show()` - -Shows the icon in the system tray icon. It calls the native method [QSystemTrayIcon: show](https://doc.qt.io/qt-5/qsystemtrayicon.html#show). - -### `trayIcon.hide()` - -Hides the system tray icon. It calls the native method [QSystemTrayIcon: hide](https://doc.qt.io/qt-5/qsystemtrayicon.html#hide). - -### `trayIcon.setIcon(icon)` - -Sets the icon of system tray. It calls the native method [QSystemTrayIcon: setIcon](https://doc.qt.io/qt-5/qsystemtrayicon.html#icon-prop). - -- `icon` [QIcon](api/QIcon.md) - -### `trayIcon.isVisible()` - -Returns the visibility of icon. It calls the native method [QSystemTrayIcon: setIcon](https://doc.qt.io/qt-5/qsystemtrayicon.html#visible-prop). - -### `trayIcon.setToolTip(toolTip)` - -Sets the tooltip of system tray. It calls the native method [QSystemTrayIcon: setToolTip](https://doc.qt.io/qt-5/qsystemtrayicon.html#toolTip-prop). - -- `toolTip` string. - -### `trayIcon.setContextMenu(contextMenu)` - -Sets the specified menu to be the context menu for the system tray icon. It calls the native method [QSystemTrayIcon: setIcon](https://doc.qt.io/qt-5/qsystemtrayicon.html#setContextMenu). - -- `contextMenu` [QMenu](api/QMenu.md) diff --git a/website/docs/api/QTabWidget.md b/website/docs/api/QTabWidget.md deleted file mode 100644 index 3c6f6c086..000000000 --- a/website/docs/api/QTabWidget.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebar_label: QTabWidget -title: QTabWidget ---- - -Will be available from NodeGUI v0.1.10 and up diff --git a/website/docs/api/QWidget.md b/website/docs/api/QWidget.md deleted file mode 100644 index 2eb88a2fa..000000000 --- a/website/docs/api/QWidget.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -sidebar_label: QWidget -title: QWidget ---- - -> Create and control views. - -**This class is a JS wrapper around Qt's [QWidget class](https://doc.qt.io/qt-5/qwidget.html)** - -A `QWidget` can be used to encapsulate other widgets and provide structure. It functions similar to a `div` in the web world. - -**QWidget inherits from [NodeWidget](api/NodeWidget.md)** - -### Example - -```javascript -const { QWidget } = require("@nodegui/nodegui"); - -const view = new QWidget(); -view.setObjectName("container"); //Similar to setting `id` on the web -view.setLayout(new FlexLayout()); -``` - -### `new QWidget(parent?)` - -- `parent` NodeWidget (_optional_). Any widget inheriting from NodeWidget can be passed as a parent. This will make this widget, the child of the parent widget. - -## Static Methods - -QWidget can access all the static methods defined in [NodeWidget](api/NodeWidget.md) - -## Instance Properties - -QWidget can access all the instance properties defined in [NodeWidget](api/NodeWidget.md) - -## Instance Methods - -QWidget can access all the instance methods defined in [NodeWidget](api/NodeWidget.md) diff --git a/website/docs/api/QtEnums.md b/website/docs/api/QtEnums.md deleted file mode 100644 index 5bc2dd5ec..000000000 --- a/website/docs/api/QtEnums.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -sidebar_label: Qt Enums -title: Qt Enums ---- - -## Enums from Qt - -For a complete list of Enums that we can use from Javascript see file - -Qt enums: [`src/lib/QtEnums/index.ts`](https://github.com/nodegui/nodegui/blob/master/src/lib/QtEnums/index.ts) in the NodeGui repo. - -All the enums in this file can be imported directly from `@nodegui/@nodegui`. - -### Example - -```js -import { AspectRatioMode } from "@nodegui/nodegui"; -``` diff --git a/website/docs/api/YogaWidget.md b/website/docs/api/YogaWidget.md deleted file mode 100644 index f8d54f081..000000000 --- a/website/docs/api/YogaWidget.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_label: YogaWidget -title: YogaWidget ---- - -> Abstract class to add common functionality related to Flex layout to all Widgets. - -**This class implements methods related to flex layout required to be present in all widgets** - -`YogaWidget` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities related to flex layout to all widget's easily. We implement flex layout using a library called [Yoga](https://github.com/facebook/yoga). As part of yoga every widget needs to store its own flex properties such as alignItems, flexDirection etc. This is done with the help of YogaWidget. - -**YogaWidget is the base class for EventWidget which means all widgets inherit it aswell. It inherits from another abstract class [Component](api/Component.md)** - -```javascript -const { QWidget } = require("@nodegui/nodegui"); - -const view = new QWidget(); -// getFlexNode is a method from YogaWidget -const flexNode = view.getFlexNode(); -``` - -YogaWidget helps in storing all flex properties of a widget. - -## Static Methods - -YogaWidget can access all the static methods defined in [Component](api/Component.md) - -## Instance Properties - -YogaWidget can access all the instance properties defined in [Component](api/Component.md) - -## Instance Methods - -YogaWidget can access all the instance methods defined in [Component](api/Component.md) - -Additionally it also has the following instance methods: - -### `widget.getFlexNode()` - -Returns a native reference to the flex node used in c++ instance for the widget. This is not a regular javascript object and hence no methods or properties can be accessed from it. It exists so that we pass around a widgets flex node to layouts, etc. diff --git a/website/docs/api/generated/classes/component.md b/website/docs/api/generated/classes/component.md new file mode 100644 index 000000000..c85bce71b --- /dev/null +++ b/website/docs/api/generated/classes/component.md @@ -0,0 +1,100 @@ +--- +id: "component" +title: "Component" +sidebar_label: "Component" +--- + +> Abstract class that is root most base class for all widgets and layouts in the NodeGui World. + +*This class is used to add core properties to all widgets, layouts etc in NodeGui world. +Currently it helps us maintain references to the native C++ instance of the widget or layout. +It also helps in preventing gc of child elements of a layout or widget** + +`Component` is an abstract class and hence no instances of the same should be created. +It exists so that we can add core functionalities to all widgets and layouts easily. This is an internal class. + +Its the root base class in NodeGui world. + +## Hierarchy + +* **Component** + + ↳ [QClipboard](qclipboard.md) + + ↳ [QStyle](qstyle.md) + + ↳ [QApplication](qapplication.md) + + ↳ [QKeySequence](qkeysequence.md) + + ↳ [QVariant](qvariant.md) + + ↳ [QPixmap](qpixmap.md) + + ↳ [QIcon](qicon.md) + + ↳ [EventWidget](eventwidget.md) + + ↳ [QSize](qsize.md) + + ↳ [QCursor](qcursor.md) + + ↳ [QFontDatabase](qfontdatabase.md) + + ↳ [QRect](qrect.md) + + ↳ [QTableWidgetItem](qtablewidgetitem.md) + + ↳ [QTreeWidgetItem](qtreewidgetitem.md) + + ↳ [QColor](qcolor.md) + + ↳ [QPoint](qpoint.md) + + ↳ [QPainter](qpainter.md) + + ↳ [QUrl](qurl.md) + +## Index + +### Properties + +* [native](component.md#abstract-native) +* [nodeChildren](component.md#nodechildren) +* [nodeParent](component.md#optional-nodeparent) + +### Methods + +* [setNodeParent](component.md#setnodeparent) + +## Properties + +### `Abstract` native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +___ + +### `Optional` nodeParent + +• **nodeParent**? : *[Component](component.md)* + +## Methods + +### setNodeParent + +▸ **setNodeParent**(`parent?`: [Component](component.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent?` | [Component](component.md) | + +**Returns:** *void* diff --git a/website/docs/api/generated/classes/eventwidget.md b/website/docs/api/generated/classes/eventwidget.md new file mode 100644 index 000000000..8bbef6e99 --- /dev/null +++ b/website/docs/api/generated/classes/eventwidget.md @@ -0,0 +1,202 @@ +--- +id: "eventwidget" +title: "EventWidget" +sidebar_label: "EventWidget" +--- + +> Abstract class that adds event handling support to all widgets. + +*This class implements an event emitter and merges it with Qt's event and signal system. It allows us to register and unregister event and signal listener at will from javascript** + +`EventWidget` is an abstract class and hence no instances of the same should be created. It exists so that we can add event handling functionalities to all widget's easily. This is an internal class. + +### Example + +```javascript +const { QWidget, QWidgetSignals, WidgetEventTypes } = require("@nodegui/nodegui"); + +const view = new QWidget(); +// You either listen for a widget's signal +view.addEventListener('windowTitleChanged', () => { +console.log("window title changed"); +}); + +// or you can listen for an event + +view.addEventListener(WidgetEventTypes.MouseMove, () => { +console.log("mouse moved"); +}); +``` + +## Type parameters + +▪ **Signals**: *__type* + +## Hierarchy + +* [Component](component.md) + + ↳ **EventWidget** + + ↳ [NodeObject](nodeobject.md) + +## Index + +### Constructors + +* [constructor](eventwidget.md#constructor) + +### Properties + +* [native](eventwidget.md#abstract-native) +* [nodeChildren](eventwidget.md#nodechildren) +* [nodeParent](eventwidget.md#optional-nodeparent) + +### Methods + +* [addEventListener](eventwidget.md#addeventlistener) +* [removeEventListener](eventwidget.md#removeeventlistener) +* [setNodeParent](eventwidget.md#setnodeparent) + +## Constructors + +### constructor + +\+ **new EventWidget**(`native`: [NativeElement](../globals.md#nativeelement)): *[EventWidget](eventwidget.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[EventWidget](eventwidget.md)* + +## Properties + +### `Abstract` native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Inherited from [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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`: Signals[SignalType]): *void* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**Parameters:** + +Name | Type | +------ | ------ | +`signalType` | SignalType | +`callback` | Signals[SignalType] | + +**Returns:** *void* + +▸ **removeEventListener**(`eventType`: [WidgetEventTypes](../enums/widgeteventtypes.md), `callback`: function): *void* + +**Parameters:** + +▪ **eventType**: *[WidgetEventTypes](../enums/widgeteventtypes.md)* + +▪ **callback**: *function* + +▸ (`event?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**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* diff --git a/website/docs/api/generated/classes/flexlayout.md b/website/docs/api/generated/classes/flexlayout.md new file mode 100644 index 000000000..680ccb346 --- /dev/null +++ b/website/docs/api/generated/classes/flexlayout.md @@ -0,0 +1,403 @@ +--- +id: "flexlayout" +title: "FlexLayout" +sidebar_label: "FlexLayout" +--- + +> Custom layout to help layout child widgets using flex layout. + +**This class is a JS wrapper around custom Qt layout implemented using [Yoga](https://github.com/facebook/yoga)** + +A `FlexLayout` can be used to layout all child NodeGui widgets using flex. + +### Example + +```javascript +const { FlexLayout, QWidget, QLabel } = require("@nodegui/nodegui"); + +const view = new QWidget(); +const layout = new FlexLayout(); +view.setLayout(layout); + +const label = new QLabel(); +label.setText("label1"); +const label2 = new QLabel(); +label2.setText("label2"); + +layout.addWidget(label); +layout.addWidget(label2); +``` + +## Hierarchy + + ↳ [NodeLayout](nodelayout.md)‹[FlexLayoutSignals](../globals.md#flexlayoutsignals)› + + ↳ **FlexLayout** + +## Index + +### Constructors + +* [constructor](flexlayout.md#constructor) + +### Properties + +* [native](flexlayout.md#native) +* [nodeChildren](flexlayout.md#nodechildren) +* [nodeParent](flexlayout.md#optional-nodeparent) +* [type](flexlayout.md#type) + +### Methods + +* [activate](flexlayout.md#activate) +* [addEventListener](flexlayout.md#addeventlistener) +* [addWidget](flexlayout.md#addwidget) +* [inherits](flexlayout.md#inherits) +* [insertChildBefore](flexlayout.md#insertchildbefore) +* [invalidate](flexlayout.md#invalidate) +* [objectName](flexlayout.md#objectname) +* [property](flexlayout.md#property) +* [removeEventListener](flexlayout.md#removeeventlistener) +* [removeWidget](flexlayout.md#removewidget) +* [setFlexNode](flexlayout.md#setflexnode) +* [setNodeParent](flexlayout.md#setnodeparent) +* [setObjectName](flexlayout.md#setobjectname) +* [setProperty](flexlayout.md#setproperty) +* [update](flexlayout.md#update) + +## Constructors + +### constructor + +\+ **new FlexLayout**(): *[FlexLayout](flexlayout.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[FlexLayout](flexlayout.md)* + +\+ **new FlexLayout**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[FlexLayout](flexlayout.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[FlexLayout](flexlayout.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "layout" + +*Inherited from [NodeLayout](nodelayout.md).[type](nodelayout.md#type)* + +## Methods + +### activate + +▸ **activate**(): *boolean* + +*Inherited from [NodeLayout](nodelayout.md).[activate](nodelayout.md#activate)* + +**Returns:** *boolean* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof FlexLayoutSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### addWidget + +▸ **addWidget**(`childWidget`: [NodeWidget](nodewidget.md)‹any›, `childFlexNode?`: [FlexNode](../globals.md#flexnode)): *void* + +*Overrides [NodeLayout](nodelayout.md).[addWidget](nodelayout.md#abstract-addwidget)* + +**Parameters:** + +Name | Type | +------ | ------ | +`childWidget` | [NodeWidget](nodewidget.md)‹any› | +`childFlexNode?` | [FlexNode](../globals.md#flexnode) | + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### insertChildBefore + +▸ **insertChildBefore**(`childWidget`: [NodeWidget](nodewidget.md)‹any›, `beforeChildWidget`: [NodeWidget](nodewidget.md)‹any›, `childFlexNode?`: [FlexNode](../globals.md#flexnode), `beforeChildFlexNode?`: [FlexNode](../globals.md#flexnode)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`childWidget` | [NodeWidget](nodewidget.md)‹any› | +`beforeChildWidget` | [NodeWidget](nodewidget.md)‹any› | +`childFlexNode?` | [FlexNode](../globals.md#flexnode) | +`beforeChildFlexNode?` | [FlexNode](../globals.md#flexnode) | + +**Returns:** *void* + +___ + +### invalidate + +▸ **invalidate**(): *void* + +*Inherited from [NodeLayout](nodelayout.md).[invalidate](nodelayout.md#invalidate)* + +**Returns:** *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`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof FlexLayoutSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### removeWidget + +▸ **removeWidget**(`childWidget`: [NodeWidget](nodewidget.md)‹any›, `childFlexNode?`: [FlexNode](../globals.md#flexnode)): *void* + +*Overrides [NodeLayout](nodelayout.md).[removeWidget](nodelayout.md#abstract-removewidget)* + +**Parameters:** + +Name | Type | +------ | ------ | +`childWidget` | [NodeWidget](nodewidget.md)‹any› | +`childFlexNode?` | [FlexNode](../globals.md#flexnode) | + +**Returns:** *void* + +___ + +### setFlexNode + +▸ **setFlexNode**(`flexNode`: [FlexNode](../globals.md#flexnode)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`flexNode` | [FlexNode](../globals.md#flexnode) | + +**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* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeLayout](nodelayout.md).[update](nodelayout.md#update)* + +**Returns:** *void* diff --git a/website/docs/api/generated/classes/nodelayout.md b/website/docs/api/generated/classes/nodelayout.md new file mode 100644 index 000000000..dd60c196d --- /dev/null +++ b/website/docs/api/generated/classes/nodelayout.md @@ -0,0 +1,364 @@ +--- +id: "nodelayout" +title: "NodeLayout" +sidebar_label: "NodeLayout" +--- + +> Abstract class to add functionalities common to all Layout. + +*This class implements all methods, properties of Qt's [QLayout class](https://doc.qt.io/qt-5/qlayout.html) so that it can be inherited by all layouts** + +`NodeLayout` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all layout's easily. Additionally it helps in typechecking process. + +### Example + +```javascript +const { +NodeLayout, +NodeWidget, +FlexLayout, +GridLayout, +QPushButton, +QWidget +} = require("@nodegui/nodegui"); + +// addChildToLayout can accept any layout since it expects NodeLayout +const addChildToLayout = (layout: NodeLayout, widget: NodeWidget) => { +layout.addWidget(widget); +}; + +addChildToLayout(new FlexLayout(), new QPushButton()); +addChildToLayout(new GridLayout(), new QWidget()); +``` + +## Type parameters + +▪ **Signals**: *[QLayoutSignals](../globals.md#qlayoutsignals)* + +## Hierarchy + + ↳ [NodeObject](nodeobject.md)‹Signals› + + ↳ **NodeLayout** + + ↳ [FlexLayout](flexlayout.md) + + ↳ [QBoxLayout](qboxlayout.md) + + ↳ [QGridLayout](qgridlayout.md) + +## Index + +### Constructors + +* [constructor](nodelayout.md#constructor) + +### Properties + +* [native](nodelayout.md#abstract-native) +* [nodeChildren](nodelayout.md#nodechildren) +* [nodeParent](nodelayout.md#optional-nodeparent) +* [type](nodelayout.md#type) + +### Methods + +* [activate](nodelayout.md#activate) +* [addEventListener](nodelayout.md#addeventlistener) +* [addWidget](nodelayout.md#abstract-addwidget) +* [inherits](nodelayout.md#inherits) +* [invalidate](nodelayout.md#invalidate) +* [objectName](nodelayout.md#objectname) +* [property](nodelayout.md#property) +* [removeEventListener](nodelayout.md#removeeventlistener) +* [removeWidget](nodelayout.md#abstract-removewidget) +* [setNodeParent](nodelayout.md#setnodeparent) +* [setObjectName](nodelayout.md#setobjectname) +* [setProperty](nodelayout.md#setproperty) +* [update](nodelayout.md#update) + +## Constructors + +### constructor + +\+ **new NodeLayout**(`native`: [NativeElement](../globals.md#nativeelement)): *[NodeLayout](nodelayout.md)* + +*Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[NodeLayout](nodelayout.md)* + +## Properties + +### `Abstract` native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Inherited from [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "layout" + +## Methods + +### activate + +▸ **activate**(): *boolean* + +**Returns:** *boolean* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### `Abstract` addWidget + +▸ **addWidget**(`childWidget`: [NodeWidget](nodewidget.md)‹any›, ...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`childWidget` | [NodeWidget](nodewidget.md)‹any› | +`...args` | any[] | + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### invalidate + +▸ **invalidate**(): *void* + +**Returns:** *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`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### `Abstract` removeWidget + +▸ **removeWidget**(`childWidget`: [NodeWidget](nodewidget.md)‹any›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`childWidget` | [NodeWidget](nodewidget.md)‹any› | + +**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* + +___ + +### update + +▸ **update**(): *void* + +**Returns:** *void* diff --git a/website/docs/api/generated/classes/nodeobject.md b/website/docs/api/generated/classes/nodeobject.md new file mode 100644 index 000000000..a1b959aa6 --- /dev/null +++ b/website/docs/api/generated/classes/nodeobject.md @@ -0,0 +1,270 @@ +--- +id: "nodeobject" +title: "NodeObject" +sidebar_label: "NodeObject" +--- + +## Type parameters + +▪ **Signals**: *[QObjectSignals](../interfaces/qobjectsignals.md)* + +## Hierarchy + + ↳ [EventWidget](eventwidget.md)‹Signals› + + ↳ **NodeObject** + + ↳ [QObject](qobject.md) + + ↳ [QMovie](qmovie.md) + + ↳ [NodeLayout](nodelayout.md) + + ↳ [YogaWidget](yogawidget.md) + + ↳ [QAction](qaction.md) + + ↳ [QSystemTrayIcon](qsystemtrayicon.md) + + ↳ [QShortcut](qshortcut.md) + +## Index + +### Constructors + +* [constructor](nodeobject.md#constructor) + +### Properties + +* [native](nodeobject.md#abstract-native) +* [nodeChildren](nodeobject.md#nodechildren) +* [nodeParent](nodeobject.md#optional-nodeparent) + +### Methods + +* [addEventListener](nodeobject.md#addeventlistener) +* [inherits](nodeobject.md#inherits) +* [objectName](nodeobject.md#objectname) +* [property](nodeobject.md#property) +* [removeEventListener](nodeobject.md#removeeventlistener) +* [setNodeParent](nodeobject.md#setnodeparent) +* [setObjectName](nodeobject.md#setobjectname) +* [setProperty](nodeobject.md#setproperty) + +## Constructors + +### constructor + +\+ **new NodeObject**(`native`: [NativeElement](../globals.md#nativeelement)): *[NodeObject](nodeobject.md)* + +*Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[NodeObject](nodeobject.md)* + +## Properties + +### `Abstract` native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Inherited from [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### objectName + +▸ **objectName**(): *string* + +**Returns:** *string* + +___ + +### property + +▸ **property**(`name`: string): *[QVariant](qvariant.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`name` | string | + +**Returns:** *[QVariant](qvariant.md)* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**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* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +**Returns:** *void* + +___ + +### setProperty + +▸ **setProperty**(`name`: string, `value`: [QVariantType](../globals.md#qvarianttype)): *boolean* + +**Parameters:** + +Name | Type | +------ | ------ | +`name` | string | +`value` | [QVariantType](../globals.md#qvarianttype) | + +**Returns:** *boolean* diff --git a/website/docs/api/generated/classes/nodewidget.md b/website/docs/api/generated/classes/nodewidget.md new file mode 100644 index 000000000..9706b7c16 --- /dev/null +++ b/website/docs/api/generated/classes/nodewidget.md @@ -0,0 +1,905 @@ +--- +id: "nodewidget" +title: "NodeWidget" +sidebar_label: "NodeWidget" +--- + +> Abstract class to add functionalities common to all Widgets. + +*This class implements all methods, properties of Qt's [QWidget class](https://doc.qt.io/qt-5/qwidget.html) so that it can be inherited by all widgets** + +`NodeWidget` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all widget's easily. Additionally it helps in type checking process. If you wish to create a `div` like widget use [QWidget](api/QWidget.md) instead. + +*NodeWidget is the base class for all widgets.** + +### Example + +```javascript +const { +NodeWidget, +QPushButton, +QWidget, +QRadioButton +} = require("@nodegui/nodegui"); + +// showWidget can accept any widget since it expects NodeWidget +const showWidget = (widget: NodeWidget) => { +widget.show(); +}; + +showWidget(new QPushButton()); +showWidget(new QWidget()); +showWidget(new QRadioButton()); +``` +All Widgets should extend from NodeWidget +Implement all native QWidget methods here so that all widgets get access to those aswell + +## Type parameters + +▪ **Signals**: *[QWidgetSignals](../interfaces/qwidgetsignals.md)* + +## Hierarchy + + ↳ [YogaWidget](yogawidget.md)‹Signals› + + ↳ **NodeWidget** + + ↳ [QWidget](qwidget.md) + + ↳ [QAbstractScrollArea](qabstractscrollarea.md) + + ↳ [QAbstractSlider](qabstractslider.md) + + ↳ [QAbstractButton](qabstractbutton.md) + + ↳ [QLabel](qlabel.md) + + ↳ [QFileDialog](qfiledialog.md) + + ↳ [QLineEdit](qlineedit.md) + + ↳ [QMenu](qmenu.md) + + ↳ [QMenuBar](qmenubar.md) + + ↳ [QMainWindow](qmainwindow.md) + + ↳ [QProgressBar](qprogressbar.md) + + ↳ [QComboBox](qcombobox.md) + + ↳ [QSpinBox](qspinbox.md) + + ↳ [QStackedWidget](qstackedwidget.md) + + ↳ [QTabWidget](qtabwidget.md) + + ↳ [QGroupBox](qgroupbox.md) + +## Index + +### Constructors + +* [constructor](nodewidget.md#constructor) + +### Properties + +* [_rawInlineStyle](nodewidget.md#_rawinlinestyle) +* [layout](nodewidget.md#optional-layout) +* [native](nodewidget.md#abstract-native) +* [nodeChildren](nodewidget.md#nodechildren) +* [nodeParent](nodewidget.md#optional-nodeparent) +* [type](nodewidget.md#type) + +### Methods + +* [activateWindow](nodewidget.md#activatewindow) +* [addEventListener](nodewidget.md#addeventlistener) +* [adjustSize](nodewidget.md#adjustsize) +* [close](nodewidget.md#close) +* [geometry](nodewidget.md#geometry) +* [getFlexNode](nodewidget.md#getflexnode) +* [hasMouseTracking](nodewidget.md#hasmousetracking) +* [hide](nodewidget.md#hide) +* [inherits](nodewidget.md#inherits) +* [isEnabled](nodewidget.md#isenabled) +* [isVisible](nodewidget.md#isvisible) +* [lower](nodewidget.md#lower) +* [move](nodewidget.md#move) +* [objectName](nodewidget.md#objectname) +* [pos](nodewidget.md#pos) +* [property](nodewidget.md#property) +* [raise](nodewidget.md#raise) +* [removeEventListener](nodewidget.md#removeeventlistener) +* [repaint](nodewidget.md#repaint) +* [resize](nodewidget.md#resize) +* [setAttribute](nodewidget.md#setattribute) +* [setContextMenuPolicy](nodewidget.md#setcontextmenupolicy) +* [setCursor](nodewidget.md#setcursor) +* [setEnabled](nodewidget.md#setenabled) +* [setFixedSize](nodewidget.md#setfixedsize) +* [setFlexNodeSizeControlled](nodewidget.md#setflexnodesizecontrolled) +* [setGeometry](nodewidget.md#setgeometry) +* [setInlineStyle](nodewidget.md#setinlinestyle) +* [setLayout](nodewidget.md#setlayout) +* [setMaximumSize](nodewidget.md#setmaximumsize) +* [setMinimumSize](nodewidget.md#setminimumsize) +* [setMouseTracking](nodewidget.md#setmousetracking) +* [setNodeParent](nodewidget.md#setnodeparent) +* [setObjectName](nodewidget.md#setobjectname) +* [setProperty](nodewidget.md#setproperty) +* [setStyleSheet](nodewidget.md#setstylesheet) +* [setWindowFlag](nodewidget.md#setwindowflag) +* [setWindowIcon](nodewidget.md#setwindowicon) +* [setWindowOpacity](nodewidget.md#setwindowopacity) +* [setWindowState](nodewidget.md#setwindowstate) +* [setWindowTitle](nodewidget.md#setwindowtitle) +* [show](nodewidget.md#show) +* [showFullScreen](nodewidget.md#showfullscreen) +* [showMaximized](nodewidget.md#showmaximized) +* [showMinimized](nodewidget.md#showminimized) +* [showNormal](nodewidget.md#shownormal) +* [size](nodewidget.md#size) +* [styleSheet](nodewidget.md#stylesheet) +* [testAttribute](nodewidget.md#testattribute) +* [update](nodewidget.md#update) +* [updateGeometry](nodewidget.md#updategeometry) +* [windowOpacity](nodewidget.md#windowopacity) +* [windowState](nodewidget.md#windowstate) +* [windowTitle](nodewidget.md#windowtitle) + +## Constructors + +### constructor + +\+ **new NodeWidget**(`native`: [NativeElement](../globals.md#nativeelement)): *[NodeWidget](nodewidget.md)* + +*Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[NodeWidget](nodewidget.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹Signals›* + +___ + +### `Abstract` native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Inherited from [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹Signals›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹Signals› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qabstractbutton.md b/website/docs/api/generated/classes/qabstractbutton.md new file mode 100644 index 000000000..d3e5f74b8 --- /dev/null +++ b/website/docs/api/generated/classes/qabstractbutton.md @@ -0,0 +1,1001 @@ +--- +id: "qabstractbutton" +title: "QAbstractButton" +sidebar_label: "QAbstractButton" +--- + +## Type parameters + +▪ **Signals**: *[QAbstractButtonSignals](../interfaces/qabstractbuttonsignals.md)* + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹Signals› + + ↳ **QAbstractButton** + + ↳ [QCheckBox](qcheckbox.md) + + ↳ [QPushButton](qpushbutton.md) + + ↳ [QToolButton](qtoolbutton.md) + + ↳ [QRadioButton](qradiobutton.md) + +## Index + +### Constructors + +* [constructor](qabstractbutton.md#constructor) + +### Properties + +* [_rawInlineStyle](qabstractbutton.md#_rawinlinestyle) +* [layout](qabstractbutton.md#optional-layout) +* [native](qabstractbutton.md#abstract-native) +* [nodeChildren](qabstractbutton.md#nodechildren) +* [nodeParent](qabstractbutton.md#optional-nodeparent) +* [type](qabstractbutton.md#type) + +### Methods + +* [activateWindow](qabstractbutton.md#activatewindow) +* [addEventListener](qabstractbutton.md#addeventlistener) +* [adjustSize](qabstractbutton.md#adjustsize) +* [close](qabstractbutton.md#close) +* [geometry](qabstractbutton.md#geometry) +* [getFlexNode](qabstractbutton.md#getflexnode) +* [hasMouseTracking](qabstractbutton.md#hasmousetracking) +* [hide](qabstractbutton.md#hide) +* [iconSize](qabstractbutton.md#iconsize) +* [inherits](qabstractbutton.md#inherits) +* [isEnabled](qabstractbutton.md#isenabled) +* [isVisible](qabstractbutton.md#isvisible) +* [lower](qabstractbutton.md#lower) +* [move](qabstractbutton.md#move) +* [objectName](qabstractbutton.md#objectname) +* [pos](qabstractbutton.md#pos) +* [property](qabstractbutton.md#property) +* [raise](qabstractbutton.md#raise) +* [removeEventListener](qabstractbutton.md#removeeventlistener) +* [repaint](qabstractbutton.md#repaint) +* [resize](qabstractbutton.md#resize) +* [setAttribute](qabstractbutton.md#setattribute) +* [setContextMenuPolicy](qabstractbutton.md#setcontextmenupolicy) +* [setCursor](qabstractbutton.md#setcursor) +* [setEnabled](qabstractbutton.md#setenabled) +* [setFixedSize](qabstractbutton.md#setfixedsize) +* [setFlexNodeSizeControlled](qabstractbutton.md#setflexnodesizecontrolled) +* [setGeometry](qabstractbutton.md#setgeometry) +* [setIcon](qabstractbutton.md#seticon) +* [setIconSize](qabstractbutton.md#seticonsize) +* [setInlineStyle](qabstractbutton.md#setinlinestyle) +* [setLayout](qabstractbutton.md#setlayout) +* [setMaximumSize](qabstractbutton.md#setmaximumsize) +* [setMinimumSize](qabstractbutton.md#setminimumsize) +* [setMouseTracking](qabstractbutton.md#setmousetracking) +* [setNodeParent](qabstractbutton.md#setnodeparent) +* [setObjectName](qabstractbutton.md#setobjectname) +* [setProperty](qabstractbutton.md#setproperty) +* [setStyleSheet](qabstractbutton.md#setstylesheet) +* [setText](qabstractbutton.md#settext) +* [setWindowFlag](qabstractbutton.md#setwindowflag) +* [setWindowIcon](qabstractbutton.md#setwindowicon) +* [setWindowOpacity](qabstractbutton.md#setwindowopacity) +* [setWindowState](qabstractbutton.md#setwindowstate) +* [setWindowTitle](qabstractbutton.md#setwindowtitle) +* [show](qabstractbutton.md#show) +* [showFullScreen](qabstractbutton.md#showfullscreen) +* [showMaximized](qabstractbutton.md#showmaximized) +* [showMinimized](qabstractbutton.md#showminimized) +* [showNormal](qabstractbutton.md#shownormal) +* [size](qabstractbutton.md#size) +* [styleSheet](qabstractbutton.md#stylesheet) +* [testAttribute](qabstractbutton.md#testattribute) +* [update](qabstractbutton.md#update) +* [updateGeometry](qabstractbutton.md#updategeometry) +* [windowOpacity](qabstractbutton.md#windowopacity) +* [windowState](qabstractbutton.md#windowstate) +* [windowTitle](qabstractbutton.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QAbstractButton**(`native`: [NativeElement](../globals.md#nativeelement)): *[QAbstractButton](qabstractbutton.md)* + +*Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QAbstractButton](qabstractbutton.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹Signals›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### `Abstract` native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Inherited from [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### iconSize + +▸ **iconSize**(): *[QSize](qsize.md)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setIcon + +▸ **setIcon**(`icon`: [QIcon](qicon.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setIconSize + +▸ **setIconSize**(`iconSize`: [QSize](qsize.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`iconSize` | [QSize](qsize.md) | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹Signals›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹Signals› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setText + +▸ **setText**(`text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qabstractscrollarea.md b/website/docs/api/generated/classes/qabstractscrollarea.md new file mode 100644 index 000000000..d93167815 --- /dev/null +++ b/website/docs/api/generated/classes/qabstractscrollarea.md @@ -0,0 +1,1018 @@ +--- +id: "qabstractscrollarea" +title: "QAbstractScrollArea" +sidebar_label: "QAbstractScrollArea" +--- + +> Abstract class to add functionalities common to all scrollarea based widgets. + +*This class implements all methods, properties of Qt's [QAbstractScrollArea class](https://doc.qt.io/qt-5/qabstractscrollarea.html) so that it can be inherited by all scroll based widgets** + +`QAbstractScrollArea` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all scrollable widget's easily. If you wish to create a scrollarea use [QScrollArea](api/QScrollArea.md) instead. + +*QAbstractScrollArea is the base class for all widgets.** + +QAbstractScrollArea will list all methods and properties that are common to all scrollable widgets in the NodeGui world. + +## Type parameters + +▪ **Signals**: *[QAbstractScrollAreaSignals](../globals.md#qabstractscrollareasignals)* + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹Signals› + + ↳ **QAbstractScrollArea** + + ↳ [QTableWidget](qtablewidget.md) + + ↳ [QPlainTextEdit](qplaintextedit.md) + + ↳ [QScrollArea](qscrollarea.md) + + ↳ [QTreeWidget](qtreewidget.md) + +## Index + +### Constructors + +* [constructor](qabstractscrollarea.md#constructor) + +### Properties + +* [_rawInlineStyle](qabstractscrollarea.md#_rawinlinestyle) +* [layout](qabstractscrollarea.md#optional-layout) +* [native](qabstractscrollarea.md#abstract-native) +* [nodeChildren](qabstractscrollarea.md#nodechildren) +* [nodeParent](qabstractscrollarea.md#optional-nodeparent) +* [type](qabstractscrollarea.md#type) +* [viewportWidget](qabstractscrollarea.md#optional-viewportwidget) + +### Methods + +* [activateWindow](qabstractscrollarea.md#activatewindow) +* [addEventListener](qabstractscrollarea.md#addeventlistener) +* [adjustSize](qabstractscrollarea.md#adjustsize) +* [close](qabstractscrollarea.md#close) +* [geometry](qabstractscrollarea.md#geometry) +* [getFlexNode](qabstractscrollarea.md#getflexnode) +* [hasMouseTracking](qabstractscrollarea.md#hasmousetracking) +* [hide](qabstractscrollarea.md#hide) +* [inherits](qabstractscrollarea.md#inherits) +* [isEnabled](qabstractscrollarea.md#isenabled) +* [isVisible](qabstractscrollarea.md#isvisible) +* [lower](qabstractscrollarea.md#lower) +* [move](qabstractscrollarea.md#move) +* [objectName](qabstractscrollarea.md#objectname) +* [pos](qabstractscrollarea.md#pos) +* [property](qabstractscrollarea.md#property) +* [raise](qabstractscrollarea.md#raise) +* [removeEventListener](qabstractscrollarea.md#removeeventlistener) +* [repaint](qabstractscrollarea.md#repaint) +* [resize](qabstractscrollarea.md#resize) +* [setAttribute](qabstractscrollarea.md#setattribute) +* [setContextMenuPolicy](qabstractscrollarea.md#setcontextmenupolicy) +* [setCursor](qabstractscrollarea.md#setcursor) +* [setEnabled](qabstractscrollarea.md#setenabled) +* [setFixedSize](qabstractscrollarea.md#setfixedsize) +* [setFlexNodeSizeControlled](qabstractscrollarea.md#setflexnodesizecontrolled) +* [setGeometry](qabstractscrollarea.md#setgeometry) +* [setHorizontalScrollBarPolicy](qabstractscrollarea.md#sethorizontalscrollbarpolicy) +* [setInlineStyle](qabstractscrollarea.md#setinlinestyle) +* [setLayout](qabstractscrollarea.md#setlayout) +* [setMaximumSize](qabstractscrollarea.md#setmaximumsize) +* [setMinimumSize](qabstractscrollarea.md#setminimumsize) +* [setMouseTracking](qabstractscrollarea.md#setmousetracking) +* [setNodeParent](qabstractscrollarea.md#setnodeparent) +* [setObjectName](qabstractscrollarea.md#setobjectname) +* [setProperty](qabstractscrollarea.md#setproperty) +* [setStyleSheet](qabstractscrollarea.md#setstylesheet) +* [setVerticalScrollBarPolicy](qabstractscrollarea.md#setverticalscrollbarpolicy) +* [setViewport](qabstractscrollarea.md#setviewport) +* [setWindowFlag](qabstractscrollarea.md#setwindowflag) +* [setWindowIcon](qabstractscrollarea.md#setwindowicon) +* [setWindowOpacity](qabstractscrollarea.md#setwindowopacity) +* [setWindowState](qabstractscrollarea.md#setwindowstate) +* [setWindowTitle](qabstractscrollarea.md#setwindowtitle) +* [show](qabstractscrollarea.md#show) +* [showFullScreen](qabstractscrollarea.md#showfullscreen) +* [showMaximized](qabstractscrollarea.md#showmaximized) +* [showMinimized](qabstractscrollarea.md#showminimized) +* [showNormal](qabstractscrollarea.md#shownormal) +* [size](qabstractscrollarea.md#size) +* [styleSheet](qabstractscrollarea.md#stylesheet) +* [testAttribute](qabstractscrollarea.md#testattribute) +* [update](qabstractscrollarea.md#update) +* [updateGeometry](qabstractscrollarea.md#updategeometry) +* [viewport](qabstractscrollarea.md#viewport) +* [windowOpacity](qabstractscrollarea.md#windowopacity) +* [windowState](qabstractscrollarea.md#windowstate) +* [windowTitle](qabstractscrollarea.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QAbstractScrollArea**(`native`: [NativeElement](../globals.md#nativeelement)): *[QAbstractScrollArea](qabstractscrollarea.md)* + +*Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QAbstractScrollArea](qabstractscrollarea.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹Signals›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### `Abstract` native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Inherited from [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +___ + +### `Optional` viewportWidget + +• **viewportWidget**? : *[NodeWidget](nodewidget.md)‹any›* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setHorizontalScrollBarPolicy + +▸ **setHorizontalScrollBarPolicy**(`policy`: [ScrollBarPolicy](../enums/scrollbarpolicy.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`policy` | [ScrollBarPolicy](../enums/scrollbarpolicy.md) | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹Signals›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹Signals› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setVerticalScrollBarPolicy + +▸ **setVerticalScrollBarPolicy**(`policy`: [ScrollBarPolicy](../enums/scrollbarpolicy.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`policy` | [ScrollBarPolicy](../enums/scrollbarpolicy.md) | + +**Returns:** *void* + +___ + +### setViewport + +▸ **setViewport**(`widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### viewport + +▸ **viewport**(): *[QWidget](qwidget.md)* + +**Returns:** *[QWidget](qwidget.md)* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qabstractslider.md b/website/docs/api/generated/classes/qabstractslider.md new file mode 100644 index 000000000..b8da457ca --- /dev/null +++ b/website/docs/api/generated/classes/qabstractslider.md @@ -0,0 +1,1053 @@ +--- +id: "qabstractslider" +title: "QAbstractSlider" +sidebar_label: "QAbstractSlider" +--- + +> Abstract class to add functionalities common to all slider based widgets. + +*This class implements all methods, properties of Qt's [QAbstractSlider class](https://doc.qt.io/qt-5/qabstractslider.html) so that it can be inherited by all slider based widgets** + +`QAbstractSlider` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all slider widget's easily. If you wish to create a slider use [QDial](api/QDial.md) instead. + +*QAbstractSlider is the base class for all slider widgets.** + +QAbstractSlider will list all methods and properties that are common to all slider widgets in the NodeGui world. + +## Type parameters + +▪ **Signals**: *[QAbstractSliderSignals](../interfaces/qabstractslidersignals.md)* + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹Signals› + + ↳ **QAbstractSlider** + + ↳ [QDial](qdial.md) + +## Index + +### Constructors + +* [constructor](qabstractslider.md#constructor) + +### Properties + +* [_rawInlineStyle](qabstractslider.md#_rawinlinestyle) +* [layout](qabstractslider.md#optional-layout) +* [native](qabstractslider.md#abstract-native) +* [nodeChildren](qabstractslider.md#nodechildren) +* [nodeParent](qabstractslider.md#optional-nodeparent) +* [type](qabstractslider.md#type) + +### Methods + +* [activateWindow](qabstractslider.md#activatewindow) +* [addEventListener](qabstractslider.md#addeventlistener) +* [adjustSize](qabstractslider.md#adjustsize) +* [close](qabstractslider.md#close) +* [geometry](qabstractslider.md#geometry) +* [getFlexNode](qabstractslider.md#getflexnode) +* [hasMouseTracking](qabstractslider.md#hasmousetracking) +* [hide](qabstractslider.md#hide) +* [inherits](qabstractslider.md#inherits) +* [isEnabled](qabstractslider.md#isenabled) +* [isVisible](qabstractslider.md#isvisible) +* [lower](qabstractslider.md#lower) +* [maximum](qabstractslider.md#maximum) +* [minimum](qabstractslider.md#minimum) +* [move](qabstractslider.md#move) +* [objectName](qabstractslider.md#objectname) +* [pos](qabstractslider.md#pos) +* [property](qabstractslider.md#property) +* [raise](qabstractslider.md#raise) +* [removeEventListener](qabstractslider.md#removeeventlistener) +* [repaint](qabstractslider.md#repaint) +* [resize](qabstractslider.md#resize) +* [setAttribute](qabstractslider.md#setattribute) +* [setContextMenuPolicy](qabstractslider.md#setcontextmenupolicy) +* [setCursor](qabstractslider.md#setcursor) +* [setEnabled](qabstractslider.md#setenabled) +* [setFixedSize](qabstractslider.md#setfixedsize) +* [setFlexNodeSizeControlled](qabstractslider.md#setflexnodesizecontrolled) +* [setGeometry](qabstractslider.md#setgeometry) +* [setInlineStyle](qabstractslider.md#setinlinestyle) +* [setLayout](qabstractslider.md#setlayout) +* [setMaximum](qabstractslider.md#setmaximum) +* [setMaximumSize](qabstractslider.md#setmaximumsize) +* [setMinimum](qabstractslider.md#setminimum) +* [setMinimumSize](qabstractslider.md#setminimumsize) +* [setMouseTracking](qabstractslider.md#setmousetracking) +* [setNodeParent](qabstractslider.md#setnodeparent) +* [setObjectName](qabstractslider.md#setobjectname) +* [setOrientation](qabstractslider.md#setorientation) +* [setProperty](qabstractslider.md#setproperty) +* [setSingleStep](qabstractslider.md#setsinglestep) +* [setStyleSheet](qabstractslider.md#setstylesheet) +* [setValue](qabstractslider.md#setvalue) +* [setWindowFlag](qabstractslider.md#setwindowflag) +* [setWindowIcon](qabstractslider.md#setwindowicon) +* [setWindowOpacity](qabstractslider.md#setwindowopacity) +* [setWindowState](qabstractslider.md#setwindowstate) +* [setWindowTitle](qabstractslider.md#setwindowtitle) +* [show](qabstractslider.md#show) +* [showFullScreen](qabstractslider.md#showfullscreen) +* [showMaximized](qabstractslider.md#showmaximized) +* [showMinimized](qabstractslider.md#showminimized) +* [showNormal](qabstractslider.md#shownormal) +* [size](qabstractslider.md#size) +* [styleSheet](qabstractslider.md#stylesheet) +* [testAttribute](qabstractslider.md#testattribute) +* [update](qabstractslider.md#update) +* [updateGeometry](qabstractslider.md#updategeometry) +* [value](qabstractslider.md#value) +* [windowOpacity](qabstractslider.md#windowopacity) +* [windowState](qabstractslider.md#windowstate) +* [windowTitle](qabstractslider.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QAbstractSlider**(`native`: [NativeElement](../globals.md#nativeelement)): *[QAbstractSlider](qabstractslider.md)* + +*Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QAbstractSlider](qabstractslider.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹Signals›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### `Abstract` native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Inherited from [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### maximum + +▸ **maximum**(): *number* + +**Returns:** *number* + +___ + +### minimum + +▸ **minimum**(): *number* + +**Returns:** *number* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹Signals›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹Signals› | + +**Returns:** *void* + +___ + +### setMaximum + +▸ **setMaximum**(`maximum`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`maximum` | number | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimum + +▸ **setMinimum**(`minimum`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`minimum` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [NodeObject](nodeobject.md).[setObjectName](nodeobject.md#setobjectname)* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +**Returns:** *void* + +___ + +### setOrientation + +▸ **setOrientation**(`orientation`: [Orientation](../enums/orientation.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`orientation` | [Orientation](../enums/orientation.md) | + +**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* + +___ + +### setSingleStep + +▸ **setSingleStep**(`step`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`step` | number | + +**Returns:** *void* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setValue + +▸ **setValue**(`value`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | number | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### value + +▸ **value**(): *number* + +**Returns:** *number* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qaction.md b/website/docs/api/generated/classes/qaction.md new file mode 100644 index 000000000..154cd14f6 --- /dev/null +++ b/website/docs/api/generated/classes/qaction.md @@ -0,0 +1,474 @@ +--- +id: "qaction" +title: "QAction" +sidebar_label: "QAction" +--- + +> The QAction class provides an abstract user interface action that can be inserted into widgets. + +**This class is a JS wrapper around Qt's [QAction class](https://doc.qt.io/qt-5/qaction.html)** + +### Example + +```javascript +const { QAction, QMenu } = require("@nodegui/nodegui"); + +const menu = new QMenu(); +const menuAction = new QAction(); +menuAction.setText("subAction"); +menuAction.addEventListener("triggered", () => { +console.log("Action clicked"); +}); +menu.addAction(menuAction); +``` + +## Hierarchy + + ↳ [NodeObject](nodeobject.md)‹[QActionSignals](../interfaces/qactionsignals.md)› + + ↳ **QAction** + +## Index + +### Constructors + +* [constructor](qaction.md#constructor) + +### Properties + +* [icon](qaction.md#optional-icon) +* [menu](qaction.md#optional-menu) +* [native](qaction.md#native) +* [nodeChildren](qaction.md#nodechildren) +* [nodeParent](qaction.md#optional-nodeparent) + +### Methods + +* [addEventListener](qaction.md#addeventlistener) +* [inherits](qaction.md#inherits) +* [isCheckable](qaction.md#ischeckable) +* [isChecked](qaction.md#ischecked) +* [isSeparator](qaction.md#isseparator) +* [objectName](qaction.md#objectname) +* [property](qaction.md#property) +* [removeEventListener](qaction.md#removeeventlistener) +* [setCheckable](qaction.md#setcheckable) +* [setChecked](qaction.md#setchecked) +* [setEnabled](qaction.md#setenabled) +* [setIcon](qaction.md#seticon) +* [setMenu](qaction.md#setmenu) +* [setNodeParent](qaction.md#setnodeparent) +* [setObjectName](qaction.md#setobjectname) +* [setProperty](qaction.md#setproperty) +* [setSeparator](qaction.md#setseparator) +* [setShortcut](qaction.md#setshortcut) +* [setShortcutContext](qaction.md#setshortcutcontext) +* [setText](qaction.md#settext) + +## Constructors + +### constructor + +\+ **new QAction**(): *[QAction](qaction.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QAction](qaction.md)* + +\+ **new QAction**(`native`: [NativeElement](../globals.md#nativeelement)): *[QAction](qaction.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QAction](qaction.md)* + +\+ **new QAction**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QAction](qaction.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QAction](qaction.md)* + +## Properties + +### `Optional` icon + +• **icon**? : *[QIcon](qicon.md)* + +___ + +### `Optional` menu + +• **menu**? : *[QMenu](qmenu.md)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QActionSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isCheckable + +▸ **isCheckable**(): *boolean* + +**Returns:** *boolean* + +___ + +### isChecked + +▸ **isChecked**(): *boolean* + +**Returns:** *boolean* + +___ + +### isSeparator + +▸ **isSeparator**(): *boolean* + +**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)* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QActionSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### setCheckable + +▸ **setCheckable**(`isCheckable`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`isCheckable` | boolean | + +**Returns:** *void* + +___ + +### setChecked + +▸ **setChecked**(`isChecked`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`isChecked` | boolean | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setIcon + +▸ **setIcon**(`icon`: [QIcon](qicon.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setMenu + +▸ **setMenu**(`menu`: [QMenu](qmenu.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`menu` | [QMenu](qmenu.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* + +___ + +### 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* + +___ + +### setSeparator + +▸ **setSeparator**(`isSeparator`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`isSeparator` | boolean | + +**Returns:** *void* + +___ + +### setShortcut + +▸ **setShortcut**(`keysequence`: [QKeySequence](qkeysequence.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`keysequence` | [QKeySequence](qkeysequence.md) | + +**Returns:** *void* + +___ + +### setShortcutContext + +▸ **setShortcutContext**(`shortcutContext`: [ShortcutContext](../enums/shortcutcontext.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`shortcutContext` | [ShortcutContext](../enums/shortcutcontext.md) | + +**Returns:** *void* + +___ + +### setText + +▸ **setText**(`text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +**Returns:** *void* diff --git a/website/docs/api/generated/classes/qapplication.md b/website/docs/api/generated/classes/qapplication.md new file mode 100644 index 000000000..d469db5de --- /dev/null +++ b/website/docs/api/generated/classes/qapplication.md @@ -0,0 +1,193 @@ +--- +id: "qapplication" +title: "QApplication" +sidebar_label: "QApplication" +--- + +> QApplication is the root object for the entire application. It manages app level settings. + +**This class is a JS wrapper around Qt's [QApplication class](https://doc.qt.io/qt-5/qapplication.html)** + +The QApplication class manages the GUI application's control flow and main settings. In NodeGui you will never create an instance of it manually. NodeGui's internal runtime `Qode` does it for you on app start. You can access the initialised QApplication though if needed. + +### Example + +```js +const { QApplication } = require("@nodegui/nodegui"); + +const qApp = QApplication.instance(); +qApp.quit(); +``` + +## Hierarchy + +* [Component](component.md) + + ↳ **QApplication** + +## Index + +### Constructors + +* [constructor](qapplication.md#constructor) + +### Properties + +* [native](qapplication.md#native) +* [nodeChildren](qapplication.md#nodechildren) +* [nodeParent](qapplication.md#optional-nodeparent) + +### Methods + +* [exec](qapplication.md#exec) +* [exit](qapplication.md#exit) +* [processEvents](qapplication.md#processevents) +* [quit](qapplication.md#quit) +* [quitOnLastWindowClosed](qapplication.md#quitonlastwindowclosed) +* [setNodeParent](qapplication.md#setnodeparent) +* [setQuitOnLastWindowClosed](qapplication.md#setquitonlastwindowclosed) +* [clipboard](qapplication.md#static-clipboard) +* [instance](qapplication.md#static-instance) +* [style](qapplication.md#static-style) + +## Constructors + +### constructor + +\+ **new QApplication**(): *[QApplication](qapplication.md)* + +**Returns:** *[QApplication](qapplication.md)* + +\+ **new QApplication**(`native`: [NativeElement](../globals.md#nativeelement)): *[QApplication](qapplication.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QApplication](qapplication.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### exec + +▸ **exec**(): *number* + +**Returns:** *number* + +___ + +### exit + +▸ **exit**(`exitCode`: number): *number* + +**Parameters:** + +Name | Type | +------ | ------ | +`exitCode` | number | + +**Returns:** *number* + +___ + +### processEvents + +▸ **processEvents**(): *void* + +**Returns:** *void* + +___ + +### quit + +▸ **quit**(): *number* + +**Returns:** *number* + +___ + +### quitOnLastWindowClosed + +▸ **quitOnLastWindowClosed**(): *boolean* + +**Returns:** *boolean* + +___ + +### 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* + +___ + +### setQuitOnLastWindowClosed + +▸ **setQuitOnLastWindowClosed**(`quit`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`quit` | boolean | + +**Returns:** *void* + +___ + +### `Static` clipboard + +▸ **clipboard**(): *[QClipboard](qclipboard.md)* + +**Returns:** *[QClipboard](qclipboard.md)* + +___ + +### `Static` instance + +▸ **instance**(): *[QApplication](qapplication.md)* + +**Returns:** *[QApplication](qapplication.md)* + +___ + +### `Static` style + +▸ **style**(): *[QStyle](qstyle.md)* + +**Returns:** *[QStyle](qstyle.md)* diff --git a/website/docs/api/generated/classes/qboxlayout.md b/website/docs/api/generated/classes/qboxlayout.md new file mode 100644 index 000000000..58bcb9f69 --- /dev/null +++ b/website/docs/api/generated/classes/qboxlayout.md @@ -0,0 +1,478 @@ +--- +id: "qboxlayout" +title: "QBoxLayout" +sidebar_label: "QBoxLayout" +--- + +## Hierarchy + + ↳ [NodeLayout](nodelayout.md)‹[QBoxLayoutSignals](../globals.md#qboxlayoutsignals)› + + ↳ **QBoxLayout** + +## Index + +### Constructors + +* [constructor](qboxlayout.md#constructor) + +### Properties + +* [childLayouts](qboxlayout.md#childlayouts) +* [native](qboxlayout.md#native) +* [nodeChildren](qboxlayout.md#nodechildren) +* [nodeParent](qboxlayout.md#optional-nodeparent) +* [type](qboxlayout.md#type) + +### Methods + +* [activate](qboxlayout.md#activate) +* [addEventListener](qboxlayout.md#addeventlistener) +* [addLayout](qboxlayout.md#addlayout) +* [addSpacing](qboxlayout.md#addspacing) +* [addStretch](qboxlayout.md#addstretch) +* [addStrut](qboxlayout.md#addstrut) +* [addWidget](qboxlayout.md#addwidget) +* [direction](qboxlayout.md#direction) +* [inherits](qboxlayout.md#inherits) +* [insertLayout](qboxlayout.md#insertlayout) +* [insertWidget](qboxlayout.md#insertwidget) +* [invalidate](qboxlayout.md#invalidate) +* [objectName](qboxlayout.md#objectname) +* [property](qboxlayout.md#property) +* [removeEventListener](qboxlayout.md#removeeventlistener) +* [removeWidget](qboxlayout.md#removewidget) +* [setDirection](qboxlayout.md#setdirection) +* [setNodeParent](qboxlayout.md#setnodeparent) +* [setObjectName](qboxlayout.md#setobjectname) +* [setProperty](qboxlayout.md#setproperty) +* [update](qboxlayout.md#update) + +## Constructors + +### constructor + +\+ **new QBoxLayout**(`dir`: [Direction](../enums/direction.md)): *[QBoxLayout](qboxlayout.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`dir` | [Direction](../enums/direction.md) | + +**Returns:** *[QBoxLayout](qboxlayout.md)* + +\+ **new QBoxLayout**(`dir`: [Direction](../enums/direction.md), `parent`: [NodeWidget](nodewidget.md)‹any›): *[QBoxLayout](qboxlayout.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`dir` | [Direction](../enums/direction.md) | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QBoxLayout](qboxlayout.md)* + +## Properties + +### childLayouts + +• **childLayouts**: *Set‹[NodeLayout](nodelayout.md)‹any››* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "layout" + +*Inherited from [NodeLayout](nodelayout.md).[type](nodelayout.md#type)* + +## Methods + +### activate + +▸ **activate**(): *boolean* + +*Inherited from [NodeLayout](nodelayout.md).[activate](nodelayout.md#activate)* + +**Returns:** *boolean* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QBoxLayoutSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### addLayout + +▸ **addLayout**(`layout`: [NodeLayout](nodelayout.md)‹any›, `stretch`: number): *void* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`layout` | [NodeLayout](nodelayout.md)‹any› | - | +`stretch` | number | 0 | + +**Returns:** *void* + +___ + +### addSpacing + +▸ **addSpacing**(`size`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`size` | number | + +**Returns:** *void* + +___ + +### addStretch + +▸ **addStretch**(`stretch`: number): *void* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`stretch` | number | 0 | + +**Returns:** *void* + +___ + +### addStrut + +▸ **addStrut**(`size`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`size` | number | + +**Returns:** *void* + +___ + +### addWidget + +▸ **addWidget**(`widget`: [NodeWidget](nodewidget.md)‹any›, `stretch`: number): *void* + +*Overrides [NodeLayout](nodelayout.md).[addWidget](nodelayout.md#abstract-addwidget)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | - | +`stretch` | number | 0 | + +**Returns:** *void* + +___ + +### direction + +▸ **direction**(): *[Direction](../enums/direction.md)* + +**Returns:** *[Direction](../enums/direction.md)* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### insertLayout + +▸ **insertLayout**(`index`: number, `layout`: [NodeLayout](nodelayout.md)‹any›, `stretch`: number): *void* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index` | number | - | +`layout` | [NodeLayout](nodelayout.md)‹any› | - | +`stretch` | number | 0 | + +**Returns:** *void* + +___ + +### insertWidget + +▸ **insertWidget**(`index`: number, `widget`: [NodeWidget](nodewidget.md)‹any›, `stretch`: number): *void* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index` | number | - | +`widget` | [NodeWidget](nodewidget.md)‹any› | - | +`stretch` | number | 0 | + +**Returns:** *void* + +___ + +### invalidate + +▸ **invalidate**(): *void* + +*Inherited from [NodeLayout](nodelayout.md).[invalidate](nodelayout.md#invalidate)* + +**Returns:** *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`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QBoxLayoutSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### removeWidget + +▸ **removeWidget**(`widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +*Overrides [NodeLayout](nodelayout.md).[removeWidget](nodelayout.md#abstract-removewidget)* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### setDirection + +▸ **setDirection**(`dir`: [Direction](../enums/direction.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`dir` | [Direction](../enums/direction.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* + +___ + +### 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* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeLayout](nodelayout.md).[update](nodelayout.md#update)* + +**Returns:** *void* diff --git a/website/docs/api/generated/classes/qcheckbox.md b/website/docs/api/generated/classes/qcheckbox.md new file mode 100644 index 000000000..6d8742c18 --- /dev/null +++ b/website/docs/api/generated/classes/qcheckbox.md @@ -0,0 +1,1042 @@ +--- +id: "qcheckbox" +title: "QCheckBox" +sidebar_label: "QCheckBox" +--- + +> Create and control checkbox. + +**This class is a JS wrapper around Qt's [QCheckBox class](https://doc.qt.io/qt-5/qcheckbox.html)** + +A `QCheckBox` provides ability to add and manipulate native checkbox widgets. + +### Example + +```javascript +const { QCheckBox } = require("@nodegui/nodegui"); + +const checkbox = new QCheckBox(); +checkbox.setText("Hello"); +``` + +## Hierarchy + + ↳ [QAbstractButton](qabstractbutton.md)‹[QCheckBoxSignals](../globals.md#qcheckboxsignals)› + + ↳ **QCheckBox** + +## Index + +### Constructors + +* [constructor](qcheckbox.md#constructor) + +### Properties + +* [_rawInlineStyle](qcheckbox.md#_rawinlinestyle) +* [layout](qcheckbox.md#optional-layout) +* [native](qcheckbox.md#native) +* [nodeChildren](qcheckbox.md#nodechildren) +* [nodeParent](qcheckbox.md#optional-nodeparent) +* [type](qcheckbox.md#type) + +### Methods + +* [activateWindow](qcheckbox.md#activatewindow) +* [addEventListener](qcheckbox.md#addeventlistener) +* [adjustSize](qcheckbox.md#adjustsize) +* [close](qcheckbox.md#close) +* [geometry](qcheckbox.md#geometry) +* [getFlexNode](qcheckbox.md#getflexnode) +* [hasMouseTracking](qcheckbox.md#hasmousetracking) +* [hide](qcheckbox.md#hide) +* [iconSize](qcheckbox.md#iconsize) +* [inherits](qcheckbox.md#inherits) +* [isChecked](qcheckbox.md#ischecked) +* [isEnabled](qcheckbox.md#isenabled) +* [isVisible](qcheckbox.md#isvisible) +* [lower](qcheckbox.md#lower) +* [move](qcheckbox.md#move) +* [objectName](qcheckbox.md#objectname) +* [pos](qcheckbox.md#pos) +* [property](qcheckbox.md#property) +* [raise](qcheckbox.md#raise) +* [removeEventListener](qcheckbox.md#removeeventlistener) +* [repaint](qcheckbox.md#repaint) +* [resize](qcheckbox.md#resize) +* [setAttribute](qcheckbox.md#setattribute) +* [setChecked](qcheckbox.md#setchecked) +* [setContextMenuPolicy](qcheckbox.md#setcontextmenupolicy) +* [setCursor](qcheckbox.md#setcursor) +* [setEnabled](qcheckbox.md#setenabled) +* [setFixedSize](qcheckbox.md#setfixedsize) +* [setFlexNodeSizeControlled](qcheckbox.md#setflexnodesizecontrolled) +* [setGeometry](qcheckbox.md#setgeometry) +* [setIcon](qcheckbox.md#seticon) +* [setIconSize](qcheckbox.md#seticonsize) +* [setInlineStyle](qcheckbox.md#setinlinestyle) +* [setLayout](qcheckbox.md#setlayout) +* [setMaximumSize](qcheckbox.md#setmaximumsize) +* [setMinimumSize](qcheckbox.md#setminimumsize) +* [setMouseTracking](qcheckbox.md#setmousetracking) +* [setNodeParent](qcheckbox.md#setnodeparent) +* [setObjectName](qcheckbox.md#setobjectname) +* [setProperty](qcheckbox.md#setproperty) +* [setStyleSheet](qcheckbox.md#setstylesheet) +* [setText](qcheckbox.md#settext) +* [setWindowFlag](qcheckbox.md#setwindowflag) +* [setWindowIcon](qcheckbox.md#setwindowicon) +* [setWindowOpacity](qcheckbox.md#setwindowopacity) +* [setWindowState](qcheckbox.md#setwindowstate) +* [setWindowTitle](qcheckbox.md#setwindowtitle) +* [show](qcheckbox.md#show) +* [showFullScreen](qcheckbox.md#showfullscreen) +* [showMaximized](qcheckbox.md#showmaximized) +* [showMinimized](qcheckbox.md#showminimized) +* [showNormal](qcheckbox.md#shownormal) +* [size](qcheckbox.md#size) +* [styleSheet](qcheckbox.md#stylesheet) +* [testAttribute](qcheckbox.md#testattribute) +* [update](qcheckbox.md#update) +* [updateGeometry](qcheckbox.md#updategeometry) +* [windowOpacity](qcheckbox.md#windowopacity) +* [windowState](qcheckbox.md#windowstate) +* [windowTitle](qcheckbox.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QCheckBox**(): *[QCheckBox](qcheckbox.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QCheckBox](qcheckbox.md)* + +\+ **new QCheckBox**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QCheckBox](qcheckbox.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QCheckBox](qcheckbox.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QCheckBoxSignals](../globals.md#qcheckboxsignals)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QCheckBoxSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### iconSize + +▸ **iconSize**(): *[QSize](qsize.md)* + +*Inherited from [QAbstractButton](qabstractbutton.md).[iconSize](qabstractbutton.md#iconsize)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isChecked + +▸ **isChecked**(): *boolean* + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QCheckBoxSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setChecked + +▸ **setChecked**(`check`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`check` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setIcon + +▸ **setIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [QAbstractButton](qabstractbutton.md).[setIcon](qabstractbutton.md#seticon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setIconSize + +▸ **setIconSize**(`iconSize`: [QSize](qsize.md)): *void* + +*Inherited from [QAbstractButton](qabstractbutton.md).[setIconSize](qabstractbutton.md#seticonsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`iconSize` | [QSize](qsize.md) | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QCheckBoxSignals](../globals.md#qcheckboxsignals)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QCheckBoxSignals](../globals.md#qcheckboxsignals)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setText + +▸ **setText**(`text`: string): *void* + +*Inherited from [QAbstractButton](qabstractbutton.md).[setText](qabstractbutton.md#settext)* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qclipboard.md b/website/docs/api/generated/classes/qclipboard.md new file mode 100644 index 000000000..e2e8f1161 --- /dev/null +++ b/website/docs/api/generated/classes/qclipboard.md @@ -0,0 +1,144 @@ +--- +id: "qclipboard" +title: "QClipboard" +sidebar_label: "QClipboard" +--- + +> The QClipboard class provides access to the window system clipboard. + +**This class is a JS wrapper around Qt's [QClipboard class](https://doc.qt.io/qt-5/QClipboard.html)** + +### Example + +```javascript +const { +QClipboard, +QClipboardMode, +QApplication +} = require("@nodegui/nodegui"); + +const clipboard = QApplication.clipboard(); +const text = clipboard.text(QClipboardMode.Clipboard); +``` + +## Hierarchy + +* [Component](component.md) + + ↳ **QClipboard** + +## Index + +### Constructors + +* [constructor](qclipboard.md#constructor) + +### Properties + +* [native](qclipboard.md#native) +* [nodeChildren](qclipboard.md#nodechildren) +* [nodeParent](qclipboard.md#optional-nodeparent) + +### Methods + +* [clear](qclipboard.md#clear) +* [setNodeParent](qclipboard.md#setnodeparent) +* [setText](qclipboard.md#settext) +* [text](qclipboard.md#text) + +## Constructors + +### constructor + +\+ **new QClipboard**(`native`: [NativeElement](../globals.md#nativeelement)): *[QClipboard](qclipboard.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QClipboard](qclipboard.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### clear + +▸ **clear**(`mode`: [QClipboardMode](../enums/qclipboardmode.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`mode` | [QClipboardMode](../enums/qclipboardmode.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* + +___ + +### setText + +▸ **setText**(`text`: string, `mode`: [QClipboardMode](../enums/qclipboardmode.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | +`mode` | [QClipboardMode](../enums/qclipboardmode.md) | + +**Returns:** *void* + +___ + +### text + +▸ **text**(`mode`: [QClipboardMode](../enums/qclipboardmode.md)): *string* + +**Parameters:** + +Name | Type | +------ | ------ | +`mode` | [QClipboardMode](../enums/qclipboardmode.md) | + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qcolor.md b/website/docs/api/generated/classes/qcolor.md new file mode 100644 index 000000000..ff1c469a1 --- /dev/null +++ b/website/docs/api/generated/classes/qcolor.md @@ -0,0 +1,229 @@ +--- +id: "qcolor" +title: "QColor" +sidebar_label: "QColor" +--- + +## Hierarchy + +* [Component](component.md) + + ↳ **QColor** + +## Index + +### Constructors + +* [constructor](qcolor.md#constructor) + +### Properties + +* [native](qcolor.md#native) +* [nodeChildren](qcolor.md#nodechildren) +* [nodeParent](qcolor.md#optional-nodeparent) + +### Methods + +* [alpha](qcolor.md#alpha) +* [blue](qcolor.md#blue) +* [green](qcolor.md#green) +* [red](qcolor.md#red) +* [setAlpha](qcolor.md#setalpha) +* [setBlue](qcolor.md#setblue) +* [setGreen](qcolor.md#setgreen) +* [setNodeParent](qcolor.md#setnodeparent) +* [setRed](qcolor.md#setred) +* [fromQVariant](qcolor.md#static-fromqvariant) + +## Constructors + +### constructor + +\+ **new QColor**(): *[QColor](qcolor.md)* + +**Returns:** *[QColor](qcolor.md)* + +\+ **new QColor**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QColor](qcolor.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`nativeElement` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QColor](qcolor.md)* + +\+ **new QColor**(`colorString`: string): *[QColor](qcolor.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`colorString` | string | + +**Returns:** *[QColor](qcolor.md)* + +\+ **new QColor**(`color`: [GlobalColor](../enums/globalcolor.md)): *[QColor](qcolor.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`color` | [GlobalColor](../enums/globalcolor.md) | + +**Returns:** *[QColor](qcolor.md)* + +\+ **new QColor**(`r?`: undefined | number, `g?`: undefined | number, `b?`: undefined | number, `a?`: undefined | number): *[QColor](qcolor.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`r?` | undefined | number | +`g?` | undefined | number | +`b?` | undefined | number | +`a?` | undefined | number | + +**Returns:** *[QColor](qcolor.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### alpha + +▸ **alpha**(): *number* + +**Returns:** *number* + +___ + +### blue + +▸ **blue**(): *number* + +**Returns:** *number* + +___ + +### green + +▸ **green**(): *number* + +**Returns:** *number* + +___ + +### red + +▸ **red**(): *number* + +**Returns:** *number* + +___ + +### setAlpha + +▸ **setAlpha**(`value`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | number | + +**Returns:** *void* + +___ + +### setBlue + +▸ **setBlue**(`value`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | number | + +**Returns:** *void* + +___ + +### setGreen + +▸ **setGreen**(`value`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | 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* + +___ + +### setRed + +▸ **setRed**(`value`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | number | + +**Returns:** *void* + +___ + +### `Static` fromQVariant + +▸ **fromQVariant**(`variant`: [QVariant](qvariant.md)): *[QColor](qcolor.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`variant` | [QVariant](qvariant.md) | + +**Returns:** *[QColor](qcolor.md)* diff --git a/website/docs/api/generated/classes/qcombobox.md b/website/docs/api/generated/classes/qcombobox.md new file mode 100644 index 000000000..2f4e9c634 --- /dev/null +++ b/website/docs/api/generated/classes/qcombobox.md @@ -0,0 +1,1196 @@ +--- +id: "qcombobox" +title: "QComboBox" +sidebar_label: "QComboBox" +--- + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QComboBoxSignals](../interfaces/qcomboboxsignals.md)› + + ↳ **QComboBox** + +## Index + +### Constructors + +* [constructor](qcombobox.md#constructor) + +### Properties + +* [_rawInlineStyle](qcombobox.md#_rawinlinestyle) +* [layout](qcombobox.md#optional-layout) +* [native](qcombobox.md#native) +* [nodeChildren](qcombobox.md#nodechildren) +* [nodeParent](qcombobox.md#optional-nodeparent) +* [type](qcombobox.md#type) + +### Methods + +* [activateWindow](qcombobox.md#activatewindow) +* [addEventListener](qcombobox.md#addeventlistener) +* [addItem](qcombobox.md#additem) +* [addItems](qcombobox.md#additems) +* [adjustSize](qcombobox.md#adjustsize) +* [clear](qcombobox.md#clear) +* [close](qcombobox.md#close) +* [currentIndex](qcombobox.md#currentindex) +* [currentText](qcombobox.md#currenttext) +* [geometry](qcombobox.md#geometry) +* [getFlexNode](qcombobox.md#getflexnode) +* [hasMouseTracking](qcombobox.md#hasmousetracking) +* [hide](qcombobox.md#hide) +* [inherits](qcombobox.md#inherits) +* [insertItem](qcombobox.md#insertitem) +* [insertItems](qcombobox.md#insertitems) +* [insertSeparator](qcombobox.md#insertseparator) +* [isEditable](qcombobox.md#iseditable) +* [isEnabled](qcombobox.md#isenabled) +* [isVisible](qcombobox.md#isvisible) +* [itemData](qcombobox.md#itemdata) +* [itemText](qcombobox.md#itemtext) +* [lower](qcombobox.md#lower) +* [maxVisibleItems](qcombobox.md#maxvisibleitems) +* [move](qcombobox.md#move) +* [objectName](qcombobox.md#objectname) +* [pos](qcombobox.md#pos) +* [property](qcombobox.md#property) +* [raise](qcombobox.md#raise) +* [removeEventListener](qcombobox.md#removeeventlistener) +* [removeItem](qcombobox.md#removeitem) +* [repaint](qcombobox.md#repaint) +* [resize](qcombobox.md#resize) +* [setAttribute](qcombobox.md#setattribute) +* [setContextMenuPolicy](qcombobox.md#setcontextmenupolicy) +* [setCurrentIndex](qcombobox.md#setcurrentindex) +* [setCurrentText](qcombobox.md#setcurrenttext) +* [setCursor](qcombobox.md#setcursor) +* [setEditable](qcombobox.md#seteditable) +* [setEnabled](qcombobox.md#setenabled) +* [setFixedSize](qcombobox.md#setfixedsize) +* [setFlexNodeSizeControlled](qcombobox.md#setflexnodesizecontrolled) +* [setGeometry](qcombobox.md#setgeometry) +* [setInlineStyle](qcombobox.md#setinlinestyle) +* [setLayout](qcombobox.md#setlayout) +* [setMaxVisibleItems](qcombobox.md#setmaxvisibleitems) +* [setMaximumSize](qcombobox.md#setmaximumsize) +* [setMinimumSize](qcombobox.md#setminimumsize) +* [setMouseTracking](qcombobox.md#setmousetracking) +* [setNodeParent](qcombobox.md#setnodeparent) +* [setObjectName](qcombobox.md#setobjectname) +* [setProperty](qcombobox.md#setproperty) +* [setSizeAdjustPolicy](qcombobox.md#setsizeadjustpolicy) +* [setStyleSheet](qcombobox.md#setstylesheet) +* [setWindowFlag](qcombobox.md#setwindowflag) +* [setWindowIcon](qcombobox.md#setwindowicon) +* [setWindowOpacity](qcombobox.md#setwindowopacity) +* [setWindowState](qcombobox.md#setwindowstate) +* [setWindowTitle](qcombobox.md#setwindowtitle) +* [show](qcombobox.md#show) +* [showFullScreen](qcombobox.md#showfullscreen) +* [showMaximized](qcombobox.md#showmaximized) +* [showMinimized](qcombobox.md#showminimized) +* [showNormal](qcombobox.md#shownormal) +* [size](qcombobox.md#size) +* [sizeAdjustPolicy](qcombobox.md#sizeadjustpolicy) +* [styleSheet](qcombobox.md#stylesheet) +* [testAttribute](qcombobox.md#testattribute) +* [update](qcombobox.md#update) +* [updateGeometry](qcombobox.md#updategeometry) +* [windowOpacity](qcombobox.md#windowopacity) +* [windowState](qcombobox.md#windowstate) +* [windowTitle](qcombobox.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QComboBox**(): *[QComboBox](qcombobox.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QComboBox](qcombobox.md)* + +\+ **new QComboBox**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QComboBox](qcombobox.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QComboBox](qcombobox.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QComboBoxSignals](../interfaces/qcomboboxsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QComboBoxSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### addItem + +▸ **addItem**(`icon`: [QIcon](qicon.md) | undefined, `text`: string, `userData`: [QVariant](qvariant.md)): *void* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`icon` | [QIcon](qicon.md) | undefined | - | +`text` | string | - | +`userData` | [QVariant](qvariant.md) | new QVariant() | + +**Returns:** *void* + +___ + +### addItems + +▸ **addItems**(`texts`: string[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`texts` | string[] | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### clear + +▸ **clear**(): *void* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### currentIndex + +▸ **currentIndex**(): *number* + +**Returns:** *number* + +___ + +### currentText + +▸ **currentText**(): *string* + +**Returns:** *string* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### insertItem + +▸ **insertItem**(`index`: number, `icon`: [QIcon](qicon.md) | undefined, `text`: string, `userData`: [QVariant](qvariant.md)): *void* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index` | number | - | +`icon` | [QIcon](qicon.md) | undefined | - | +`text` | string | - | +`userData` | [QVariant](qvariant.md) | new QVariant() | + +**Returns:** *void* + +___ + +### insertItems + +▸ **insertItems**(`index`: number, `texts`: string[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`index` | number | +`texts` | string[] | + +**Returns:** *void* + +___ + +### insertSeparator + +▸ **insertSeparator**(`index`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`index` | number | + +**Returns:** *void* + +___ + +### isEditable + +▸ **isEditable**(): *boolean* + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### itemData + +▸ **itemData**(`index`: number): *[QVariant](qvariant.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index` | number | + +**Returns:** *[QVariant](qvariant.md)* + +___ + +### itemText + +▸ **itemText**(`index`: number): *string* + +**Parameters:** + +Name | Type | +------ | ------ | +`index` | number | + +**Returns:** *string* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### maxVisibleItems + +▸ **maxVisibleItems**(): *number* + +**Returns:** *number* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QComboBoxSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### removeItem + +▸ **removeItem**(`index`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`index` | number | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCurrentIndex + +▸ **setCurrentIndex**(`index`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`index` | number | + +**Returns:** *void* + +___ + +### setCurrentText + +▸ **setCurrentText**(`text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEditable + +▸ **setEditable**(`editable`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`editable` | boolean | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QComboBoxSignals](../interfaces/qcomboboxsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QComboBoxSignals](../interfaces/qcomboboxsignals.md)› | + +**Returns:** *void* + +___ + +### setMaxVisibleItems + +▸ **setMaxVisibleItems**(`index`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`index` | number | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setSizeAdjustPolicy + +▸ **setSizeAdjustPolicy**(`policy`: [SizeAdjustPolicy](../enums/sizeadjustpolicy.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`policy` | [SizeAdjustPolicy](../enums/sizeadjustpolicy.md) | + +**Returns:** *void* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### sizeAdjustPolicy + +▸ **sizeAdjustPolicy**(): *number* + +**Returns:** *number* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qcursor.md b/website/docs/api/generated/classes/qcursor.md new file mode 100644 index 000000000..f94123f4b --- /dev/null +++ b/website/docs/api/generated/classes/qcursor.md @@ -0,0 +1,132 @@ +--- +id: "qcursor" +title: "QCursor" +sidebar_label: "QCursor" +--- + +> The QCursor class provides scalable icons in different modes and states. + +**This class is a JS wrapper around Qt's [QCursor class](https://doc.qt.io/qt-5/qcursor.html)** + +### Example + +```javascript +const { QCursor } = require("@nodegui/nodegui"); + +const cursor = new QCursor(); +``` + +## Hierarchy + +* [Component](component.md) + + ↳ **QCursor** + +## Index + +### Constructors + +* [constructor](qcursor.md#constructor) + +### Properties + +* [native](qcursor.md#native) +* [nodeChildren](qcursor.md#nodechildren) +* [nodeParent](qcursor.md#optional-nodeparent) + +### Methods + +* [pos](qcursor.md#pos) +* [setNodeParent](qcursor.md#setnodeparent) +* [setPos](qcursor.md#setpos) + +## Constructors + +### constructor + +\+ **new QCursor**(): *[QCursor](qcursor.md)* + +**Returns:** *[QCursor](qcursor.md)* + +\+ **new QCursor**(`native`: [NativeElement](../globals.md#nativeelement)): *[QCursor](qcursor.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QCursor](qcursor.md)* + +\+ **new QCursor**(`shape`: [CursorShape](../enums/cursorshape.md)): *[QCursor](qcursor.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`shape` | [CursorShape](../enums/cursorshape.md) | + +**Returns:** *[QCursor](qcursor.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### pos + +▸ **pos**(): *object* + +**Returns:** *object* + +___ + +### 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* + +___ + +### setPos + +▸ **setPos**(`x`: number, `y`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* diff --git a/website/docs/api/generated/classes/qdial.md b/website/docs/api/generated/classes/qdial.md new file mode 100644 index 000000000..86bf265c9 --- /dev/null +++ b/website/docs/api/generated/classes/qdial.md @@ -0,0 +1,1145 @@ +--- +id: "qdial" +title: "QDial" +sidebar_label: "QDial" +--- + +> Create and control dial slider widgets. + +**This class is a JS wrapper around Qt's [QDial class](https://doc.qt.io/qt-5/qdial.html)** + +A `QDial` provides ability to add and manipulate native dial slider widgets. + +### Example + +```javascript +const { QDial } = require("@nodegui/nodegui"); + +const dial = new QDial(); +``` + +## Hierarchy + + ↳ [QAbstractSlider](qabstractslider.md)‹[QDialSignals](../globals.md#qdialsignals)› + + ↳ **QDial** + +## Index + +### Constructors + +* [constructor](qdial.md#constructor) + +### Properties + +* [_rawInlineStyle](qdial.md#_rawinlinestyle) +* [layout](qdial.md#optional-layout) +* [native](qdial.md#native) +* [nodeChildren](qdial.md#nodechildren) +* [nodeParent](qdial.md#optional-nodeparent) +* [type](qdial.md#type) + +### Methods + +* [activateWindow](qdial.md#activatewindow) +* [addEventListener](qdial.md#addeventlistener) +* [adjustSize](qdial.md#adjustsize) +* [close](qdial.md#close) +* [geometry](qdial.md#geometry) +* [getFlexNode](qdial.md#getflexnode) +* [hasMouseTracking](qdial.md#hasmousetracking) +* [hide](qdial.md#hide) +* [inherits](qdial.md#inherits) +* [isEnabled](qdial.md#isenabled) +* [isVisible](qdial.md#isvisible) +* [lower](qdial.md#lower) +* [maximum](qdial.md#maximum) +* [minimum](qdial.md#minimum) +* [move](qdial.md#move) +* [notchTarget](qdial.md#notchtarget) +* [notchesVisible](qdial.md#notchesvisible) +* [objectName](qdial.md#objectname) +* [pos](qdial.md#pos) +* [property](qdial.md#property) +* [raise](qdial.md#raise) +* [removeEventListener](qdial.md#removeeventlistener) +* [repaint](qdial.md#repaint) +* [resize](qdial.md#resize) +* [setAttribute](qdial.md#setattribute) +* [setContextMenuPolicy](qdial.md#setcontextmenupolicy) +* [setCursor](qdial.md#setcursor) +* [setEnabled](qdial.md#setenabled) +* [setFixedSize](qdial.md#setfixedsize) +* [setFlexNodeSizeControlled](qdial.md#setflexnodesizecontrolled) +* [setGeometry](qdial.md#setgeometry) +* [setInlineStyle](qdial.md#setinlinestyle) +* [setLayout](qdial.md#setlayout) +* [setMaximum](qdial.md#setmaximum) +* [setMaximumSize](qdial.md#setmaximumsize) +* [setMinimum](qdial.md#setminimum) +* [setMinimumSize](qdial.md#setminimumsize) +* [setMouseTracking](qdial.md#setmousetracking) +* [setNodeParent](qdial.md#setnodeparent) +* [setNotchTarget](qdial.md#setnotchtarget) +* [setNotchesVisible](qdial.md#setnotchesvisible) +* [setObjectName](qdial.md#setobjectname) +* [setOrientation](qdial.md#setorientation) +* [setProperty](qdial.md#setproperty) +* [setSingleStep](qdial.md#setsinglestep) +* [setStyleSheet](qdial.md#setstylesheet) +* [setValue](qdial.md#setvalue) +* [setWindowFlag](qdial.md#setwindowflag) +* [setWindowIcon](qdial.md#setwindowicon) +* [setWindowOpacity](qdial.md#setwindowopacity) +* [setWindowState](qdial.md#setwindowstate) +* [setWindowTitle](qdial.md#setwindowtitle) +* [setWrapping](qdial.md#setwrapping) +* [show](qdial.md#show) +* [showFullScreen](qdial.md#showfullscreen) +* [showMaximized](qdial.md#showmaximized) +* [showMinimized](qdial.md#showminimized) +* [showNormal](qdial.md#shownormal) +* [size](qdial.md#size) +* [styleSheet](qdial.md#stylesheet) +* [testAttribute](qdial.md#testattribute) +* [update](qdial.md#update) +* [updateGeometry](qdial.md#updategeometry) +* [value](qdial.md#value) +* [windowOpacity](qdial.md#windowopacity) +* [windowState](qdial.md#windowstate) +* [windowTitle](qdial.md#windowtitle) +* [wrapping](qdial.md#wrapping) + +## Constructors + +### constructor + +\+ **new QDial**(): *[QDial](qdial.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QDial](qdial.md)* + +\+ **new QDial**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QDial](qdial.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QDial](qdial.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QDialSignals](../globals.md#qdialsignals)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QDialSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### maximum + +▸ **maximum**(): *number* + +*Inherited from [QAbstractSlider](qabstractslider.md).[maximum](qabstractslider.md#maximum)* + +**Returns:** *number* + +___ + +### minimum + +▸ **minimum**(): *number* + +*Inherited from [QAbstractSlider](qabstractslider.md).[minimum](qabstractslider.md#minimum)* + +**Returns:** *number* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### notchTarget + +▸ **notchTarget**(): *number* + +**Returns:** *number* + +___ + +### notchesVisible + +▸ **notchesVisible**(): *boolean* + +**Returns:** *boolean* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QDialSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QDialSignals](../globals.md#qdialsignals)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QDialSignals](../globals.md#qdialsignals)› | + +**Returns:** *void* + +___ + +### setMaximum + +▸ **setMaximum**(`maximum`: number): *void* + +*Inherited from [QAbstractSlider](qabstractslider.md).[setMaximum](qabstractslider.md#setmaximum)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maximum` | number | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimum + +▸ **setMinimum**(`minimum`: number): *void* + +*Inherited from [QAbstractSlider](qabstractslider.md).[setMinimum](qabstractslider.md#setminimum)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minimum` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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* + +___ + +### setNotchTarget + +▸ **setNotchTarget**(`target`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | number | + +**Returns:** *void* + +___ + +### setNotchesVisible + +▸ **setNotchesVisible**(`visible`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`visible` | boolean | + +**Returns:** *void* + +___ + +### setObjectName + +▸ **setObjectName**(`objectName`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [NodeObject](nodeobject.md).[setObjectName](nodeobject.md#setobjectname)* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +**Returns:** *void* + +___ + +### setOrientation + +▸ **setOrientation**(`orientation`: [Orientation](../enums/orientation.md)): *void* + +*Inherited from [QAbstractSlider](qabstractslider.md).[setOrientation](qabstractslider.md#setorientation)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orientation` | [Orientation](../enums/orientation.md) | + +**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* + +___ + +### setSingleStep + +▸ **setSingleStep**(`step`: number): *void* + +*Inherited from [QAbstractSlider](qabstractslider.md).[setSingleStep](qabstractslider.md#setsinglestep)* + +**Parameters:** + +Name | Type | +------ | ------ | +`step` | number | + +**Returns:** *void* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setValue + +▸ **setValue**(`value`: number): *void* + +*Inherited from [QAbstractSlider](qabstractslider.md).[setValue](qabstractslider.md#setvalue)* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | number | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### setWrapping + +▸ **setWrapping**(`on`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`on` | boolean | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### value + +▸ **value**(): *number* + +*Inherited from [QAbstractSlider](qabstractslider.md).[value](qabstractslider.md#value)* + +**Returns:** *number* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* + +___ + +### wrapping + +▸ **wrapping**(): *boolean* + +**Returns:** *boolean* diff --git a/website/docs/api/generated/classes/qfiledialog.md b/website/docs/api/generated/classes/qfiledialog.md new file mode 100644 index 000000000..7a7815802 --- /dev/null +++ b/website/docs/api/generated/classes/qfiledialog.md @@ -0,0 +1,1129 @@ +--- +id: "qfiledialog" +title: "QFileDialog" +sidebar_label: "QFileDialog" +--- + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QFileDialogSignals](../interfaces/qfiledialogsignals.md)› + + ↳ **QFileDialog** + +## Index + +### Constructors + +* [constructor](qfiledialog.md#constructor) + +### Properties + +* [_rawInlineStyle](qfiledialog.md#_rawinlinestyle) +* [layout](qfiledialog.md#optional-layout) +* [native](qfiledialog.md#native) +* [nodeChildren](qfiledialog.md#nodechildren) +* [nodeParent](qfiledialog.md#optional-nodeparent) +* [type](qfiledialog.md#type) + +### Methods + +* [acceptMode](qfiledialog.md#acceptmode) +* [activateWindow](qfiledialog.md#activatewindow) +* [addEventListener](qfiledialog.md#addeventlistener) +* [adjustSize](qfiledialog.md#adjustsize) +* [close](qfiledialog.md#close) +* [defaultSuffix](qfiledialog.md#defaultsuffix) +* [fileMode](qfiledialog.md#filemode) +* [geometry](qfiledialog.md#geometry) +* [getFlexNode](qfiledialog.md#getflexnode) +* [hasMouseTracking](qfiledialog.md#hasmousetracking) +* [hide](qfiledialog.md#hide) +* [inherits](qfiledialog.md#inherits) +* [isEnabled](qfiledialog.md#isenabled) +* [isVisible](qfiledialog.md#isvisible) +* [labelText](qfiledialog.md#labeltext) +* [lower](qfiledialog.md#lower) +* [move](qfiledialog.md#move) +* [objectName](qfiledialog.md#objectname) +* [open](qfiledialog.md#open) +* [options](qfiledialog.md#options) +* [pos](qfiledialog.md#pos) +* [property](qfiledialog.md#property) +* [raise](qfiledialog.md#raise) +* [removeEventListener](qfiledialog.md#removeeventlistener) +* [repaint](qfiledialog.md#repaint) +* [resize](qfiledialog.md#resize) +* [setAcceptMode](qfiledialog.md#setacceptmode) +* [setAttribute](qfiledialog.md#setattribute) +* [setContextMenuPolicy](qfiledialog.md#setcontextmenupolicy) +* [setCursor](qfiledialog.md#setcursor) +* [setDefaultSuffix](qfiledialog.md#setdefaultsuffix) +* [setEnabled](qfiledialog.md#setenabled) +* [setFileMode](qfiledialog.md#setfilemode) +* [setFixedSize](qfiledialog.md#setfixedsize) +* [setFlexNodeSizeControlled](qfiledialog.md#setflexnodesizecontrolled) +* [setGeometry](qfiledialog.md#setgeometry) +* [setInlineStyle](qfiledialog.md#setinlinestyle) +* [setLabelText](qfiledialog.md#setlabeltext) +* [setLayout](qfiledialog.md#setlayout) +* [setMaximumSize](qfiledialog.md#setmaximumsize) +* [setMinimumSize](qfiledialog.md#setminimumsize) +* [setMouseTracking](qfiledialog.md#setmousetracking) +* [setNodeParent](qfiledialog.md#setnodeparent) +* [setObjectName](qfiledialog.md#setobjectname) +* [setOption](qfiledialog.md#setoption) +* [setOptions](qfiledialog.md#setoptions) +* [setProperty](qfiledialog.md#setproperty) +* [setStyleSheet](qfiledialog.md#setstylesheet) +* [setSupportedSchemes](qfiledialog.md#setsupportedschemes) +* [setWindowFlag](qfiledialog.md#setwindowflag) +* [setWindowIcon](qfiledialog.md#setwindowicon) +* [setWindowOpacity](qfiledialog.md#setwindowopacity) +* [setWindowState](qfiledialog.md#setwindowstate) +* [setWindowTitle](qfiledialog.md#setwindowtitle) +* [show](qfiledialog.md#show) +* [showFullScreen](qfiledialog.md#showfullscreen) +* [showMaximized](qfiledialog.md#showmaximized) +* [showMinimized](qfiledialog.md#showminimized) +* [showNormal](qfiledialog.md#shownormal) +* [size](qfiledialog.md#size) +* [styleSheet](qfiledialog.md#stylesheet) +* [supportedSchemes](qfiledialog.md#supportedschemes) +* [testAttribute](qfiledialog.md#testattribute) +* [update](qfiledialog.md#update) +* [updateGeometry](qfiledialog.md#updategeometry) +* [viewMode](qfiledialog.md#viewmode) +* [windowOpacity](qfiledialog.md#windowopacity) +* [windowState](qfiledialog.md#windowstate) +* [windowTitle](qfiledialog.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QFileDialog**(): *[QFileDialog](qfiledialog.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QFileDialog](qfiledialog.md)* + +\+ **new QFileDialog**(`parent`: [NodeWidget](nodewidget.md)‹any›, `caption?`: undefined | string, `directory?`: undefined | string, `filter?`: undefined | string): *[QFileDialog](qfiledialog.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | +`caption?` | undefined | string | +`directory?` | undefined | string | +`filter?` | undefined | string | + +**Returns:** *[QFileDialog](qfiledialog.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QFileDialogSignals](../interfaces/qfiledialogsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### acceptMode + +▸ **acceptMode**(): *[AcceptMode](../enums/acceptmode.md)* + +**Returns:** *[AcceptMode](../enums/acceptmode.md)* + +___ + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QFileDialogSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### defaultSuffix + +▸ **defaultSuffix**(): *string* + +**Returns:** *string* + +___ + +### fileMode + +▸ **fileMode**(): *[FileMode](../enums/filemode.md)* + +**Returns:** *[FileMode](../enums/filemode.md)* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### labelText + +▸ **labelText**(`label`: [DialogLabel](../enums/dialoglabel.md)): *string* + +**Parameters:** + +Name | Type | +------ | ------ | +`label` | [DialogLabel](../enums/dialoglabel.md) | + +**Returns:** *string* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### open + +▸ **open**(): *void* + +**Returns:** *void* + +___ + +### options + +▸ **options**(): *[Option](../enums/option.md)* + +**Returns:** *[Option](../enums/option.md)* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QFileDialogSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAcceptMode + +▸ **setAcceptMode**(`acceptMode`: [AcceptMode](../enums/acceptmode.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`acceptMode` | [AcceptMode](../enums/acceptmode.md) | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setDefaultSuffix + +▸ **setDefaultSuffix**(`defaultSuffix`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`defaultSuffix` | string | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFileMode + +▸ **setFileMode**(`fileMode`: [FileMode](../enums/filemode.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`fileMode` | [FileMode](../enums/filemode.md) | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLabelText + +▸ **setLabelText**(`label`: [DialogLabel](../enums/dialoglabel.md), `text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`label` | [DialogLabel](../enums/dialoglabel.md) | +`text` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QFileDialogSignals](../interfaces/qfiledialogsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QFileDialogSignals](../interfaces/qfiledialogsignals.md)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [NodeObject](nodeobject.md).[setObjectName](nodeobject.md#setobjectname)* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +**Returns:** *void* + +___ + +### setOption + +▸ **setOption**(`option`: [Option](../enums/option.md), `on`: boolean): *void* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`option` | [Option](../enums/option.md) | - | +`on` | boolean | true | + +**Returns:** *void* + +___ + +### setOptions + +▸ **setOptions**(`options`: [Option](../enums/option.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`options` | [Option](../enums/option.md) | + +**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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setSupportedSchemes + +▸ **setSupportedSchemes**(`schemes`: string[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`schemes` | string[] | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### supportedSchemes + +▸ **supportedSchemes**(): *string[]* + +**Returns:** *string[]* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### viewMode + +▸ **viewMode**(): *[ViewMode](../enums/viewmode.md)* + +**Returns:** *[ViewMode](../enums/viewmode.md)* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qfontdatabase.md b/website/docs/api/generated/classes/qfontdatabase.md new file mode 100644 index 000000000..a289c6d7a --- /dev/null +++ b/website/docs/api/generated/classes/qfontdatabase.md @@ -0,0 +1,153 @@ +--- +id: "qfontdatabase" +title: "QFontDatabase" +sidebar_label: "QFontDatabase" +--- + +## Hierarchy + +* [Component](component.md) + + ↳ **QFontDatabase** + +## Index + +### Constructors + +* [constructor](qfontdatabase.md#constructor) + +### Properties + +* [native](qfontdatabase.md#native) +* [nodeChildren](qfontdatabase.md#nodechildren) +* [nodeParent](qfontdatabase.md#optional-nodeparent) + +### Methods + +* [bold](qfontdatabase.md#bold) +* [italic](qfontdatabase.md#italic) +* [setNodeParent](qfontdatabase.md#setnodeparent) +* [weight](qfontdatabase.md#weight) +* [addApplicationFont](qfontdatabase.md#static-addapplicationfont) +* [removeApplicationFont](qfontdatabase.md#static-removeapplicationfont) + +## Constructors + +### constructor + +\+ **new QFontDatabase**(): *[QFontDatabase](qfontdatabase.md)* + +**Returns:** *[QFontDatabase](qfontdatabase.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### bold + +▸ **bold**(`family`: string, `style`: string): *boolean* + +**Parameters:** + +Name | Type | +------ | ------ | +`family` | string | +`style` | string | + +**Returns:** *boolean* + +___ + +### italic + +▸ **italic**(`family`: string, `style`: string): *boolean* + +**Parameters:** + +Name | Type | +------ | ------ | +`family` | string | +`style` | string | + +**Returns:** *boolean* + +___ + +### 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* + +___ + +### weight + +▸ **weight**(`family`: string, `style`: string): *number* + +**Parameters:** + +Name | Type | +------ | ------ | +`family` | string | +`style` | string | + +**Returns:** *number* + +___ + +### `Static` addApplicationFont + +▸ **addApplicationFont**(`fileName`: string): *number* + +**Parameters:** + +Name | Type | +------ | ------ | +`fileName` | string | + +**Returns:** *number* + +___ + +### `Static` removeApplicationFont + +▸ **removeApplicationFont**(`id`: number): *boolean* + +**Parameters:** + +Name | Type | +------ | ------ | +`id` | number | + +**Returns:** *boolean* diff --git a/website/docs/api/generated/classes/qgridlayout.md b/website/docs/api/generated/classes/qgridlayout.md new file mode 100644 index 000000000..0bf170389 --- /dev/null +++ b/website/docs/api/generated/classes/qgridlayout.md @@ -0,0 +1,370 @@ +--- +id: "qgridlayout" +title: "QGridLayout" +sidebar_label: "QGridLayout" +--- + +> The QGridLayout class lays out widgets in a grid. + +**This class is a JS wrapper around Qt's [QGridLayout](https://doc.qt.io/qt-5/qgridlayout.html)** + +### Example + +```javascript +const { QGridLayout, QWidget, QLabel } = require("@nodegui/nodegui"); + +const view = new QWidget(); +const layout = new QGridLayout(); +view.setLayout(layout); + +const label = new QLabel(); +label.setText("label1"); +const label2 = new QLabel(); +label2.setText("label2"); + +layout.addWidget(label); +layout.addWidget(label2); +``` + +## Hierarchy + + ↳ [NodeLayout](nodelayout.md)‹[QGridLayoutSignals](../globals.md#qgridlayoutsignals)› + + ↳ **QGridLayout** + +## Index + +### Constructors + +* [constructor](qgridlayout.md#constructor) + +### Properties + +* [native](qgridlayout.md#native) +* [nodeChildren](qgridlayout.md#nodechildren) +* [nodeParent](qgridlayout.md#optional-nodeparent) +* [type](qgridlayout.md#type) + +### Methods + +* [activate](qgridlayout.md#activate) +* [addEventListener](qgridlayout.md#addeventlistener) +* [addWidget](qgridlayout.md#addwidget) +* [inherits](qgridlayout.md#inherits) +* [invalidate](qgridlayout.md#invalidate) +* [objectName](qgridlayout.md#objectname) +* [property](qgridlayout.md#property) +* [removeEventListener](qgridlayout.md#removeeventlistener) +* [removeWidget](qgridlayout.md#removewidget) +* [setNodeParent](qgridlayout.md#setnodeparent) +* [setObjectName](qgridlayout.md#setobjectname) +* [setProperty](qgridlayout.md#setproperty) +* [update](qgridlayout.md#update) + +## Constructors + +### constructor + +\+ **new QGridLayout**(): *[QGridLayout](qgridlayout.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QGridLayout](qgridlayout.md)* + +\+ **new QGridLayout**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QGridLayout](qgridlayout.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QGridLayout](qgridlayout.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "layout" + +*Inherited from [NodeLayout](nodelayout.md).[type](nodelayout.md#type)* + +## Methods + +### activate + +▸ **activate**(): *boolean* + +*Inherited from [NodeLayout](nodelayout.md).[activate](nodelayout.md#activate)* + +**Returns:** *boolean* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QGridLayoutSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### addWidget + +▸ **addWidget**(`widget`: [NodeWidget](nodewidget.md)‹any›, `row`: number, `col`: number, `rowSpan`: number, `colSpan`: number): *void* + +*Overrides [NodeLayout](nodelayout.md).[addWidget](nodelayout.md#abstract-addwidget)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | - | +`row` | number | 0 | +`col` | number | 0 | +`rowSpan` | number | 1 | +`colSpan` | number | 1 | + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### invalidate + +▸ **invalidate**(): *void* + +*Inherited from [NodeLayout](nodelayout.md).[invalidate](nodelayout.md#invalidate)* + +**Returns:** *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`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QGridLayoutSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### removeWidget + +▸ **removeWidget**(`widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +*Overrides [NodeLayout](nodelayout.md).[removeWidget](nodelayout.md#abstract-removewidget)* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**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* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeLayout](nodelayout.md).[update](nodelayout.md#update)* + +**Returns:** *void* diff --git a/website/docs/api/generated/classes/qgroupbox.md b/website/docs/api/generated/classes/qgroupbox.md new file mode 100644 index 000000000..803f82f81 --- /dev/null +++ b/website/docs/api/generated/classes/qgroupbox.md @@ -0,0 +1,1061 @@ +--- +id: "qgroupbox" +title: "QGroupBox" +sidebar_label: "QGroupBox" +--- + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QGroupBoxSignals](../interfaces/qgroupboxsignals.md)› + + ↳ **QGroupBox** + +## Index + +### Constructors + +* [constructor](qgroupbox.md#constructor) + +### Properties + +* [_rawInlineStyle](qgroupbox.md#_rawinlinestyle) +* [layout](qgroupbox.md#optional-layout) +* [native](qgroupbox.md#native) +* [nodeChildren](qgroupbox.md#nodechildren) +* [nodeParent](qgroupbox.md#optional-nodeparent) +* [type](qgroupbox.md#type) + +### Methods + +* [activateWindow](qgroupbox.md#activatewindow) +* [addEventListener](qgroupbox.md#addeventlistener) +* [adjustSize](qgroupbox.md#adjustsize) +* [alignment](qgroupbox.md#alignment) +* [close](qgroupbox.md#close) +* [geometry](qgroupbox.md#geometry) +* [getFlexNode](qgroupbox.md#getflexnode) +* [hasMouseTracking](qgroupbox.md#hasmousetracking) +* [hide](qgroupbox.md#hide) +* [inherits](qgroupbox.md#inherits) +* [isCheckable](qgroupbox.md#ischeckable) +* [isChecked](qgroupbox.md#ischecked) +* [isEnabled](qgroupbox.md#isenabled) +* [isFlat](qgroupbox.md#isflat) +* [isVisible](qgroupbox.md#isvisible) +* [lower](qgroupbox.md#lower) +* [move](qgroupbox.md#move) +* [objectName](qgroupbox.md#objectname) +* [pos](qgroupbox.md#pos) +* [property](qgroupbox.md#property) +* [raise](qgroupbox.md#raise) +* [removeEventListener](qgroupbox.md#removeeventlistener) +* [repaint](qgroupbox.md#repaint) +* [resize](qgroupbox.md#resize) +* [setAlignment](qgroupbox.md#setalignment) +* [setAttribute](qgroupbox.md#setattribute) +* [setCheckable](qgroupbox.md#setcheckable) +* [setChecked](qgroupbox.md#setchecked) +* [setContextMenuPolicy](qgroupbox.md#setcontextmenupolicy) +* [setCursor](qgroupbox.md#setcursor) +* [setEnabled](qgroupbox.md#setenabled) +* [setFixedSize](qgroupbox.md#setfixedsize) +* [setFlat](qgroupbox.md#setflat) +* [setFlexNodeSizeControlled](qgroupbox.md#setflexnodesizecontrolled) +* [setGeometry](qgroupbox.md#setgeometry) +* [setInlineStyle](qgroupbox.md#setinlinestyle) +* [setLayout](qgroupbox.md#setlayout) +* [setMaximumSize](qgroupbox.md#setmaximumsize) +* [setMinimumSize](qgroupbox.md#setminimumsize) +* [setMouseTracking](qgroupbox.md#setmousetracking) +* [setNodeParent](qgroupbox.md#setnodeparent) +* [setObjectName](qgroupbox.md#setobjectname) +* [setProperty](qgroupbox.md#setproperty) +* [setStyleSheet](qgroupbox.md#setstylesheet) +* [setTitle](qgroupbox.md#settitle) +* [setWindowFlag](qgroupbox.md#setwindowflag) +* [setWindowIcon](qgroupbox.md#setwindowicon) +* [setWindowOpacity](qgroupbox.md#setwindowopacity) +* [setWindowState](qgroupbox.md#setwindowstate) +* [setWindowTitle](qgroupbox.md#setwindowtitle) +* [show](qgroupbox.md#show) +* [showFullScreen](qgroupbox.md#showfullscreen) +* [showMaximized](qgroupbox.md#showmaximized) +* [showMinimized](qgroupbox.md#showminimized) +* [showNormal](qgroupbox.md#shownormal) +* [size](qgroupbox.md#size) +* [styleSheet](qgroupbox.md#stylesheet) +* [testAttribute](qgroupbox.md#testattribute) +* [title](qgroupbox.md#title) +* [update](qgroupbox.md#update) +* [updateGeometry](qgroupbox.md#updategeometry) +* [windowOpacity](qgroupbox.md#windowopacity) +* [windowState](qgroupbox.md#windowstate) +* [windowTitle](qgroupbox.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QGroupBox**(): *[QGroupBox](qgroupbox.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QGroupBox](qgroupbox.md)* + +\+ **new QGroupBox**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QGroupBox](qgroupbox.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QGroupBox](qgroupbox.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QGroupBoxSignals](../interfaces/qgroupboxsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QGroupBoxSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### alignment + +▸ **alignment**(): *[AlignmentFlag](../enums/alignmentflag.md)* + +**Returns:** *[AlignmentFlag](../enums/alignmentflag.md)* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isCheckable + +▸ **isCheckable**(): *boolean* + +**Returns:** *boolean* + +___ + +### isChecked + +▸ **isChecked**(): *boolean* + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isFlat + +▸ **isFlat**(): *boolean* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QGroupBoxSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAlignment + +▸ **setAlignment**(`alignment`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`alignment` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setCheckable + +▸ **setCheckable**(`checkable`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`checkable` | boolean | + +**Returns:** *void* + +___ + +### setChecked + +▸ **setChecked**(`checked`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`checked` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlat + +▸ **setFlat**(`flat`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`flat` | boolean | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QGroupBoxSignals](../interfaces/qgroupboxsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QGroupBoxSignals](../interfaces/qgroupboxsignals.md)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setTitle + +▸ **setTitle**(`title`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### title + +▸ **title**(): *string* + +**Returns:** *string* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qicon.md b/website/docs/api/generated/classes/qicon.md new file mode 100644 index 000000000..58f0f4fcb --- /dev/null +++ b/website/docs/api/generated/classes/qicon.md @@ -0,0 +1,174 @@ +--- +id: "qicon" +title: "QIcon" +sidebar_label: "QIcon" +--- + +> The QIcon class provides scalable icons in different modes and states. + +**This class is a JS wrapper around Qt's [QIcon class](https://doc.qt.io/qt-5/qicon.html)** + +### Example + +```javascript +const { QIcon } = require("@nodegui/nodegui"); + +const imageUrl = "path/to/png"; +const icon = new QIcon(imageUrl); +``` + +## Hierarchy + +* [Component](component.md) + + ↳ **QIcon** + +## Index + +### Constructors + +* [constructor](qicon.md#constructor) + +### Properties + +* [native](qicon.md#native) +* [nodeChildren](qicon.md#nodechildren) +* [nodeParent](qicon.md#optional-nodeparent) + +### Methods + +* [cacheKey](qicon.md#cachekey) +* [isMask](qicon.md#ismask) +* [pixmap](qicon.md#pixmap) +* [setIsMask](qicon.md#setismask) +* [setNodeParent](qicon.md#setnodeparent) +* [fromQVariant](qicon.md#static-fromqvariant) + +## Constructors + +### constructor + +\+ **new QIcon**(): *[QIcon](qicon.md)* + +**Returns:** *[QIcon](qicon.md)* + +\+ **new QIcon**(`native`: [NativeElement](../globals.md#nativeelement)): *[QIcon](qicon.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QIcon](qicon.md)* + +\+ **new QIcon**(`filePath`: string): *[QIcon](qicon.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`filePath` | string | + +**Returns:** *[QIcon](qicon.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### cacheKey + +▸ **cacheKey**(): *number* + +**Returns:** *number* + +___ + +### isMask + +▸ **isMask**(): *boolean* + +**Returns:** *boolean* + +___ + +### pixmap + +▸ **pixmap**(`width`: number, `height`: number, `mode?`: [QIconMode](../enums/qiconmode.md), `state?`: [QIconState](../enums/qiconstate.md)): *[QPixmap](qpixmap.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | +`mode?` | [QIconMode](../enums/qiconmode.md) | +`state?` | [QIconState](../enums/qiconstate.md) | + +**Returns:** *[QPixmap](qpixmap.md)* + +___ + +### setIsMask + +▸ **setIsMask**(`isMask`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMask` | boolean | + +**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* + +___ + +### `Static` fromQVariant + +▸ **fromQVariant**(`variant`: [QVariant](qvariant.md)): *[QIcon](qicon.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`variant` | [QVariant](qvariant.md) | + +**Returns:** *[QIcon](qicon.md)* diff --git a/website/docs/api/generated/classes/qkeyevent.md b/website/docs/api/generated/classes/qkeyevent.md new file mode 100644 index 000000000..181e0ede4 --- /dev/null +++ b/website/docs/api/generated/classes/qkeyevent.md @@ -0,0 +1,87 @@ +--- +id: "qkeyevent" +title: "QKeyEvent" +sidebar_label: "QKeyEvent" +--- + +## Hierarchy + +* **QKeyEvent** + +## Index + +### Constructors + +* [constructor](qkeyevent.md#constructor) + +### Properties + +* [native](qkeyevent.md#native) + +### Methods + +* [count](qkeyevent.md#count) +* [isAutoRepeat](qkeyevent.md#isautorepeat) +* [key](qkeyevent.md#key) +* [modifiers](qkeyevent.md#modifiers) +* [text](qkeyevent.md#text) + +## Constructors + +### constructor + +\+ **new QKeyEvent**(`event`: [NativeElement](../globals.md#nativeelement)): *[QKeyEvent](qkeyevent.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QKeyEvent](qkeyevent.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +## Methods + +### count + +▸ **count**(): *number* + +**Returns:** *number* + +___ + +### isAutoRepeat + +▸ **isAutoRepeat**(): *boolean* + +**Returns:** *boolean* + +___ + +### key + +▸ **key**(): *number* + +**Returns:** *number* + +___ + +### modifiers + +▸ **modifiers**(): *number* + +**Returns:** *number* + +___ + +### text + +▸ **text**(): *string* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qkeysequence.md b/website/docs/api/generated/classes/qkeysequence.md new file mode 100644 index 000000000..12a881711 --- /dev/null +++ b/website/docs/api/generated/classes/qkeysequence.md @@ -0,0 +1,106 @@ +--- +id: "qkeysequence" +title: "QKeySequence" +sidebar_label: "QKeySequence" +--- + +> The QKeySequence class encapsulates a key sequence as used by shortcuts. . + +**This class is a JS wrapper around Qt's [QKeySequence class](https://doc.qt.io/qt-5/qkeysequence.html)** + +### Example + +```javascript +const { QKeySequence } = require("@nodegui/nodegui"); + +const keySequence = new QKeySequence(`Ctrl+L`); +``` + +## Hierarchy + +* [Component](component.md) + + ↳ **QKeySequence** + +## Index + +### Constructors + +* [constructor](qkeysequence.md#constructor) + +### Properties + +* [native](qkeysequence.md#native) +* [nodeChildren](qkeysequence.md#nodechildren) +* [nodeParent](qkeysequence.md#optional-nodeparent) + +### Methods + +* [count](qkeysequence.md#count) +* [setNodeParent](qkeysequence.md#setnodeparent) + +## Constructors + +### constructor + +\+ **new QKeySequence**(): *[QKeySequence](qkeysequence.md)* + +**Returns:** *[QKeySequence](qkeysequence.md)* + +\+ **new QKeySequence**(`keySequence`: string): *[QKeySequence](qkeysequence.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`keySequence` | string | + +**Returns:** *[QKeySequence](qkeysequence.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### count + +▸ **count**(): *number* + +**Returns:** *number* + +___ + +### 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* diff --git a/website/docs/api/generated/classes/qlabel.md b/website/docs/api/generated/classes/qlabel.md new file mode 100644 index 000000000..d926b8bb5 --- /dev/null +++ b/website/docs/api/generated/classes/qlabel.md @@ -0,0 +1,1181 @@ +--- +id: "qlabel" +title: "QLabel" +sidebar_label: "QLabel" +--- + +> Create and control text. + +**This class is a JS wrapper around Qt's [QLabel class](https://doc.qt.io/qt-5/qlabel.html)** + +A `QLabel` provides ability to add and manipulate text. + +### Example + +```javascript +const { QLabel } = require("@nodegui/nodegui"); + +const label = new QLabel(); +label.setText("Hello"); +``` + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QLabelSignals](../globals.md#qlabelsignals)› + + ↳ **QLabel** + +## Index + +### Constructors + +* [constructor](qlabel.md#constructor) + +### Properties + +* [_rawInlineStyle](qlabel.md#_rawinlinestyle) +* [layout](qlabel.md#optional-layout) +* [native](qlabel.md#native) +* [nodeChildren](qlabel.md#nodechildren) +* [nodeParent](qlabel.md#optional-nodeparent) +* [type](qlabel.md#type) + +### Methods + +* [activateWindow](qlabel.md#activatewindow) +* [addEventListener](qlabel.md#addeventlistener) +* [adjustSize](qlabel.md#adjustsize) +* [alignment](qlabel.md#alignment) +* [clear](qlabel.md#clear) +* [close](qlabel.md#close) +* [geometry](qlabel.md#geometry) +* [getFlexNode](qlabel.md#getflexnode) +* [hasMouseTracking](qlabel.md#hasmousetracking) +* [hide](qlabel.md#hide) +* [indent](qlabel.md#indent) +* [inherits](qlabel.md#inherits) +* [isEnabled](qlabel.md#isenabled) +* [isVisible](qlabel.md#isvisible) +* [lower](qlabel.md#lower) +* [margin](qlabel.md#margin) +* [move](qlabel.md#move) +* [movie](qlabel.md#movie) +* [objectName](qlabel.md#objectname) +* [openExternalLinks](qlabel.md#openexternallinks) +* [pixmap](qlabel.md#pixmap) +* [pos](qlabel.md#pos) +* [property](qlabel.md#property) +* [raise](qlabel.md#raise) +* [removeEventListener](qlabel.md#removeeventlistener) +* [repaint](qlabel.md#repaint) +* [resize](qlabel.md#resize) +* [setAlignment](qlabel.md#setalignment) +* [setAttribute](qlabel.md#setattribute) +* [setContextMenuPolicy](qlabel.md#setcontextmenupolicy) +* [setCursor](qlabel.md#setcursor) +* [setEnabled](qlabel.md#setenabled) +* [setFixedSize](qlabel.md#setfixedsize) +* [setFlexNodeSizeControlled](qlabel.md#setflexnodesizecontrolled) +* [setGeometry](qlabel.md#setgeometry) +* [setIndent](qlabel.md#setindent) +* [setInlineStyle](qlabel.md#setinlinestyle) +* [setLayout](qlabel.md#setlayout) +* [setMargin](qlabel.md#setmargin) +* [setMaximumSize](qlabel.md#setmaximumsize) +* [setMinimumSize](qlabel.md#setminimumsize) +* [setMouseTracking](qlabel.md#setmousetracking) +* [setMovie](qlabel.md#setmovie) +* [setNodeParent](qlabel.md#setnodeparent) +* [setObjectName](qlabel.md#setobjectname) +* [setOpenExternalLinks](qlabel.md#setopenexternallinks) +* [setPixmap](qlabel.md#setpixmap) +* [setProperty](qlabel.md#setproperty) +* [setStyleSheet](qlabel.md#setstylesheet) +* [setText](qlabel.md#settext) +* [setTextFormat](qlabel.md#settextformat) +* [setWindowFlag](qlabel.md#setwindowflag) +* [setWindowIcon](qlabel.md#setwindowicon) +* [setWindowOpacity](qlabel.md#setwindowopacity) +* [setWindowState](qlabel.md#setwindowstate) +* [setWindowTitle](qlabel.md#setwindowtitle) +* [setWordWrap](qlabel.md#setwordwrap) +* [show](qlabel.md#show) +* [showFullScreen](qlabel.md#showfullscreen) +* [showMaximized](qlabel.md#showmaximized) +* [showMinimized](qlabel.md#showminimized) +* [showNormal](qlabel.md#shownormal) +* [size](qlabel.md#size) +* [styleSheet](qlabel.md#stylesheet) +* [testAttribute](qlabel.md#testattribute) +* [text](qlabel.md#text) +* [textFormat](qlabel.md#textformat) +* [update](qlabel.md#update) +* [updateGeometry](qlabel.md#updategeometry) +* [windowOpacity](qlabel.md#windowopacity) +* [windowState](qlabel.md#windowstate) +* [windowTitle](qlabel.md#windowtitle) +* [wordWrap](qlabel.md#wordwrap) + +## Constructors + +### constructor + +\+ **new QLabel**(): *[QLabel](qlabel.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QLabel](qlabel.md)* + +\+ **new QLabel**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QLabel](qlabel.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QLabel](qlabel.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QLabelSignals](../globals.md#qlabelsignals)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QLabelSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### alignment + +▸ **alignment**(): *[AlignmentFlag](../enums/alignmentflag.md)* + +**Returns:** *[AlignmentFlag](../enums/alignmentflag.md)* + +___ + +### clear + +▸ **clear**(): *void* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### indent + +▸ **indent**(): *number* + +**Returns:** *number* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### margin + +▸ **margin**(): *number* + +**Returns:** *number* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### movie + +▸ **movie**(): *[QMovie](qmovie.md) | undefined* + +**Returns:** *[QMovie](qmovie.md) | undefined* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### openExternalLinks + +▸ **openExternalLinks**(): *boolean* + +**Returns:** *boolean* + +___ + +### pixmap + +▸ **pixmap**(): *[QPixmap](qpixmap.md) | undefined* + +**Returns:** *[QPixmap](qpixmap.md) | undefined* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QLabelSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAlignment + +▸ **setAlignment**(`alignment`: [AlignmentFlag](../enums/alignmentflag.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`alignment` | [AlignmentFlag](../enums/alignmentflag.md) | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setIndent + +▸ **setIndent**(`indent`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`indent` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QLabelSignals](../globals.md#qlabelsignals)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QLabelSignals](../globals.md#qlabelsignals)› | + +**Returns:** *void* + +___ + +### setMargin + +▸ **setMargin**(`margin`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`margin` | number | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**Returns:** *void* + +___ + +### setMovie + +▸ **setMovie**(`movie`: [QMovie](qmovie.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`movie` | [QMovie](qmovie.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* + +___ + +### setObjectName + +▸ **setObjectName**(`objectName`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [NodeObject](nodeobject.md).[setObjectName](nodeobject.md#setobjectname)* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +**Returns:** *void* + +___ + +### setOpenExternalLinks + +▸ **setOpenExternalLinks**(`open`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`open` | boolean | + +**Returns:** *void* + +___ + +### setPixmap + +▸ **setPixmap**(`pixMap`: [QPixmap](qpixmap.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pixMap` | [QPixmap](qpixmap.md) | + +**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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setText + +▸ **setText**(`text`: string | number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | number | + +**Returns:** *void* + +___ + +### setTextFormat + +▸ **setTextFormat**(`format`: [TextFormat](../enums/textformat.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`format` | [TextFormat](../enums/textformat.md) | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### setWordWrap + +▸ **setWordWrap**(`on`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`on` | boolean | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### text + +▸ **text**(): *string* + +**Returns:** *string* + +___ + +### textFormat + +▸ **textFormat**(): *[TextFormat](../enums/textformat.md)* + +**Returns:** *[TextFormat](../enums/textformat.md)* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* + +___ + +### wordWrap + +▸ **wordWrap**(): *boolean* + +**Returns:** *boolean* diff --git a/website/docs/api/generated/classes/qlineedit.md b/website/docs/api/generated/classes/qlineedit.md new file mode 100644 index 000000000..31fa2468d --- /dev/null +++ b/website/docs/api/generated/classes/qlineedit.md @@ -0,0 +1,1051 @@ +--- +id: "qlineedit" +title: "QLineEdit" +sidebar_label: "QLineEdit" +--- + +> Create and control editable text field. + +**This class is a JS wrapper around Qt's [QLineEdit class](https://doc.qt.io/qt-5/qlineedit.html)** + +A `QLineEdit` provides ability to add and manipulate native editable text field widgets. + +### Example + +```javascript +const { QLineEdit } = require("@nodegui/nodegui"); + +const lineEdit = new QLineEdit(); +``` + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QLineEditSignals](../interfaces/qlineeditsignals.md)› + + ↳ **QLineEdit** + +## Index + +### Constructors + +* [constructor](qlineedit.md#constructor) + +### Properties + +* [_rawInlineStyle](qlineedit.md#_rawinlinestyle) +* [layout](qlineedit.md#optional-layout) +* [native](qlineedit.md#native) +* [nodeChildren](qlineedit.md#nodechildren) +* [nodeParent](qlineedit.md#optional-nodeparent) +* [type](qlineedit.md#type) + +### Methods + +* [activateWindow](qlineedit.md#activatewindow) +* [addEventListener](qlineedit.md#addeventlistener) +* [adjustSize](qlineedit.md#adjustsize) +* [clear](qlineedit.md#clear) +* [close](qlineedit.md#close) +* [geometry](qlineedit.md#geometry) +* [getFlexNode](qlineedit.md#getflexnode) +* [hasMouseTracking](qlineedit.md#hasmousetracking) +* [hide](qlineedit.md#hide) +* [inherits](qlineedit.md#inherits) +* [isEnabled](qlineedit.md#isenabled) +* [isReadOnly](qlineedit.md#isreadonly) +* [isVisible](qlineedit.md#isvisible) +* [lower](qlineedit.md#lower) +* [move](qlineedit.md#move) +* [objectName](qlineedit.md#objectname) +* [placeholderText](qlineedit.md#placeholdertext) +* [pos](qlineedit.md#pos) +* [property](qlineedit.md#property) +* [raise](qlineedit.md#raise) +* [removeEventListener](qlineedit.md#removeeventlistener) +* [repaint](qlineedit.md#repaint) +* [resize](qlineedit.md#resize) +* [setAttribute](qlineedit.md#setattribute) +* [setContextMenuPolicy](qlineedit.md#setcontextmenupolicy) +* [setCursor](qlineedit.md#setcursor) +* [setEchoMode](qlineedit.md#setechomode) +* [setEnabled](qlineedit.md#setenabled) +* [setFixedSize](qlineedit.md#setfixedsize) +* [setFlexNodeSizeControlled](qlineedit.md#setflexnodesizecontrolled) +* [setGeometry](qlineedit.md#setgeometry) +* [setInlineStyle](qlineedit.md#setinlinestyle) +* [setLayout](qlineedit.md#setlayout) +* [setMaximumSize](qlineedit.md#setmaximumsize) +* [setMinimumSize](qlineedit.md#setminimumsize) +* [setMouseTracking](qlineedit.md#setmousetracking) +* [setNodeParent](qlineedit.md#setnodeparent) +* [setObjectName](qlineedit.md#setobjectname) +* [setPlaceholderText](qlineedit.md#setplaceholdertext) +* [setProperty](qlineedit.md#setproperty) +* [setReadOnly](qlineedit.md#setreadonly) +* [setStyleSheet](qlineedit.md#setstylesheet) +* [setText](qlineedit.md#settext) +* [setWindowFlag](qlineedit.md#setwindowflag) +* [setWindowIcon](qlineedit.md#setwindowicon) +* [setWindowOpacity](qlineedit.md#setwindowopacity) +* [setWindowState](qlineedit.md#setwindowstate) +* [setWindowTitle](qlineedit.md#setwindowtitle) +* [show](qlineedit.md#show) +* [showFullScreen](qlineedit.md#showfullscreen) +* [showMaximized](qlineedit.md#showmaximized) +* [showMinimized](qlineedit.md#showminimized) +* [showNormal](qlineedit.md#shownormal) +* [size](qlineedit.md#size) +* [styleSheet](qlineedit.md#stylesheet) +* [testAttribute](qlineedit.md#testattribute) +* [text](qlineedit.md#text) +* [update](qlineedit.md#update) +* [updateGeometry](qlineedit.md#updategeometry) +* [windowOpacity](qlineedit.md#windowopacity) +* [windowState](qlineedit.md#windowstate) +* [windowTitle](qlineedit.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QLineEdit**(): *[QLineEdit](qlineedit.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QLineEdit](qlineedit.md)* + +\+ **new QLineEdit**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QLineEdit](qlineedit.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QLineEdit](qlineedit.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QLineEditSignals](../interfaces/qlineeditsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QLineEditSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### clear + +▸ **clear**(): *void* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isReadOnly + +▸ **isReadOnly**(): *boolean* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### placeholderText + +▸ **placeholderText**(): *string* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QLineEditSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEchoMode + +▸ **setEchoMode**(`mode`: [EchoMode](../enums/echomode.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`mode` | [EchoMode](../enums/echomode.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QLineEditSignals](../interfaces/qlineeditsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QLineEditSignals](../interfaces/qlineeditsignals.md)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [NodeObject](nodeobject.md).[setObjectName](nodeobject.md#setobjectname)* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +**Returns:** *void* + +___ + +### setPlaceholderText + +▸ **setPlaceholderText**(`text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | 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* + +___ + +### setReadOnly + +▸ **setReadOnly**(`isReadOnly`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`isReadOnly` | boolean | + +**Returns:** *void* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setText + +▸ **setText**(`text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### text + +▸ **text**(): *string* + +**Returns:** *string* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qmainwindow.md b/website/docs/api/generated/classes/qmainwindow.md new file mode 100644 index 000000000..6dddff128 --- /dev/null +++ b/website/docs/api/generated/classes/qmainwindow.md @@ -0,0 +1,1049 @@ +--- +id: "qmainwindow" +title: "QMainWindow" +sidebar_label: "QMainWindow" +--- + +> Create and control windows. + +**This class is a JS wrapper around Qt's [QMainWindow class](https://doc.qt.io/qt-5/qmainwindow.html)** + +A `QMainWindow` provides a main application window. Every widget in NodeGui should be a child/nested child of QMainWindow. QMainWindow in NodeGui is also responsible for FlexLayout calculations of its children. + +### Example + +```javascript +const { QMainWindow, QWidget } = require("@nodegui/nodegui"); + +const win = new QMainWindow(); + +const centralWidget = new QWidget(); +win.setCentralWidget(centralWidget); + +win.show(); + +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. + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QMainWindowSignals](../globals.md#qmainwindowsignals)› + + ↳ **QMainWindow** + +## Index + +### Constructors + +* [constructor](qmainwindow.md#constructor) + +### Properties + +* [_rawInlineStyle](qmainwindow.md#_rawinlinestyle) +* [centralWidget](qmainwindow.md#optional-centralwidget) +* [native](qmainwindow.md#native) +* [nodeChildren](qmainwindow.md#nodechildren) +* [nodeParent](qmainwindow.md#optional-nodeparent) +* [type](qmainwindow.md#type) + +### Accessors + +* [layout](qmainwindow.md#layout) + +### Methods + +* [activateWindow](qmainwindow.md#activatewindow) +* [addEventListener](qmainwindow.md#addeventlistener) +* [adjustSize](qmainwindow.md#adjustsize) +* [center](qmainwindow.md#center) +* [close](qmainwindow.md#close) +* [geometry](qmainwindow.md#geometry) +* [getFlexNode](qmainwindow.md#getflexnode) +* [hasMouseTracking](qmainwindow.md#hasmousetracking) +* [hide](qmainwindow.md#hide) +* [inherits](qmainwindow.md#inherits) +* [isEnabled](qmainwindow.md#isenabled) +* [isVisible](qmainwindow.md#isvisible) +* [lower](qmainwindow.md#lower) +* [menuBar](qmainwindow.md#menubar) +* [move](qmainwindow.md#move) +* [objectName](qmainwindow.md#objectname) +* [pos](qmainwindow.md#pos) +* [property](qmainwindow.md#property) +* [raise](qmainwindow.md#raise) +* [removeEventListener](qmainwindow.md#removeeventlistener) +* [repaint](qmainwindow.md#repaint) +* [resize](qmainwindow.md#resize) +* [setAttribute](qmainwindow.md#setattribute) +* [setCentralWidget](qmainwindow.md#setcentralwidget) +* [setContextMenuPolicy](qmainwindow.md#setcontextmenupolicy) +* [setCursor](qmainwindow.md#setcursor) +* [setEnabled](qmainwindow.md#setenabled) +* [setFixedSize](qmainwindow.md#setfixedsize) +* [setFlexNodeSizeControlled](qmainwindow.md#setflexnodesizecontrolled) +* [setGeometry](qmainwindow.md#setgeometry) +* [setInlineStyle](qmainwindow.md#setinlinestyle) +* [setLayout](qmainwindow.md#setlayout) +* [setMaximumSize](qmainwindow.md#setmaximumsize) +* [setMenuBar](qmainwindow.md#setmenubar) +* [setMenuWidget](qmainwindow.md#setmenuwidget) +* [setMinimumSize](qmainwindow.md#setminimumsize) +* [setMouseTracking](qmainwindow.md#setmousetracking) +* [setNodeParent](qmainwindow.md#setnodeparent) +* [setObjectName](qmainwindow.md#setobjectname) +* [setProperty](qmainwindow.md#setproperty) +* [setStyleSheet](qmainwindow.md#setstylesheet) +* [setWindowFlag](qmainwindow.md#setwindowflag) +* [setWindowIcon](qmainwindow.md#setwindowicon) +* [setWindowOpacity](qmainwindow.md#setwindowopacity) +* [setWindowState](qmainwindow.md#setwindowstate) +* [setWindowTitle](qmainwindow.md#setwindowtitle) +* [show](qmainwindow.md#show) +* [showFullScreen](qmainwindow.md#showfullscreen) +* [showMaximized](qmainwindow.md#showmaximized) +* [showMinimized](qmainwindow.md#showminimized) +* [showNormal](qmainwindow.md#shownormal) +* [size](qmainwindow.md#size) +* [styleSheet](qmainwindow.md#stylesheet) +* [takeCentralWidget](qmainwindow.md#takecentralwidget) +* [testAttribute](qmainwindow.md#testattribute) +* [update](qmainwindow.md#update) +* [updateGeometry](qmainwindow.md#updategeometry) +* [windowOpacity](qmainwindow.md#windowopacity) +* [windowState](qmainwindow.md#windowstate) +* [windowTitle](qmainwindow.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QMainWindow**(): *[QMainWindow](qmainwindow.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QMainWindow](qmainwindow.md)* + +\+ **new QMainWindow**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QMainWindow](qmainwindow.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QMainWindow](qmainwindow.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` centralWidget + +• **centralWidget**? : *[NodeWidget](nodewidget.md)‹any› | null* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Accessors + +### layout + +• **get layout**(): *[NodeLayout](nodelayout.md)‹any› | undefined* + +*Overrides [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +**Returns:** *[NodeLayout](nodelayout.md)‹any› | undefined* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QMainWindowSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### center + +▸ **center**(): *void* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### menuBar + +▸ **menuBar**(): *[QMenuBar](qmenubar.md) | undefined* + +**Returns:** *[QMenuBar](qmenubar.md) | undefined* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QMainWindowSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setCentralWidget + +▸ **setCentralWidget**(`widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QMainWindowSignals](../globals.md#qmainwindowsignals)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QMainWindowSignals](../globals.md#qmainwindowsignals)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMenuBar + +▸ **setMenuBar**(`menuBar`: [QMenuBar](qmenubar.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`menuBar` | [QMenuBar](qmenubar.md) | + +**Returns:** *void* + +___ + +### setMenuWidget + +▸ **setMenuWidget**(`menuWidget`: [NodeWidget](nodewidget.md)‹any›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`menuWidget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### takeCentralWidget + +▸ **takeCentralWidget**(): *[NodeWidget](nodewidget.md)‹any› | null* + +**Returns:** *[NodeWidget](nodewidget.md)‹any› | null* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qmenu.md b/website/docs/api/generated/classes/qmenu.md new file mode 100644 index 000000000..1fe5ada7a --- /dev/null +++ b/website/docs/api/generated/classes/qmenu.md @@ -0,0 +1,990 @@ +--- +id: "qmenu" +title: "QMenu" +sidebar_label: "QMenu" +--- + +> The QMenu class provides a menu widget for use in menu bars, context menus, and other popup menus. + +**This class is a JS wrapper around Qt's [QMenu class](https://doc.qt.io/qt-5/qmenu.html)** + +### Example + +```javascript +const { QMenu } = require("@nodegui/nodegui"); + +const menu = new QMenu(); +``` + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QMenuSignals](../globals.md#qmenusignals)› + + ↳ **QMenu** + +## Index + +### Constructors + +* [constructor](qmenu.md#constructor) + +### Properties + +* [_rawInlineStyle](qmenu.md#_rawinlinestyle) +* [actions](qmenu.md#actions) +* [layout](qmenu.md#optional-layout) +* [native](qmenu.md#native) +* [nodeChildren](qmenu.md#nodechildren) +* [nodeParent](qmenu.md#optional-nodeparent) +* [type](qmenu.md#type) + +### Methods + +* [activateWindow](qmenu.md#activatewindow) +* [addAction](qmenu.md#addaction) +* [addEventListener](qmenu.md#addeventlistener) +* [adjustSize](qmenu.md#adjustsize) +* [close](qmenu.md#close) +* [geometry](qmenu.md#geometry) +* [getFlexNode](qmenu.md#getflexnode) +* [hasMouseTracking](qmenu.md#hasmousetracking) +* [hide](qmenu.md#hide) +* [inherits](qmenu.md#inherits) +* [isEnabled](qmenu.md#isenabled) +* [isVisible](qmenu.md#isvisible) +* [lower](qmenu.md#lower) +* [move](qmenu.md#move) +* [objectName](qmenu.md#objectname) +* [pos](qmenu.md#pos) +* [property](qmenu.md#property) +* [raise](qmenu.md#raise) +* [removeEventListener](qmenu.md#removeeventlistener) +* [repaint](qmenu.md#repaint) +* [resize](qmenu.md#resize) +* [setAttribute](qmenu.md#setattribute) +* [setContextMenuPolicy](qmenu.md#setcontextmenupolicy) +* [setCursor](qmenu.md#setcursor) +* [setEnabled](qmenu.md#setenabled) +* [setFixedSize](qmenu.md#setfixedsize) +* [setFlexNodeSizeControlled](qmenu.md#setflexnodesizecontrolled) +* [setGeometry](qmenu.md#setgeometry) +* [setInlineStyle](qmenu.md#setinlinestyle) +* [setLayout](qmenu.md#setlayout) +* [setMaximumSize](qmenu.md#setmaximumsize) +* [setMinimumSize](qmenu.md#setminimumsize) +* [setMouseTracking](qmenu.md#setmousetracking) +* [setNodeParent](qmenu.md#setnodeparent) +* [setObjectName](qmenu.md#setobjectname) +* [setProperty](qmenu.md#setproperty) +* [setStyleSheet](qmenu.md#setstylesheet) +* [setTitle](qmenu.md#settitle) +* [setWindowFlag](qmenu.md#setwindowflag) +* [setWindowIcon](qmenu.md#setwindowicon) +* [setWindowOpacity](qmenu.md#setwindowopacity) +* [setWindowState](qmenu.md#setwindowstate) +* [setWindowTitle](qmenu.md#setwindowtitle) +* [show](qmenu.md#show) +* [showFullScreen](qmenu.md#showfullscreen) +* [showMaximized](qmenu.md#showmaximized) +* [showMinimized](qmenu.md#showminimized) +* [showNormal](qmenu.md#shownormal) +* [size](qmenu.md#size) +* [styleSheet](qmenu.md#stylesheet) +* [testAttribute](qmenu.md#testattribute) +* [update](qmenu.md#update) +* [updateGeometry](qmenu.md#updategeometry) +* [windowOpacity](qmenu.md#windowopacity) +* [windowState](qmenu.md#windowstate) +* [windowTitle](qmenu.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QMenu**(): *[QMenu](qmenu.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QMenu](qmenu.md)* + +\+ **new QMenu**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QMenu](qmenu.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QMenu](qmenu.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### actions + +• **actions**: *Set‹[QAction](qaction.md)›* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QMenuSignals](../globals.md#qmenusignals)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addAction + +▸ **addAction**(`action`: [QAction](qaction.md)): *[QAction](qaction.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`action` | [QAction](qaction.md) | + +**Returns:** *[QAction](qaction.md)* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QMenuSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QMenuSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QMenuSignals](../globals.md#qmenusignals)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QMenuSignals](../globals.md#qmenusignals)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setTitle + +▸ **setTitle**(`title`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qmenubar.md b/website/docs/api/generated/classes/qmenubar.md new file mode 100644 index 000000000..86a0a4f94 --- /dev/null +++ b/website/docs/api/generated/classes/qmenubar.md @@ -0,0 +1,999 @@ +--- +id: "qmenubar" +title: "QMenuBar" +sidebar_label: "QMenuBar" +--- + +> The QMenuBar class provides a menu widget for use in menu bars, context menus, and other popup menus. + +**This class is a JS wrapper around Qt's [QMenuBar class](https://doc.qt.io/qt-5/qmenu.html)** + +### Example + +```javascript +const { QMenuBar, QMainWindow } = require("@nodegui/nodegui"); +const win = new QMainWindow(); +const menu = new QMenuBar(); +const menuBar = new QMenuBar(); +win.setMenuBar(menuBar); +win.show(); +global.win = win; +``` + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QMenuBarSignals](../globals.md#qmenubarsignals)› + + ↳ **QMenuBar** + +## Index + +### Constructors + +* [constructor](qmenubar.md#constructor) + +### Properties + +* [_rawInlineStyle](qmenubar.md#_rawinlinestyle) +* [layout](qmenubar.md#optional-layout) +* [native](qmenubar.md#native) +* [nodeChildren](qmenubar.md#nodechildren) +* [nodeParent](qmenubar.md#optional-nodeparent) +* [type](qmenubar.md#type) + +### Methods + +* [activateWindow](qmenubar.md#activatewindow) +* [addEventListener](qmenubar.md#addeventlistener) +* [addMenu](qmenubar.md#addmenu) +* [adjustSize](qmenubar.md#adjustsize) +* [close](qmenubar.md#close) +* [geometry](qmenubar.md#geometry) +* [getFlexNode](qmenubar.md#getflexnode) +* [hasMouseTracking](qmenubar.md#hasmousetracking) +* [hide](qmenubar.md#hide) +* [inherits](qmenubar.md#inherits) +* [isEnabled](qmenubar.md#isenabled) +* [isVisible](qmenubar.md#isvisible) +* [lower](qmenubar.md#lower) +* [move](qmenubar.md#move) +* [objectName](qmenubar.md#objectname) +* [pos](qmenubar.md#pos) +* [property](qmenubar.md#property) +* [raise](qmenubar.md#raise) +* [removeEventListener](qmenubar.md#removeeventlistener) +* [repaint](qmenubar.md#repaint) +* [resize](qmenubar.md#resize) +* [setAttribute](qmenubar.md#setattribute) +* [setContextMenuPolicy](qmenubar.md#setcontextmenupolicy) +* [setCursor](qmenubar.md#setcursor) +* [setEnabled](qmenubar.md#setenabled) +* [setFixedSize](qmenubar.md#setfixedsize) +* [setFlexNodeSizeControlled](qmenubar.md#setflexnodesizecontrolled) +* [setGeometry](qmenubar.md#setgeometry) +* [setInlineStyle](qmenubar.md#setinlinestyle) +* [setLayout](qmenubar.md#setlayout) +* [setMaximumSize](qmenubar.md#setmaximumsize) +* [setMinimumSize](qmenubar.md#setminimumsize) +* [setMouseTracking](qmenubar.md#setmousetracking) +* [setNativeMenuBar](qmenubar.md#setnativemenubar) +* [setNodeParent](qmenubar.md#setnodeparent) +* [setObjectName](qmenubar.md#setobjectname) +* [setProperty](qmenubar.md#setproperty) +* [setStyleSheet](qmenubar.md#setstylesheet) +* [setWindowFlag](qmenubar.md#setwindowflag) +* [setWindowIcon](qmenubar.md#setwindowicon) +* [setWindowOpacity](qmenubar.md#setwindowopacity) +* [setWindowState](qmenubar.md#setwindowstate) +* [setWindowTitle](qmenubar.md#setwindowtitle) +* [show](qmenubar.md#show) +* [showFullScreen](qmenubar.md#showfullscreen) +* [showMaximized](qmenubar.md#showmaximized) +* [showMinimized](qmenubar.md#showminimized) +* [showNormal](qmenubar.md#shownormal) +* [size](qmenubar.md#size) +* [styleSheet](qmenubar.md#stylesheet) +* [testAttribute](qmenubar.md#testattribute) +* [update](qmenubar.md#update) +* [updateGeometry](qmenubar.md#updategeometry) +* [windowOpacity](qmenubar.md#windowopacity) +* [windowState](qmenubar.md#windowstate) +* [windowTitle](qmenubar.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QMenuBar**(): *[QMenuBar](qmenubar.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QMenuBar](qmenubar.md)* + +\+ **new QMenuBar**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QMenuBar](qmenubar.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QMenuBar](qmenubar.md)* + +\+ **new QMenuBar**(`native`: [NativeElement](../globals.md#nativeelement)): *[QMenuBar](qmenubar.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QMenuBar](qmenubar.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QMenuBarSignals](../globals.md#qmenubarsignals)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QMenuBarSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### addMenu + +▸ **addMenu**(`menu`: [QMenu](qmenu.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`menu` | [QMenu](qmenu.md) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QMenuBarSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QMenuBarSignals](../globals.md#qmenubarsignals)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QMenuBarSignals](../globals.md#qmenubarsignals)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**Returns:** *void* + +___ + +### setNativeMenuBar + +▸ **setNativeMenuBar**(`nativeMenuBar`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`nativeMenuBar` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qmouseevent.md b/website/docs/api/generated/classes/qmouseevent.md new file mode 100644 index 000000000..d31e9dbf5 --- /dev/null +++ b/website/docs/api/generated/classes/qmouseevent.md @@ -0,0 +1,87 @@ +--- +id: "qmouseevent" +title: "QMouseEvent" +sidebar_label: "QMouseEvent" +--- + +## Hierarchy + +* **QMouseEvent** + +## Index + +### Constructors + +* [constructor](qmouseevent.md#constructor) + +### Properties + +* [native](qmouseevent.md#native) + +### Methods + +* [button](qmouseevent.md#button) +* [globalX](qmouseevent.md#globalx) +* [globalY](qmouseevent.md#globaly) +* [x](qmouseevent.md#x) +* [y](qmouseevent.md#y) + +## Constructors + +### constructor + +\+ **new QMouseEvent**(`event`: [NativeElement](../globals.md#nativeelement)): *[QMouseEvent](qmouseevent.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QMouseEvent](qmouseevent.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +## Methods + +### button + +▸ **button**(): *string* + +**Returns:** *string* + +___ + +### globalX + +▸ **globalX**(): *number* + +**Returns:** *number* + +___ + +### globalY + +▸ **globalY**(): *number* + +**Returns:** *number* + +___ + +### x + +▸ **x**(): *number* + +**Returns:** *number* + +___ + +### y + +▸ **y**(): *number* + +**Returns:** *number* diff --git a/website/docs/api/generated/classes/qmovie.md b/website/docs/api/generated/classes/qmovie.md new file mode 100644 index 000000000..7921f8118 --- /dev/null +++ b/website/docs/api/generated/classes/qmovie.md @@ -0,0 +1,472 @@ +--- +id: "qmovie" +title: "QMovie" +sidebar_label: "QMovie" +--- + +## Hierarchy + + ↳ [NodeObject](nodeobject.md)‹[QMovieSignals](../interfaces/qmoviesignals.md)› + + ↳ **QMovie** + +## Index + +### Constructors + +* [constructor](qmovie.md#constructor) + +### Properties + +* [native](qmovie.md#native) +* [nodeChildren](qmovie.md#nodechildren) +* [nodeParent](qmovie.md#optional-nodeparent) + +### Methods + +* [addEventListener](qmovie.md#addeventlistener) +* [currentFrameNumber](qmovie.md#currentframenumber) +* [currentPixmap](qmovie.md#currentpixmap) +* [fileName](qmovie.md#filename) +* [format](qmovie.md#format) +* [inherits](qmovie.md#inherits) +* [jumpToFrame](qmovie.md#jumptoframe) +* [jumpToNextFrame](qmovie.md#jumptonextframe) +* [loadFromData](qmovie.md#loadfromdata) +* [objectName](qmovie.md#objectname) +* [property](qmovie.md#property) +* [removeEventListener](qmovie.md#removeeventlistener) +* [setCacheMode](qmovie.md#setcachemode) +* [setFileName](qmovie.md#setfilename) +* [setFormat](qmovie.md#setformat) +* [setNodeParent](qmovie.md#setnodeparent) +* [setObjectName](qmovie.md#setobjectname) +* [setPaused](qmovie.md#setpaused) +* [setProperty](qmovie.md#setproperty) +* [setScaledSize](qmovie.md#setscaledsize) +* [setSpeed](qmovie.md#setspeed) +* [start](qmovie.md#start) +* [state](qmovie.md#state) +* [stop](qmovie.md#stop) + +## Constructors + +### constructor + +\+ **new QMovie**(): *[QMovie](qmovie.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QMovie](qmovie.md)* + +\+ **new QMovie**(`native`: [NativeElement](../globals.md#nativeelement)): *[QMovie](qmovie.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QMovie](qmovie.md)* + +\+ **new QMovie**(`parent`: [NodeObject](nodeobject.md)‹any›): *[QMovie](qmovie.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeObject](nodeobject.md)‹any› | + +**Returns:** *[QMovie](qmovie.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QMovieSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### currentFrameNumber + +▸ **currentFrameNumber**(): *number* + +**Returns:** *number* + +___ + +### currentPixmap + +▸ **currentPixmap**(): *[QPixmap](qpixmap.md)* + +**Returns:** *[QPixmap](qpixmap.md)* + +___ + +### fileName + +▸ **fileName**(): *string* + +**Returns:** *string* + +___ + +### format + +▸ **format**(): *string* + +**Returns:** *string* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### jumpToFrame + +▸ **jumpToFrame**(`frame`: number): *boolean* + +**Parameters:** + +Name | Type | +------ | ------ | +`frame` | number | + +**Returns:** *boolean* + +___ + +### jumpToNextFrame + +▸ **jumpToNextFrame**(): *boolean* + +**Returns:** *boolean* + +___ + +### loadFromData + +▸ **loadFromData**(`buffer`: Buffer): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`buffer` | Buffer | + +**Returns:** *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`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QMovieSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### setCacheMode + +▸ **setCacheMode**(`cacheMode`: [CacheMode](../enums/cachemode.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`cacheMode` | [CacheMode](../enums/cachemode.md) | + +**Returns:** *void* + +___ + +### setFileName + +▸ **setFileName**(`fileName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`fileName` | string | + +**Returns:** *void* + +___ + +### setFormat + +▸ **setFormat**(`formatName`: SupportedFormats): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`formatName` | SupportedFormats | + +**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* + +___ + +### setPaused + +▸ **setPaused**(`paused`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`paused` | boolean | + +**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* + +___ + +### setScaledSize + +▸ **setScaledSize**(`size`: [QSize](qsize.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`size` | [QSize](qsize.md) | + +**Returns:** *void* + +___ + +### setSpeed + +▸ **setSpeed**(`percentSpeed`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`percentSpeed` | number | + +**Returns:** *void* + +___ + +### start + +▸ **start**(): *void* + +**Returns:** *void* + +___ + +### state + +▸ **state**(): *[MovieState](../enums/moviestate.md)* + +**Returns:** *[MovieState](../enums/moviestate.md)* + +___ + +### stop + +▸ **stop**(): *void* + +**Returns:** *void* diff --git a/website/docs/api/generated/classes/qobject.md b/website/docs/api/generated/classes/qobject.md new file mode 100644 index 000000000..b6c478da1 --- /dev/null +++ b/website/docs/api/generated/classes/qobject.md @@ -0,0 +1,280 @@ +--- +id: "qobject" +title: "QObject" +sidebar_label: "QObject" +--- + +## Hierarchy + + ↳ [NodeObject](nodeobject.md)‹[QObjectSignals](../interfaces/qobjectsignals.md)› + + ↳ **QObject** + +## Index + +### Constructors + +* [constructor](qobject.md#constructor) + +### Properties + +* [native](qobject.md#native) +* [nodeChildren](qobject.md#nodechildren) +* [nodeParent](qobject.md#optional-nodeparent) + +### Methods + +* [addEventListener](qobject.md#addeventlistener) +* [inherits](qobject.md#inherits) +* [objectName](qobject.md#objectname) +* [property](qobject.md#property) +* [removeEventListener](qobject.md#removeeventlistener) +* [setNodeParent](qobject.md#setnodeparent) +* [setObjectName](qobject.md#setobjectname) +* [setProperty](qobject.md#setproperty) + +## Constructors + +### constructor + +\+ **new QObject**(): *[QObject](qobject.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QObject](qobject.md)* + +\+ **new QObject**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QObject](qobject.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`nativeElement` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QObject](qobject.md)* + +\+ **new QObject**(`parent`: [NodeObject](nodeobject.md)‹any›): *[QObject](qobject.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeObject](nodeobject.md)‹any› | + +**Returns:** *[QObject](qobject.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QObjectSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### 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)* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QObjectSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**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/qpainter.md b/website/docs/api/generated/classes/qpainter.md new file mode 100644 index 000000000..45a867e16 --- /dev/null +++ b/website/docs/api/generated/classes/qpainter.md @@ -0,0 +1,270 @@ +--- +id: "qpainter" +title: "QPainter" +sidebar_label: "QPainter" +--- + +## Hierarchy + +* [Component](component.md) + + ↳ **QPainter** + +## Index + +### Constructors + +* [constructor](qpainter.md#constructor) + +### Properties + +* [native](qpainter.md#native) +* [nodeChildren](qpainter.md#nodechildren) +* [nodeParent](qpainter.md#optional-nodeparent) + +### Methods + +* [begin](qpainter.md#begin) +* [drawConvexPolygon](qpainter.md#drawconvexpolygon) +* [drawLine](qpainter.md#drawline) +* [drawText](qpainter.md#drawtext) +* [end](qpainter.md#end) +* [restore](qpainter.md#restore) +* [rotate](qpainter.md#rotate) +* [save](qpainter.md#save) +* [scale](qpainter.md#scale) +* [setBrush](qpainter.md#setbrush) +* [setNodeParent](qpainter.md#setnodeparent) +* [setPen](qpainter.md#setpen) +* [setRenderHint](qpainter.md#setrenderhint) +* [translate](qpainter.md#translate) + +## Constructors + +### constructor + +\+ **new QPainter**(): *[QPainter](qpainter.md)* + +**Returns:** *[QPainter](qpainter.md)* + +\+ **new QPainter**(`device`: [Component](component.md)): *[QPainter](qpainter.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`device` | [Component](component.md) | + +**Returns:** *[QPainter](qpainter.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### begin + +▸ **begin**(`device`: [Component](component.md)): *boolean* + +**Parameters:** + +Name | Type | +------ | ------ | +`device` | [Component](component.md) | + +**Returns:** *boolean* + +___ + +### drawConvexPolygon + +▸ **drawConvexPolygon**(`points`: [QPoint](qpoint.md)[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`points` | [QPoint](qpoint.md)[] | + +**Returns:** *void* + +___ + +### drawLine + +▸ **drawLine**(`x1`: number, `y1`: number, `x2`: number, `y2`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`x1` | number | +`y1` | number | +`x2` | number | +`y2` | number | + +**Returns:** *void* + +___ + +### drawText + +▸ **drawText**(`x`: number, `y`: number, `text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`text` | string | + +**Returns:** *void* + +___ + +### end + +▸ **end**(): *boolean* + +**Returns:** *boolean* + +___ + +### restore + +▸ **restore**(): *void* + +**Returns:** *void* + +___ + +### rotate + +▸ **rotate**(`angle`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`angle` | number | + +**Returns:** *void* + +___ + +### save + +▸ **save**(): *void* + +**Returns:** *void* + +___ + +### scale + +▸ **scale**(`sx`: number, `sy`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`sx` | number | +`sy` | number | + +**Returns:** *void* + +___ + +### setBrush + +▸ **setBrush**(`color`: [QColor](qcolor.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`color` | [QColor](qcolor.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* + +___ + +### setPen + +▸ **setPen**(`arg`: [PenStyle](../enums/penstyle.md) | [QColor](qcolor.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`arg` | [PenStyle](../enums/penstyle.md) | [QColor](qcolor.md) | + +**Returns:** *void* + +___ + +### setRenderHint + +▸ **setRenderHint**(`hint`: [RenderHint](../enums/renderhint.md), `on`: boolean): *void* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`hint` | [RenderHint](../enums/renderhint.md) | - | +`on` | boolean | true | + +**Returns:** *void* + +___ + +### translate + +▸ **translate**(`dx`: number, `dy`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`dx` | number | +`dy` | number | + +**Returns:** *void* diff --git a/website/docs/api/generated/classes/qpixmap.md b/website/docs/api/generated/classes/qpixmap.md new file mode 100644 index 000000000..36b31a006 --- /dev/null +++ b/website/docs/api/generated/classes/qpixmap.md @@ -0,0 +1,208 @@ +--- +id: "qpixmap" +title: "QPixmap" +sidebar_label: "QPixmap" +--- + +> The QPixmap class helps hold an image in the form of off-screen image representation. + +**This class is a JS wrapper around Qt's [QPixmap class](https://doc.qt.io/qt-5/qpixmap.html)** + +A `QPixmap` provides ability to store an image in the memory. + +### Example + +```javascript +const { QPixmap } = require("@nodegui/nodegui"); + +const imageUrl = "path/to/png"; +const pixMap = new QPixmap(imageUrl); +``` + +## Hierarchy + +* [Component](component.md) + + ↳ **QPixmap** + +## Index + +### Constructors + +* [constructor](qpixmap.md#constructor) + +### Properties + +* [native](qpixmap.md#native) +* [nodeChildren](qpixmap.md#nodechildren) +* [nodeParent](qpixmap.md#optional-nodeparent) + +### Methods + +* [height](qpixmap.md#height) +* [load](qpixmap.md#load) +* [loadFromData](qpixmap.md#loadfromdata) +* [save](qpixmap.md#save) +* [scaled](qpixmap.md#scaled) +* [setNodeParent](qpixmap.md#setnodeparent) +* [width](qpixmap.md#width) +* [fromQVariant](qpixmap.md#static-fromqvariant) + +## Constructors + +### constructor + +\+ **new QPixmap**(): *[QPixmap](qpixmap.md)* + +**Returns:** *[QPixmap](qpixmap.md)* + +\+ **new QPixmap**(`native`: [NativeElement](../globals.md#nativeelement)): *[QPixmap](qpixmap.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QPixmap](qpixmap.md)* + +\+ **new QPixmap**(`filePath`: string): *[QPixmap](qpixmap.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`filePath` | string | + +**Returns:** *[QPixmap](qpixmap.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### height + +▸ **height**(): *number* + +**Returns:** *number* + +___ + +### load + +▸ **load**(`imagePath`: string): *boolean* + +**Parameters:** + +Name | Type | +------ | ------ | +`imagePath` | string | + +**Returns:** *boolean* + +___ + +### loadFromData + +▸ **loadFromData**(`buffer`: Buffer, `format?`: [ImageFormats](../globals.md#imageformats)): *boolean* + +**Parameters:** + +Name | Type | +------ | ------ | +`buffer` | Buffer | +`format?` | [ImageFormats](../globals.md#imageformats) | + +**Returns:** *boolean* + +___ + +### save + +▸ **save**(`fileName`: string, `format?`: [ImageFormats](../globals.md#imageformats)): *boolean* + +**Parameters:** + +Name | Type | +------ | ------ | +`fileName` | string | +`format?` | [ImageFormats](../globals.md#imageformats) | + +**Returns:** *boolean* + +___ + +### scaled + +▸ **scaled**(`width`: number, `height`: number, `aspectRatioMode?`: [AspectRatioMode](../enums/aspectratiomode.md), `transformationMode?`: [TransformationMode](../enums/transformationmode.md)): *[QPixmap](qpixmap.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | +`aspectRatioMode?` | [AspectRatioMode](../enums/aspectratiomode.md) | +`transformationMode?` | [TransformationMode](../enums/transformationmode.md) | + +**Returns:** *[QPixmap](qpixmap.md)* + +___ + +### 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* + +___ + +### width + +▸ **width**(): *number* + +**Returns:** *number* + +___ + +### `Static` fromQVariant + +▸ **fromQVariant**(`variant`: [QVariant](qvariant.md)): *[QPixmap](qpixmap.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`variant` | [QVariant](qvariant.md) | + +**Returns:** *[QPixmap](qpixmap.md)* diff --git a/website/docs/api/generated/classes/qplaintextedit.md b/website/docs/api/generated/classes/qplaintextedit.md new file mode 100644 index 000000000..017cdbf4e --- /dev/null +++ b/website/docs/api/generated/classes/qplaintextedit.md @@ -0,0 +1,1159 @@ +--- +id: "qplaintextedit" +title: "QPlainTextEdit" +sidebar_label: "QPlainTextEdit" +--- + +> Used to edit and display plain text. + +**This class is a JS wrapper around Qt's [QPlainTextEdit class](https://doc.qt.io/qt-5/qplaintextedit.html)** + +A `QPlainTextEdit` provides ability to add and manipulate native editable text field widgets. + +### Example + +```javascript +const { QPlainTextEdit } = require("@nodegui/nodegui"); + +const plainTextEdit = new QPlainTextEdit(); +``` + +## Hierarchy + + ↳ [QAbstractScrollArea](qabstractscrollarea.md)‹[QPlainTextEditSignals](../interfaces/qplaintexteditsignals.md)› + + ↳ **QPlainTextEdit** + +## Index + +### Constructors + +* [constructor](qplaintextedit.md#constructor) + +### Properties + +* [_rawInlineStyle](qplaintextedit.md#_rawinlinestyle) +* [layout](qplaintextedit.md#optional-layout) +* [native](qplaintextedit.md#native) +* [nodeChildren](qplaintextedit.md#nodechildren) +* [nodeParent](qplaintextedit.md#optional-nodeparent) +* [placeholderText](qplaintextedit.md#optional-placeholdertext) +* [type](qplaintextedit.md#type) +* [viewportWidget](qplaintextedit.md#optional-viewportwidget) + +### Methods + +* [activateWindow](qplaintextedit.md#activatewindow) +* [addEventListener](qplaintextedit.md#addeventlistener) +* [adjustSize](qplaintextedit.md#adjustsize) +* [clear](qplaintextedit.md#clear) +* [close](qplaintextedit.md#close) +* [geometry](qplaintextedit.md#geometry) +* [getFlexNode](qplaintextedit.md#getflexnode) +* [hasMouseTracking](qplaintextedit.md#hasmousetracking) +* [hide](qplaintextedit.md#hide) +* [inherits](qplaintextedit.md#inherits) +* [insertPlainText](qplaintextedit.md#insertplaintext) +* [isEnabled](qplaintextedit.md#isenabled) +* [isVisible](qplaintextedit.md#isvisible) +* [lineWrapMode](qplaintextedit.md#linewrapmode) +* [lower](qplaintextedit.md#lower) +* [move](qplaintextedit.md#move) +* [objectName](qplaintextedit.md#objectname) +* [pos](qplaintextedit.md#pos) +* [property](qplaintextedit.md#property) +* [raise](qplaintextedit.md#raise) +* [removeEventListener](qplaintextedit.md#removeeventlistener) +* [repaint](qplaintextedit.md#repaint) +* [resize](qplaintextedit.md#resize) +* [setAttribute](qplaintextedit.md#setattribute) +* [setContextMenuPolicy](qplaintextedit.md#setcontextmenupolicy) +* [setCursor](qplaintextedit.md#setcursor) +* [setEnabled](qplaintextedit.md#setenabled) +* [setFixedSize](qplaintextedit.md#setfixedsize) +* [setFlexNodeSizeControlled](qplaintextedit.md#setflexnodesizecontrolled) +* [setGeometry](qplaintextedit.md#setgeometry) +* [setHorizontalScrollBarPolicy](qplaintextedit.md#sethorizontalscrollbarpolicy) +* [setInlineStyle](qplaintextedit.md#setinlinestyle) +* [setLayout](qplaintextedit.md#setlayout) +* [setLineWrapMode](qplaintextedit.md#setlinewrapmode) +* [setMaximumSize](qplaintextedit.md#setmaximumsize) +* [setMinimumSize](qplaintextedit.md#setminimumsize) +* [setMouseTracking](qplaintextedit.md#setmousetracking) +* [setNodeParent](qplaintextedit.md#setnodeparent) +* [setObjectName](qplaintextedit.md#setobjectname) +* [setPlaceholderText](qplaintextedit.md#setplaceholdertext) +* [setPlainText](qplaintextedit.md#setplaintext) +* [setProperty](qplaintextedit.md#setproperty) +* [setReadOnly](qplaintextedit.md#setreadonly) +* [setStyleSheet](qplaintextedit.md#setstylesheet) +* [setVerticalScrollBarPolicy](qplaintextedit.md#setverticalscrollbarpolicy) +* [setViewport](qplaintextedit.md#setviewport) +* [setWindowFlag](qplaintextedit.md#setwindowflag) +* [setWindowIcon](qplaintextedit.md#setwindowicon) +* [setWindowOpacity](qplaintextedit.md#setwindowopacity) +* [setWindowState](qplaintextedit.md#setwindowstate) +* [setWindowTitle](qplaintextedit.md#setwindowtitle) +* [setWordWrapMode](qplaintextedit.md#setwordwrapmode) +* [show](qplaintextedit.md#show) +* [showFullScreen](qplaintextedit.md#showfullscreen) +* [showMaximized](qplaintextedit.md#showmaximized) +* [showMinimized](qplaintextedit.md#showminimized) +* [showNormal](qplaintextedit.md#shownormal) +* [size](qplaintextedit.md#size) +* [styleSheet](qplaintextedit.md#stylesheet) +* [testAttribute](qplaintextedit.md#testattribute) +* [toPlainText](qplaintextedit.md#toplaintext) +* [update](qplaintextedit.md#update) +* [updateGeometry](qplaintextedit.md#updategeometry) +* [viewport](qplaintextedit.md#viewport) +* [windowOpacity](qplaintextedit.md#windowopacity) +* [windowState](qplaintextedit.md#windowstate) +* [windowTitle](qplaintextedit.md#windowtitle) +* [wordWrapMode](qplaintextedit.md#wordwrapmode) + +## Constructors + +### constructor + +\+ **new QPlainTextEdit**(): *[QPlainTextEdit](qplaintextedit.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QPlainTextEdit](qplaintextedit.md)* + +\+ **new QPlainTextEdit**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QPlainTextEdit](qplaintextedit.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QPlainTextEdit](qplaintextedit.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QPlainTextEditSignals](../interfaces/qplaintexteditsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### `Optional` placeholderText + +• **placeholderText**? : *undefined | string* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +___ + +### `Optional` viewportWidget + +• **viewportWidget**? : *[NodeWidget](nodewidget.md)‹any›* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[viewportWidget](qabstractscrollarea.md#optional-viewportwidget)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QPlainTextEditSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### clear + +▸ **clear**(): *void* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### insertPlainText + +▸ **insertPlainText**(`text`: string | number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | number | + +**Returns:** *void* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lineWrapMode + +▸ **lineWrapMode**(): *[LineWrapMode](../enums/linewrapmode.md)* + +**Returns:** *[LineWrapMode](../enums/linewrapmode.md)* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QPlainTextEditSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setHorizontalScrollBarPolicy + +▸ **setHorizontalScrollBarPolicy**(`policy`: [ScrollBarPolicy](../enums/scrollbarpolicy.md)): *void* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[setHorizontalScrollBarPolicy](qabstractscrollarea.md#sethorizontalscrollbarpolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`policy` | [ScrollBarPolicy](../enums/scrollbarpolicy.md) | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QPlainTextEditSignals](../interfaces/qplaintexteditsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QPlainTextEditSignals](../interfaces/qplaintexteditsignals.md)› | + +**Returns:** *void* + +___ + +### setLineWrapMode + +▸ **setLineWrapMode**(`mode`: [LineWrapMode](../enums/linewrapmode.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`mode` | [LineWrapMode](../enums/linewrapmode.md) | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [NodeObject](nodeobject.md).[setObjectName](nodeobject.md#setobjectname)* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +**Returns:** *void* + +___ + +### setPlaceholderText + +▸ **setPlaceholderText**(`text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +**Returns:** *void* + +___ + +### setPlainText + +▸ **setPlainText**(`text`: string | number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | number | + +**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* + +___ + +### setReadOnly + +▸ **setReadOnly**(`isReadOnly`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`isReadOnly` | boolean | + +**Returns:** *void* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setVerticalScrollBarPolicy + +▸ **setVerticalScrollBarPolicy**(`policy`: [ScrollBarPolicy](../enums/scrollbarpolicy.md)): *void* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[setVerticalScrollBarPolicy](qabstractscrollarea.md#setverticalscrollbarpolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`policy` | [ScrollBarPolicy](../enums/scrollbarpolicy.md) | + +**Returns:** *void* + +___ + +### setViewport + +▸ **setViewport**(`widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[setViewport](qabstractscrollarea.md#setviewport)* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### setWordWrapMode + +▸ **setWordWrapMode**(`mode`: [QTextOptionWrapMode](../enums/qtextoptionwrapmode.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`mode` | [QTextOptionWrapMode](../enums/qtextoptionwrapmode.md) | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### toPlainText + +▸ **toPlainText**(): *string* + +**Returns:** *string* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### viewport + +▸ **viewport**(): *[QWidget](qwidget.md)* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[viewport](qabstractscrollarea.md#viewport)* + +**Returns:** *[QWidget](qwidget.md)* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* + +___ + +### wordWrapMode + +▸ **wordWrapMode**(): *[QTextOptionWrapMode](../enums/qtextoptionwrapmode.md)* + +**Returns:** *[QTextOptionWrapMode](../enums/qtextoptionwrapmode.md)* diff --git a/website/docs/api/generated/classes/qpoint.md b/website/docs/api/generated/classes/qpoint.md new file mode 100644 index 000000000..c7b55499f --- /dev/null +++ b/website/docs/api/generated/classes/qpoint.md @@ -0,0 +1,159 @@ +--- +id: "qpoint" +title: "QPoint" +sidebar_label: "QPoint" +--- + +## Hierarchy + +* [Component](component.md) + + ↳ **QPoint** + +## Index + +### Constructors + +* [constructor](qpoint.md#constructor) + +### Properties + +* [native](qpoint.md#native) +* [nodeChildren](qpoint.md#nodechildren) +* [nodeParent](qpoint.md#optional-nodeparent) + +### Methods + +* [setNodeParent](qpoint.md#setnodeparent) +* [setX](qpoint.md#setx) +* [setY](qpoint.md#sety) +* [x](qpoint.md#x) +* [y](qpoint.md#y) +* [fromQVariant](qpoint.md#static-fromqvariant) + +## Constructors + +### constructor + +\+ **new QPoint**(): *[QPoint](qpoint.md)* + +**Returns:** *[QPoint](qpoint.md)* + +\+ **new QPoint**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QPoint](qpoint.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`nativeElement` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QPoint](qpoint.md)* + +\+ **new QPoint**(`x?`: undefined | number, `y?`: undefined | number): *[QPoint](qpoint.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x?` | undefined | number | +`y?` | undefined | number | + +**Returns:** *[QPoint](qpoint.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### 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* + +___ + +### setX + +▸ **setX**(`value`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | number | + +**Returns:** *void* + +___ + +### setY + +▸ **setY**(`value`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | number | + +**Returns:** *void* + +___ + +### x + +▸ **x**(): *number* + +**Returns:** *number* + +___ + +### y + +▸ **y**(): *number* + +**Returns:** *number* + +___ + +### `Static` fromQVariant + +▸ **fromQVariant**(`variant`: [QVariant](qvariant.md)): *[QPoint](qpoint.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`variant` | [QVariant](qvariant.md) | + +**Returns:** *[QPoint](qpoint.md)* diff --git a/website/docs/api/generated/classes/qprogressbar.md b/website/docs/api/generated/classes/qprogressbar.md new file mode 100644 index 000000000..e111888fe --- /dev/null +++ b/website/docs/api/generated/classes/qprogressbar.md @@ -0,0 +1,1024 @@ +--- +id: "qprogressbar" +title: "QProgressBar" +sidebar_label: "QProgressBar" +--- + +> Create and control progress bar widgets. + +**This class is a JS wrapper around Qt's [QProgressBar class](https://doc.qt.io/qt-5/qprogressbar.html)** + +A `QProgressBar` provides ability to add and manipulate native progress bar widgets. + +### Example + +```javascript +const { QProgressBar } = require("@nodegui/nodegui"); + +const progressBar = new QProgressBar(); +``` + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QProgressBarSignals](../interfaces/qprogressbarsignals.md)› + + ↳ **QProgressBar** + +## Index + +### Constructors + +* [constructor](qprogressbar.md#constructor) + +### Properties + +* [_rawInlineStyle](qprogressbar.md#_rawinlinestyle) +* [layout](qprogressbar.md#optional-layout) +* [native](qprogressbar.md#native) +* [nodeChildren](qprogressbar.md#nodechildren) +* [nodeParent](qprogressbar.md#optional-nodeparent) +* [type](qprogressbar.md#type) + +### Methods + +* [activateWindow](qprogressbar.md#activatewindow) +* [addEventListener](qprogressbar.md#addeventlistener) +* [adjustSize](qprogressbar.md#adjustsize) +* [close](qprogressbar.md#close) +* [geometry](qprogressbar.md#geometry) +* [getFlexNode](qprogressbar.md#getflexnode) +* [hasMouseTracking](qprogressbar.md#hasmousetracking) +* [hide](qprogressbar.md#hide) +* [inherits](qprogressbar.md#inherits) +* [isEnabled](qprogressbar.md#isenabled) +* [isVisible](qprogressbar.md#isvisible) +* [lower](qprogressbar.md#lower) +* [move](qprogressbar.md#move) +* [objectName](qprogressbar.md#objectname) +* [pos](qprogressbar.md#pos) +* [property](qprogressbar.md#property) +* [raise](qprogressbar.md#raise) +* [removeEventListener](qprogressbar.md#removeeventlistener) +* [repaint](qprogressbar.md#repaint) +* [resize](qprogressbar.md#resize) +* [setAttribute](qprogressbar.md#setattribute) +* [setContextMenuPolicy](qprogressbar.md#setcontextmenupolicy) +* [setCursor](qprogressbar.md#setcursor) +* [setEnabled](qprogressbar.md#setenabled) +* [setFixedSize](qprogressbar.md#setfixedsize) +* [setFlexNodeSizeControlled](qprogressbar.md#setflexnodesizecontrolled) +* [setGeometry](qprogressbar.md#setgeometry) +* [setInlineStyle](qprogressbar.md#setinlinestyle) +* [setLayout](qprogressbar.md#setlayout) +* [setMaximum](qprogressbar.md#setmaximum) +* [setMaximumSize](qprogressbar.md#setmaximumsize) +* [setMinimum](qprogressbar.md#setminimum) +* [setMinimumSize](qprogressbar.md#setminimumsize) +* [setMouseTracking](qprogressbar.md#setmousetracking) +* [setNodeParent](qprogressbar.md#setnodeparent) +* [setObjectName](qprogressbar.md#setobjectname) +* [setOrientation](qprogressbar.md#setorientation) +* [setProperty](qprogressbar.md#setproperty) +* [setStyleSheet](qprogressbar.md#setstylesheet) +* [setValue](qprogressbar.md#setvalue) +* [setWindowFlag](qprogressbar.md#setwindowflag) +* [setWindowIcon](qprogressbar.md#setwindowicon) +* [setWindowOpacity](qprogressbar.md#setwindowopacity) +* [setWindowState](qprogressbar.md#setwindowstate) +* [setWindowTitle](qprogressbar.md#setwindowtitle) +* [show](qprogressbar.md#show) +* [showFullScreen](qprogressbar.md#showfullscreen) +* [showMaximized](qprogressbar.md#showmaximized) +* [showMinimized](qprogressbar.md#showminimized) +* [showNormal](qprogressbar.md#shownormal) +* [size](qprogressbar.md#size) +* [styleSheet](qprogressbar.md#stylesheet) +* [testAttribute](qprogressbar.md#testattribute) +* [update](qprogressbar.md#update) +* [updateGeometry](qprogressbar.md#updategeometry) +* [value](qprogressbar.md#value) +* [windowOpacity](qprogressbar.md#windowopacity) +* [windowState](qprogressbar.md#windowstate) +* [windowTitle](qprogressbar.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QProgressBar**(): *[QProgressBar](qprogressbar.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QProgressBar](qprogressbar.md)* + +\+ **new QProgressBar**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QProgressBar](qprogressbar.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QProgressBar](qprogressbar.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QProgressBarSignals](../interfaces/qprogressbarsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QProgressBarSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QProgressBarSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QProgressBarSignals](../interfaces/qprogressbarsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QProgressBarSignals](../interfaces/qprogressbarsignals.md)› | + +**Returns:** *void* + +___ + +### setMaximum + +▸ **setMaximum**(`max`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`max` | number | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimum + +▸ **setMinimum**(`min`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`min` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [NodeObject](nodeobject.md).[setObjectName](nodeobject.md#setobjectname)* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +**Returns:** *void* + +___ + +### setOrientation + +▸ **setOrientation**(`orientation`: [Orientation](../enums/orientation.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`orientation` | [Orientation](../enums/orientation.md) | + +**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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setValue + +▸ **setValue**(`value`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | number | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### value + +▸ **value**(): *number* + +**Returns:** *number* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qpushbutton.md b/website/docs/api/generated/classes/qpushbutton.md new file mode 100644 index 000000000..f35023eb2 --- /dev/null +++ b/website/docs/api/generated/classes/qpushbutton.md @@ -0,0 +1,1033 @@ +--- +id: "qpushbutton" +title: "QPushButton" +sidebar_label: "QPushButton" +--- + +> Create and control buttons. + +**This class is a JS wrapper around Qt's [QPushButton class](https://doc.qt.io/qt-5/qpushbutton.html)** + +A `QPushButton` provides ability to add and manipulate native button widgets. + +### Example + +```javascript +const { QPushButton } = require("@nodegui/nodegui"); + +const button = new QPushButton(); +button.setText("Hello"); +``` + +## Hierarchy + + ↳ [QAbstractButton](qabstractbutton.md)‹[QPushButtonSignals](../globals.md#qpushbuttonsignals)› + + ↳ **QPushButton** + +## Index + +### Constructors + +* [constructor](qpushbutton.md#constructor) + +### Properties + +* [_rawInlineStyle](qpushbutton.md#_rawinlinestyle) +* [layout](qpushbutton.md#optional-layout) +* [native](qpushbutton.md#native) +* [nodeChildren](qpushbutton.md#nodechildren) +* [nodeParent](qpushbutton.md#optional-nodeparent) +* [type](qpushbutton.md#type) + +### Methods + +* [activateWindow](qpushbutton.md#activatewindow) +* [addEventListener](qpushbutton.md#addeventlistener) +* [adjustSize](qpushbutton.md#adjustsize) +* [close](qpushbutton.md#close) +* [geometry](qpushbutton.md#geometry) +* [getFlexNode](qpushbutton.md#getflexnode) +* [hasMouseTracking](qpushbutton.md#hasmousetracking) +* [hide](qpushbutton.md#hide) +* [iconSize](qpushbutton.md#iconsize) +* [inherits](qpushbutton.md#inherits) +* [isEnabled](qpushbutton.md#isenabled) +* [isVisible](qpushbutton.md#isvisible) +* [lower](qpushbutton.md#lower) +* [move](qpushbutton.md#move) +* [objectName](qpushbutton.md#objectname) +* [pos](qpushbutton.md#pos) +* [property](qpushbutton.md#property) +* [raise](qpushbutton.md#raise) +* [removeEventListener](qpushbutton.md#removeeventlistener) +* [repaint](qpushbutton.md#repaint) +* [resize](qpushbutton.md#resize) +* [setAttribute](qpushbutton.md#setattribute) +* [setContextMenuPolicy](qpushbutton.md#setcontextmenupolicy) +* [setCursor](qpushbutton.md#setcursor) +* [setEnabled](qpushbutton.md#setenabled) +* [setFixedSize](qpushbutton.md#setfixedsize) +* [setFlat](qpushbutton.md#setflat) +* [setFlexNodeSizeControlled](qpushbutton.md#setflexnodesizecontrolled) +* [setGeometry](qpushbutton.md#setgeometry) +* [setIcon](qpushbutton.md#seticon) +* [setIconSize](qpushbutton.md#seticonsize) +* [setInlineStyle](qpushbutton.md#setinlinestyle) +* [setLayout](qpushbutton.md#setlayout) +* [setMaximumSize](qpushbutton.md#setmaximumsize) +* [setMinimumSize](qpushbutton.md#setminimumsize) +* [setMouseTracking](qpushbutton.md#setmousetracking) +* [setNodeParent](qpushbutton.md#setnodeparent) +* [setObjectName](qpushbutton.md#setobjectname) +* [setProperty](qpushbutton.md#setproperty) +* [setStyleSheet](qpushbutton.md#setstylesheet) +* [setText](qpushbutton.md#settext) +* [setWindowFlag](qpushbutton.md#setwindowflag) +* [setWindowIcon](qpushbutton.md#setwindowicon) +* [setWindowOpacity](qpushbutton.md#setwindowopacity) +* [setWindowState](qpushbutton.md#setwindowstate) +* [setWindowTitle](qpushbutton.md#setwindowtitle) +* [show](qpushbutton.md#show) +* [showFullScreen](qpushbutton.md#showfullscreen) +* [showMaximized](qpushbutton.md#showmaximized) +* [showMinimized](qpushbutton.md#showminimized) +* [showNormal](qpushbutton.md#shownormal) +* [size](qpushbutton.md#size) +* [styleSheet](qpushbutton.md#stylesheet) +* [testAttribute](qpushbutton.md#testattribute) +* [update](qpushbutton.md#update) +* [updateGeometry](qpushbutton.md#updategeometry) +* [windowOpacity](qpushbutton.md#windowopacity) +* [windowState](qpushbutton.md#windowstate) +* [windowTitle](qpushbutton.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QPushButton**(): *[QPushButton](qpushbutton.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QPushButton](qpushbutton.md)* + +\+ **new QPushButton**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QPushButton](qpushbutton.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QPushButton](qpushbutton.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QPushButtonSignals](../globals.md#qpushbuttonsignals)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QPushButtonSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### iconSize + +▸ **iconSize**(): *[QSize](qsize.md)* + +*Inherited from [QAbstractButton](qabstractbutton.md).[iconSize](qabstractbutton.md#iconsize)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QPushButtonSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlat + +▸ **setFlat**(`isFlat`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`isFlat` | boolean | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setIcon + +▸ **setIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [QAbstractButton](qabstractbutton.md).[setIcon](qabstractbutton.md#seticon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setIconSize + +▸ **setIconSize**(`iconSize`: [QSize](qsize.md)): *void* + +*Inherited from [QAbstractButton](qabstractbutton.md).[setIconSize](qabstractbutton.md#seticonsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`iconSize` | [QSize](qsize.md) | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QPushButtonSignals](../globals.md#qpushbuttonsignals)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QPushButtonSignals](../globals.md#qpushbuttonsignals)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setText + +▸ **setText**(`text`: string): *void* + +*Inherited from [QAbstractButton](qabstractbutton.md).[setText](qabstractbutton.md#settext)* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qradiobutton.md b/website/docs/api/generated/classes/qradiobutton.md new file mode 100644 index 000000000..280cdc995 --- /dev/null +++ b/website/docs/api/generated/classes/qradiobutton.md @@ -0,0 +1,1018 @@ +--- +id: "qradiobutton" +title: "QRadioButton" +sidebar_label: "QRadioButton" +--- + +> Create and control radio button. + +**This class is a JS wrapper around Qt's [QRadioButton class](https://doc.qt.io/qt-5/qradiobutton.html)** + +A `QRadioButton` provides ability to add and manipulate native radio button widgets. + +### Example + +```javascript +const { QRadioButton } = require("@nodegui/nodegui"); + +const radioButton = new QRadioButton(); +radioButton.setText("Hello"); +``` + +## Hierarchy + + ↳ [QAbstractButton](qabstractbutton.md)‹[QRadioButtonSignals](../globals.md#qradiobuttonsignals)› + + ↳ **QRadioButton** + +## Index + +### Constructors + +* [constructor](qradiobutton.md#constructor) + +### Properties + +* [_rawInlineStyle](qradiobutton.md#_rawinlinestyle) +* [layout](qradiobutton.md#optional-layout) +* [native](qradiobutton.md#native) +* [nodeChildren](qradiobutton.md#nodechildren) +* [nodeParent](qradiobutton.md#optional-nodeparent) +* [type](qradiobutton.md#type) + +### Methods + +* [activateWindow](qradiobutton.md#activatewindow) +* [addEventListener](qradiobutton.md#addeventlistener) +* [adjustSize](qradiobutton.md#adjustsize) +* [close](qradiobutton.md#close) +* [geometry](qradiobutton.md#geometry) +* [getFlexNode](qradiobutton.md#getflexnode) +* [hasMouseTracking](qradiobutton.md#hasmousetracking) +* [hide](qradiobutton.md#hide) +* [iconSize](qradiobutton.md#iconsize) +* [inherits](qradiobutton.md#inherits) +* [isEnabled](qradiobutton.md#isenabled) +* [isVisible](qradiobutton.md#isvisible) +* [lower](qradiobutton.md#lower) +* [move](qradiobutton.md#move) +* [objectName](qradiobutton.md#objectname) +* [pos](qradiobutton.md#pos) +* [property](qradiobutton.md#property) +* [raise](qradiobutton.md#raise) +* [removeEventListener](qradiobutton.md#removeeventlistener) +* [repaint](qradiobutton.md#repaint) +* [resize](qradiobutton.md#resize) +* [setAttribute](qradiobutton.md#setattribute) +* [setContextMenuPolicy](qradiobutton.md#setcontextmenupolicy) +* [setCursor](qradiobutton.md#setcursor) +* [setEnabled](qradiobutton.md#setenabled) +* [setFixedSize](qradiobutton.md#setfixedsize) +* [setFlexNodeSizeControlled](qradiobutton.md#setflexnodesizecontrolled) +* [setGeometry](qradiobutton.md#setgeometry) +* [setIcon](qradiobutton.md#seticon) +* [setIconSize](qradiobutton.md#seticonsize) +* [setInlineStyle](qradiobutton.md#setinlinestyle) +* [setLayout](qradiobutton.md#setlayout) +* [setMaximumSize](qradiobutton.md#setmaximumsize) +* [setMinimumSize](qradiobutton.md#setminimumsize) +* [setMouseTracking](qradiobutton.md#setmousetracking) +* [setNodeParent](qradiobutton.md#setnodeparent) +* [setObjectName](qradiobutton.md#setobjectname) +* [setProperty](qradiobutton.md#setproperty) +* [setStyleSheet](qradiobutton.md#setstylesheet) +* [setText](qradiobutton.md#settext) +* [setWindowFlag](qradiobutton.md#setwindowflag) +* [setWindowIcon](qradiobutton.md#setwindowicon) +* [setWindowOpacity](qradiobutton.md#setwindowopacity) +* [setWindowState](qradiobutton.md#setwindowstate) +* [setWindowTitle](qradiobutton.md#setwindowtitle) +* [show](qradiobutton.md#show) +* [showFullScreen](qradiobutton.md#showfullscreen) +* [showMaximized](qradiobutton.md#showmaximized) +* [showMinimized](qradiobutton.md#showminimized) +* [showNormal](qradiobutton.md#shownormal) +* [size](qradiobutton.md#size) +* [styleSheet](qradiobutton.md#stylesheet) +* [testAttribute](qradiobutton.md#testattribute) +* [update](qradiobutton.md#update) +* [updateGeometry](qradiobutton.md#updategeometry) +* [windowOpacity](qradiobutton.md#windowopacity) +* [windowState](qradiobutton.md#windowstate) +* [windowTitle](qradiobutton.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QRadioButton**(): *[QRadioButton](qradiobutton.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QRadioButton](qradiobutton.md)* + +\+ **new QRadioButton**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QRadioButton](qradiobutton.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QRadioButton](qradiobutton.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QRadioButtonSignals](../globals.md#qradiobuttonsignals)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QRadioButtonSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### iconSize + +▸ **iconSize**(): *[QSize](qsize.md)* + +*Inherited from [QAbstractButton](qabstractbutton.md).[iconSize](qabstractbutton.md#iconsize)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QRadioButtonSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setIcon + +▸ **setIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [QAbstractButton](qabstractbutton.md).[setIcon](qabstractbutton.md#seticon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setIconSize + +▸ **setIconSize**(`iconSize`: [QSize](qsize.md)): *void* + +*Inherited from [QAbstractButton](qabstractbutton.md).[setIconSize](qabstractbutton.md#seticonsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`iconSize` | [QSize](qsize.md) | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QRadioButtonSignals](../globals.md#qradiobuttonsignals)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QRadioButtonSignals](../globals.md#qradiobuttonsignals)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setText + +▸ **setText**(`text`: string): *void* + +*Inherited from [QAbstractButton](qabstractbutton.md).[setText](qabstractbutton.md#settext)* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qrect.md b/website/docs/api/generated/classes/qrect.md new file mode 100644 index 000000000..55cb7e395 --- /dev/null +++ b/website/docs/api/generated/classes/qrect.md @@ -0,0 +1,209 @@ +--- +id: "qrect" +title: "QRect" +sidebar_label: "QRect" +--- + +## Hierarchy + +* [Component](component.md) + + ↳ **QRect** + +## Index + +### Constructors + +* [constructor](qrect.md#constructor) + +### Properties + +* [native](qrect.md#native) +* [nodeChildren](qrect.md#nodechildren) +* [nodeParent](qrect.md#optional-nodeparent) + +### Methods + +* [height](qrect.md#height) +* [left](qrect.md#left) +* [setHeight](qrect.md#setheight) +* [setLeft](qrect.md#setleft) +* [setNodeParent](qrect.md#setnodeparent) +* [setTop](qrect.md#settop) +* [setWidth](qrect.md#setwidth) +* [top](qrect.md#top) +* [width](qrect.md#width) +* [fromQVariant](qrect.md#static-fromqvariant) + +## Constructors + +### constructor + +\+ **new QRect**(): *[QRect](qrect.md)* + +**Returns:** *[QRect](qrect.md)* + +\+ **new QRect**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QRect](qrect.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`nativeElement` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QRect](qrect.md)* + +\+ **new QRect**(`x?`: undefined | number, `y?`: undefined | number, `width?`: undefined | number, `height?`: undefined | number): *[QRect](qrect.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x?` | undefined | number | +`y?` | undefined | number | +`width?` | undefined | number | +`height?` | undefined | number | + +**Returns:** *[QRect](qrect.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### height + +▸ **height**(): *number* + +**Returns:** *number* + +___ + +### left + +▸ **left**(): *number* + +**Returns:** *number* + +___ + +### setHeight + +▸ **setHeight**(`height`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`height` | number | + +**Returns:** *void* + +___ + +### setLeft + +▸ **setLeft**(`height`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`height` | 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* + +___ + +### setTop + +▸ **setTop**(`height`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`height` | number | + +**Returns:** *void* + +___ + +### setWidth + +▸ **setWidth**(`width`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | + +**Returns:** *void* + +___ + +### top + +▸ **top**(): *number* + +**Returns:** *number* + +___ + +### width + +▸ **width**(): *number* + +**Returns:** *number* + +___ + +### `Static` fromQVariant + +▸ **fromQVariant**(`variant`: [QVariant](qvariant.md)): *[QRect](qrect.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`variant` | [QVariant](qvariant.md) | + +**Returns:** *[QRect](qrect.md)* diff --git a/website/docs/api/generated/classes/qscrollarea.md b/website/docs/api/generated/classes/qscrollarea.md new file mode 100644 index 000000000..359891bbc --- /dev/null +++ b/website/docs/api/generated/classes/qscrollarea.md @@ -0,0 +1,1088 @@ +--- +id: "qscrollarea" +title: "QScrollArea" +sidebar_label: "QScrollArea" +--- + +> A `QScrollArea` provides a scrolling view onto another widget. + +**This class is a JS wrapper around Qt's [QScrollArea class](https://doc.qt.io/qt-5/qscrollarea.html)** + +### Example + +```javascript +const { QScrollArea } = require("@nodegui/nodegui"); + +const scrollArea = new QScrollArea(); +scrollArea.setInlineStyle("flex: 1; width:'100%';"); + +const imageLabel = new QLabel(); +const pixmap = new QPixmap( +path.resolve(__dirname, "../extras/assets/kitchen.png") +); +imageLabel.setPixmap(pixmap); + +scrollArea.setWidget(imageLabel); +``` + +## Hierarchy + + ↳ [QAbstractScrollArea](qabstractscrollarea.md)‹[QScrollAreaSignals](../globals.md#qscrollareasignals)› + + ↳ **QScrollArea** + +## Index + +### Constructors + +* [constructor](qscrollarea.md#constructor) + +### Properties + +* [_rawInlineStyle](qscrollarea.md#_rawinlinestyle) +* [contentWidget](qscrollarea.md#optional-contentwidget) +* [layout](qscrollarea.md#optional-layout) +* [native](qscrollarea.md#native) +* [nodeChildren](qscrollarea.md#nodechildren) +* [nodeParent](qscrollarea.md#optional-nodeparent) +* [type](qscrollarea.md#type) +* [viewportWidget](qscrollarea.md#optional-viewportwidget) + +### Methods + +* [activateWindow](qscrollarea.md#activatewindow) +* [addEventListener](qscrollarea.md#addeventlistener) +* [adjustSize](qscrollarea.md#adjustsize) +* [close](qscrollarea.md#close) +* [geometry](qscrollarea.md#geometry) +* [getFlexNode](qscrollarea.md#getflexnode) +* [hasMouseTracking](qscrollarea.md#hasmousetracking) +* [hide](qscrollarea.md#hide) +* [inherits](qscrollarea.md#inherits) +* [isEnabled](qscrollarea.md#isenabled) +* [isVisible](qscrollarea.md#isvisible) +* [lower](qscrollarea.md#lower) +* [move](qscrollarea.md#move) +* [objectName](qscrollarea.md#objectname) +* [pos](qscrollarea.md#pos) +* [property](qscrollarea.md#property) +* [raise](qscrollarea.md#raise) +* [removeEventListener](qscrollarea.md#removeeventlistener) +* [repaint](qscrollarea.md#repaint) +* [resize](qscrollarea.md#resize) +* [setAttribute](qscrollarea.md#setattribute) +* [setContextMenuPolicy](qscrollarea.md#setcontextmenupolicy) +* [setCursor](qscrollarea.md#setcursor) +* [setEnabled](qscrollarea.md#setenabled) +* [setFixedSize](qscrollarea.md#setfixedsize) +* [setFlexNodeSizeControlled](qscrollarea.md#setflexnodesizecontrolled) +* [setGeometry](qscrollarea.md#setgeometry) +* [setHorizontalScrollBarPolicy](qscrollarea.md#sethorizontalscrollbarpolicy) +* [setInlineStyle](qscrollarea.md#setinlinestyle) +* [setLayout](qscrollarea.md#setlayout) +* [setMaximumSize](qscrollarea.md#setmaximumsize) +* [setMinimumSize](qscrollarea.md#setminimumsize) +* [setMouseTracking](qscrollarea.md#setmousetracking) +* [setNodeParent](qscrollarea.md#setnodeparent) +* [setObjectName](qscrollarea.md#setobjectname) +* [setProperty](qscrollarea.md#setproperty) +* [setStyleSheet](qscrollarea.md#setstylesheet) +* [setVerticalScrollBarPolicy](qscrollarea.md#setverticalscrollbarpolicy) +* [setViewport](qscrollarea.md#setviewport) +* [setWidget](qscrollarea.md#setwidget) +* [setWidgetResizable](qscrollarea.md#setwidgetresizable) +* [setWindowFlag](qscrollarea.md#setwindowflag) +* [setWindowIcon](qscrollarea.md#setwindowicon) +* [setWindowOpacity](qscrollarea.md#setwindowopacity) +* [setWindowState](qscrollarea.md#setwindowstate) +* [setWindowTitle](qscrollarea.md#setwindowtitle) +* [show](qscrollarea.md#show) +* [showFullScreen](qscrollarea.md#showfullscreen) +* [showMaximized](qscrollarea.md#showmaximized) +* [showMinimized](qscrollarea.md#showminimized) +* [showNormal](qscrollarea.md#shownormal) +* [size](qscrollarea.md#size) +* [styleSheet](qscrollarea.md#stylesheet) +* [takeWidget](qscrollarea.md#takewidget) +* [testAttribute](qscrollarea.md#testattribute) +* [update](qscrollarea.md#update) +* [updateGeometry](qscrollarea.md#updategeometry) +* [viewport](qscrollarea.md#viewport) +* [widgetResizable](qscrollarea.md#widgetresizable) +* [windowOpacity](qscrollarea.md#windowopacity) +* [windowState](qscrollarea.md#windowstate) +* [windowTitle](qscrollarea.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QScrollArea**(): *[QScrollArea](qscrollarea.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QScrollArea](qscrollarea.md)* + +\+ **new QScrollArea**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QScrollArea](qscrollarea.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QScrollArea](qscrollarea.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` contentWidget + +• **contentWidget**? : *[NodeWidget](nodewidget.md)‹any› | null* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QScrollAreaSignals](../globals.md#qscrollareasignals)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +___ + +### `Optional` viewportWidget + +• **viewportWidget**? : *[NodeWidget](nodewidget.md)‹any›* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[viewportWidget](qabstractscrollarea.md#optional-viewportwidget)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QScrollAreaSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QScrollAreaSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setHorizontalScrollBarPolicy + +▸ **setHorizontalScrollBarPolicy**(`policy`: [ScrollBarPolicy](../enums/scrollbarpolicy.md)): *void* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[setHorizontalScrollBarPolicy](qabstractscrollarea.md#sethorizontalscrollbarpolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`policy` | [ScrollBarPolicy](../enums/scrollbarpolicy.md) | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QScrollAreaSignals](../globals.md#qscrollareasignals)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QScrollAreaSignals](../globals.md#qscrollareasignals)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setVerticalScrollBarPolicy + +▸ **setVerticalScrollBarPolicy**(`policy`: [ScrollBarPolicy](../enums/scrollbarpolicy.md)): *void* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[setVerticalScrollBarPolicy](qabstractscrollarea.md#setverticalscrollbarpolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`policy` | [ScrollBarPolicy](../enums/scrollbarpolicy.md) | + +**Returns:** *void* + +___ + +### setViewport + +▸ **setViewport**(`widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[setViewport](qabstractscrollarea.md#setviewport)* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### setWidget + +▸ **setWidget**(`widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### setWidgetResizable + +▸ **setWidgetResizable**(`resizable`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`resizable` | boolean | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### takeWidget + +▸ **takeWidget**(): *[NodeWidget](nodewidget.md)‹any› | null* + +**Returns:** *[NodeWidget](nodewidget.md)‹any› | null* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### viewport + +▸ **viewport**(): *[QWidget](qwidget.md)* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[viewport](qabstractscrollarea.md#viewport)* + +**Returns:** *[QWidget](qwidget.md)* + +___ + +### widgetResizable + +▸ **widgetResizable**(): *boolean* + +**Returns:** *boolean* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qshortcut.md b/website/docs/api/generated/classes/qshortcut.md new file mode 100644 index 000000000..9012fa8e5 --- /dev/null +++ b/website/docs/api/generated/classes/qshortcut.md @@ -0,0 +1,344 @@ +--- +id: "qshortcut" +title: "QShortcut" +sidebar_label: "QShortcut" +--- + +> The QShortcut class is used to create keyboard shortcuts. + +**This class is a JS wrapper around Qt's [QShortcut class](https://doc.qt.io/qt-5/qshortcut.html)** + +### Example + +```javascript +const { QShortcut, QKeySequence, QMainWindow } = require("@nodegui/nodegui"); + +const win = new QMainWindow(); +const shortcut = new QShortcut(win); +shortcut.setKey(new QKeySequence("Ctrl+M")); +shortcut.setEnabled(true); +shortcut.addEventListener(QShortcutEvents.activated, () => { +console.log("Shortcut Activated"); +}); + +win.show(); +global.win = win; +global.shortcut = shortcut; +``` + +## Hierarchy + + ↳ [NodeObject](nodeobject.md)‹[QShortcutSignals](../interfaces/qshortcutsignals.md)› + + ↳ **QShortcut** + +## Index + +### Constructors + +* [constructor](qshortcut.md#constructor) + +### Properties + +* [native](qshortcut.md#native) +* [nodeChildren](qshortcut.md#nodechildren) +* [nodeParent](qshortcut.md#optional-nodeparent) + +### Methods + +* [addEventListener](qshortcut.md#addeventlistener) +* [inherits](qshortcut.md#inherits) +* [objectName](qshortcut.md#objectname) +* [property](qshortcut.md#property) +* [removeEventListener](qshortcut.md#removeeventlistener) +* [setAutoRepeat](qshortcut.md#setautorepeat) +* [setContext](qshortcut.md#setcontext) +* [setEnabled](qshortcut.md#setenabled) +* [setKey](qshortcut.md#setkey) +* [setNodeParent](qshortcut.md#setnodeparent) +* [setObjectName](qshortcut.md#setobjectname) +* [setProperty](qshortcut.md#setproperty) + +## Constructors + +### constructor + +\+ **new QShortcut**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QShortcut](qshortcut.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QShortcut](qshortcut.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QShortcutSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### 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)* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QShortcutSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### setAutoRepeat + +▸ **setAutoRepeat**(`on`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`on` | boolean | + +**Returns:** *void* + +___ + +### setContext + +▸ **setContext**(`shortcutContext`: [ShortcutContext](../enums/shortcutcontext.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`shortcutContext` | [ShortcutContext](../enums/shortcutcontext.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setKey + +▸ **setKey**(`keysequence`: [QKeySequence](qkeysequence.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`keysequence` | [QKeySequence](qkeysequence.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* + +___ + +### 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/qsize.md b/website/docs/api/generated/classes/qsize.md new file mode 100644 index 000000000..8bea0e75c --- /dev/null +++ b/website/docs/api/generated/classes/qsize.md @@ -0,0 +1,159 @@ +--- +id: "qsize" +title: "QSize" +sidebar_label: "QSize" +--- + +## Hierarchy + +* [Component](component.md) + + ↳ **QSize** + +## Index + +### Constructors + +* [constructor](qsize.md#constructor) + +### Properties + +* [native](qsize.md#native) +* [nodeChildren](qsize.md#nodechildren) +* [nodeParent](qsize.md#optional-nodeparent) + +### Methods + +* [height](qsize.md#height) +* [setHeight](qsize.md#setheight) +* [setNodeParent](qsize.md#setnodeparent) +* [setWidth](qsize.md#setwidth) +* [width](qsize.md#width) +* [fromQVariant](qsize.md#static-fromqvariant) + +## Constructors + +### constructor + +\+ **new QSize**(): *[QSize](qsize.md)* + +**Returns:** *[QSize](qsize.md)* + +\+ **new QSize**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QSize](qsize.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`nativeElement` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QSize](qsize.md)* + +\+ **new QSize**(`width?`: undefined | number, `height?`: undefined | number): *[QSize](qsize.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width?` | undefined | number | +`height?` | undefined | number | + +**Returns:** *[QSize](qsize.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### height + +▸ **height**(): *number* + +**Returns:** *number* + +___ + +### setHeight + +▸ **setHeight**(`height`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`height` | 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* + +___ + +### setWidth + +▸ **setWidth**(`width`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | + +**Returns:** *void* + +___ + +### width + +▸ **width**(): *number* + +**Returns:** *number* + +___ + +### `Static` fromQVariant + +▸ **fromQVariant**(`variant`: [QVariant](qvariant.md)): *[QSize](qsize.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`variant` | [QVariant](qvariant.md) | + +**Returns:** *[QSize](qsize.md)* diff --git a/website/docs/api/generated/classes/qspinbox.md b/website/docs/api/generated/classes/qspinbox.md new file mode 100644 index 000000000..e03838596 --- /dev/null +++ b/website/docs/api/generated/classes/qspinbox.md @@ -0,0 +1,1067 @@ +--- +id: "qspinbox" +title: "QSpinBox" +sidebar_label: "QSpinBox" +--- + +> Create and control spin box widgets. + +**This class is a JS wrapper around Qt's [QSpinBox class](https://doc.qt.io/qt-5/qspinbox.html)** + +A `QSpinBox` provides ability to add and manipulate native spin box widgets. + +### Example + +```javascript +const { QSpinBox } = require("@nodegui/nodegui"); + +const spinBox = new QSpinBox(); +``` + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QSpinBoxSignals](../interfaces/qspinboxsignals.md)› + + ↳ **QSpinBox** + +## Index + +### Constructors + +* [constructor](qspinbox.md#constructor) + +### Properties + +* [_rawInlineStyle](qspinbox.md#_rawinlinestyle) +* [layout](qspinbox.md#optional-layout) +* [native](qspinbox.md#native) +* [nodeChildren](qspinbox.md#nodechildren) +* [nodeParent](qspinbox.md#optional-nodeparent) +* [type](qspinbox.md#type) + +### Methods + +* [activateWindow](qspinbox.md#activatewindow) +* [addEventListener](qspinbox.md#addeventlistener) +* [adjustSize](qspinbox.md#adjustsize) +* [cleanText](qspinbox.md#cleantext) +* [close](qspinbox.md#close) +* [geometry](qspinbox.md#geometry) +* [getFlexNode](qspinbox.md#getflexnode) +* [hasMouseTracking](qspinbox.md#hasmousetracking) +* [hide](qspinbox.md#hide) +* [inherits](qspinbox.md#inherits) +* [isEnabled](qspinbox.md#isenabled) +* [isVisible](qspinbox.md#isvisible) +* [lower](qspinbox.md#lower) +* [maximum](qspinbox.md#maximum) +* [minimum](qspinbox.md#minimum) +* [move](qspinbox.md#move) +* [objectName](qspinbox.md#objectname) +* [pos](qspinbox.md#pos) +* [property](qspinbox.md#property) +* [raise](qspinbox.md#raise) +* [removeEventListener](qspinbox.md#removeeventlistener) +* [repaint](qspinbox.md#repaint) +* [resize](qspinbox.md#resize) +* [setAttribute](qspinbox.md#setattribute) +* [setContextMenuPolicy](qspinbox.md#setcontextmenupolicy) +* [setCursor](qspinbox.md#setcursor) +* [setEnabled](qspinbox.md#setenabled) +* [setFixedSize](qspinbox.md#setfixedsize) +* [setFlexNodeSizeControlled](qspinbox.md#setflexnodesizecontrolled) +* [setGeometry](qspinbox.md#setgeometry) +* [setInlineStyle](qspinbox.md#setinlinestyle) +* [setLayout](qspinbox.md#setlayout) +* [setMaximumSize](qspinbox.md#setmaximumsize) +* [setMinimumSize](qspinbox.md#setminimumsize) +* [setMouseTracking](qspinbox.md#setmousetracking) +* [setNodeParent](qspinbox.md#setnodeparent) +* [setObjectName](qspinbox.md#setobjectname) +* [setPrefix](qspinbox.md#setprefix) +* [setProperty](qspinbox.md#setproperty) +* [setRange](qspinbox.md#setrange) +* [setSingleStep](qspinbox.md#setsinglestep) +* [setStyleSheet](qspinbox.md#setstylesheet) +* [setSuffix](qspinbox.md#setsuffix) +* [setValue](qspinbox.md#setvalue) +* [setWindowFlag](qspinbox.md#setwindowflag) +* [setWindowIcon](qspinbox.md#setwindowicon) +* [setWindowOpacity](qspinbox.md#setwindowopacity) +* [setWindowState](qspinbox.md#setwindowstate) +* [setWindowTitle](qspinbox.md#setwindowtitle) +* [show](qspinbox.md#show) +* [showFullScreen](qspinbox.md#showfullscreen) +* [showMaximized](qspinbox.md#showmaximized) +* [showMinimized](qspinbox.md#showminimized) +* [showNormal](qspinbox.md#shownormal) +* [size](qspinbox.md#size) +* [styleSheet](qspinbox.md#stylesheet) +* [testAttribute](qspinbox.md#testattribute) +* [update](qspinbox.md#update) +* [updateGeometry](qspinbox.md#updategeometry) +* [value](qspinbox.md#value) +* [windowOpacity](qspinbox.md#windowopacity) +* [windowState](qspinbox.md#windowstate) +* [windowTitle](qspinbox.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QSpinBox**(): *[QSpinBox](qspinbox.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QSpinBox](qspinbox.md)* + +\+ **new QSpinBox**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QSpinBox](qspinbox.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QSpinBox](qspinbox.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QSpinBoxSignals](../interfaces/qspinboxsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QSpinBoxSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### cleanText + +▸ **cleanText**(): *string* + +**Returns:** *string* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### maximum + +▸ **maximum**(): *number* + +**Returns:** *number* + +___ + +### minimum + +▸ **minimum**(): *number* + +**Returns:** *number* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QSpinBoxSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QSpinBoxSignals](../interfaces/qspinboxsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QSpinBoxSignals](../interfaces/qspinboxsignals.md)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [NodeObject](nodeobject.md).[setObjectName](nodeobject.md#setobjectname)* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +**Returns:** *void* + +___ + +### setPrefix + +▸ **setPrefix**(`prefix`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`prefix` | 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* + +___ + +### setRange + +▸ **setRange**(`minimum`: number, `maximum`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`minimum` | number | +`maximum` | number | + +**Returns:** *void* + +___ + +### setSingleStep + +▸ **setSingleStep**(`val`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`val` | number | + +**Returns:** *void* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setSuffix + +▸ **setSuffix**(`suffix`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`suffix` | string | + +**Returns:** *void* + +___ + +### setValue + +▸ **setValue**(`val`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`val` | number | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### value + +▸ **value**(): *number* + +**Returns:** *number* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qstackedwidget.md b/website/docs/api/generated/classes/qstackedwidget.md new file mode 100644 index 000000000..8af675417 --- /dev/null +++ b/website/docs/api/generated/classes/qstackedwidget.md @@ -0,0 +1,1010 @@ +--- +id: "qstackedwidget" +title: "QStackedWidget" +sidebar_label: "QStackedWidget" +--- + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QStackedWidgetSignals](../interfaces/qstackedwidgetsignals.md)› + + ↳ **QStackedWidget** + +## Index + +### Constructors + +* [constructor](qstackedwidget.md#constructor) + +### Properties + +* [_rawInlineStyle](qstackedwidget.md#_rawinlinestyle) +* [layout](qstackedwidget.md#optional-layout) +* [native](qstackedwidget.md#native) +* [nodeChildren](qstackedwidget.md#nodechildren) +* [nodeParent](qstackedwidget.md#optional-nodeparent) +* [type](qstackedwidget.md#type) + +### Methods + +* [activateWindow](qstackedwidget.md#activatewindow) +* [addEventListener](qstackedwidget.md#addeventlistener) +* [addWidget](qstackedwidget.md#addwidget) +* [adjustSize](qstackedwidget.md#adjustsize) +* [close](qstackedwidget.md#close) +* [currentIndex](qstackedwidget.md#currentindex) +* [geometry](qstackedwidget.md#geometry) +* [getFlexNode](qstackedwidget.md#getflexnode) +* [hasMouseTracking](qstackedwidget.md#hasmousetracking) +* [hide](qstackedwidget.md#hide) +* [inherits](qstackedwidget.md#inherits) +* [isEnabled](qstackedwidget.md#isenabled) +* [isVisible](qstackedwidget.md#isvisible) +* [lower](qstackedwidget.md#lower) +* [move](qstackedwidget.md#move) +* [objectName](qstackedwidget.md#objectname) +* [pos](qstackedwidget.md#pos) +* [property](qstackedwidget.md#property) +* [raise](qstackedwidget.md#raise) +* [removeEventListener](qstackedwidget.md#removeeventlistener) +* [removeWidget](qstackedwidget.md#removewidget) +* [repaint](qstackedwidget.md#repaint) +* [resize](qstackedwidget.md#resize) +* [setAttribute](qstackedwidget.md#setattribute) +* [setContextMenuPolicy](qstackedwidget.md#setcontextmenupolicy) +* [setCurrentIndex](qstackedwidget.md#setcurrentindex) +* [setCurrentWidget](qstackedwidget.md#setcurrentwidget) +* [setCursor](qstackedwidget.md#setcursor) +* [setEnabled](qstackedwidget.md#setenabled) +* [setFixedSize](qstackedwidget.md#setfixedsize) +* [setFlexNodeSizeControlled](qstackedwidget.md#setflexnodesizecontrolled) +* [setGeometry](qstackedwidget.md#setgeometry) +* [setInlineStyle](qstackedwidget.md#setinlinestyle) +* [setLayout](qstackedwidget.md#setlayout) +* [setMaximumSize](qstackedwidget.md#setmaximumsize) +* [setMinimumSize](qstackedwidget.md#setminimumsize) +* [setMouseTracking](qstackedwidget.md#setmousetracking) +* [setNodeParent](qstackedwidget.md#setnodeparent) +* [setObjectName](qstackedwidget.md#setobjectname) +* [setProperty](qstackedwidget.md#setproperty) +* [setStyleSheet](qstackedwidget.md#setstylesheet) +* [setWindowFlag](qstackedwidget.md#setwindowflag) +* [setWindowIcon](qstackedwidget.md#setwindowicon) +* [setWindowOpacity](qstackedwidget.md#setwindowopacity) +* [setWindowState](qstackedwidget.md#setwindowstate) +* [setWindowTitle](qstackedwidget.md#setwindowtitle) +* [show](qstackedwidget.md#show) +* [showFullScreen](qstackedwidget.md#showfullscreen) +* [showMaximized](qstackedwidget.md#showmaximized) +* [showMinimized](qstackedwidget.md#showminimized) +* [showNormal](qstackedwidget.md#shownormal) +* [size](qstackedwidget.md#size) +* [styleSheet](qstackedwidget.md#stylesheet) +* [testAttribute](qstackedwidget.md#testattribute) +* [update](qstackedwidget.md#update) +* [updateGeometry](qstackedwidget.md#updategeometry) +* [windowOpacity](qstackedwidget.md#windowopacity) +* [windowState](qstackedwidget.md#windowstate) +* [windowTitle](qstackedwidget.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QStackedWidget**(): *[QStackedWidget](qstackedwidget.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QStackedWidget](qstackedwidget.md)* + +\+ **new QStackedWidget**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QStackedWidget](qstackedwidget.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QStackedWidget](qstackedwidget.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QStackedWidgetSignals](../interfaces/qstackedwidgetsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QStackedWidgetSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### addWidget + +▸ **addWidget**(`widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### currentIndex + +▸ **currentIndex**(): *number* + +**Returns:** *number* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QStackedWidgetSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### removeWidget + +▸ **removeWidget**(`widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCurrentIndex + +▸ **setCurrentIndex**(`index`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`index` | number | + +**Returns:** *void* + +___ + +### setCurrentWidget + +▸ **setCurrentWidget**(`widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QStackedWidgetSignals](../interfaces/qstackedwidgetsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QStackedWidgetSignals](../interfaces/qstackedwidgetsignals.md)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qstyle.md b/website/docs/api/generated/classes/qstyle.md new file mode 100644 index 000000000..30db726c8 --- /dev/null +++ b/website/docs/api/generated/classes/qstyle.md @@ -0,0 +1,96 @@ +--- +id: "qstyle" +title: "QStyle" +sidebar_label: "QStyle" +--- + +## Hierarchy + +* [Component](component.md) + + ↳ **QStyle** + +## Index + +### Constructors + +* [constructor](qstyle.md#constructor) + +### Properties + +* [native](qstyle.md#native) +* [nodeChildren](qstyle.md#nodechildren) +* [nodeParent](qstyle.md#optional-nodeparent) + +### Methods + +* [pixelMetric](qstyle.md#pixelmetric) +* [setNodeParent](qstyle.md#setnodeparent) + +## Constructors + +### constructor + +\+ **new QStyle**(`native`: [NativeElement](../globals.md#nativeelement)): *[QStyle](qstyle.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QStyle](qstyle.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### pixelMetric + +▸ **pixelMetric**(`metric`: [QStylePixelMetric](../enums/qstylepixelmetric.md)): *number* + +**Parameters:** + +Name | Type | +------ | ------ | +`metric` | [QStylePixelMetric](../enums/qstylepixelmetric.md) | + +**Returns:** *number* + +___ + +### 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* diff --git a/website/docs/api/generated/classes/qsystemtrayicon.md b/website/docs/api/generated/classes/qsystemtrayicon.md new file mode 100644 index 000000000..3c3e20a61 --- /dev/null +++ b/website/docs/api/generated/classes/qsystemtrayicon.md @@ -0,0 +1,384 @@ +--- +id: "qsystemtrayicon" +title: "QSystemTrayIcon" +sidebar_label: "QSystemTrayIcon" +--- + +> Create and control system tray icon. + +**This class is a JS wrapper around Qt's [QSystemTrayIcon class](https://doc.qt.io/qt-5/qsystemtrayicon.html)** + +A `QSystemTrayIcon` provides ability to add and manipulate native system tray icon. + +### Example + +```javascript +const { QSystemTrayIcon, QIcon } = require("@nodegui/nodegui"); +const trayIcon = new QIcon( +resolve(__dirname, "some/image/file.png"); +); +const tray = new QSystemTrayIcon(); +tray.show(); + +global.tray = tray; // prevents garbage collection of tray +``` + +## Hierarchy + + ↳ [NodeObject](nodeobject.md)‹[QSystemTrayIconSignals](../interfaces/qsystemtrayiconsignals.md)› + + ↳ **QSystemTrayIcon** + +## Index + +### Constructors + +* [constructor](qsystemtrayicon.md#constructor) + +### Properties + +* [contextMenu](qsystemtrayicon.md#optional-contextmenu) +* [native](qsystemtrayicon.md#native) +* [nodeChildren](qsystemtrayicon.md#nodechildren) +* [nodeParent](qsystemtrayicon.md#optional-nodeparent) + +### Methods + +* [addEventListener](qsystemtrayicon.md#addeventlistener) +* [hide](qsystemtrayicon.md#hide) +* [inherits](qsystemtrayicon.md#inherits) +* [isVisible](qsystemtrayicon.md#isvisible) +* [objectName](qsystemtrayicon.md#objectname) +* [property](qsystemtrayicon.md#property) +* [removeEventListener](qsystemtrayicon.md#removeeventlistener) +* [setContextMenu](qsystemtrayicon.md#setcontextmenu) +* [setIcon](qsystemtrayicon.md#seticon) +* [setNodeParent](qsystemtrayicon.md#setnodeparent) +* [setObjectName](qsystemtrayicon.md#setobjectname) +* [setProperty](qsystemtrayicon.md#setproperty) +* [setToolTip](qsystemtrayicon.md#settooltip) +* [show](qsystemtrayicon.md#show) +* [showMessage](qsystemtrayicon.md#showmessage) + +## Constructors + +### constructor + +\+ **new QSystemTrayIcon**(): *[QSystemTrayIcon](qsystemtrayicon.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QSystemTrayIcon](qsystemtrayicon.md)* + +\+ **new QSystemTrayIcon**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QSystemTrayIcon](qsystemtrayicon.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QSystemTrayIcon](qsystemtrayicon.md)* + +## Properties + +### `Optional` contextMenu + +• **contextMenu**? : *[QMenu](qmenu.md)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QSystemTrayIconSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### hide + +▸ **hide**(): *void* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +**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)* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QSystemTrayIconSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### setContextMenu + +▸ **setContextMenu**(`menu`: [QMenu](qmenu.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`menu` | [QMenu](qmenu.md) | + +**Returns:** *void* + +___ + +### setIcon + +▸ **setIcon**(`icon`: [QIcon](qicon.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.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* + +___ + +### 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* + +___ + +### setToolTip + +▸ **setToolTip**(`tooltip`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`tooltip` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +**Returns:** *void* + +___ + +### showMessage + +▸ **showMessage**(`title`: string, `message`: string, `icon`: [QIcon](qicon.md), `millisecondsTimeoutHint`: number): *void* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`title` | string | "" | +`message` | string | "" | +`icon` | [QIcon](qicon.md) | new QIcon() | +`millisecondsTimeoutHint` | number | 10000 | + +**Returns:** *void* diff --git a/website/docs/api/generated/classes/qtablewidget.md b/website/docs/api/generated/classes/qtablewidget.md new file mode 100644 index 000000000..b903f5646 --- /dev/null +++ b/website/docs/api/generated/classes/qtablewidget.md @@ -0,0 +1,1491 @@ +--- +id: "qtablewidget" +title: "QTableWidget" +sidebar_label: "QTableWidget" +--- + +## Hierarchy + + ↳ [QAbstractScrollArea](qabstractscrollarea.md)‹[QTableWidgetSignals](../interfaces/qtablewidgetsignals.md)› + + ↳ **QTableWidget** + +## Index + +### Constructors + +* [constructor](qtablewidget.md#constructor) + +### Properties + +* [_rawInlineStyle](qtablewidget.md#_rawinlinestyle) +* [items](qtablewidget.md#items) +* [layout](qtablewidget.md#optional-layout) +* [native](qtablewidget.md#native) +* [nodeChildren](qtablewidget.md#nodechildren) +* [nodeParent](qtablewidget.md#optional-nodeparent) +* [type](qtablewidget.md#type) +* [viewportWidget](qtablewidget.md#optional-viewportwidget) + +### Methods + +* [activateWindow](qtablewidget.md#activatewindow) +* [addEventListener](qtablewidget.md#addeventlistener) +* [adjustSize](qtablewidget.md#adjustsize) +* [clear](qtablewidget.md#clear) +* [clearContents](qtablewidget.md#clearcontents) +* [close](qtablewidget.md#close) +* [closePersistentEditor](qtablewidget.md#closepersistenteditor) +* [editItem](qtablewidget.md#edititem) +* [geometry](qtablewidget.md#geometry) +* [getFlexNode](qtablewidget.md#getflexnode) +* [hasMouseTracking](qtablewidget.md#hasmousetracking) +* [hide](qtablewidget.md#hide) +* [hideColumn](qtablewidget.md#hidecolumn) +* [hideRow](qtablewidget.md#hiderow) +* [inherits](qtablewidget.md#inherits) +* [insertColumn](qtablewidget.md#insertcolumn) +* [insertRow](qtablewidget.md#insertrow) +* [isEnabled](qtablewidget.md#isenabled) +* [isSortingEnabled](qtablewidget.md#issortingenabled) +* [isVisible](qtablewidget.md#isvisible) +* [lower](qtablewidget.md#lower) +* [move](qtablewidget.md#move) +* [objectName](qtablewidget.md#objectname) +* [pos](qtablewidget.md#pos) +* [property](qtablewidget.md#property) +* [raise](qtablewidget.md#raise) +* [removeColumn](qtablewidget.md#removecolumn) +* [removeEventListener](qtablewidget.md#removeeventlistener) +* [removeRow](qtablewidget.md#removerow) +* [repaint](qtablewidget.md#repaint) +* [resize](qtablewidget.md#resize) +* [resizeColumnToContents](qtablewidget.md#resizecolumntocontents) +* [resizeColumnsToContents](qtablewidget.md#resizecolumnstocontents) +* [resizeRowToContents](qtablewidget.md#resizerowtocontents) +* [resizeRowsToContents](qtablewidget.md#resizerowstocontents) +* [scrollToItem](qtablewidget.md#scrolltoitem) +* [selectColumn](qtablewidget.md#selectcolumn) +* [selectRow](qtablewidget.md#selectrow) +* [selectedRanges](qtablewidget.md#selectedranges) +* [setAttribute](qtablewidget.md#setattribute) +* [setCellWidget](qtablewidget.md#setcellwidget) +* [setColumnWidth](qtablewidget.md#setcolumnwidth) +* [setContextMenuPolicy](qtablewidget.md#setcontextmenupolicy) +* [setCursor](qtablewidget.md#setcursor) +* [setEnabled](qtablewidget.md#setenabled) +* [setFixedSize](qtablewidget.md#setfixedsize) +* [setFlexNodeSizeControlled](qtablewidget.md#setflexnodesizecontrolled) +* [setGeometry](qtablewidget.md#setgeometry) +* [setHorizontalHeaderItem](qtablewidget.md#sethorizontalheaderitem) +* [setHorizontalHeaderLabels](qtablewidget.md#sethorizontalheaderlabels) +* [setHorizontalScrollBarPolicy](qtablewidget.md#sethorizontalscrollbarpolicy) +* [setInlineStyle](qtablewidget.md#setinlinestyle) +* [setItem](qtablewidget.md#setitem) +* [setLayout](qtablewidget.md#setlayout) +* [setMaximumSize](qtablewidget.md#setmaximumsize) +* [setMinimumSize](qtablewidget.md#setminimumsize) +* [setMouseTracking](qtablewidget.md#setmousetracking) +* [setNodeParent](qtablewidget.md#setnodeparent) +* [setObjectName](qtablewidget.md#setobjectname) +* [setProperty](qtablewidget.md#setproperty) +* [setRowHeight](qtablewidget.md#setrowheight) +* [setShowGrid](qtablewidget.md#setshowgrid) +* [setSortingEnabled](qtablewidget.md#setsortingenabled) +* [setStyleSheet](qtablewidget.md#setstylesheet) +* [setVerticalHeaderItem](qtablewidget.md#setverticalheaderitem) +* [setVerticalHeaderLabels](qtablewidget.md#setverticalheaderlabels) +* [setVerticalScrollBarPolicy](qtablewidget.md#setverticalscrollbarpolicy) +* [setViewport](qtablewidget.md#setviewport) +* [setWindowFlag](qtablewidget.md#setwindowflag) +* [setWindowIcon](qtablewidget.md#setwindowicon) +* [setWindowOpacity](qtablewidget.md#setwindowopacity) +* [setWindowState](qtablewidget.md#setwindowstate) +* [setWindowTitle](qtablewidget.md#setwindowtitle) +* [show](qtablewidget.md#show) +* [showColumn](qtablewidget.md#showcolumn) +* [showFullScreen](qtablewidget.md#showfullscreen) +* [showGrid](qtablewidget.md#showgrid) +* [showMaximized](qtablewidget.md#showmaximized) +* [showMinimized](qtablewidget.md#showminimized) +* [showNormal](qtablewidget.md#shownormal) +* [showRow](qtablewidget.md#showrow) +* [size](qtablewidget.md#size) +* [sortByColumn](qtablewidget.md#sortbycolumn) +* [styleSheet](qtablewidget.md#stylesheet) +* [testAttribute](qtablewidget.md#testattribute) +* [update](qtablewidget.md#update) +* [updateGeometry](qtablewidget.md#updategeometry) +* [viewport](qtablewidget.md#viewport) +* [windowOpacity](qtablewidget.md#windowopacity) +* [windowState](qtablewidget.md#windowstate) +* [windowTitle](qtablewidget.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QTableWidget**(`rows`: number, `columns`: number): *[QTableWidget](qtablewidget.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`rows` | number | +`columns` | number | + +**Returns:** *[QTableWidget](qtablewidget.md)* + +\+ **new QTableWidget**(`rows`: number, `columns`: number, `parent`: [NodeWidget](nodewidget.md)‹any›): *[QTableWidget](qtablewidget.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`rows` | number | +`columns` | number | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QTableWidget](qtablewidget.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### items + +• **items**: *Set‹[NativeElement](../globals.md#nativeelement) | [Component](component.md)›* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QTableWidgetSignals](../interfaces/qtablewidgetsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +___ + +### `Optional` viewportWidget + +• **viewportWidget**? : *[NodeWidget](nodewidget.md)‹any›* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[viewportWidget](qabstractscrollarea.md#optional-viewportwidget)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QTableWidgetSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### clear + +▸ **clear**(): *void* + +**Returns:** *void* + +___ + +### clearContents + +▸ **clearContents**(): *void* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### closePersistentEditor + +▸ **closePersistentEditor**(`item`: [QTableWidgetItem](qtablewidgetitem.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`item` | [QTableWidgetItem](qtablewidgetitem.md) | + +**Returns:** *void* + +___ + +### editItem + +▸ **editItem**(`item`: [Component](component.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`item` | [Component](component.md) | + +**Returns:** *void* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### hideColumn + +▸ **hideColumn**(`column`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`column` | number | + +**Returns:** *void* + +___ + +### hideRow + +▸ **hideRow**(`row`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### insertColumn + +▸ **insertColumn**(`column`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`column` | number | + +**Returns:** *void* + +___ + +### insertRow + +▸ **insertRow**(`row`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | + +**Returns:** *void* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isSortingEnabled + +▸ **isSortingEnabled**(): *boolean* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeColumn + +▸ **removeColumn**(`column`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`column` | number | + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QTableWidgetSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### removeRow + +▸ **removeRow**(`row`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### resizeColumnToContents + +▸ **resizeColumnToContents**(`column`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`column` | number | + +**Returns:** *void* + +___ + +### resizeColumnsToContents + +▸ **resizeColumnsToContents**(): *void* + +**Returns:** *void* + +___ + +### resizeRowToContents + +▸ **resizeRowToContents**(`row`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | + +**Returns:** *void* + +___ + +### resizeRowsToContents + +▸ **resizeRowsToContents**(): *void* + +**Returns:** *void* + +___ + +### scrollToItem + +▸ **scrollToItem**(`item`: [QTableWidgetItem](qtablewidgetitem.md), `hint`: [ScrollHint](../enums/scrollhint.md)): *void* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`item` | [QTableWidgetItem](qtablewidgetitem.md) | - | +`hint` | [ScrollHint](../enums/scrollhint.md) | ScrollHint.EnsureVisible | + +**Returns:** *void* + +___ + +### selectColumn + +▸ **selectColumn**(`column`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`column` | number | + +**Returns:** *void* + +___ + +### selectRow + +▸ **selectRow**(`row`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | + +**Returns:** *void* + +___ + +### selectedRanges + +▸ **selectedRanges**(): *Range[]* + +**Returns:** *Range[]* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setCellWidget + +▸ **setCellWidget**(`row`: number, `column`: number, `widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | +`column` | number | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### setColumnWidth + +▸ **setColumnWidth**(`column`: number, `width`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`column` | number | +`width` | number | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setHorizontalHeaderItem + +▸ **setHorizontalHeaderItem**(`column`: number, `item`: [QTableWidgetItem](qtablewidgetitem.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`column` | number | +`item` | [QTableWidgetItem](qtablewidgetitem.md) | + +**Returns:** *void* + +___ + +### setHorizontalHeaderLabels + +▸ **setHorizontalHeaderLabels**(`labels`: string[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`labels` | string[] | + +**Returns:** *void* + +___ + +### setHorizontalScrollBarPolicy + +▸ **setHorizontalScrollBarPolicy**(`policy`: [ScrollBarPolicy](../enums/scrollbarpolicy.md)): *void* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[setHorizontalScrollBarPolicy](qabstractscrollarea.md#sethorizontalscrollbarpolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`policy` | [ScrollBarPolicy](../enums/scrollbarpolicy.md) | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setItem + +▸ **setItem**(`row`: number, `column`: number, `item`: [QTableWidgetItem](qtablewidgetitem.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | +`column` | number | +`item` | [QTableWidgetItem](qtablewidgetitem.md) | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QTableWidgetSignals](../interfaces/qtablewidgetsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QTableWidgetSignals](../interfaces/qtablewidgetsignals.md)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setRowHeight + +▸ **setRowHeight**(`row`: number, `height`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setShowGrid + +▸ **setShowGrid**(`show`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`show` | boolean | + +**Returns:** *void* + +___ + +### setSortingEnabled + +▸ **setSortingEnabled**(`enable`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`enable` | boolean | + +**Returns:** *void* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setVerticalHeaderItem + +▸ **setVerticalHeaderItem**(`row`: number, `item`: [QTableWidgetItem](qtablewidgetitem.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | +`item` | [QTableWidgetItem](qtablewidgetitem.md) | + +**Returns:** *void* + +___ + +### setVerticalHeaderLabels + +▸ **setVerticalHeaderLabels**(`labels`: string[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`labels` | string[] | + +**Returns:** *void* + +___ + +### setVerticalScrollBarPolicy + +▸ **setVerticalScrollBarPolicy**(`policy`: [ScrollBarPolicy](../enums/scrollbarpolicy.md)): *void* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[setVerticalScrollBarPolicy](qabstractscrollarea.md#setverticalscrollbarpolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`policy` | [ScrollBarPolicy](../enums/scrollbarpolicy.md) | + +**Returns:** *void* + +___ + +### setViewport + +▸ **setViewport**(`widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[setViewport](qabstractscrollarea.md#setviewport)* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showColumn + +▸ **showColumn**(`column`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`column` | number | + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showGrid + +▸ **showGrid**(): *boolean* + +**Returns:** *boolean* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### showRow + +▸ **showRow**(`row`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### sortByColumn + +▸ **sortByColumn**(`column`: number, `order`: [SortOrder](../enums/sortorder.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`column` | number | +`order` | [SortOrder](../enums/sortorder.md) | + +**Returns:** *void* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### viewport + +▸ **viewport**(): *[QWidget](qwidget.md)* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[viewport](qabstractscrollarea.md#viewport)* + +**Returns:** *[QWidget](qwidget.md)* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qtablewidgetitem.md b/website/docs/api/generated/classes/qtablewidgetitem.md new file mode 100644 index 000000000..ce4c2fe77 --- /dev/null +++ b/website/docs/api/generated/classes/qtablewidgetitem.md @@ -0,0 +1,157 @@ +--- +id: "qtablewidgetitem" +title: "QTableWidgetItem" +sidebar_label: "QTableWidgetItem" +--- + +## Hierarchy + +* [Component](component.md) + + ↳ **QTableWidgetItem** + +## Index + +### Constructors + +* [constructor](qtablewidgetitem.md#constructor) + +### Properties + +* [native](qtablewidgetitem.md#native) +* [nodeChildren](qtablewidgetitem.md#nodechildren) +* [nodeParent](qtablewidgetitem.md#optional-nodeparent) + +### Methods + +* [setNodeParent](qtablewidgetitem.md#setnodeparent) +* [setText](qtablewidgetitem.md#settext) +* [setTextAlignment](qtablewidgetitem.md#settextalignment) +* [setToolTip](qtablewidgetitem.md#settooltip) +* [text](qtablewidgetitem.md#text) +* [textAlignment](qtablewidgetitem.md#textalignment) +* [toolTip](qtablewidgetitem.md#tooltip) + +## Constructors + +### constructor + +\+ **new QTableWidgetItem**(): *[QTableWidgetItem](qtablewidgetitem.md)* + +**Returns:** *[QTableWidgetItem](qtablewidgetitem.md)* + +\+ **new QTableWidgetItem**(`text`: string): *[QTableWidgetItem](qtablewidgetitem.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +**Returns:** *[QTableWidgetItem](qtablewidgetitem.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### 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* + +___ + +### setText + +▸ **setText**(`text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +**Returns:** *void* + +___ + +### setTextAlignment + +▸ **setTextAlignment**(`alignment`: [AlignmentFlag](../enums/alignmentflag.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`alignment` | [AlignmentFlag](../enums/alignmentflag.md) | + +**Returns:** *void* + +___ + +### setToolTip + +▸ **setToolTip**(`text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +**Returns:** *void* + +___ + +### text + +▸ **text**(): *string* + +**Returns:** *string* + +___ + +### textAlignment + +▸ **textAlignment**(): *[AlignmentFlag](../enums/alignmentflag.md)* + +**Returns:** *[AlignmentFlag](../enums/alignmentflag.md)* + +___ + +### toolTip + +▸ **toolTip**(): *string* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qtabwidget.md b/website/docs/api/generated/classes/qtabwidget.md new file mode 100644 index 000000000..8c3c9faeb --- /dev/null +++ b/website/docs/api/generated/classes/qtabwidget.md @@ -0,0 +1,1034 @@ +--- +id: "qtabwidget" +title: "QTabWidget" +sidebar_label: "QTabWidget" +--- + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QTabWidgetSignals](../interfaces/qtabwidgetsignals.md)› + + ↳ **QTabWidget** + +## Index + +### Constructors + +* [constructor](qtabwidget.md#constructor) + +### Properties + +* [_rawInlineStyle](qtabwidget.md#_rawinlinestyle) +* [layout](qtabwidget.md#optional-layout) +* [native](qtabwidget.md#native) +* [nodeChildren](qtabwidget.md#nodechildren) +* [nodeParent](qtabwidget.md#optional-nodeparent) +* [tabs](qtabwidget.md#tabs) +* [type](qtabwidget.md#type) + +### Methods + +* [activateWindow](qtabwidget.md#activatewindow) +* [addEventListener](qtabwidget.md#addeventlistener) +* [addTab](qtabwidget.md#addtab) +* [adjustSize](qtabwidget.md#adjustsize) +* [close](qtabwidget.md#close) +* [currentIndex](qtabwidget.md#currentindex) +* [geometry](qtabwidget.md#geometry) +* [getFlexNode](qtabwidget.md#getflexnode) +* [hasMouseTracking](qtabwidget.md#hasmousetracking) +* [hide](qtabwidget.md#hide) +* [inherits](qtabwidget.md#inherits) +* [isEnabled](qtabwidget.md#isenabled) +* [isVisible](qtabwidget.md#isvisible) +* [lower](qtabwidget.md#lower) +* [move](qtabwidget.md#move) +* [objectName](qtabwidget.md#objectname) +* [pos](qtabwidget.md#pos) +* [property](qtabwidget.md#property) +* [raise](qtabwidget.md#raise) +* [removeEventListener](qtabwidget.md#removeeventlistener) +* [removeTab](qtabwidget.md#removetab) +* [repaint](qtabwidget.md#repaint) +* [resize](qtabwidget.md#resize) +* [setAttribute](qtabwidget.md#setattribute) +* [setContextMenuPolicy](qtabwidget.md#setcontextmenupolicy) +* [setCurrentIndex](qtabwidget.md#setcurrentindex) +* [setCursor](qtabwidget.md#setcursor) +* [setEnabled](qtabwidget.md#setenabled) +* [setFixedSize](qtabwidget.md#setfixedsize) +* [setFlexNodeSizeControlled](qtabwidget.md#setflexnodesizecontrolled) +* [setGeometry](qtabwidget.md#setgeometry) +* [setInlineStyle](qtabwidget.md#setinlinestyle) +* [setLayout](qtabwidget.md#setlayout) +* [setMaximumSize](qtabwidget.md#setmaximumsize) +* [setMinimumSize](qtabwidget.md#setminimumsize) +* [setMouseTracking](qtabwidget.md#setmousetracking) +* [setNodeParent](qtabwidget.md#setnodeparent) +* [setObjectName](qtabwidget.md#setobjectname) +* [setProperty](qtabwidget.md#setproperty) +* [setStyleSheet](qtabwidget.md#setstylesheet) +* [setTabPosition](qtabwidget.md#settabposition) +* [setTabsClosable](qtabwidget.md#settabsclosable) +* [setWindowFlag](qtabwidget.md#setwindowflag) +* [setWindowIcon](qtabwidget.md#setwindowicon) +* [setWindowOpacity](qtabwidget.md#setwindowopacity) +* [setWindowState](qtabwidget.md#setwindowstate) +* [setWindowTitle](qtabwidget.md#setwindowtitle) +* [show](qtabwidget.md#show) +* [showFullScreen](qtabwidget.md#showfullscreen) +* [showMaximized](qtabwidget.md#showmaximized) +* [showMinimized](qtabwidget.md#showminimized) +* [showNormal](qtabwidget.md#shownormal) +* [size](qtabwidget.md#size) +* [styleSheet](qtabwidget.md#stylesheet) +* [testAttribute](qtabwidget.md#testattribute) +* [update](qtabwidget.md#update) +* [updateGeometry](qtabwidget.md#updategeometry) +* [windowOpacity](qtabwidget.md#windowopacity) +* [windowState](qtabwidget.md#windowstate) +* [windowTitle](qtabwidget.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QTabWidget**(): *[QTabWidget](qtabwidget.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QTabWidget](qtabwidget.md)* + +\+ **new QTabWidget**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QTabWidget](qtabwidget.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QTabWidget](qtabwidget.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QTabWidgetSignals](../interfaces/qtabwidgetsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### tabs + +• **tabs**: *[NodeWidget](nodewidget.md)‹any›[]* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QTabWidgetSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### addTab + +▸ **addTab**(`page`: [NodeWidget](nodewidget.md)‹any›, `icon`: [QIcon](qicon.md), `label`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`page` | [NodeWidget](nodewidget.md)‹any› | +`icon` | [QIcon](qicon.md) | +`label` | string | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### currentIndex + +▸ **currentIndex**(): *number* + +**Returns:** *number* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QTabWidgetSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### removeTab + +▸ **removeTab**(`index`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`index` | number | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCurrentIndex + +▸ **setCurrentIndex**(`index`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`index` | number | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QTabWidgetSignals](../interfaces/qtabwidgetsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QTabWidgetSignals](../interfaces/qtabwidgetsignals.md)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setTabPosition + +▸ **setTabPosition**(`tabPosition`: [TabPosition](../enums/tabposition.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`tabPosition` | [TabPosition](../enums/tabposition.md) | + +**Returns:** *void* + +___ + +### setTabsClosable + +▸ **setTabsClosable**(`closeable`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`closeable` | boolean | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qtoolbutton.md b/website/docs/api/generated/classes/qtoolbutton.md new file mode 100644 index 000000000..ea813b073 --- /dev/null +++ b/website/docs/api/generated/classes/qtoolbutton.md @@ -0,0 +1,1138 @@ +--- +id: "qtoolbutton" +title: "QToolButton" +sidebar_label: "QToolButton" +--- + +## Hierarchy + + ↳ [QAbstractButton](qabstractbutton.md)‹[QToolButtonSignals](../interfaces/qtoolbuttonsignals.md)› + + ↳ **QToolButton** + +## Index + +### Constructors + +* [constructor](qtoolbutton.md#constructor) + +### Properties + +* [_rawInlineStyle](qtoolbutton.md#_rawinlinestyle) +* [layout](qtoolbutton.md#optional-layout) +* [native](qtoolbutton.md#native) +* [nodeChildren](qtoolbutton.md#nodechildren) +* [nodeParent](qtoolbutton.md#optional-nodeparent) +* [type](qtoolbutton.md#type) + +### Methods + +* [activateWindow](qtoolbutton.md#activatewindow) +* [addEventListener](qtoolbutton.md#addeventlistener) +* [adjustSize](qtoolbutton.md#adjustsize) +* [arrowType](qtoolbutton.md#arrowtype) +* [autoRaise](qtoolbutton.md#autoraise) +* [close](qtoolbutton.md#close) +* [geometry](qtoolbutton.md#geometry) +* [getFlexNode](qtoolbutton.md#getflexnode) +* [hasMouseTracking](qtoolbutton.md#hasmousetracking) +* [hide](qtoolbutton.md#hide) +* [iconSize](qtoolbutton.md#iconsize) +* [inherits](qtoolbutton.md#inherits) +* [isEnabled](qtoolbutton.md#isenabled) +* [isVisible](qtoolbutton.md#isvisible) +* [lower](qtoolbutton.md#lower) +* [move](qtoolbutton.md#move) +* [objectName](qtoolbutton.md#objectname) +* [popupMode](qtoolbutton.md#popupmode) +* [pos](qtoolbutton.md#pos) +* [property](qtoolbutton.md#property) +* [raise](qtoolbutton.md#raise) +* [removeEventListener](qtoolbutton.md#removeeventlistener) +* [repaint](qtoolbutton.md#repaint) +* [resize](qtoolbutton.md#resize) +* [setArrowType](qtoolbutton.md#setarrowtype) +* [setAttribute](qtoolbutton.md#setattribute) +* [setAutoRaise](qtoolbutton.md#setautoraise) +* [setContextMenuPolicy](qtoolbutton.md#setcontextmenupolicy) +* [setCursor](qtoolbutton.md#setcursor) +* [setDefaultAction](qtoolbutton.md#setdefaultaction) +* [setEnabled](qtoolbutton.md#setenabled) +* [setFixedSize](qtoolbutton.md#setfixedsize) +* [setFlexNodeSizeControlled](qtoolbutton.md#setflexnodesizecontrolled) +* [setGeometry](qtoolbutton.md#setgeometry) +* [setIcon](qtoolbutton.md#seticon) +* [setIconSize](qtoolbutton.md#seticonsize) +* [setInlineStyle](qtoolbutton.md#setinlinestyle) +* [setLayout](qtoolbutton.md#setlayout) +* [setMaximumSize](qtoolbutton.md#setmaximumsize) +* [setMenu](qtoolbutton.md#setmenu) +* [setMinimumSize](qtoolbutton.md#setminimumsize) +* [setMouseTracking](qtoolbutton.md#setmousetracking) +* [setNodeParent](qtoolbutton.md#setnodeparent) +* [setObjectName](qtoolbutton.md#setobjectname) +* [setPopupMode](qtoolbutton.md#setpopupmode) +* [setProperty](qtoolbutton.md#setproperty) +* [setStyleSheet](qtoolbutton.md#setstylesheet) +* [setText](qtoolbutton.md#settext) +* [setToolButtonStyle](qtoolbutton.md#settoolbuttonstyle) +* [setWindowFlag](qtoolbutton.md#setwindowflag) +* [setWindowIcon](qtoolbutton.md#setwindowicon) +* [setWindowOpacity](qtoolbutton.md#setwindowopacity) +* [setWindowState](qtoolbutton.md#setwindowstate) +* [setWindowTitle](qtoolbutton.md#setwindowtitle) +* [show](qtoolbutton.md#show) +* [showFullScreen](qtoolbutton.md#showfullscreen) +* [showMaximized](qtoolbutton.md#showmaximized) +* [showMenu](qtoolbutton.md#showmenu) +* [showMinimized](qtoolbutton.md#showminimized) +* [showNormal](qtoolbutton.md#shownormal) +* [size](qtoolbutton.md#size) +* [styleSheet](qtoolbutton.md#stylesheet) +* [testAttribute](qtoolbutton.md#testattribute) +* [toolButtonStyle](qtoolbutton.md#toolbuttonstyle) +* [update](qtoolbutton.md#update) +* [updateGeometry](qtoolbutton.md#updategeometry) +* [windowOpacity](qtoolbutton.md#windowopacity) +* [windowState](qtoolbutton.md#windowstate) +* [windowTitle](qtoolbutton.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QToolButton**(): *[QToolButton](qtoolbutton.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QToolButton](qtoolbutton.md)* + +\+ **new QToolButton**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QToolButton](qtoolbutton.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QToolButton](qtoolbutton.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QToolButtonSignals](../interfaces/qtoolbuttonsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QToolButtonSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### arrowType + +▸ **arrowType**(): *[ArrowType](../enums/arrowtype.md)* + +**Returns:** *[ArrowType](../enums/arrowtype.md)* + +___ + +### autoRaise + +▸ **autoRaise**(): *boolean* + +**Returns:** *boolean* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### iconSize + +▸ **iconSize**(): *[QSize](qsize.md)* + +*Inherited from [QAbstractButton](qabstractbutton.md).[iconSize](qabstractbutton.md#iconsize)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### popupMode + +▸ **popupMode**(): *[ToolButtonPopupMode](../enums/toolbuttonpopupmode.md)* + +**Returns:** *[ToolButtonPopupMode](../enums/toolbuttonpopupmode.md)* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QToolButtonSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setArrowType + +▸ **setArrowType**(`type`: [ArrowType](../enums/arrowtype.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`type` | [ArrowType](../enums/arrowtype.md) | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setAutoRaise + +▸ **setAutoRaise**(`enable`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`enable` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setDefaultAction + +▸ **setDefaultAction**(`action`: [QAction](qaction.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`action` | [QAction](qaction.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setIcon + +▸ **setIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [QAbstractButton](qabstractbutton.md).[setIcon](qabstractbutton.md#seticon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setIconSize + +▸ **setIconSize**(`iconSize`: [QSize](qsize.md)): *void* + +*Inherited from [QAbstractButton](qabstractbutton.md).[setIconSize](qabstractbutton.md#seticonsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`iconSize` | [QSize](qsize.md) | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QToolButtonSignals](../interfaces/qtoolbuttonsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QToolButtonSignals](../interfaces/qtoolbuttonsignals.md)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMenu + +▸ **setMenu**(`menu`: [QMenu](qmenu.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`menu` | [QMenu](qmenu.md) | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [NodeObject](nodeobject.md).[setObjectName](nodeobject.md#setobjectname)* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +**Returns:** *void* + +___ + +### setPopupMode + +▸ **setPopupMode**(`mode`: [ToolButtonPopupMode](../enums/toolbuttonpopupmode.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`mode` | [ToolButtonPopupMode](../enums/toolbuttonpopupmode.md) | + +**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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setText + +▸ **setText**(`text`: string): *void* + +*Inherited from [QAbstractButton](qabstractbutton.md).[setText](qabstractbutton.md#settext)* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +**Returns:** *void* + +___ + +### setToolButtonStyle + +▸ **setToolButtonStyle**(`style`: [ToolButtonStyle](../enums/toolbuttonstyle.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | [ToolButtonStyle](../enums/toolbuttonstyle.md) | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMenu + +▸ **showMenu**(): *void* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### toolButtonStyle + +▸ **toolButtonStyle**(): *[ToolButtonStyle](../enums/toolbuttonstyle.md)* + +**Returns:** *[ToolButtonStyle](../enums/toolbuttonstyle.md)* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qtreewidget.md b/website/docs/api/generated/classes/qtreewidget.md new file mode 100644 index 000000000..76c1ad3f0 --- /dev/null +++ b/website/docs/api/generated/classes/qtreewidget.md @@ -0,0 +1,1058 @@ +--- +id: "qtreewidget" +title: "QTreeWidget" +sidebar_label: "QTreeWidget" +--- + +## Hierarchy + + ↳ [QAbstractScrollArea](qabstractscrollarea.md)‹[QTreeWidgetSignals](../interfaces/qtreewidgetsignals.md)› + + ↳ **QTreeWidget** + +## Index + +### Constructors + +* [constructor](qtreewidget.md#constructor) + +### Properties + +* [_rawInlineStyle](qtreewidget.md#_rawinlinestyle) +* [layout](qtreewidget.md#optional-layout) +* [native](qtreewidget.md#native) +* [nodeChildren](qtreewidget.md#nodechildren) +* [nodeParent](qtreewidget.md#optional-nodeparent) +* [topLevelItems](qtreewidget.md#toplevelitems) +* [type](qtreewidget.md#type) +* [viewportWidget](qtreewidget.md#optional-viewportwidget) + +### Methods + +* [activateWindow](qtreewidget.md#activatewindow) +* [addEventListener](qtreewidget.md#addeventlistener) +* [addTopLevelItem](qtreewidget.md#addtoplevelitem) +* [adjustSize](qtreewidget.md#adjustsize) +* [close](qtreewidget.md#close) +* [geometry](qtreewidget.md#geometry) +* [getFlexNode](qtreewidget.md#getflexnode) +* [hasMouseTracking](qtreewidget.md#hasmousetracking) +* [hide](qtreewidget.md#hide) +* [inherits](qtreewidget.md#inherits) +* [isEnabled](qtreewidget.md#isenabled) +* [isVisible](qtreewidget.md#isvisible) +* [lower](qtreewidget.md#lower) +* [move](qtreewidget.md#move) +* [objectName](qtreewidget.md#objectname) +* [pos](qtreewidget.md#pos) +* [property](qtreewidget.md#property) +* [raise](qtreewidget.md#raise) +* [removeEventListener](qtreewidget.md#removeeventlistener) +* [repaint](qtreewidget.md#repaint) +* [resize](qtreewidget.md#resize) +* [selectedItems](qtreewidget.md#selecteditems) +* [setAttribute](qtreewidget.md#setattribute) +* [setContextMenuPolicy](qtreewidget.md#setcontextmenupolicy) +* [setCursor](qtreewidget.md#setcursor) +* [setEnabled](qtreewidget.md#setenabled) +* [setFixedSize](qtreewidget.md#setfixedsize) +* [setFlexNodeSizeControlled](qtreewidget.md#setflexnodesizecontrolled) +* [setGeometry](qtreewidget.md#setgeometry) +* [setHeaderHidden](qtreewidget.md#setheaderhidden) +* [setHorizontalScrollBarPolicy](qtreewidget.md#sethorizontalscrollbarpolicy) +* [setInlineStyle](qtreewidget.md#setinlinestyle) +* [setLayout](qtreewidget.md#setlayout) +* [setMaximumSize](qtreewidget.md#setmaximumsize) +* [setMinimumSize](qtreewidget.md#setminimumsize) +* [setMouseTracking](qtreewidget.md#setmousetracking) +* [setNodeParent](qtreewidget.md#setnodeparent) +* [setObjectName](qtreewidget.md#setobjectname) +* [setProperty](qtreewidget.md#setproperty) +* [setStyleSheet](qtreewidget.md#setstylesheet) +* [setVerticalScrollBarPolicy](qtreewidget.md#setverticalscrollbarpolicy) +* [setViewport](qtreewidget.md#setviewport) +* [setWindowFlag](qtreewidget.md#setwindowflag) +* [setWindowIcon](qtreewidget.md#setwindowicon) +* [setWindowOpacity](qtreewidget.md#setwindowopacity) +* [setWindowState](qtreewidget.md#setwindowstate) +* [setWindowTitle](qtreewidget.md#setwindowtitle) +* [show](qtreewidget.md#show) +* [showFullScreen](qtreewidget.md#showfullscreen) +* [showMaximized](qtreewidget.md#showmaximized) +* [showMinimized](qtreewidget.md#showminimized) +* [showNormal](qtreewidget.md#shownormal) +* [size](qtreewidget.md#size) +* [styleSheet](qtreewidget.md#stylesheet) +* [testAttribute](qtreewidget.md#testattribute) +* [update](qtreewidget.md#update) +* [updateGeometry](qtreewidget.md#updategeometry) +* [viewport](qtreewidget.md#viewport) +* [windowOpacity](qtreewidget.md#windowopacity) +* [windowState](qtreewidget.md#windowstate) +* [windowTitle](qtreewidget.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QTreeWidget**(): *[QTreeWidget](qtreewidget.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Returns:** *[QTreeWidget](qtreewidget.md)* + +\+ **new QTreeWidget**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QTreeWidget](qtreewidget.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *[QTreeWidget](qtreewidget.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QTreeWidgetSignals](../interfaces/qtreewidgetsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### topLevelItems + +• **topLevelItems**: *Set‹[QTreeWidgetItem](qtreewidgetitem.md)›* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +___ + +### `Optional` viewportWidget + +• **viewportWidget**? : *[NodeWidget](nodewidget.md)‹any›* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[viewportWidget](qabstractscrollarea.md#optional-viewportwidget)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QTreeWidgetSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### addTopLevelItem + +▸ **addTopLevelItem**(`item`: [QTreeWidgetItem](qtreewidgetitem.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`item` | [QTreeWidgetItem](qtreewidgetitem.md) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QTreeWidgetSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### selectedItems + +▸ **selectedItems**(): *[QTreeWidgetItem](qtreewidgetitem.md)[]* + +**Returns:** *[QTreeWidgetItem](qtreewidgetitem.md)[]* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setHeaderHidden + +▸ **setHeaderHidden**(`hide`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`hide` | boolean | + +**Returns:** *void* + +___ + +### setHorizontalScrollBarPolicy + +▸ **setHorizontalScrollBarPolicy**(`policy`: [ScrollBarPolicy](../enums/scrollbarpolicy.md)): *void* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[setHorizontalScrollBarPolicy](qabstractscrollarea.md#sethorizontalscrollbarpolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`policy` | [ScrollBarPolicy](../enums/scrollbarpolicy.md) | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QTreeWidgetSignals](../interfaces/qtreewidgetsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QTreeWidgetSignals](../interfaces/qtreewidgetsignals.md)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setVerticalScrollBarPolicy + +▸ **setVerticalScrollBarPolicy**(`policy`: [ScrollBarPolicy](../enums/scrollbarpolicy.md)): *void* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[setVerticalScrollBarPolicy](qabstractscrollarea.md#setverticalscrollbarpolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`policy` | [ScrollBarPolicy](../enums/scrollbarpolicy.md) | + +**Returns:** *void* + +___ + +### setViewport + +▸ **setViewport**(`widget`: [NodeWidget](nodewidget.md)‹any›): *void* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[setViewport](qabstractscrollarea.md#setviewport)* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](nodewidget.md)‹any› | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### viewport + +▸ **viewport**(): *[QWidget](qwidget.md)* + +*Inherited from [QAbstractScrollArea](qabstractscrollarea.md).[viewport](qabstractscrollarea.md#viewport)* + +**Returns:** *[QWidget](qwidget.md)* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qtreewidgetitem.md b/website/docs/api/generated/classes/qtreewidgetitem.md new file mode 100644 index 000000000..08d018703 --- /dev/null +++ b/website/docs/api/generated/classes/qtreewidgetitem.md @@ -0,0 +1,211 @@ +--- +id: "qtreewidgetitem" +title: "QTreeWidgetItem" +sidebar_label: "QTreeWidgetItem" +--- + +## Hierarchy + +* [Component](component.md) + + ↳ **QTreeWidgetItem** + +## Index + +### Constructors + +* [constructor](qtreewidgetitem.md#constructor) + +### Properties + +* [native](qtreewidgetitem.md#native) +* [nodeChildren](qtreewidgetitem.md#nodechildren) +* [nodeParent](qtreewidgetitem.md#optional-nodeparent) + +### Methods + +* [child](qtreewidgetitem.md#child) +* [childCount](qtreewidgetitem.md#childcount) +* [parent](qtreewidgetitem.md#parent) +* [setExpanded](qtreewidgetitem.md#setexpanded) +* [setNodeParent](qtreewidgetitem.md#setnodeparent) +* [setSelected](qtreewidgetitem.md#setselected) +* [setText](qtreewidgetitem.md#settext) +* [text](qtreewidgetitem.md#text) + +## Constructors + +### constructor + +\+ **new QTreeWidgetItem**(): *[QTreeWidgetItem](qtreewidgetitem.md)* + +**Returns:** *[QTreeWidgetItem](qtreewidgetitem.md)* + +\+ **new QTreeWidgetItem**(`parent`: [QTreeWidgetItem](qtreewidgetitem.md), `strings?`: string[]): *[QTreeWidgetItem](qtreewidgetitem.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [QTreeWidgetItem](qtreewidgetitem.md) | +`strings?` | string[] | + +**Returns:** *[QTreeWidgetItem](qtreewidgetitem.md)* + +\+ **new QTreeWidgetItem**(`parent`: [QTreeWidget](qtreewidget.md), `strings?`: string[]): *[QTreeWidgetItem](qtreewidgetitem.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parent` | [QTreeWidget](qtreewidget.md) | +`strings?` | string[] | + +**Returns:** *[QTreeWidgetItem](qtreewidgetitem.md)* + +\+ **new QTreeWidgetItem**(`native`: [NativeElement](../globals.md#nativeelement)): *[QTreeWidgetItem](qtreewidgetitem.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QTreeWidgetItem](qtreewidgetitem.md)* + +\+ **new QTreeWidgetItem**(`strings`: string[]): *[QTreeWidgetItem](qtreewidgetitem.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`strings` | string[] | + +**Returns:** *[QTreeWidgetItem](qtreewidgetitem.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### child + +▸ **child**(`index`: number): *[QTreeWidgetItem](qtreewidgetitem.md) | undefined* + +**Parameters:** + +Name | Type | +------ | ------ | +`index` | number | + +**Returns:** *[QTreeWidgetItem](qtreewidgetitem.md) | undefined* + +___ + +### childCount + +▸ **childCount**(): *number* + +**Returns:** *number* + +___ + +### parent + +▸ **parent**(): *[QTreeWidgetItem](qtreewidgetitem.md) | undefined* + +**Returns:** *[QTreeWidgetItem](qtreewidgetitem.md) | undefined* + +___ + +### setExpanded + +▸ **setExpanded**(`expanded`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`expanded` | boolean | + +**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* + +___ + +### setSelected + +▸ **setSelected**(`selected`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`selected` | boolean | + +**Returns:** *void* + +___ + +### setText + +▸ **setText**(`column`: number, `text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`column` | number | +`text` | string | + +**Returns:** *void* + +___ + +### text + +▸ **text**(`column`: number): *string* + +**Parameters:** + +Name | Type | +------ | ------ | +`column` | number | + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qurl.md b/website/docs/api/generated/classes/qurl.md new file mode 100644 index 000000000..8ec7690e5 --- /dev/null +++ b/website/docs/api/generated/classes/qurl.md @@ -0,0 +1,135 @@ +--- +id: "qurl" +title: "QUrl" +sidebar_label: "QUrl" +--- + +## Hierarchy + +* [Component](component.md) + + ↳ **QUrl** + +## Index + +### Constructors + +* [constructor](qurl.md#constructor) + +### Properties + +* [native](qurl.md#native) +* [nodeChildren](qurl.md#nodechildren) +* [nodeParent](qurl.md#optional-nodeparent) + +### Methods + +* [setNodeParent](qurl.md#setnodeparent) +* [setUrl](qurl.md#seturl) +* [toString](qurl.md#tostring) +* [fromQVariant](qurl.md#static-fromqvariant) + +## Constructors + +### constructor + +\+ **new QUrl**(): *[QUrl](qurl.md)* + +**Returns:** *[QUrl](qurl.md)* + +\+ **new QUrl**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QUrl](qurl.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`nativeElement` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QUrl](qurl.md)* + +\+ **new QUrl**(`url`: string, `parsingMode?`: [ParsingMode](../enums/parsingmode.md)): *[QUrl](qurl.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`url` | string | +`parsingMode?` | [ParsingMode](../enums/parsingmode.md) | + +**Returns:** *[QUrl](qurl.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### 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* + +___ + +### setUrl + +▸ **setUrl**(`url`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`url` | string | + +**Returns:** *void* + +___ + +### toString + +▸ **toString**(): *string* + +**Returns:** *string* + +___ + +### `Static` fromQVariant + +▸ **fromQVariant**(`variant`: [QVariant](qvariant.md)): *[QUrl](qurl.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`variant` | [QVariant](qvariant.md) | + +**Returns:** *[QUrl](qurl.md)* diff --git a/website/docs/api/generated/classes/qvariant.md b/website/docs/api/generated/classes/qvariant.md new file mode 100644 index 000000000..d5356cc3b --- /dev/null +++ b/website/docs/api/generated/classes/qvariant.md @@ -0,0 +1,131 @@ +--- +id: "qvariant" +title: "QVariant" +sidebar_label: "QVariant" +--- + +## Hierarchy + +* [Component](component.md) + + ↳ **QVariant** + +## Index + +### Constructors + +* [constructor](qvariant.md#constructor) + +### Properties + +* [native](qvariant.md#native) +* [nodeChildren](qvariant.md#nodechildren) +* [nodeParent](qvariant.md#optional-nodeparent) + +### Methods + +* [setNodeParent](qvariant.md#setnodeparent) +* [toBool](qvariant.md#tobool) +* [toDouble](qvariant.md#todouble) +* [toInt](qvariant.md#toint) +* [toString](qvariant.md#tostring) + +## Constructors + +### constructor + +\+ **new QVariant**(): *[QVariant](qvariant.md)* + +**Returns:** *[QVariant](qvariant.md)* + +\+ **new QVariant**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QVariant](qvariant.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`nativeElement` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QVariant](qvariant.md)* + +\+ **new QVariant**(`variant`: [QVariantType](../globals.md#qvarianttype)): *[QVariant](qvariant.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`variant` | [QVariantType](../globals.md#qvarianttype) | + +**Returns:** *[QVariant](qvariant.md)* + +## Properties + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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 + +### 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* + +___ + +### toBool + +▸ **toBool**(): *boolean* + +**Returns:** *boolean* + +___ + +### toDouble + +▸ **toDouble**(): *number* + +**Returns:** *number* + +___ + +### toInt + +▸ **toInt**(): *number* + +**Returns:** *number* + +___ + +### toString + +▸ **toString**(): *string* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/qwidget.md b/website/docs/api/generated/classes/qwidget.md new file mode 100644 index 000000000..b547eb5a3 --- /dev/null +++ b/website/docs/api/generated/classes/qwidget.md @@ -0,0 +1,951 @@ +--- +id: "qwidget" +title: "QWidget" +sidebar_label: "QWidget" +--- + +> Create and control views. + +**This class is a JS wrapper around Qt's [QWidget class](https://doc.qt.io/qt-5/qwidget.html)** + +A `QWidget` can be used to encapsulate other widgets and provide structure. It functions similar to a `div` in the web world. + +### Example + +```javascript +const { QWidget } = require("@nodegui/nodegui"); + +const view = new QWidget(); +view.setObjectName("container"); //Similar to setting `id` on the web +view.setLayout(new FlexLayout()); +``` + +## Hierarchy + + ↳ [NodeWidget](nodewidget.md)‹[QWidgetSignals](../interfaces/qwidgetsignals.md)› + + ↳ **QWidget** + +## Index + +### Constructors + +* [constructor](qwidget.md#constructor) + +### Properties + +* [_rawInlineStyle](qwidget.md#_rawinlinestyle) +* [layout](qwidget.md#optional-layout) +* [native](qwidget.md#native) +* [nodeChildren](qwidget.md#nodechildren) +* [nodeParent](qwidget.md#optional-nodeparent) +* [type](qwidget.md#type) + +### Methods + +* [activateWindow](qwidget.md#activatewindow) +* [addEventListener](qwidget.md#addeventlistener) +* [adjustSize](qwidget.md#adjustsize) +* [close](qwidget.md#close) +* [geometry](qwidget.md#geometry) +* [getFlexNode](qwidget.md#getflexnode) +* [hasMouseTracking](qwidget.md#hasmousetracking) +* [hide](qwidget.md#hide) +* [inherits](qwidget.md#inherits) +* [isEnabled](qwidget.md#isenabled) +* [isVisible](qwidget.md#isvisible) +* [lower](qwidget.md#lower) +* [move](qwidget.md#move) +* [objectName](qwidget.md#objectname) +* [pos](qwidget.md#pos) +* [property](qwidget.md#property) +* [raise](qwidget.md#raise) +* [removeEventListener](qwidget.md#removeeventlistener) +* [repaint](qwidget.md#repaint) +* [resize](qwidget.md#resize) +* [setAttribute](qwidget.md#setattribute) +* [setContextMenuPolicy](qwidget.md#setcontextmenupolicy) +* [setCursor](qwidget.md#setcursor) +* [setEnabled](qwidget.md#setenabled) +* [setFixedSize](qwidget.md#setfixedsize) +* [setFlexNodeSizeControlled](qwidget.md#setflexnodesizecontrolled) +* [setGeometry](qwidget.md#setgeometry) +* [setInlineStyle](qwidget.md#setinlinestyle) +* [setLayout](qwidget.md#setlayout) +* [setMaximumSize](qwidget.md#setmaximumsize) +* [setMinimumSize](qwidget.md#setminimumsize) +* [setMouseTracking](qwidget.md#setmousetracking) +* [setNodeParent](qwidget.md#setnodeparent) +* [setObjectName](qwidget.md#setobjectname) +* [setProperty](qwidget.md#setproperty) +* [setStyleSheet](qwidget.md#setstylesheet) +* [setWindowFlag](qwidget.md#setwindowflag) +* [setWindowIcon](qwidget.md#setwindowicon) +* [setWindowOpacity](qwidget.md#setwindowopacity) +* [setWindowState](qwidget.md#setwindowstate) +* [setWindowTitle](qwidget.md#setwindowtitle) +* [show](qwidget.md#show) +* [showFullScreen](qwidget.md#showfullscreen) +* [showMaximized](qwidget.md#showmaximized) +* [showMinimized](qwidget.md#showminimized) +* [showNormal](qwidget.md#shownormal) +* [size](qwidget.md#size) +* [styleSheet](qwidget.md#stylesheet) +* [testAttribute](qwidget.md#testattribute) +* [update](qwidget.md#update) +* [updateGeometry](qwidget.md#updategeometry) +* [windowOpacity](qwidget.md#windowopacity) +* [windowState](qwidget.md#windowstate) +* [windowTitle](qwidget.md#windowtitle) + +## Constructors + +### constructor + +\+ **new QWidget**(`arg?`: [NodeWidget](nodewidget.md)‹[QWidgetSignals](../interfaces/qwidgetsignals.md)› | [NativeElement](../globals.md#nativeelement)): *[QWidget](qwidget.md)* + +*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`arg?` | [NodeWidget](nodewidget.md)‹[QWidgetSignals](../interfaces/qwidgetsignals.md)› | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[QWidget](qwidget.md)* + +## Properties + +### _rawInlineStyle + +• **_rawInlineStyle**: *string* = "" + +*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)* + +___ + +### `Optional` layout + +• **layout**? : *[NodeLayout](nodelayout.md)‹[QWidgetSignals](../interfaces/qwidgetsignals.md)›* + +*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)* + +___ + +### native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Overrides [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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)* + +___ + +### type + +• **type**: *string* = "widget" + +*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)* + +## Methods + +### activateWindow + +▸ **activateWindow**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)* + +**Returns:** *void* + +___ + +### addEventListener + +▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QWidgetSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### adjustSize + +▸ **adjustSize**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)* + +**Returns:** *void* + +___ + +### close + +▸ **close**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)* + +**Returns:** *boolean* + +___ + +### geometry + +▸ **geometry**(): *[QRect](qrect.md)* + +*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)* + +**Returns:** *[QRect](qrect.md)* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### hasMouseTracking + +▸ **hasMouseTracking**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)* + +**Returns:** *boolean* + +___ + +### hide + +▸ **hide**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)* + +**Returns:** *void* + +___ + +### inherits + +▸ **inherits**(`className`: string): *boolean* + +*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)* + +**Parameters:** + +Name | Type | +------ | ------ | +`className` | string | + +**Returns:** *boolean* + +___ + +### isEnabled + +▸ **isEnabled**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)* + +**Returns:** *boolean* + +___ + +### isVisible + +▸ **isVisible**(): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)* + +**Returns:** *boolean* + +___ + +### lower + +▸ **lower**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)* + +**Returns:** *void* + +___ + +### move + +▸ **move**(`x`: number, `y`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### objectName + +▸ **objectName**(): *string* + +*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)* + +**Returns:** *string* + +___ + +### pos + +▸ **pos**(): *object* + +*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)* + +**Returns:** *object* + +___ + +### 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)* + +___ + +### raise + +▸ **raise**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)* + +**Returns:** *void* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof QWidgetSignals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### repaint + +▸ **repaint**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)* + +**Returns:** *void* + +___ + +### resize + +▸ **resize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setContextMenuPolicy + +▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)* + +**Parameters:** + +Name | Type | +------ | ------ | +`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) | + +**Returns:** *void* + +___ + +### setCursor + +▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`cursor` | [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md) | + +**Returns:** *void* + +___ + +### setEnabled + +▸ **setEnabled**(`enabled`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)* + +**Parameters:** + +Name | Type | +------ | ------ | +`enabled` | boolean | + +**Returns:** *void* + +___ + +### setFixedSize + +▸ **setFixedSize**(`width`: number, `height`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`width` | number | +`height` | number | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**Returns:** *void* + +___ + +### setGeometry + +▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)* + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | +`w` | number | +`h` | number | + +**Returns:** *void* + +___ + +### setInlineStyle + +▸ **setInlineStyle**(`style`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`style` | string | + +**Returns:** *void* + +___ + +### setLayout + +▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QWidgetSignals](../interfaces/qwidgetsignals.md)›): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)* + +**Parameters:** + +Name | Type | +------ | ------ | +`parentLayout` | [NodeLayout](nodelayout.md)‹[QWidgetSignals](../interfaces/qwidgetsignals.md)› | + +**Returns:** *void* + +___ + +### setMaximumSize + +▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`maxw` | number | +`maxh` | number | + +**Returns:** *void* + +___ + +### setMinimumSize + +▸ **setMinimumSize**(`minw`: number, `minh`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)* + +**Parameters:** + +Name | Type | +------ | ------ | +`minw` | number | +`minh` | number | + +**Returns:** *void* + +___ + +### setMouseTracking + +▸ **setMouseTracking**(`isMouseTracked`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)* + +**Parameters:** + +Name | Type | +------ | ------ | +`isMouseTracked` | boolean | + +**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 [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)* + +*Overrides [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* + +___ + +### setStyleSheet + +▸ **setStyleSheet**(`styleSheet`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)* + +**Parameters:** + +Name | Type | +------ | ------ | +`styleSheet` | string | + +**Returns:** *void* + +___ + +### setWindowFlag + +▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)* + +**Parameters:** + +Name | Type | +------ | ------ | +`windowType` | [WindowType](../enums/windowtype.md) | +`switchOn` | boolean | + +**Returns:** *void* + +___ + +### setWindowIcon + +▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)* + +**Parameters:** + +Name | Type | +------ | ------ | +`icon` | [QIcon](qicon.md) | + +**Returns:** *void* + +___ + +### setWindowOpacity + +▸ **setWindowOpacity**(`opacity`: number): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)* + +**Parameters:** + +Name | Type | +------ | ------ | +`opacity` | number | + +**Returns:** *void* + +___ + +### setWindowState + +▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [WindowState](../enums/windowstate.md) | + +**Returns:** *void* + +___ + +### setWindowTitle + +▸ **setWindowTitle**(`title`: string): *void* + +*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | + +**Returns:** *void* + +___ + +### show + +▸ **show**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)* + +**Returns:** *void* + +___ + +### showFullScreen + +▸ **showFullScreen**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)* + +**Returns:** *void* + +___ + +### showMaximized + +▸ **showMaximized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)* + +**Returns:** *void* + +___ + +### showMinimized + +▸ **showMinimized**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)* + +**Returns:** *void* + +___ + +### showNormal + +▸ **showNormal**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)* + +**Returns:** *void* + +___ + +### size + +▸ **size**(): *[QSize](qsize.md)* + +*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)* + +**Returns:** *[QSize](qsize.md)* + +___ + +### styleSheet + +▸ **styleSheet**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)* + +**Returns:** *string* + +___ + +### testAttribute + +▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean* + +*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)* + +**Parameters:** + +Name | Type | +------ | ------ | +`attribute` | [WidgetAttribute](../enums/widgetattribute.md) | + +**Returns:** *boolean* + +___ + +### update + +▸ **update**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)* + +**Returns:** *void* + +___ + +### updateGeometry + +▸ **updateGeometry**(): *void* + +*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)* + +**Returns:** *void* + +___ + +### windowOpacity + +▸ **windowOpacity**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)* + +**Returns:** *number* + +___ + +### windowState + +▸ **windowState**(): *number* + +*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)* + +**Returns:** *number* + +___ + +### windowTitle + +▸ **windowTitle**(): *string* + +*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)* + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/stylesheet.md b/website/docs/api/generated/classes/stylesheet.md new file mode 100644 index 000000000..7417e181d --- /dev/null +++ b/website/docs/api/generated/classes/stylesheet.md @@ -0,0 +1,29 @@ +--- +id: "stylesheet" +title: "StyleSheet" +sidebar_label: "StyleSheet" +--- + +## Hierarchy + +* **StyleSheet** + +## Index + +### Methods + +* [create](stylesheet.md#static-create) + +## Methods + +### `Static` create + +▸ **create**(`cssString`: string): *string* + +**Parameters:** + +Name | Type | +------ | ------ | +`cssString` | string | + +**Returns:** *string* diff --git a/website/docs/api/generated/classes/yogawidget.md b/website/docs/api/generated/classes/yogawidget.md new file mode 100644 index 000000000..6fdde60d8 --- /dev/null +++ b/website/docs/api/generated/classes/yogawidget.md @@ -0,0 +1,310 @@ +--- +id: "yogawidget" +title: "YogaWidget" +sidebar_label: "YogaWidget" +--- + +> Abstract class to add common functionality related to Flex layout to all Widgets. + +*This class implements methods related to flex layout required to be present in all widgets** + +`YogaWidget` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities related to flex layout to all widget's easily. We implement flex layout using a library called [Yoga](https://github.com/facebook/yoga). As part of yoga every widget needs to store its own flex properties such as alignItems, flexDirection etc. This is done with the help of YogaWidget. + +```javascript +const { QWidget } = require("@nodegui/nodegui"); + +const view = new QWidget(); +// getFlexNode is a method from YogaWidget +const flexNode = view.getFlexNode(); +``` + +YogaWidget helps in storing all flex properties of a widget. + +## Type parameters + +▪ **Signals**: *[QObjectSignals](../interfaces/qobjectsignals.md)* + +## Hierarchy + + ↳ [NodeObject](nodeobject.md)‹Signals› + + ↳ **YogaWidget** + + ↳ [NodeWidget](nodewidget.md) + +## Index + +### Constructors + +* [constructor](yogawidget.md#constructor) + +### Properties + +* [native](yogawidget.md#abstract-native) +* [nodeChildren](yogawidget.md#nodechildren) +* [nodeParent](yogawidget.md#optional-nodeparent) + +### Methods + +* [addEventListener](yogawidget.md#addeventlistener) +* [getFlexNode](yogawidget.md#getflexnode) +* [inherits](yogawidget.md#inherits) +* [objectName](yogawidget.md#objectname) +* [property](yogawidget.md#property) +* [removeEventListener](yogawidget.md#removeeventlistener) +* [setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled) +* [setNodeParent](yogawidget.md#setnodeparent) +* [setObjectName](yogawidget.md#setobjectname) +* [setProperty](yogawidget.md#setproperty) + +## Constructors + +### constructor + +\+ **new YogaWidget**(`native`: [NativeElement](../globals.md#nativeelement)): *[YogaWidget](yogawidget.md)* + +*Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* + +**Parameters:** + +Name | Type | +------ | ------ | +`native` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *[YogaWidget](yogawidget.md)* + +## Properties + +### `Abstract` native + +• **native**: *[NativeElement](../globals.md#nativeelement)* + +*Inherited from [Component](component.md).[native](component.md#abstract-native)* + +___ + +### nodeChildren + +• **nodeChildren**: *Set‹unknown›* = new Set() + +*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`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### getFlexNode + +▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)* + +**Returns:** *[FlexNode](../globals.md#flexnode)* + +___ + +### 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)* + +___ + +### removeEventListener + +▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void* + +*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)* + +**Type parameters:** + +▪ **SignalType**: *keyof Signals* + +**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?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`event?` | [NativeElement](../globals.md#nativeelement) | + +**Returns:** *void* + +___ + +### setFlexNodeSizeControlled + +▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void* + +sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`isSizeControlled` | boolean | | + +**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/enums/acceptmode.md b/website/docs/api/generated/enums/acceptmode.md new file mode 100644 index 000000000..791d70cd3 --- /dev/null +++ b/website/docs/api/generated/enums/acceptmode.md @@ -0,0 +1,24 @@ +--- +id: "acceptmode" +title: "AcceptMode" +sidebar_label: "AcceptMode" +--- + +## Index + +### Enumeration members + +* [AcceptOpen](acceptmode.md#acceptopen) +* [AcceptSave](acceptmode.md#acceptsave) + +## Enumeration members + +### AcceptOpen + +• **AcceptOpen**: = 0 + +___ + +### AcceptSave + +• **AcceptSave**: = 1 diff --git a/website/docs/api/generated/enums/alignmentflag.md b/website/docs/api/generated/enums/alignmentflag.md new file mode 100644 index 000000000..660b69379 --- /dev/null +++ b/website/docs/api/generated/enums/alignmentflag.md @@ -0,0 +1,73 @@ +--- +id: "alignmentflag" +title: "AlignmentFlag" +sidebar_label: "AlignmentFlag" +--- + +## Index + +### Enumeration members + +* [AlignBaseline](alignmentflag.md#alignbaseline) +* [AlignBottom](alignmentflag.md#alignbottom) +* [AlignCenter](alignmentflag.md#aligncenter) +* [AlignHCenter](alignmentflag.md#alignhcenter) +* [AlignJustify](alignmentflag.md#alignjustify) +* [AlignLeft](alignmentflag.md#alignleft) +* [AlignRight](alignmentflag.md#alignright) +* [AlignTop](alignmentflag.md#aligntop) +* [AlignVCenter](alignmentflag.md#alignvcenter) + +## Enumeration members + +### AlignBaseline + +• **AlignBaseline**: = 256 + +___ + +### AlignBottom + +• **AlignBottom**: = 64 + +___ + +### AlignCenter + +• **AlignCenter**: = 132 + +___ + +### AlignHCenter + +• **AlignHCenter**: = 4 + +___ + +### AlignJustify + +• **AlignJustify**: = 8 + +___ + +### AlignLeft + +• **AlignLeft**: = 1 + +___ + +### AlignRight + +• **AlignRight**: = 2 + +___ + +### AlignTop + +• **AlignTop**: = 32 + +___ + +### AlignVCenter + +• **AlignVCenter**: = 128 diff --git a/website/docs/api/generated/enums/anchorpoint.md b/website/docs/api/generated/enums/anchorpoint.md new file mode 100644 index 000000000..cfa7c2e9d --- /dev/null +++ b/website/docs/api/generated/enums/anchorpoint.md @@ -0,0 +1,52 @@ +--- +id: "anchorpoint" +title: "AnchorPoint" +sidebar_label: "AnchorPoint" +--- + +## Index + +### Enumeration members + +* [AnchorBottom](anchorpoint.md#anchorbottom) +* [AnchorHorizontalCenter](anchorpoint.md#anchorhorizontalcenter) +* [AnchorLeft](anchorpoint.md#anchorleft) +* [AnchorRight](anchorpoint.md#anchorright) +* [AnchorTop](anchorpoint.md#anchortop) +* [AnchorVerticalCenter](anchorpoint.md#anchorverticalcenter) + +## Enumeration members + +### AnchorBottom + +• **AnchorBottom**: = 5 + +___ + +### AnchorHorizontalCenter + +• **AnchorHorizontalCenter**: = 1 + +___ + +### AnchorLeft + +• **AnchorLeft**: = 0 + +___ + +### AnchorRight + +• **AnchorRight**: = 2 + +___ + +### AnchorTop + +• **AnchorTop**: = 3 + +___ + +### AnchorVerticalCenter + +• **AnchorVerticalCenter**: = 4 diff --git a/website/docs/api/generated/enums/applicationattribute.md b/website/docs/api/generated/enums/applicationattribute.md new file mode 100644 index 000000000..d6efe2352 --- /dev/null +++ b/website/docs/api/generated/enums/applicationattribute.md @@ -0,0 +1,199 @@ +--- +id: "applicationattribute" +title: "ApplicationAttribute" +sidebar_label: "ApplicationAttribute" +--- + +## Index + +### Enumeration members + +* [AA_CompressHighFrequencyEvents](applicationattribute.md#aa_compresshighfrequencyevents) +* [AA_CompressTabletEvents](applicationattribute.md#aa_compresstabletevents) +* [AA_DisableHighDpiScaling](applicationattribute.md#aa_disablehighdpiscaling) +* [AA_DisableShaderDiskCache](applicationattribute.md#aa_disableshaderdiskcache) +* [AA_DisableWindowContextHelpButton](applicationattribute.md#aa_disablewindowcontexthelpbutton) +* [AA_DontCheckOpenGLContextThreadAffinity](applicationattribute.md#aa_dontcheckopenglcontextthreadaffinity) +* [AA_DontCreateNativeWidgetSiblings](applicationattribute.md#aa_dontcreatenativewidgetsiblings) +* [AA_DontShowIconsInMenus](applicationattribute.md#aa_dontshowiconsinmenus) +* [AA_DontShowShortcutsInContextMenus](applicationattribute.md#aa_dontshowshortcutsincontextmenus) +* [AA_DontUseNativeDialogs](applicationattribute.md#aa_dontusenativedialogs) +* [AA_DontUseNativeMenuBar](applicationattribute.md#aa_dontusenativemenubar) +* [AA_EnableHighDpiScaling](applicationattribute.md#aa_enablehighdpiscaling) +* [AA_ForceRasterWidgets](applicationattribute.md#aa_forcerasterwidgets) +* [AA_MacDontSwapCtrlAndMeta](applicationattribute.md#aa_macdontswapctrlandmeta) +* [AA_NativeWindows](applicationattribute.md#aa_nativewindows) +* [AA_PluginApplication](applicationattribute.md#aa_pluginapplication) +* [AA_SetPalette](applicationattribute.md#aa_setpalette) +* [AA_ShareOpenGLContexts](applicationattribute.md#aa_shareopenglcontexts) +* [AA_SynthesizeMouseForUnhandledTabletEvents](applicationattribute.md#aa_synthesizemouseforunhandledtabletevents) +* [AA_SynthesizeMouseForUnhandledTouchEvents](applicationattribute.md#aa_synthesizemouseforunhandledtouchevents) +* [AA_SynthesizeTouchForUnhandledMouseEvents](applicationattribute.md#aa_synthesizetouchforunhandledmouseevents) +* [AA_Use96Dpi](applicationattribute.md#aa_use96dpi) +* [AA_UseDesktopOpenGL](applicationattribute.md#aa_usedesktopopengl) +* [AA_UseHighDpiPixmaps](applicationattribute.md#aa_usehighdpipixmaps) +* [AA_UseOpenGLES](applicationattribute.md#aa_useopengles) +* [AA_UseSoftwareOpenGL](applicationattribute.md#aa_usesoftwareopengl) +* [AA_UseStyleSheetPropagationInWidgetStyles](applicationattribute.md#aa_usestylesheetpropagationinwidgetstyles) + +## Enumeration members + +### AA_CompressHighFrequencyEvents + +• **AA_CompressHighFrequencyEvents**: = 25 + +___ + +### AA_CompressTabletEvents + +• **AA_CompressTabletEvents**: = 29 + +___ + +### AA_DisableHighDpiScaling + +• **AA_DisableHighDpiScaling**: = 21 + +___ + +### AA_DisableShaderDiskCache + +• **AA_DisableShaderDiskCache**: = 27 + +___ + +### AA_DisableWindowContextHelpButton + +• **AA_DisableWindowContextHelpButton**: = 30 + +___ + +### AA_DontCheckOpenGLContextThreadAffinity + +• **AA_DontCheckOpenGLContextThreadAffinity**: = 26 + +___ + +### AA_DontCreateNativeWidgetSiblings + +• **AA_DontCreateNativeWidgetSiblings**: = 4 + +___ + +### AA_DontShowIconsInMenus + +• **AA_DontShowIconsInMenus**: = 2 + +___ + +### AA_DontShowShortcutsInContextMenus + +• **AA_DontShowShortcutsInContextMenus**: = 28 + +___ + +### AA_DontUseNativeDialogs + +• **AA_DontUseNativeDialogs**: = 23 + +___ + +### AA_DontUseNativeMenuBar + +• **AA_DontUseNativeMenuBar**: = 6 + +___ + +### AA_EnableHighDpiScaling + +• **AA_EnableHighDpiScaling**: = 20 + +___ + +### AA_ForceRasterWidgets + +• **AA_ForceRasterWidgets**: = 14 + +___ + +### AA_MacDontSwapCtrlAndMeta + +• **AA_MacDontSwapCtrlAndMeta**: = 7 + +___ + +### AA_NativeWindows + +• **AA_NativeWindows**: = 3 + +___ + +### AA_PluginApplication + +• **AA_PluginApplication**: = 5 + +___ + +### AA_SetPalette + +• **AA_SetPalette**: = 19 + +___ + +### AA_ShareOpenGLContexts + +• **AA_ShareOpenGLContexts**: = 18 + +___ + +### AA_SynthesizeMouseForUnhandledTabletEvents + +• **AA_SynthesizeMouseForUnhandledTabletEvents**: = 24 + +___ + +### AA_SynthesizeMouseForUnhandledTouchEvents + +• **AA_SynthesizeMouseForUnhandledTouchEvents**: = 12 + +___ + +### AA_SynthesizeTouchForUnhandledMouseEvents + +• **AA_SynthesizeTouchForUnhandledMouseEvents**: = 11 + +___ + +### AA_Use96Dpi + +• **AA_Use96Dpi**: = 8 + +___ + +### AA_UseDesktopOpenGL + +• **AA_UseDesktopOpenGL**: = 15 + +___ + +### AA_UseHighDpiPixmaps + +• **AA_UseHighDpiPixmaps**: = 13 + +___ + +### AA_UseOpenGLES + +• **AA_UseOpenGLES**: = 16 + +___ + +### AA_UseSoftwareOpenGL + +• **AA_UseSoftwareOpenGL**: = 17 + +___ + +### AA_UseStyleSheetPropagationInWidgetStyles + +• **AA_UseStyleSheetPropagationInWidgetStyles**: = 22 diff --git a/website/docs/api/generated/enums/applicationstate.md b/website/docs/api/generated/enums/applicationstate.md new file mode 100644 index 000000000..88443d14d --- /dev/null +++ b/website/docs/api/generated/enums/applicationstate.md @@ -0,0 +1,38 @@ +--- +id: "applicationstate" +title: "ApplicationState" +sidebar_label: "ApplicationState" +--- + +## Index + +### Enumeration members + +* [ApplicationActive](applicationstate.md#applicationactive) +* [ApplicationHidden](applicationstate.md#applicationhidden) +* [ApplicationInactive](applicationstate.md#applicationinactive) +* [ApplicationSuspended](applicationstate.md#applicationsuspended) + +## Enumeration members + +### ApplicationActive + +• **ApplicationActive**: = 4 + +___ + +### ApplicationHidden + +• **ApplicationHidden**: = 1 + +___ + +### ApplicationInactive + +• **ApplicationInactive**: = 2 + +___ + +### ApplicationSuspended + +• **ApplicationSuspended**: = 0 diff --git a/website/docs/api/generated/enums/arrowtype.md b/website/docs/api/generated/enums/arrowtype.md new file mode 100644 index 000000000..08f075555 --- /dev/null +++ b/website/docs/api/generated/enums/arrowtype.md @@ -0,0 +1,45 @@ +--- +id: "arrowtype" +title: "ArrowType" +sidebar_label: "ArrowType" +--- + +## Index + +### Enumeration members + +* [DownArrow](arrowtype.md#downarrow) +* [LeftArrow](arrowtype.md#leftarrow) +* [NoArrow](arrowtype.md#noarrow) +* [RightArrow](arrowtype.md#rightarrow) +* [UpArrow](arrowtype.md#uparrow) + +## Enumeration members + +### DownArrow + +• **DownArrow**: = 2 + +___ + +### LeftArrow + +• **LeftArrow**: = 3 + +___ + +### NoArrow + +• **NoArrow**: = 0 + +___ + +### RightArrow + +• **RightArrow**: = 4 + +___ + +### UpArrow + +• **UpArrow**: = 1 diff --git a/website/docs/api/generated/enums/aspectratiomode.md b/website/docs/api/generated/enums/aspectratiomode.md new file mode 100644 index 000000000..433613261 --- /dev/null +++ b/website/docs/api/generated/enums/aspectratiomode.md @@ -0,0 +1,31 @@ +--- +id: "aspectratiomode" +title: "AspectRatioMode" +sidebar_label: "AspectRatioMode" +--- + +## Index + +### Enumeration members + +* [IgnoreAspectRatio](aspectratiomode.md#ignoreaspectratio) +* [KeepAspectRatio](aspectratiomode.md#keepaspectratio) +* [KeepAspectRatioByExpanding](aspectratiomode.md#keepaspectratiobyexpanding) + +## Enumeration members + +### IgnoreAspectRatio + +• **IgnoreAspectRatio**: = 0 + +___ + +### KeepAspectRatio + +• **KeepAspectRatio**: = 1 + +___ + +### KeepAspectRatioByExpanding + +• **KeepAspectRatioByExpanding**: = 2 diff --git a/website/docs/api/generated/enums/axis.md b/website/docs/api/generated/enums/axis.md new file mode 100644 index 000000000..1899464d7 --- /dev/null +++ b/website/docs/api/generated/enums/axis.md @@ -0,0 +1,31 @@ +--- +id: "axis" +title: "Axis" +sidebar_label: "Axis" +--- + +## Index + +### Enumeration members + +* [XAxis](axis.md#xaxis) +* [YAxis](axis.md#yaxis) +* [ZAxis](axis.md#zaxis) + +## Enumeration members + +### XAxis + +• **XAxis**: = 0 + +___ + +### YAxis + +• **YAxis**: = 1 + +___ + +### ZAxis + +• **ZAxis**: = 2 diff --git a/website/docs/api/generated/enums/bgmode.md b/website/docs/api/generated/enums/bgmode.md new file mode 100644 index 000000000..5b18fdd96 --- /dev/null +++ b/website/docs/api/generated/enums/bgmode.md @@ -0,0 +1,24 @@ +--- +id: "bgmode" +title: "BGMode" +sidebar_label: "BGMode" +--- + +## Index + +### Enumeration members + +* [OpaqueMode](bgmode.md#opaquemode) +* [TransparentMode](bgmode.md#transparentmode) + +## Enumeration members + +### OpaqueMode + +• **OpaqueMode**: = 1 + +___ + +### TransparentMode + +• **TransparentMode**: = 0 diff --git a/website/docs/api/generated/enums/brushstyle.md b/website/docs/api/generated/enums/brushstyle.md new file mode 100644 index 000000000..5021986b6 --- /dev/null +++ b/website/docs/api/generated/enums/brushstyle.md @@ -0,0 +1,143 @@ +--- +id: "brushstyle" +title: "BrushStyle" +sidebar_label: "BrushStyle" +--- + +## Index + +### Enumeration members + +* [BDiagPattern](brushstyle.md#bdiagpattern) +* [ConicalGradientPattern](brushstyle.md#conicalgradientpattern) +* [CrossPattern](brushstyle.md#crosspattern) +* [Dense1Pattern](brushstyle.md#dense1pattern) +* [Dense2Pattern](brushstyle.md#dense2pattern) +* [Dense3Pattern](brushstyle.md#dense3pattern) +* [Dense4Pattern](brushstyle.md#dense4pattern) +* [Dense5Pattern](brushstyle.md#dense5pattern) +* [Dense6Pattern](brushstyle.md#dense6pattern) +* [Dense7Pattern](brushstyle.md#dense7pattern) +* [DiagCrossPattern](brushstyle.md#diagcrosspattern) +* [FDiagPattern](brushstyle.md#fdiagpattern) +* [HorPattern](brushstyle.md#horpattern) +* [LinearGradientPattern](brushstyle.md#lineargradientpattern) +* [NoBrush](brushstyle.md#nobrush) +* [RadialGradientPattern](brushstyle.md#radialgradientpattern) +* [SolidPattern](brushstyle.md#solidpattern) +* [TexturePattern](brushstyle.md#texturepattern) +* [VerPattern](brushstyle.md#verpattern) + +## Enumeration members + +### BDiagPattern + +• **BDiagPattern**: = 12 + +___ + +### ConicalGradientPattern + +• **ConicalGradientPattern**: = 17 + +___ + +### CrossPattern + +• **CrossPattern**: = 11 + +___ + +### Dense1Pattern + +• **Dense1Pattern**: = 2 + +___ + +### Dense2Pattern + +• **Dense2Pattern**: = 3 + +___ + +### Dense3Pattern + +• **Dense3Pattern**: = 4 + +___ + +### Dense4Pattern + +• **Dense4Pattern**: = 5 + +___ + +### Dense5Pattern + +• **Dense5Pattern**: = 6 + +___ + +### Dense6Pattern + +• **Dense6Pattern**: = 7 + +___ + +### Dense7Pattern + +• **Dense7Pattern**: = 8 + +___ + +### DiagCrossPattern + +• **DiagCrossPattern**: = 14 + +___ + +### FDiagPattern + +• **FDiagPattern**: = 13 + +___ + +### HorPattern + +• **HorPattern**: = 9 + +___ + +### LinearGradientPattern + +• **LinearGradientPattern**: = 15 + +___ + +### NoBrush + +• **NoBrush**: = 0 + +___ + +### RadialGradientPattern + +• **RadialGradientPattern**: = 16 + +___ + +### SolidPattern + +• **SolidPattern**: = 1 + +___ + +### TexturePattern + +• **TexturePattern**: = 24 + +___ + +### VerPattern + +• **VerPattern**: = 10 diff --git a/website/docs/api/generated/enums/cachemode.md b/website/docs/api/generated/enums/cachemode.md new file mode 100644 index 000000000..f5dee0f8c --- /dev/null +++ b/website/docs/api/generated/enums/cachemode.md @@ -0,0 +1,24 @@ +--- +id: "cachemode" +title: "CacheMode" +sidebar_label: "CacheMode" +--- + +## Index + +### Enumeration members + +* [CacheAll](cachemode.md#cacheall) +* [CacheNone](cachemode.md#cachenone) + +## Enumeration members + +### CacheAll + +• **CacheAll**: + +___ + +### CacheNone + +• **CacheNone**: diff --git a/website/docs/api/generated/enums/casesensitivity.md b/website/docs/api/generated/enums/casesensitivity.md new file mode 100644 index 000000000..c6518d9f6 --- /dev/null +++ b/website/docs/api/generated/enums/casesensitivity.md @@ -0,0 +1,24 @@ +--- +id: "casesensitivity" +title: "CaseSensitivity" +sidebar_label: "CaseSensitivity" +--- + +## Index + +### Enumeration members + +* [CaseInsensitive](casesensitivity.md#caseinsensitive) +* [CaseSensitive](casesensitivity.md#casesensitive) + +## Enumeration members + +### CaseInsensitive + +• **CaseInsensitive**: = 0 + +___ + +### CaseSensitive + +• **CaseSensitive**: = 1 diff --git a/website/docs/api/generated/enums/checkstate.md b/website/docs/api/generated/enums/checkstate.md new file mode 100644 index 000000000..d5535f7ce --- /dev/null +++ b/website/docs/api/generated/enums/checkstate.md @@ -0,0 +1,31 @@ +--- +id: "checkstate" +title: "CheckState" +sidebar_label: "CheckState" +--- + +## Index + +### Enumeration members + +* [Checked](checkstate.md#checked) +* [PartiallyChecked](checkstate.md#partiallychecked) +* [Unchecked](checkstate.md#unchecked) + +## Enumeration members + +### Checked + +• **Checked**: = 2 + +___ + +### PartiallyChecked + +• **PartiallyChecked**: = 1 + +___ + +### Unchecked + +• **Unchecked**: = 0 diff --git a/website/docs/api/generated/enums/checksumtype.md b/website/docs/api/generated/enums/checksumtype.md new file mode 100644 index 000000000..54d288984 --- /dev/null +++ b/website/docs/api/generated/enums/checksumtype.md @@ -0,0 +1,24 @@ +--- +id: "checksumtype" +title: "ChecksumType" +sidebar_label: "ChecksumType" +--- + +## Index + +### Enumeration members + +* [ChecksumIso3309](checksumtype.md#checksumiso3309) +* [ChecksumItuV41](checksumtype.md#checksumituv41) + +## Enumeration members + +### ChecksumIso3309 + +• **ChecksumIso3309**: = 0 + +___ + +### ChecksumItuV41 + +• **ChecksumItuV41**: = 1 diff --git a/website/docs/api/generated/enums/clipoperation.md b/website/docs/api/generated/enums/clipoperation.md new file mode 100644 index 000000000..ec1269d92 --- /dev/null +++ b/website/docs/api/generated/enums/clipoperation.md @@ -0,0 +1,31 @@ +--- +id: "clipoperation" +title: "ClipOperation" +sidebar_label: "ClipOperation" +--- + +## Index + +### Enumeration members + +* [IntersectClip](clipoperation.md#intersectclip) +* [NoClip](clipoperation.md#noclip) +* [ReplaceClip](clipoperation.md#replaceclip) + +## Enumeration members + +### IntersectClip + +• **IntersectClip**: = 2 + +___ + +### NoClip + +• **NoClip**: = 0 + +___ + +### ReplaceClip + +• **ReplaceClip**: = 1 diff --git a/website/docs/api/generated/enums/connectiontype.md b/website/docs/api/generated/enums/connectiontype.md new file mode 100644 index 000000000..9485c7ac8 --- /dev/null +++ b/website/docs/api/generated/enums/connectiontype.md @@ -0,0 +1,45 @@ +--- +id: "connectiontype" +title: "ConnectionType" +sidebar_label: "ConnectionType" +--- + +## Index + +### Enumeration members + +* [AutoConnection](connectiontype.md#autoconnection) +* [BlockingQueuedConnection](connectiontype.md#blockingqueuedconnection) +* [DirectConnection](connectiontype.md#directconnection) +* [QueuedConnection](connectiontype.md#queuedconnection) +* [UniqueConnection](connectiontype.md#uniqueconnection) + +## Enumeration members + +### AutoConnection + +• **AutoConnection**: = 0 + +___ + +### BlockingQueuedConnection + +• **BlockingQueuedConnection**: = 3 + +___ + +### DirectConnection + +• **DirectConnection**: = 1 + +___ + +### QueuedConnection + +• **QueuedConnection**: = 2 + +___ + +### UniqueConnection + +• **UniqueConnection**: = 128 diff --git a/website/docs/api/generated/enums/contextmenupolicy.md b/website/docs/api/generated/enums/contextmenupolicy.md new file mode 100644 index 000000000..b989a3286 --- /dev/null +++ b/website/docs/api/generated/enums/contextmenupolicy.md @@ -0,0 +1,45 @@ +--- +id: "contextmenupolicy" +title: "ContextMenuPolicy" +sidebar_label: "ContextMenuPolicy" +--- + +## Index + +### Enumeration members + +* [ActionsContextMenu](contextmenupolicy.md#actionscontextmenu) +* [CustomContextMenu](contextmenupolicy.md#customcontextmenu) +* [DefaultContextMenu](contextmenupolicy.md#defaultcontextmenu) +* [NoContextMenu](contextmenupolicy.md#nocontextmenu) +* [PreventContextMenu](contextmenupolicy.md#preventcontextmenu) + +## Enumeration members + +### ActionsContextMenu + +• **ActionsContextMenu**: = 2 + +___ + +### CustomContextMenu + +• **CustomContextMenu**: = 3 + +___ + +### DefaultContextMenu + +• **DefaultContextMenu**: = 1 + +___ + +### NoContextMenu + +• **NoContextMenu**: = 0 + +___ + +### PreventContextMenu + +• **PreventContextMenu**: = 4 diff --git a/website/docs/api/generated/enums/coordinatesystem.md b/website/docs/api/generated/enums/coordinatesystem.md new file mode 100644 index 000000000..03c8ecca7 --- /dev/null +++ b/website/docs/api/generated/enums/coordinatesystem.md @@ -0,0 +1,24 @@ +--- +id: "coordinatesystem" +title: "CoordinateSystem" +sidebar_label: "CoordinateSystem" +--- + +## Index + +### Enumeration members + +* [DeviceCoordinates](coordinatesystem.md#devicecoordinates) +* [LogicalCoordinates](coordinatesystem.md#logicalcoordinates) + +## Enumeration members + +### DeviceCoordinates + +• **DeviceCoordinates**: = 0 + +___ + +### LogicalCoordinates + +• **LogicalCoordinates**: = 1 diff --git a/website/docs/api/generated/enums/corner.md b/website/docs/api/generated/enums/corner.md new file mode 100644 index 000000000..bf7e095d7 --- /dev/null +++ b/website/docs/api/generated/enums/corner.md @@ -0,0 +1,38 @@ +--- +id: "corner" +title: "Corner" +sidebar_label: "Corner" +--- + +## Index + +### Enumeration members + +* [BottomLeftCorner](corner.md#bottomleftcorner) +* [BottomRightCorner](corner.md#bottomrightcorner) +* [TopLeftCorner](corner.md#topleftcorner) +* [TopRightCorner](corner.md#toprightcorner) + +## Enumeration members + +### BottomLeftCorner + +• **BottomLeftCorner**: = 2 + +___ + +### BottomRightCorner + +• **BottomRightCorner**: = 3 + +___ + +### TopLeftCorner + +• **TopLeftCorner**: = 0 + +___ + +### TopRightCorner + +• **TopRightCorner**: = 1 diff --git a/website/docs/api/generated/enums/cursormovestyle.md b/website/docs/api/generated/enums/cursormovestyle.md new file mode 100644 index 000000000..8db65c89f --- /dev/null +++ b/website/docs/api/generated/enums/cursormovestyle.md @@ -0,0 +1,24 @@ +--- +id: "cursormovestyle" +title: "CursorMoveStyle" +sidebar_label: "CursorMoveStyle" +--- + +## Index + +### Enumeration members + +* [LogicalMoveStyle](cursormovestyle.md#logicalmovestyle) +* [VisualMoveStyle](cursormovestyle.md#visualmovestyle) + +## Enumeration members + +### LogicalMoveStyle + +• **LogicalMoveStyle**: = 0 + +___ + +### VisualMoveStyle + +• **VisualMoveStyle**: = 1 diff --git a/website/docs/api/generated/enums/cursorshape.md b/website/docs/api/generated/enums/cursorshape.md new file mode 100644 index 000000000..0975d9cc3 --- /dev/null +++ b/website/docs/api/generated/enums/cursorshape.md @@ -0,0 +1,171 @@ +--- +id: "cursorshape" +title: "CursorShape" +sidebar_label: "CursorShape" +--- + +## Index + +### Enumeration members + +* [ArrowCursor](cursorshape.md#arrowcursor) +* [BitmapCursor](cursorshape.md#bitmapcursor) +* [BlankCursor](cursorshape.md#blankcursor) +* [BusyCursor](cursorshape.md#busycursor) +* [ClosedHandCursor](cursorshape.md#closedhandcursor) +* [CrossCursor](cursorshape.md#crosscursor) +* [DragCopyCursor](cursorshape.md#dragcopycursor) +* [DragLinkCursor](cursorshape.md#draglinkcursor) +* [DragMoveCursor](cursorshape.md#dragmovecursor) +* [ForbiddenCursor](cursorshape.md#forbiddencursor) +* [IBeamCursor](cursorshape.md#ibeamcursor) +* [OpenHandCursor](cursorshape.md#openhandcursor) +* [PointingHandCursor](cursorshape.md#pointinghandcursor) +* [SizeAllCursor](cursorshape.md#sizeallcursor) +* [SizeBDiagCursor](cursorshape.md#sizebdiagcursor) +* [SizeFDiagCursor](cursorshape.md#sizefdiagcursor) +* [SizeHorCursor](cursorshape.md#sizehorcursor) +* [SizeVerCursor](cursorshape.md#sizevercursor) +* [SplitHCursor](cursorshape.md#splithcursor) +* [SplitVCursor](cursorshape.md#splitvcursor) +* [UpArrowCursor](cursorshape.md#uparrowcursor) +* [WaitCursor](cursorshape.md#waitcursor) +* [WhatsThisCursor](cursorshape.md#whatsthiscursor) + +## Enumeration members + +### ArrowCursor + +• **ArrowCursor**: = 0 + +___ + +### BitmapCursor + +• **BitmapCursor**: = 24 + +___ + +### BlankCursor + +• **BlankCursor**: = 10 + +___ + +### BusyCursor + +• **BusyCursor**: = 16 + +___ + +### ClosedHandCursor + +• **ClosedHandCursor**: = 18 + +___ + +### CrossCursor + +• **CrossCursor**: = 2 + +___ + +### DragCopyCursor + +• **DragCopyCursor**: = 19 + +___ + +### DragLinkCursor + +• **DragLinkCursor**: = 21 + +___ + +### DragMoveCursor + +• **DragMoveCursor**: = 20 + +___ + +### ForbiddenCursor + +• **ForbiddenCursor**: = 14 + +___ + +### IBeamCursor + +• **IBeamCursor**: = 4 + +___ + +### OpenHandCursor + +• **OpenHandCursor**: = 17 + +___ + +### PointingHandCursor + +• **PointingHandCursor**: = 13 + +___ + +### SizeAllCursor + +• **SizeAllCursor**: = 9 + +___ + +### SizeBDiagCursor + +• **SizeBDiagCursor**: = 7 + +___ + +### SizeFDiagCursor + +• **SizeFDiagCursor**: = 8 + +___ + +### SizeHorCursor + +• **SizeHorCursor**: = 6 + +___ + +### SizeVerCursor + +• **SizeVerCursor**: = 5 + +___ + +### SplitHCursor + +• **SplitHCursor**: = 12 + +___ + +### SplitVCursor + +• **SplitVCursor**: = 11 + +___ + +### UpArrowCursor + +• **UpArrowCursor**: = 1 + +___ + +### WaitCursor + +• **WaitCursor**: = 3 + +___ + +### WhatsThisCursor + +• **WhatsThisCursor**: = 15 diff --git a/website/docs/api/generated/enums/dateformat.md b/website/docs/api/generated/enums/dateformat.md new file mode 100644 index 000000000..87339126a --- /dev/null +++ b/website/docs/api/generated/enums/dateformat.md @@ -0,0 +1,87 @@ +--- +id: "dateformat" +title: "DateFormat" +sidebar_label: "DateFormat" +--- + +## Index + +### Enumeration members + +* [DefaultLocaleLongDate](dateformat.md#defaultlocalelongdate) +* [DefaultLocaleShortDate](dateformat.md#defaultlocaleshortdate) +* [ISODate](dateformat.md#isodate) +* [ISODateWithMs](dateformat.md#isodatewithms) +* [LocalDate](dateformat.md#localdate) +* [LocaleDate](dateformat.md#localedate) +* [RFC2822Date](dateformat.md#rfc2822date) +* [SystemLocaleDate](dateformat.md#systemlocaledate) +* [SystemLocaleLongDate](dateformat.md#systemlocalelongdate) +* [SystemLocaleShortDate](dateformat.md#systemlocaleshortdate) +* [TextDate](dateformat.md#textdate) + +## Enumeration members + +### DefaultLocaleLongDate + +• **DefaultLocaleLongDate**: = 7 + +___ + +### DefaultLocaleShortDate + +• **DefaultLocaleShortDate**: = 6 + +___ + +### ISODate + +• **ISODate**: = 1 + +___ + +### ISODateWithMs + +• **ISODateWithMs**: = 9 + +___ + +### LocalDate + +• **LocalDate**: = 2 + +___ + +### LocaleDate + +• **LocaleDate**: = 3 + +___ + +### RFC2822Date + +• **RFC2822Date**: = 8 + +___ + +### SystemLocaleDate + +• **SystemLocaleDate**: = 2 + +___ + +### SystemLocaleLongDate + +• **SystemLocaleLongDate**: = 5 + +___ + +### SystemLocaleShortDate + +• **SystemLocaleShortDate**: = 4 + +___ + +### TextDate + +• **TextDate**: = 0 diff --git a/website/docs/api/generated/enums/dayofweek.md b/website/docs/api/generated/enums/dayofweek.md new file mode 100644 index 000000000..3812c9296 --- /dev/null +++ b/website/docs/api/generated/enums/dayofweek.md @@ -0,0 +1,59 @@ +--- +id: "dayofweek" +title: "DayOfWeek" +sidebar_label: "DayOfWeek" +--- + +## Index + +### Enumeration members + +* [Friday](dayofweek.md#friday) +* [Monday](dayofweek.md#monday) +* [Saturday](dayofweek.md#saturday) +* [Sunday](dayofweek.md#sunday) +* [Thursday](dayofweek.md#thursday) +* [Tuesday](dayofweek.md#tuesday) +* [Wednesday](dayofweek.md#wednesday) + +## Enumeration members + +### Friday + +• **Friday**: = 5 + +___ + +### Monday + +• **Monday**: = 1 + +___ + +### Saturday + +• **Saturday**: = 6 + +___ + +### Sunday + +• **Sunday**: = 7 + +___ + +### Thursday + +• **Thursday**: = 4 + +___ + +### Tuesday + +• **Tuesday**: = 2 + +___ + +### Wednesday + +• **Wednesday**: = 3 diff --git a/website/docs/api/generated/enums/dialoglabel.md b/website/docs/api/generated/enums/dialoglabel.md new file mode 100644 index 000000000..5ffc97cb7 --- /dev/null +++ b/website/docs/api/generated/enums/dialoglabel.md @@ -0,0 +1,45 @@ +--- +id: "dialoglabel" +title: "DialogLabel" +sidebar_label: "DialogLabel" +--- + +## Index + +### Enumeration members + +* [Accept](dialoglabel.md#accept) +* [FileName](dialoglabel.md#filename) +* [FileType](dialoglabel.md#filetype) +* [LookIn](dialoglabel.md#lookin) +* [Reject](dialoglabel.md#reject) + +## Enumeration members + +### Accept + +• **Accept**: = 3 + +___ + +### FileName + +• **FileName**: = 1 + +___ + +### FileType + +• **FileType**: = 2 + +___ + +### LookIn + +• **LookIn**: = 0 + +___ + +### Reject + +• **Reject**: = 4 diff --git a/website/docs/api/generated/enums/direction.md b/website/docs/api/generated/enums/direction.md new file mode 100644 index 000000000..e24632e1b --- /dev/null +++ b/website/docs/api/generated/enums/direction.md @@ -0,0 +1,38 @@ +--- +id: "direction" +title: "Direction" +sidebar_label: "Direction" +--- + +## Index + +### Enumeration members + +* [BottomToTop](direction.md#bottomtotop) +* [LeftToRight](direction.md#lefttoright) +* [RightToLeft](direction.md#righttoleft) +* [TopToBottom](direction.md#toptobottom) + +## Enumeration members + +### BottomToTop + +• **BottomToTop**: = 3 + +___ + +### LeftToRight + +• **LeftToRight**: = 0 + +___ + +### RightToLeft + +• **RightToLeft**: = 1 + +___ + +### TopToBottom + +• **TopToBottom**: = 2 diff --git a/website/docs/api/generated/enums/dockwidgetarea.md b/website/docs/api/generated/enums/dockwidgetarea.md new file mode 100644 index 000000000..c4f86dc5b --- /dev/null +++ b/website/docs/api/generated/enums/dockwidgetarea.md @@ -0,0 +1,52 @@ +--- +id: "dockwidgetarea" +title: "DockWidgetArea" +sidebar_label: "DockWidgetArea" +--- + +## Index + +### Enumeration members + +* [AllDockWidgetAreas](dockwidgetarea.md#alldockwidgetareas) +* [BottomDockWidgetArea](dockwidgetarea.md#bottomdockwidgetarea) +* [LeftDockWidgetArea](dockwidgetarea.md#leftdockwidgetarea) +* [NoDockWidgetArea](dockwidgetarea.md#nodockwidgetarea) +* [RightDockWidgetArea](dockwidgetarea.md#rightdockwidgetarea) +* [TopDockWidgetArea](dockwidgetarea.md#topdockwidgetarea) + +## Enumeration members + +### AllDockWidgetAreas + +• **AllDockWidgetAreas**: = 21 + +___ + +### BottomDockWidgetArea + +• **BottomDockWidgetArea**: = 8 + +___ + +### LeftDockWidgetArea + +• **LeftDockWidgetArea**: = 1 + +___ + +### NoDockWidgetArea + +• **NoDockWidgetArea**: = 0 + +___ + +### RightDockWidgetArea + +• **RightDockWidgetArea**: = 2 + +___ + +### TopDockWidgetArea + +• **TopDockWidgetArea**: = 4 diff --git a/website/docs/api/generated/enums/dropaction.md b/website/docs/api/generated/enums/dropaction.md new file mode 100644 index 000000000..ca0141480 --- /dev/null +++ b/website/docs/api/generated/enums/dropaction.md @@ -0,0 +1,52 @@ +--- +id: "dropaction" +title: "DropAction" +sidebar_label: "DropAction" +--- + +## Index + +### Enumeration members + +* [ActionMask](dropaction.md#actionmask) +* [CopyAction](dropaction.md#copyaction) +* [IgnoreAction](dropaction.md#ignoreaction) +* [LinkAction](dropaction.md#linkaction) +* [MoveAction](dropaction.md#moveaction) +* [TargetMoveAction](dropaction.md#targetmoveaction) + +## Enumeration members + +### ActionMask + +• **ActionMask**: = 255 + +___ + +### CopyAction + +• **CopyAction**: = 1 + +___ + +### IgnoreAction + +• **IgnoreAction**: = 0 + +___ + +### LinkAction + +• **LinkAction**: = 4 + +___ + +### MoveAction + +• **MoveAction**: = 2 + +___ + +### TargetMoveAction + +• **TargetMoveAction**: = 32770 diff --git a/website/docs/api/generated/enums/echomode.md b/website/docs/api/generated/enums/echomode.md new file mode 100644 index 000000000..6902ce51b --- /dev/null +++ b/website/docs/api/generated/enums/echomode.md @@ -0,0 +1,38 @@ +--- +id: "echomode" +title: "EchoMode" +sidebar_label: "EchoMode" +--- + +## Index + +### Enumeration members + +* [NoEcho](echomode.md#noecho) +* [Normal](echomode.md#normal) +* [Password](echomode.md#password) +* [PasswordEchoOnEdit](echomode.md#passwordechoonedit) + +## Enumeration members + +### NoEcho + +• **NoEcho**: + +___ + +### Normal + +• **Normal**: + +___ + +### Password + +• **Password**: + +___ + +### PasswordEchoOnEdit + +• **PasswordEchoOnEdit**: diff --git a/website/docs/api/generated/enums/edge.md b/website/docs/api/generated/enums/edge.md new file mode 100644 index 000000000..98f1c6e73 --- /dev/null +++ b/website/docs/api/generated/enums/edge.md @@ -0,0 +1,38 @@ +--- +id: "edge" +title: "Edge" +sidebar_label: "Edge" +--- + +## Index + +### Enumeration members + +* [BottomEdge](edge.md#bottomedge) +* [LeftEdge](edge.md#leftedge) +* [RightEdge](edge.md#rightedge) +* [TopEdge](edge.md#topedge) + +## Enumeration members + +### BottomEdge + +• **BottomEdge**: = 8 + +___ + +### LeftEdge + +• **LeftEdge**: = 2 + +___ + +### RightEdge + +• **RightEdge**: = 4 + +___ + +### TopEdge + +• **TopEdge**: = 1 diff --git a/website/docs/api/generated/enums/enterkeytype.md b/website/docs/api/generated/enums/enterkeytype.md new file mode 100644 index 000000000..c5e5d2a3f --- /dev/null +++ b/website/docs/api/generated/enums/enterkeytype.md @@ -0,0 +1,66 @@ +--- +id: "enterkeytype" +title: "EnterKeyType" +sidebar_label: "EnterKeyType" +--- + +## Index + +### Enumeration members + +* [EnterKeyDefault](enterkeytype.md#enterkeydefault) +* [EnterKeyDone](enterkeytype.md#enterkeydone) +* [EnterKeyGo](enterkeytype.md#enterkeygo) +* [EnterKeyNext](enterkeytype.md#enterkeynext) +* [EnterKeyPrevious](enterkeytype.md#enterkeyprevious) +* [EnterKeyReturn](enterkeytype.md#enterkeyreturn) +* [EnterKeySearch](enterkeytype.md#enterkeysearch) +* [EnterKeySend](enterkeytype.md#enterkeysend) + +## Enumeration members + +### EnterKeyDefault + +• **EnterKeyDefault**: = 0 + +___ + +### EnterKeyDone + +• **EnterKeyDone**: = 2 + +___ + +### EnterKeyGo + +• **EnterKeyGo**: = 3 + +___ + +### EnterKeyNext + +• **EnterKeyNext**: = 6 + +___ + +### EnterKeyPrevious + +• **EnterKeyPrevious**: = 7 + +___ + +### EnterKeyReturn + +• **EnterKeyReturn**: = 1 + +___ + +### EnterKeySearch + +• **EnterKeySearch**: = 5 + +___ + +### EnterKeySend + +• **EnterKeySend**: = 4 diff --git a/website/docs/api/generated/enums/eventpriority.md b/website/docs/api/generated/enums/eventpriority.md new file mode 100644 index 000000000..7ff0c249d --- /dev/null +++ b/website/docs/api/generated/enums/eventpriority.md @@ -0,0 +1,31 @@ +--- +id: "eventpriority" +title: "EventPriority" +sidebar_label: "EventPriority" +--- + +## Index + +### Enumeration members + +* [HighEventPriority](eventpriority.md#higheventpriority) +* [LowEventPriority](eventpriority.md#loweventpriority) +* [NormalEventPriority](eventpriority.md#normaleventpriority) + +## Enumeration members + +### HighEventPriority + +• **HighEventPriority**: = 1 + +___ + +### LowEventPriority + +• **LowEventPriority**: = -1 + +___ + +### NormalEventPriority + +• **NormalEventPriority**: = 0 diff --git a/website/docs/api/generated/enums/filemode.md b/website/docs/api/generated/enums/filemode.md new file mode 100644 index 000000000..39323419b --- /dev/null +++ b/website/docs/api/generated/enums/filemode.md @@ -0,0 +1,38 @@ +--- +id: "filemode" +title: "FileMode" +sidebar_label: "FileMode" +--- + +## Index + +### Enumeration members + +* [AnyFile](filemode.md#anyfile) +* [Directory](filemode.md#directory) +* [ExistingFile](filemode.md#existingfile) +* [ExistingFiles](filemode.md#existingfiles) + +## Enumeration members + +### AnyFile + +• **AnyFile**: = 0 + +___ + +### Directory + +• **Directory**: = 2 + +___ + +### ExistingFile + +• **ExistingFile**: = 1 + +___ + +### ExistingFiles + +• **ExistingFiles**: = 3 diff --git a/website/docs/api/generated/enums/fillrule.md b/website/docs/api/generated/enums/fillrule.md new file mode 100644 index 000000000..373d8cf57 --- /dev/null +++ b/website/docs/api/generated/enums/fillrule.md @@ -0,0 +1,24 @@ +--- +id: "fillrule" +title: "FillRule" +sidebar_label: "FillRule" +--- + +## Index + +### Enumeration members + +* [OddEvenFill](fillrule.md#oddevenfill) +* [WindingFill](fillrule.md#windingfill) + +## Enumeration members + +### OddEvenFill + +• **OddEvenFill**: = 0 + +___ + +### WindingFill + +• **WindingFill**: = 1 diff --git a/website/docs/api/generated/enums/findchildoption.md b/website/docs/api/generated/enums/findchildoption.md new file mode 100644 index 000000000..21b5984bc --- /dev/null +++ b/website/docs/api/generated/enums/findchildoption.md @@ -0,0 +1,24 @@ +--- +id: "findchildoption" +title: "FindChildOption" +sidebar_label: "FindChildOption" +--- + +## Index + +### Enumeration members + +* [FindChildrenRecursively](findchildoption.md#findchildrenrecursively) +* [FindDirectChildrenOnly](findchildoption.md#finddirectchildrenonly) + +## Enumeration members + +### FindChildrenRecursively + +• **FindChildrenRecursively**: = 1 + +___ + +### FindDirectChildrenOnly + +• **FindDirectChildrenOnly**: = 0 diff --git a/website/docs/api/generated/enums/focuspolicy.md b/website/docs/api/generated/enums/focuspolicy.md new file mode 100644 index 000000000..89a7e6484 --- /dev/null +++ b/website/docs/api/generated/enums/focuspolicy.md @@ -0,0 +1,45 @@ +--- +id: "focuspolicy" +title: "FocusPolicy" +sidebar_label: "FocusPolicy" +--- + +## Index + +### Enumeration members + +* [ClickFocus](focuspolicy.md#clickfocus) +* [NoFocus](focuspolicy.md#nofocus) +* [StrongFocus](focuspolicy.md#strongfocus) +* [TabFocus](focuspolicy.md#tabfocus) +* [WheelFocus](focuspolicy.md#wheelfocus) + +## Enumeration members + +### ClickFocus + +• **ClickFocus**: = 2 + +___ + +### NoFocus + +• **NoFocus**: = 0 + +___ + +### StrongFocus + +• **StrongFocus**: = 11 + +___ + +### TabFocus + +• **TabFocus**: = 1 + +___ + +### WheelFocus + +• **WheelFocus**: = 15 diff --git a/website/docs/api/generated/enums/focusreason.md b/website/docs/api/generated/enums/focusreason.md new file mode 100644 index 000000000..482693d87 --- /dev/null +++ b/website/docs/api/generated/enums/focusreason.md @@ -0,0 +1,66 @@ +--- +id: "focusreason" +title: "FocusReason" +sidebar_label: "FocusReason" +--- + +## Index + +### Enumeration members + +* [ActiveWindowFocusReason](focusreason.md#activewindowfocusreason) +* [BacktabFocusReason](focusreason.md#backtabfocusreason) +* [MenuBarFocusReason](focusreason.md#menubarfocusreason) +* [MouseFocusReason](focusreason.md#mousefocusreason) +* [OtherFocusReason](focusreason.md#otherfocusreason) +* [PopupFocusReason](focusreason.md#popupfocusreason) +* [ShortcutFocusReason](focusreason.md#shortcutfocusreason) +* [TabFocusReason](focusreason.md#tabfocusreason) + +## Enumeration members + +### ActiveWindowFocusReason + +• **ActiveWindowFocusReason**: = 3 + +___ + +### BacktabFocusReason + +• **BacktabFocusReason**: = 2 + +___ + +### MenuBarFocusReason + +• **MenuBarFocusReason**: = 6 + +___ + +### MouseFocusReason + +• **MouseFocusReason**: = 0 + +___ + +### OtherFocusReason + +• **OtherFocusReason**: = 7 + +___ + +### PopupFocusReason + +• **PopupFocusReason**: = 4 + +___ + +### ShortcutFocusReason + +• **ShortcutFocusReason**: = 5 + +___ + +### TabFocusReason + +• **TabFocusReason**: = 1 diff --git a/website/docs/api/generated/enums/gestureflag.md b/website/docs/api/generated/enums/gestureflag.md new file mode 100644 index 000000000..0464afcf2 --- /dev/null +++ b/website/docs/api/generated/enums/gestureflag.md @@ -0,0 +1,31 @@ +--- +id: "gestureflag" +title: "GestureFlag" +sidebar_label: "GestureFlag" +--- + +## Index + +### Enumeration members + +* [DontStartGestureOnChildren](gestureflag.md#dontstartgestureonchildren) +* [IgnoredGesturesPropagateToParent](gestureflag.md#ignoredgesturespropagatetoparent) +* [ReceivePartialGestures](gestureflag.md#receivepartialgestures) + +## Enumeration members + +### DontStartGestureOnChildren + +• **DontStartGestureOnChildren**: = 1 + +___ + +### IgnoredGesturesPropagateToParent + +• **IgnoredGesturesPropagateToParent**: = 4 + +___ + +### ReceivePartialGestures + +• **ReceivePartialGestures**: = 2 diff --git a/website/docs/api/generated/enums/gesturestate.md b/website/docs/api/generated/enums/gesturestate.md new file mode 100644 index 000000000..f21dcfd6e --- /dev/null +++ b/website/docs/api/generated/enums/gesturestate.md @@ -0,0 +1,45 @@ +--- +id: "gesturestate" +title: "GestureState" +sidebar_label: "GestureState" +--- + +## Index + +### Enumeration members + +* [GestureCanceled](gesturestate.md#gesturecanceled) +* [GestureFinished](gesturestate.md#gesturefinished) +* [GestureStarted](gesturestate.md#gesturestarted) +* [GestureUpdated](gesturestate.md#gestureupdated) +* [NoGesture](gesturestate.md#nogesture) + +## Enumeration members + +### GestureCanceled + +• **GestureCanceled**: = 4 + +___ + +### GestureFinished + +• **GestureFinished**: = 3 + +___ + +### GestureStarted + +• **GestureStarted**: = 1 + +___ + +### GestureUpdated + +• **GestureUpdated**: = 2 + +___ + +### NoGesture + +• **NoGesture**: = 0 diff --git a/website/docs/api/generated/enums/gesturetype.md b/website/docs/api/generated/enums/gesturetype.md new file mode 100644 index 000000000..18c73921f --- /dev/null +++ b/website/docs/api/generated/enums/gesturetype.md @@ -0,0 +1,52 @@ +--- +id: "gesturetype" +title: "GestureType" +sidebar_label: "GestureType" +--- + +## Index + +### Enumeration members + +* [CustomGesture](gesturetype.md#customgesture) +* [PanGesture](gesturetype.md#pangesture) +* [PinchGesture](gesturetype.md#pinchgesture) +* [SwipeGesture](gesturetype.md#swipegesture) +* [TapAndHoldGesture](gesturetype.md#tapandholdgesture) +* [TapGesture](gesturetype.md#tapgesture) + +## Enumeration members + +### CustomGesture + +• **CustomGesture**: = 256 + +___ + +### PanGesture + +• **PanGesture**: = 3 + +___ + +### PinchGesture + +• **PinchGesture**: = 4 + +___ + +### SwipeGesture + +• **SwipeGesture**: = 5 + +___ + +### TapAndHoldGesture + +• **TapAndHoldGesture**: = 2 + +___ + +### TapGesture + +• **TapGesture**: = 1 diff --git a/website/docs/api/generated/enums/globalcolor.md b/website/docs/api/generated/enums/globalcolor.md new file mode 100644 index 000000000..314d920b6 --- /dev/null +++ b/website/docs/api/generated/enums/globalcolor.md @@ -0,0 +1,150 @@ +--- +id: "globalcolor" +title: "GlobalColor" +sidebar_label: "GlobalColor" +--- + +## Index + +### Enumeration members + +* [black](globalcolor.md#black) +* [blue](globalcolor.md#blue) +* [color0](globalcolor.md#color0) +* [color1](globalcolor.md#color1) +* [cyan](globalcolor.md#cyan) +* [darkBlue](globalcolor.md#darkblue) +* [darkCyan](globalcolor.md#darkcyan) +* [darkGray](globalcolor.md#darkgray) +* [darkGreen](globalcolor.md#darkgreen) +* [darkMagenta](globalcolor.md#darkmagenta) +* [darkRed](globalcolor.md#darkred) +* [darkYellow](globalcolor.md#darkyellow) +* [gray](globalcolor.md#gray) +* [green](globalcolor.md#green) +* [lightGray](globalcolor.md#lightgray) +* [magenta](globalcolor.md#magenta) +* [red](globalcolor.md#red) +* [transparent](globalcolor.md#transparent) +* [white](globalcolor.md#white) +* [yellow](globalcolor.md#yellow) + +## Enumeration members + +### black + +• **black**: = 2 + +___ + +### blue + +• **blue**: = 9 + +___ + +### color0 + +• **color0**: = 0 + +___ + +### color1 + +• **color1**: = 1 + +___ + +### cyan + +• **cyan**: = 10 + +___ + +### darkBlue + +• **darkBlue**: = 15 + +___ + +### darkCyan + +• **darkCyan**: = 16 + +___ + +### darkGray + +• **darkGray**: = 4 + +___ + +### darkGreen + +• **darkGreen**: = 14 + +___ + +### darkMagenta + +• **darkMagenta**: = 17 + +___ + +### darkRed + +• **darkRed**: = 13 + +___ + +### darkYellow + +• **darkYellow**: = 18 + +___ + +### gray + +• **gray**: = 5 + +___ + +### green + +• **green**: = 8 + +___ + +### lightGray + +• **lightGray**: = 6 + +___ + +### magenta + +• **magenta**: = 11 + +___ + +### red + +• **red**: = 7 + +___ + +### transparent + +• **transparent**: = 19 + +___ + +### white + +• **white**: = 3 + +___ + +### yellow + +• **yellow**: = 12 diff --git a/website/docs/api/generated/enums/hittestaccuracy.md b/website/docs/api/generated/enums/hittestaccuracy.md new file mode 100644 index 000000000..8118a2f31 --- /dev/null +++ b/website/docs/api/generated/enums/hittestaccuracy.md @@ -0,0 +1,24 @@ +--- +id: "hittestaccuracy" +title: "HitTestAccuracy" +sidebar_label: "HitTestAccuracy" +--- + +## Index + +### Enumeration members + +* [ExactHit](hittestaccuracy.md#exacthit) +* [FuzzyHit](hittestaccuracy.md#fuzzyhit) + +## Enumeration members + +### ExactHit + +• **ExactHit**: = 0 + +___ + +### FuzzyHit + +• **FuzzyHit**: = 1 diff --git a/website/docs/api/generated/enums/imageconversionflag.md b/website/docs/api/generated/enums/imageconversionflag.md new file mode 100644 index 000000000..262aee36d --- /dev/null +++ b/website/docs/api/generated/enums/imageconversionflag.md @@ -0,0 +1,108 @@ +--- +id: "imageconversionflag" +title: "ImageConversionFlag" +sidebar_label: "ImageConversionFlag" +--- + +## Index + +### Enumeration members + +* [AutoColor](imageconversionflag.md#autocolor) +* [AutoDither](imageconversionflag.md#autodither) +* [AvoidDither](imageconversionflag.md#avoiddither) +* [ColorOnly](imageconversionflag.md#coloronly) +* [DiffuseAlphaDither](imageconversionflag.md#diffusealphadither) +* [DiffuseDither](imageconversionflag.md#diffusedither) +* [MonoOnly](imageconversionflag.md#monoonly) +* [NoFormatConversion](imageconversionflag.md#noformatconversion) +* [NoOpaqueDetection](imageconversionflag.md#noopaquedetection) +* [OrderedAlphaDither](imageconversionflag.md#orderedalphadither) +* [OrderedDither](imageconversionflag.md#ordereddither) +* [PreferDither](imageconversionflag.md#preferdither) +* [ThresholdAlphaDither](imageconversionflag.md#thresholdalphadither) +* [ThresholdDither](imageconversionflag.md#thresholddither) + +## Enumeration members + +### AutoColor + +• **AutoColor**: = 0 + +___ + +### AutoDither + +• **AutoDither**: = 0 + +___ + +### AvoidDither + +• **AvoidDither**: = 128 + +___ + +### ColorOnly + +• **ColorOnly**: = 3 + +___ + +### DiffuseAlphaDither + +• **DiffuseAlphaDither**: = 8 + +___ + +### DiffuseDither + +• **DiffuseDither**: = 0 + +___ + +### MonoOnly + +• **MonoOnly**: = 2 + +___ + +### NoFormatConversion + +• **NoFormatConversion**: = 512 + +___ + +### NoOpaqueDetection + +• **NoOpaqueDetection**: = 256 + +___ + +### OrderedAlphaDither + +• **OrderedAlphaDither**: = 4 + +___ + +### OrderedDither + +• **OrderedDither**: = 16 + +___ + +### PreferDither + +• **PreferDither**: = 64 + +___ + +### ThresholdAlphaDither + +• **ThresholdAlphaDither**: = 0 + +___ + +### ThresholdDither + +• **ThresholdDither**: = 32 diff --git a/website/docs/api/generated/enums/imagereadererror.md b/website/docs/api/generated/enums/imagereadererror.md new file mode 100644 index 000000000..496692f17 --- /dev/null +++ b/website/docs/api/generated/enums/imagereadererror.md @@ -0,0 +1,45 @@ +--- +id: "imagereadererror" +title: "ImageReaderError" +sidebar_label: "ImageReaderError" +--- + +## Index + +### Enumeration members + +* [DeviceError](imagereadererror.md#deviceerror) +* [FileNotFoundError](imagereadererror.md#filenotfounderror) +* [InvalidDataError](imagereadererror.md#invaliddataerror) +* [UnknownError](imagereadererror.md#unknownerror) +* [UnsupportedFormatError](imagereadererror.md#unsupportedformaterror) + +## Enumeration members + +### DeviceError + +• **DeviceError**: = 2 + +___ + +### FileNotFoundError + +• **FileNotFoundError**: = 1 + +___ + +### InvalidDataError + +• **InvalidDataError**: = 4 + +___ + +### UnknownError + +• **UnknownError**: = 0 + +___ + +### UnsupportedFormatError + +• **UnsupportedFormatError**: = 3 diff --git a/website/docs/api/generated/enums/inputmethodhint.md b/website/docs/api/generated/enums/inputmethodhint.md new file mode 100644 index 000000000..87b06af25 --- /dev/null +++ b/website/docs/api/generated/enums/inputmethodhint.md @@ -0,0 +1,171 @@ +--- +id: "inputmethodhint" +title: "InputMethodHint" +sidebar_label: "InputMethodHint" +--- + +## Index + +### Enumeration members + +* [ImhDate](inputmethodhint.md#imhdate) +* [ImhDialableCharactersOnly](inputmethodhint.md#imhdialablecharactersonly) +* [ImhDigitsOnly](inputmethodhint.md#imhdigitsonly) +* [ImhEmailCharactersOnly](inputmethodhint.md#imhemailcharactersonly) +* [ImhExclusiveInputMask](inputmethodhint.md#imhexclusiveinputmask) +* [ImhFormattedNumbersOnly](inputmethodhint.md#imhformattednumbersonly) +* [ImhHiddenText](inputmethodhint.md#imhhiddentext) +* [ImhLatinOnly](inputmethodhint.md#imhlatinonly) +* [ImhLowercaseOnly](inputmethodhint.md#imhlowercaseonly) +* [ImhMultiLine](inputmethodhint.md#imhmultiline) +* [ImhNoAutoUppercase](inputmethodhint.md#imhnoautouppercase) +* [ImhNoEditMenu](inputmethodhint.md#imhnoeditmenu) +* [ImhNoPredictiveText](inputmethodhint.md#imhnopredictivetext) +* [ImhNoTextHandles](inputmethodhint.md#imhnotexthandles) +* [ImhNone](inputmethodhint.md#imhnone) +* [ImhPreferLatin](inputmethodhint.md#imhpreferlatin) +* [ImhPreferLowercase](inputmethodhint.md#imhpreferlowercase) +* [ImhPreferNumbers](inputmethodhint.md#imhprefernumbers) +* [ImhPreferUppercase](inputmethodhint.md#imhpreferuppercase) +* [ImhSensitiveData](inputmethodhint.md#imhsensitivedata) +* [ImhTime](inputmethodhint.md#imhtime) +* [ImhUppercaseOnly](inputmethodhint.md#imhuppercaseonly) +* [ImhUrlCharactersOnly](inputmethodhint.md#imhurlcharactersonly) + +## Enumeration members + +### ImhDate + +• **ImhDate**: = 128 + +___ + +### ImhDialableCharactersOnly + +• **ImhDialableCharactersOnly**: = 1048576 + +___ + +### ImhDigitsOnly + +• **ImhDigitsOnly**: = 65536 + +___ + +### ImhEmailCharactersOnly + +• **ImhEmailCharactersOnly**: = 2097152 + +___ + +### ImhExclusiveInputMask + +• **ImhExclusiveInputMask**: = 4294901760 + +___ + +### ImhFormattedNumbersOnly + +• **ImhFormattedNumbersOnly**: = 131072 + +___ + +### ImhHiddenText + +• **ImhHiddenText**: = 1 + +___ + +### ImhLatinOnly + +• **ImhLatinOnly**: = 8388608 + +___ + +### ImhLowercaseOnly + +• **ImhLowercaseOnly**: = 524288 + +___ + +### ImhMultiLine + +• **ImhMultiLine**: = 1024 + +___ + +### ImhNoAutoUppercase + +• **ImhNoAutoUppercase**: = 4 + +___ + +### ImhNoEditMenu + +• **ImhNoEditMenu**: = 2048 + +___ + +### ImhNoPredictiveText + +• **ImhNoPredictiveText**: = 64 + +___ + +### ImhNoTextHandles + +• **ImhNoTextHandles**: = 4096 + +___ + +### ImhNone + +• **ImhNone**: = 0 + +___ + +### ImhPreferLatin + +• **ImhPreferLatin**: = 512 + +___ + +### ImhPreferLowercase + +• **ImhPreferLowercase**: = 32 + +___ + +### ImhPreferNumbers + +• **ImhPreferNumbers**: = 8 + +___ + +### ImhPreferUppercase + +• **ImhPreferUppercase**: = 16 + +___ + +### ImhSensitiveData + +• **ImhSensitiveData**: = 2 + +___ + +### ImhTime + +• **ImhTime**: = 256 + +___ + +### ImhUppercaseOnly + +• **ImhUppercaseOnly**: = 262144 + +___ + +### ImhUrlCharactersOnly + +• **ImhUrlCharactersOnly**: = 4194304 diff --git a/website/docs/api/generated/enums/inputmethodquery.md b/website/docs/api/generated/enums/inputmethodquery.md new file mode 100644 index 000000000..94e87b85a --- /dev/null +++ b/website/docs/api/generated/enums/inputmethodquery.md @@ -0,0 +1,143 @@ +--- +id: "inputmethodquery" +title: "InputMethodQuery" +sidebar_label: "InputMethodQuery" +--- + +## Index + +### Enumeration members + +* [ImAbsolutePosition](inputmethodquery.md#imabsoluteposition) +* [ImAnchorPosition](inputmethodquery.md#imanchorposition) +* [ImAnchorRectangle](inputmethodquery.md#imanchorrectangle) +* [ImCurrentSelection](inputmethodquery.md#imcurrentselection) +* [ImCursorPosition](inputmethodquery.md#imcursorposition) +* [ImCursorRectangle](inputmethodquery.md#imcursorrectangle) +* [ImEnabled](inputmethodquery.md#imenabled) +* [ImEnterKeyType](inputmethodquery.md#imenterkeytype) +* [ImFont](inputmethodquery.md#imfont) +* [ImHints](inputmethodquery.md#imhints) +* [ImInputItemClipRectangle](inputmethodquery.md#iminputitemcliprectangle) +* [ImMaximumTextLength](inputmethodquery.md#immaximumtextlength) +* [ImMicroFocus](inputmethodquery.md#immicrofocus) +* [ImPlatformData](inputmethodquery.md#implatformdata) +* [ImPreferredLanguage](inputmethodquery.md#impreferredlanguage) +* [ImQueryAll](inputmethodquery.md#imqueryall) +* [ImSurroundingText](inputmethodquery.md#imsurroundingtext) +* [ImTextAfterCursor](inputmethodquery.md#imtextaftercursor) +* [ImTextBeforeCursor](inputmethodquery.md#imtextbeforecursor) + +## Enumeration members + +### ImAbsolutePosition + +• **ImAbsolutePosition**: = 1024 + +___ + +### ImAnchorPosition + +• **ImAnchorPosition**: = 128 + +___ + +### ImAnchorRectangle + +• **ImAnchorRectangle**: = 16384 + +___ + +### ImCurrentSelection + +• **ImCurrentSelection**: = 32 + +___ + +### ImCursorPosition + +• **ImCursorPosition**: = 8 + +___ + +### ImCursorRectangle + +• **ImCursorRectangle**: = 2 + +___ + +### ImEnabled + +• **ImEnabled**: = 1 + +___ + +### ImEnterKeyType + +• **ImEnterKeyType**: = 8192 + +___ + +### ImFont + +• **ImFont**: = 4 + +___ + +### ImHints + +• **ImHints**: = 256 + +___ + +### ImInputItemClipRectangle + +• **ImInputItemClipRectangle**: = 32768 + +___ + +### ImMaximumTextLength + +• **ImMaximumTextLength**: = 64 + +___ + +### ImMicroFocus + +• **ImMicroFocus**: = 2 + +___ + +### ImPlatformData + +• **ImPlatformData**: = 2147483648 + +___ + +### ImPreferredLanguage + +• **ImPreferredLanguage**: = 512 + +___ + +### ImQueryAll + +• **ImQueryAll**: = 4294967295 + +___ + +### ImSurroundingText + +• **ImSurroundingText**: = 16 + +___ + +### ImTextAfterCursor + +• **ImTextAfterCursor**: = 4096 + +___ + +### ImTextBeforeCursor + +• **ImTextBeforeCursor**: = 2048 diff --git a/website/docs/api/generated/enums/insertpolicy.md b/website/docs/api/generated/enums/insertpolicy.md new file mode 100644 index 000000000..dceaecfbe --- /dev/null +++ b/website/docs/api/generated/enums/insertpolicy.md @@ -0,0 +1,59 @@ +--- +id: "insertpolicy" +title: "InsertPolicy" +sidebar_label: "InsertPolicy" +--- + +## Index + +### Enumeration members + +* [InsertAfterCurrent](insertpolicy.md#insertaftercurrent) +* [InsertAlphabetically](insertpolicy.md#insertalphabetically) +* [InsertAtBottom](insertpolicy.md#insertatbottom) +* [InsertAtCurrent](insertpolicy.md#insertatcurrent) +* [InsertAtTop](insertpolicy.md#insertattop) +* [InsertBeforeCurrent](insertpolicy.md#insertbeforecurrent) +* [NoInsert](insertpolicy.md#noinsert) + +## Enumeration members + +### InsertAfterCurrent + +• **InsertAfterCurrent**: + +___ + +### InsertAlphabetically + +• **InsertAlphabetically**: + +___ + +### InsertAtBottom + +• **InsertAtBottom**: + +___ + +### InsertAtCurrent + +• **InsertAtCurrent**: + +___ + +### InsertAtTop + +• **InsertAtTop**: + +___ + +### InsertBeforeCurrent + +• **InsertBeforeCurrent**: + +___ + +### NoInsert + +• **NoInsert**: diff --git a/website/docs/api/generated/enums/itemdatarole.md b/website/docs/api/generated/enums/itemdatarole.md new file mode 100644 index 000000000..5bc70937e --- /dev/null +++ b/website/docs/api/generated/enums/itemdatarole.md @@ -0,0 +1,59 @@ +--- +id: "itemdatarole" +title: "ItemDataRole" +sidebar_label: "ItemDataRole" +--- + +## Index + +### Enumeration members + +* [DecorationRole](itemdatarole.md#decorationrole) +* [DisplayRole](itemdatarole.md#displayrole) +* [EditRole](itemdatarole.md#editrole) +* [SizeHintRole](itemdatarole.md#sizehintrole) +* [StatusTipRole](itemdatarole.md#statustiprole) +* [ToolTipRole](itemdatarole.md#tooltiprole) +* [WhatsThisRole](itemdatarole.md#whatsthisrole) + +## Enumeration members + +### DecorationRole + +• **DecorationRole**: = 1 + +___ + +### DisplayRole + +• **DisplayRole**: = 0 + +___ + +### EditRole + +• **EditRole**: = 2 + +___ + +### SizeHintRole + +• **SizeHintRole**: = 13 + +___ + +### StatusTipRole + +• **StatusTipRole**: = 4 + +___ + +### ToolTipRole + +• **ToolTipRole**: = 3 + +___ + +### WhatsThisRole + +• **WhatsThisRole**: = 5 diff --git a/website/docs/api/generated/enums/itemflag.md b/website/docs/api/generated/enums/itemflag.md new file mode 100644 index 000000000..8437d6fc8 --- /dev/null +++ b/website/docs/api/generated/enums/itemflag.md @@ -0,0 +1,87 @@ +--- +id: "itemflag" +title: "ItemFlag" +sidebar_label: "ItemFlag" +--- + +## Index + +### Enumeration members + +* [ItemIsAutoTristate](itemflag.md#itemisautotristate) +* [ItemIsDragEnabled](itemflag.md#itemisdragenabled) +* [ItemIsDropEnabled](itemflag.md#itemisdropenabled) +* [ItemIsEditable](itemflag.md#itemiseditable) +* [ItemIsEnabled](itemflag.md#itemisenabled) +* [ItemIsSelectable](itemflag.md#itemisselectable) +* [ItemIsTristate](itemflag.md#itemistristate) +* [ItemIsUserCheckable](itemflag.md#itemisusercheckable) +* [ItemIsUserTristate](itemflag.md#itemisusertristate) +* [ItemNeverHasChildren](itemflag.md#itemneverhaschildren) +* [NoItemFlags](itemflag.md#noitemflags) + +## Enumeration members + +### ItemIsAutoTristate + +• **ItemIsAutoTristate**: = 64 + +___ + +### ItemIsDragEnabled + +• **ItemIsDragEnabled**: = 4 + +___ + +### ItemIsDropEnabled + +• **ItemIsDropEnabled**: = 8 + +___ + +### ItemIsEditable + +• **ItemIsEditable**: = 2 + +___ + +### ItemIsEnabled + +• **ItemIsEnabled**: = 32 + +___ + +### ItemIsSelectable + +• **ItemIsSelectable**: = 1 + +___ + +### ItemIsTristate + +• **ItemIsTristate**: = 64 + +___ + +### ItemIsUserCheckable + +• **ItemIsUserCheckable**: = 16 + +___ + +### ItemIsUserTristate + +• **ItemIsUserTristate**: = 256 + +___ + +### ItemNeverHasChildren + +• **ItemNeverHasChildren**: = 128 + +___ + +### NoItemFlags + +• **NoItemFlags**: = 0 diff --git a/website/docs/api/generated/enums/itemselectionmode.md b/website/docs/api/generated/enums/itemselectionmode.md new file mode 100644 index 000000000..68d89f3d2 --- /dev/null +++ b/website/docs/api/generated/enums/itemselectionmode.md @@ -0,0 +1,38 @@ +--- +id: "itemselectionmode" +title: "ItemSelectionMode" +sidebar_label: "ItemSelectionMode" +--- + +## Index + +### Enumeration members + +* [ContainsItemBoundingRect](itemselectionmode.md#containsitemboundingrect) +* [ContainsItemShape](itemselectionmode.md#containsitemshape) +* [IntersectsItemBoundingRect](itemselectionmode.md#intersectsitemboundingrect) +* [IntersectsItemShape](itemselectionmode.md#intersectsitemshape) + +## Enumeration members + +### ContainsItemBoundingRect + +• **ContainsItemBoundingRect**: = 2 + +___ + +### ContainsItemShape + +• **ContainsItemShape**: = 0 + +___ + +### IntersectsItemBoundingRect + +• **IntersectsItemBoundingRect**: = 3 + +___ + +### IntersectsItemShape + +• **IntersectsItemShape**: = 1 diff --git a/website/docs/api/generated/enums/itemselectionoperation.md b/website/docs/api/generated/enums/itemselectionoperation.md new file mode 100644 index 000000000..c031662a0 --- /dev/null +++ b/website/docs/api/generated/enums/itemselectionoperation.md @@ -0,0 +1,24 @@ +--- +id: "itemselectionoperation" +title: "ItemSelectionOperation" +sidebar_label: "ItemSelectionOperation" +--- + +## Index + +### Enumeration members + +* [AddToSelection](itemselectionoperation.md#addtoselection) +* [ReplaceSelection](itemselectionoperation.md#replaceselection) + +## Enumeration members + +### AddToSelection + +• **AddToSelection**: = 1 + +___ + +### ReplaceSelection + +• **ReplaceSelection**: = 0 diff --git a/website/docs/api/generated/enums/key.md b/website/docs/api/generated/enums/key.md new file mode 100644 index 000000000..4f43121b1 --- /dev/null +++ b/website/docs/api/generated/enums/key.md @@ -0,0 +1,3293 @@ +--- +id: "key" +title: "Key" +sidebar_label: "Key" +--- + +## Index + +### Enumeration members + +* [Key_0](key.md#key_0) +* [Key_1](key.md#key_1) +* [Key_2](key.md#key_2) +* [Key_3](key.md#key_3) +* [Key_4](key.md#key_4) +* [Key_5](key.md#key_5) +* [Key_6](key.md#key_6) +* [Key_7](key.md#key_7) +* [Key_8](key.md#key_8) +* [Key_9](key.md#key_9) +* [Key_A](key.md#key_a) +* [Key_AE](key.md#key_ae) +* [Key_Aacute](key.md#key_aacute) +* [Key_Acircumflex](key.md#key_acircumflex) +* [Key_AddFavorite](key.md#key_addfavorite) +* [Key_Adiaeresis](key.md#key_adiaeresis) +* [Key_Agrave](key.md#key_agrave) +* [Key_Alt](key.md#key_alt) +* [Key_AltGr](key.md#key_altgr) +* [Key_Ampersand](key.md#key_ampersand) +* [Key_Any](key.md#key_any) +* [Key_Apostrophe](key.md#key_apostrophe) +* [Key_ApplicationLeft](key.md#key_applicationleft) +* [Key_ApplicationRight](key.md#key_applicationright) +* [Key_Aring](key.md#key_aring) +* [Key_AsciiCircum](key.md#key_asciicircum) +* [Key_AsciiTilde](key.md#key_asciitilde) +* [Key_Asterisk](key.md#key_asterisk) +* [Key_At](key.md#key_at) +* [Key_Atilde](key.md#key_atilde) +* [Key_AudioCycleTrack](key.md#key_audiocycletrack) +* [Key_AudioForward](key.md#key_audioforward) +* [Key_AudioRandomPlay](key.md#key_audiorandomplay) +* [Key_AudioRepeat](key.md#key_audiorepeat) +* [Key_AudioRewind](key.md#key_audiorewind) +* [Key_Away](key.md#key_away) +* [Key_B](key.md#key_b) +* [Key_Back](key.md#key_back) +* [Key_BackForward](key.md#key_backforward) +* [Key_Backslash](key.md#key_backslash) +* [Key_Backspace](key.md#key_backspace) +* [Key_Backtab](key.md#key_backtab) +* [Key_Bar](key.md#key_bar) +* [Key_BassBoost](key.md#key_bassboost) +* [Key_BassDown](key.md#key_bassdown) +* [Key_BassUp](key.md#key_bassup) +* [Key_Battery](key.md#key_battery) +* [Key_Blue](key.md#key_blue) +* [Key_Bluetooth](key.md#key_bluetooth) +* [Key_Book](key.md#key_book) +* [Key_BraceLeft](key.md#key_braceleft) +* [Key_BraceRight](key.md#key_braceright) +* [Key_BracketLeft](key.md#key_bracketleft) +* [Key_BracketRight](key.md#key_bracketright) +* [Key_BrightnessAdjust](key.md#key_brightnessadjust) +* [Key_C](key.md#key_c) +* [Key_CD](key.md#key_cd) +* [Key_Calculator](key.md#key_calculator) +* [Key_Calendar](key.md#key_calendar) +* [Key_Call](key.md#key_call) +* [Key_Camera](key.md#key_camera) +* [Key_CameraFocus](key.md#key_camerafocus) +* [Key_Cancel](key.md#key_cancel) +* [Key_CapsLock](key.md#key_capslock) +* [Key_Ccedilla](key.md#key_ccedilla) +* [Key_ChannelDown](key.md#key_channeldown) +* [Key_ChannelUp](key.md#key_channelup) +* [Key_Clear](key.md#key_clear) +* [Key_ClearGrab](key.md#key_cleargrab) +* [Key_Close](key.md#key_close) +* [Key_Codeinput](key.md#key_codeinput) +* [Key_Colon](key.md#key_colon) +* [Key_Comma](key.md#key_comma) +* [Key_Community](key.md#key_community) +* [Key_Context1](key.md#key_context1) +* [Key_Context2](key.md#key_context2) +* [Key_Context3](key.md#key_context3) +* [Key_Context4](key.md#key_context4) +* [Key_ContrastAdjust](key.md#key_contrastadjust) +* [Key_Control](key.md#key_control) +* [Key_Copy](key.md#key_copy) +* [Key_Cut](key.md#key_cut) +* [Key_D](key.md#key_d) +* [Key_DOS](key.md#key_dos) +* [Key_Dead_A](key.md#key_dead_a) +* [Key_Dead_Abovecomma](key.md#key_dead_abovecomma) +* [Key_Dead_Abovedot](key.md#key_dead_abovedot) +* [Key_Dead_Abovereversedcomma](key.md#key_dead_abovereversedcomma) +* [Key_Dead_Abovering](key.md#key_dead_abovering) +* [Key_Dead_Aboveverticalline](key.md#key_dead_aboveverticalline) +* [Key_Dead_Acute](key.md#key_dead_acute) +* [Key_Dead_Belowbreve](key.md#key_dead_belowbreve) +* [Key_Dead_Belowcircumflex](key.md#key_dead_belowcircumflex) +* [Key_Dead_Belowcomma](key.md#key_dead_belowcomma) +* [Key_Dead_Belowdiaeresis](key.md#key_dead_belowdiaeresis) +* [Key_Dead_Belowdot](key.md#key_dead_belowdot) +* [Key_Dead_Belowmacron](key.md#key_dead_belowmacron) +* [Key_Dead_Belowring](key.md#key_dead_belowring) +* [Key_Dead_Belowtilde](key.md#key_dead_belowtilde) +* [Key_Dead_Belowverticalline](key.md#key_dead_belowverticalline) +* [Key_Dead_Breve](key.md#key_dead_breve) +* [Key_Dead_Capital_Schwa](key.md#key_dead_capital_schwa) +* [Key_Dead_Caron](key.md#key_dead_caron) +* [Key_Dead_Cedilla](key.md#key_dead_cedilla) +* [Key_Dead_Circumflex](key.md#key_dead_circumflex) +* [Key_Dead_Currency](key.md#key_dead_currency) +* [Key_Dead_Diaeresis](key.md#key_dead_diaeresis) +* [Key_Dead_Doubleacute](key.md#key_dead_doubleacute) +* [Key_Dead_Doublegrave](key.md#key_dead_doublegrave) +* [Key_Dead_E](key.md#key_dead_e) +* [Key_Dead_Grave](key.md#key_dead_grave) +* [Key_Dead_Greek](key.md#key_dead_greek) +* [Key_Dead_Hook](key.md#key_dead_hook) +* [Key_Dead_Horn](key.md#key_dead_horn) +* [Key_Dead_I](key.md#key_dead_i) +* [Key_Dead_Invertedbreve](key.md#key_dead_invertedbreve) +* [Key_Dead_Iota](key.md#key_dead_iota) +* [Key_Dead_Longsolidusoverlay](key.md#key_dead_longsolidusoverlay) +* [Key_Dead_Lowline](key.md#key_dead_lowline) +* [Key_Dead_Macron](key.md#key_dead_macron) +* [Key_Dead_O](key.md#key_dead_o) +* [Key_Dead_Ogonek](key.md#key_dead_ogonek) +* [Key_Dead_Semivoiced_Sound](key.md#key_dead_semivoiced_sound) +* [Key_Dead_Small_Schwa](key.md#key_dead_small_schwa) +* [Key_Dead_Stroke](key.md#key_dead_stroke) +* [Key_Dead_Tilde](key.md#key_dead_tilde) +* [Key_Dead_U](key.md#key_dead_u) +* [Key_Dead_Voiced_Sound](key.md#key_dead_voiced_sound) +* [Key_Dead_a](key.md#key_dead_a) +* [Key_Dead_e](key.md#key_dead_e) +* [Key_Dead_i](key.md#key_dead_i) +* [Key_Dead_o](key.md#key_dead_o) +* [Key_Dead_u](key.md#key_dead_u) +* [Key_Delete](key.md#key_delete) +* [Key_Direction_L](key.md#key_direction_l) +* [Key_Direction_R](key.md#key_direction_r) +* [Key_Display](key.md#key_display) +* [Key_Documents](key.md#key_documents) +* [Key_Dollar](key.md#key_dollar) +* [Key_Down](key.md#key_down) +* [Key_E](key.md#key_e) +* [Key_ETH](key.md#key_eth) +* [Key_Eacute](key.md#key_eacute) +* [Key_Ecircumflex](key.md#key_ecircumflex) +* [Key_Ediaeresis](key.md#key_ediaeresis) +* [Key_Egrave](key.md#key_egrave) +* [Key_Eisu_Shift](key.md#key_eisu_shift) +* [Key_Eisu_toggle](key.md#key_eisu_toggle) +* [Key_Eject](key.md#key_eject) +* [Key_End](key.md#key_end) +* [Key_Enter](key.md#key_enter) +* [Key_Equal](key.md#key_equal) +* [Key_Escape](key.md#key_escape) +* [Key_Excel](key.md#key_excel) +* [Key_Exclam](key.md#key_exclam) +* [Key_Execute](key.md#key_execute) +* [Key_Exit](key.md#key_exit) +* [Key_Explorer](key.md#key_explorer) +* [Key_F](key.md#key_f) +* [Key_F1](key.md#key_f1) +* [Key_F10](key.md#key_f10) +* [Key_F11](key.md#key_f11) +* [Key_F12](key.md#key_f12) +* [Key_F13](key.md#key_f13) +* [Key_F14](key.md#key_f14) +* [Key_F15](key.md#key_f15) +* [Key_F16](key.md#key_f16) +* [Key_F17](key.md#key_f17) +* [Key_F18](key.md#key_f18) +* [Key_F19](key.md#key_f19) +* [Key_F2](key.md#key_f2) +* [Key_F20](key.md#key_f20) +* [Key_F21](key.md#key_f21) +* [Key_F22](key.md#key_f22) +* [Key_F23](key.md#key_f23) +* [Key_F24](key.md#key_f24) +* [Key_F25](key.md#key_f25) +* [Key_F26](key.md#key_f26) +* [Key_F27](key.md#key_f27) +* [Key_F28](key.md#key_f28) +* [Key_F29](key.md#key_f29) +* [Key_F3](key.md#key_f3) +* [Key_F30](key.md#key_f30) +* [Key_F31](key.md#key_f31) +* [Key_F32](key.md#key_f32) +* [Key_F33](key.md#key_f33) +* [Key_F34](key.md#key_f34) +* [Key_F35](key.md#key_f35) +* [Key_F4](key.md#key_f4) +* [Key_F5](key.md#key_f5) +* [Key_F6](key.md#key_f6) +* [Key_F7](key.md#key_f7) +* [Key_F8](key.md#key_f8) +* [Key_F9](key.md#key_f9) +* [Key_Favorites](key.md#key_favorites) +* [Key_Finance](key.md#key_finance) +* [Key_Find](key.md#key_find) +* [Key_Flip](key.md#key_flip) +* [Key_Forward](key.md#key_forward) +* [Key_G](key.md#key_g) +* [Key_Game](key.md#key_game) +* [Key_Go](key.md#key_go) +* [Key_Greater](key.md#key_greater) +* [Key_Green](key.md#key_green) +* [Key_Guide](key.md#key_guide) +* [Key_H](key.md#key_h) +* [Key_Hangul](key.md#key_hangul) +* [Key_Hangul_Banja](key.md#key_hangul_banja) +* [Key_Hangul_End](key.md#key_hangul_end) +* [Key_Hangul_Hanja](key.md#key_hangul_hanja) +* [Key_Hangul_Jamo](key.md#key_hangul_jamo) +* [Key_Hangul_Jeonja](key.md#key_hangul_jeonja) +* [Key_Hangul_PostHanja](key.md#key_hangul_posthanja) +* [Key_Hangul_PreHanja](key.md#key_hangul_prehanja) +* [Key_Hangul_Romaja](key.md#key_hangul_romaja) +* [Key_Hangul_Special](key.md#key_hangul_special) +* [Key_Hangul_Start](key.md#key_hangul_start) +* [Key_Hangup](key.md#key_hangup) +* [Key_Hankaku](key.md#key_hankaku) +* [Key_Help](key.md#key_help) +* [Key_Henkan](key.md#key_henkan) +* [Key_Hibernate](key.md#key_hibernate) +* [Key_Hiragana](key.md#key_hiragana) +* [Key_Hiragana_Katakana](key.md#key_hiragana_katakana) +* [Key_History](key.md#key_history) +* [Key_Home](key.md#key_home) +* [Key_HomePage](key.md#key_homepage) +* [Key_HotLinks](key.md#key_hotlinks) +* [Key_Hyper_L](key.md#key_hyper_l) +* [Key_Hyper_R](key.md#key_hyper_r) +* [Key_I](key.md#key_i) +* [Key_Iacute](key.md#key_iacute) +* [Key_Icircumflex](key.md#key_icircumflex) +* [Key_Idiaeresis](key.md#key_idiaeresis) +* [Key_Igrave](key.md#key_igrave) +* [Key_Info](key.md#key_info) +* [Key_Insert](key.md#key_insert) +* [Key_J](key.md#key_j) +* [Key_K](key.md#key_k) +* [Key_Kana_Lock](key.md#key_kana_lock) +* [Key_Kana_Shift](key.md#key_kana_shift) +* [Key_Kanji](key.md#key_kanji) +* [Key_Katakana](key.md#key_katakana) +* [Key_KeyboardBrightnessDown](key.md#key_keyboardbrightnessdown) +* [Key_KeyboardBrightnessUp](key.md#key_keyboardbrightnessup) +* [Key_KeyboardLightOnOff](key.md#key_keyboardlightonoff) +* [Key_L](key.md#key_l) +* [Key_LastNumberRedial](key.md#key_lastnumberredial) +* [Key_Launch0](key.md#key_launch0) +* [Key_Launch1](key.md#key_launch1) +* [Key_Launch2](key.md#key_launch2) +* [Key_Launch3](key.md#key_launch3) +* [Key_Launch4](key.md#key_launch4) +* [Key_Launch5](key.md#key_launch5) +* [Key_Launch6](key.md#key_launch6) +* [Key_Launch7](key.md#key_launch7) +* [Key_Launch8](key.md#key_launch8) +* [Key_Launch9](key.md#key_launch9) +* [Key_LaunchA](key.md#key_launcha) +* [Key_LaunchB](key.md#key_launchb) +* [Key_LaunchC](key.md#key_launchc) +* [Key_LaunchD](key.md#key_launchd) +* [Key_LaunchE](key.md#key_launche) +* [Key_LaunchF](key.md#key_launchf) +* [Key_LaunchG](key.md#key_launchg) +* [Key_LaunchH](key.md#key_launchh) +* [Key_LaunchMail](key.md#key_launchmail) +* [Key_LaunchMedia](key.md#key_launchmedia) +* [Key_Left](key.md#key_left) +* [Key_Less](key.md#key_less) +* [Key_LightBulb](key.md#key_lightbulb) +* [Key_LogOff](key.md#key_logoff) +* [Key_M](key.md#key_m) +* [Key_MailForward](key.md#key_mailforward) +* [Key_Market](key.md#key_market) +* [Key_Massyo](key.md#key_massyo) +* [Key_MediaLast](key.md#key_medialast) +* [Key_MediaNext](key.md#key_medianext) +* [Key_MediaPause](key.md#key_mediapause) +* [Key_MediaPlay](key.md#key_mediaplay) +* [Key_MediaPrevious](key.md#key_mediaprevious) +* [Key_MediaRecord](key.md#key_mediarecord) +* [Key_MediaStop](key.md#key_mediastop) +* [Key_MediaTogglePlayPause](key.md#key_mediatoggleplaypause) +* [Key_Meeting](key.md#key_meeting) +* [Key_Memo](key.md#key_memo) +* [Key_Menu](key.md#key_menu) +* [Key_MenuKB](key.md#key_menukb) +* [Key_MenuPB](key.md#key_menupb) +* [Key_Messenger](key.md#key_messenger) +* [Key_Meta](key.md#key_meta) +* [Key_MicMute](key.md#key_micmute) +* [Key_MicVolumeDown](key.md#key_micvolumedown) +* [Key_MicVolumeUp](key.md#key_micvolumeup) +* [Key_Minus](key.md#key_minus) +* [Key_Mode_switch](key.md#key_mode_switch) +* [Key_MonBrightnessDown](key.md#key_monbrightnessdown) +* [Key_MonBrightnessUp](key.md#key_monbrightnessup) +* [Key_Muhenkan](key.md#key_muhenkan) +* [Key_Multi_key](key.md#key_multi_key) +* [Key_MultipleCandidate](key.md#key_multiplecandidate) +* [Key_Music](key.md#key_music) +* [Key_MySites](key.md#key_mysites) +* [Key_N](key.md#key_n) +* [Key_New](key.md#key_new) +* [Key_News](key.md#key_news) +* [Key_No](key.md#key_no) +* [Key_Ntilde](key.md#key_ntilde) +* [Key_NumLock](key.md#key_numlock) +* [Key_NumberSign](key.md#key_numbersign) +* [Key_O](key.md#key_o) +* [Key_Oacute](key.md#key_oacute) +* [Key_Ocircumflex](key.md#key_ocircumflex) +* [Key_Odiaeresis](key.md#key_odiaeresis) +* [Key_OfficeHome](key.md#key_officehome) +* [Key_Ograve](key.md#key_ograve) +* [Key_Ooblique](key.md#key_ooblique) +* [Key_Open](key.md#key_open) +* [Key_OpenUrl](key.md#key_openurl) +* [Key_Option](key.md#key_option) +* [Key_Otilde](key.md#key_otilde) +* [Key_P](key.md#key_p) +* [Key_PageDown](key.md#key_pagedown) +* [Key_PageUp](key.md#key_pageup) +* [Key_ParenLeft](key.md#key_parenleft) +* [Key_ParenRight](key.md#key_parenright) +* [Key_Paste](key.md#key_paste) +* [Key_Pause](key.md#key_pause) +* [Key_Percent](key.md#key_percent) +* [Key_Period](key.md#key_period) +* [Key_Phone](key.md#key_phone) +* [Key_Pictures](key.md#key_pictures) +* [Key_Play](key.md#key_play) +* [Key_Plus](key.md#key_plus) +* [Key_PowerDown](key.md#key_powerdown) +* [Key_PowerOff](key.md#key_poweroff) +* [Key_PreviousCandidate](key.md#key_previouscandidate) +* [Key_Print](key.md#key_print) +* [Key_Printer](key.md#key_printer) +* [Key_Q](key.md#key_q) +* [Key_Question](key.md#key_question) +* [Key_QuoteDbl](key.md#key_quotedbl) +* [Key_QuoteLeft](key.md#key_quoteleft) +* [Key_R](key.md#key_r) +* [Key_Red](key.md#key_red) +* [Key_Redo](key.md#key_redo) +* [Key_Refresh](key.md#key_refresh) +* [Key_Reload](key.md#key_reload) +* [Key_Reply](key.md#key_reply) +* [Key_Return](key.md#key_return) +* [Key_Right](key.md#key_right) +* [Key_Romaji](key.md#key_romaji) +* [Key_RotateWindows](key.md#key_rotatewindows) +* [Key_RotationKB](key.md#key_rotationkb) +* [Key_RotationPB](key.md#key_rotationpb) +* [Key_S](key.md#key_s) +* [Key_Save](key.md#key_save) +* [Key_ScreenSaver](key.md#key_screensaver) +* [Key_ScrollLock](key.md#key_scrolllock) +* [Key_Search](key.md#key_search) +* [Key_Select](key.md#key_select) +* [Key_Semicolon](key.md#key_semicolon) +* [Key_Send](key.md#key_send) +* [Key_Settings](key.md#key_settings) +* [Key_Shift](key.md#key_shift) +* [Key_Shop](key.md#key_shop) +* [Key_SingleCandidate](key.md#key_singlecandidate) +* [Key_Slash](key.md#key_slash) +* [Key_Sleep](key.md#key_sleep) +* [Key_Space](key.md#key_space) +* [Key_Spell](key.md#key_spell) +* [Key_SplitScreen](key.md#key_splitscreen) +* [Key_Standby](key.md#key_standby) +* [Key_Stop](key.md#key_stop) +* [Key_Subtitle](key.md#key_subtitle) +* [Key_Super_L](key.md#key_super_l) +* [Key_Super_R](key.md#key_super_r) +* [Key_Support](key.md#key_support) +* [Key_Suspend](key.md#key_suspend) +* [Key_SysReq](key.md#key_sysreq) +* [Key_T](key.md#key_t) +* [Key_THORN](key.md#key_thorn) +* [Key_Tab](key.md#key_tab) +* [Key_TaskPane](key.md#key_taskpane) +* [Key_Terminal](key.md#key_terminal) +* [Key_Time](key.md#key_time) +* [Key_ToDoList](key.md#key_todolist) +* [Key_ToggleCallHangup](key.md#key_togglecallhangup) +* [Key_Tools](key.md#key_tools) +* [Key_TopMenu](key.md#key_topmenu) +* [Key_TouchpadOff](key.md#key_touchpadoff) +* [Key_TouchpadOn](key.md#key_touchpadon) +* [Key_TouchpadToggle](key.md#key_touchpadtoggle) +* [Key_Touroku](key.md#key_touroku) +* [Key_Travel](key.md#key_travel) +* [Key_TrebleDown](key.md#key_trebledown) +* [Key_TrebleUp](key.md#key_trebleup) +* [Key_U](key.md#key_u) +* [Key_UWB](key.md#key_uwb) +* [Key_Uacute](key.md#key_uacute) +* [Key_Ucircumflex](key.md#key_ucircumflex) +* [Key_Udiaeresis](key.md#key_udiaeresis) +* [Key_Ugrave](key.md#key_ugrave) +* [Key_Underscore](key.md#key_underscore) +* [Key_Undo](key.md#key_undo) +* [Key_Up](key.md#key_up) +* [Key_V](key.md#key_v) +* [Key_Video](key.md#key_video) +* [Key_View](key.md#key_view) +* [Key_VoiceDial](key.md#key_voicedial) +* [Key_VolumeDown](key.md#key_volumedown) +* [Key_VolumeMute](key.md#key_volumemute) +* [Key_VolumeUp](key.md#key_volumeup) +* [Key_W](key.md#key_w) +* [Key_WLAN](key.md#key_wlan) +* [Key_WWW](key.md#key_www) +* [Key_WakeUp](key.md#key_wakeup) +* [Key_WebCam](key.md#key_webcam) +* [Key_Word](key.md#key_word) +* [Key_X](key.md#key_x) +* [Key_Xfer](key.md#key_xfer) +* [Key_Y](key.md#key_y) +* [Key_Yacute](key.md#key_yacute) +* [Key_Yellow](key.md#key_yellow) +* [Key_Yes](key.md#key_yes) +* [Key_Z](key.md#key_z) +* [Key_Zenkaku](key.md#key_zenkaku) +* [Key_Zenkaku_Hankaku](key.md#key_zenkaku_hankaku) +* [Key_Zoom](key.md#key_zoom) +* [Key_ZoomIn](key.md#key_zoomin) +* [Key_ZoomOut](key.md#key_zoomout) +* [Key_acute](key.md#key_acute) +* [Key_brokenbar](key.md#key_brokenbar) +* [Key_cedilla](key.md#key_cedilla) +* [Key_cent](key.md#key_cent) +* [Key_copyright](key.md#key_copyright) +* [Key_currency](key.md#key_currency) +* [Key_degree](key.md#key_degree) +* [Key_diaeresis](key.md#key_diaeresis) +* [Key_division](key.md#key_division) +* [Key_exclamdown](key.md#key_exclamdown) +* [Key_guillemotleft](key.md#key_guillemotleft) +* [Key_guillemotright](key.md#key_guillemotright) +* [Key_hyphen](key.md#key_hyphen) +* [Key_iTouch](key.md#key_itouch) +* [Key_macron](key.md#key_macron) +* [Key_masculine](key.md#key_masculine) +* [Key_mu](key.md#key_mu) +* [Key_multiply](key.md#key_multiply) +* [Key_nobreakspace](key.md#key_nobreakspace) +* [Key_notsign](key.md#key_notsign) +* [Key_onehalf](key.md#key_onehalf) +* [Key_onequarter](key.md#key_onequarter) +* [Key_onesuperior](key.md#key_onesuperior) +* [Key_ordfeminine](key.md#key_ordfeminine) +* [Key_paragraph](key.md#key_paragraph) +* [Key_periodcentered](key.md#key_periodcentered) +* [Key_plusminus](key.md#key_plusminus) +* [Key_questiondown](key.md#key_questiondown) +* [Key_registered](key.md#key_registered) +* [Key_section](key.md#key_section) +* [Key_ssharp](key.md#key_ssharp) +* [Key_sterling](key.md#key_sterling) +* [Key_threequarters](key.md#key_threequarters) +* [Key_threesuperior](key.md#key_threesuperior) +* [Key_twosuperior](key.md#key_twosuperior) +* [Key_unknown](key.md#key_unknown) +* [Key_ydiaeresis](key.md#key_ydiaeresis) +* [Key_yen](key.md#key_yen) + +## Enumeration members + +### Key_0 + +• **Key_0**: = 48 + +___ + +### Key_1 + +• **Key_1**: = 49 + +___ + +### Key_2 + +• **Key_2**: = 50 + +___ + +### Key_3 + +• **Key_3**: = 51 + +___ + +### Key_4 + +• **Key_4**: = 52 + +___ + +### Key_5 + +• **Key_5**: = 53 + +___ + +### Key_6 + +• **Key_6**: = 54 + +___ + +### Key_7 + +• **Key_7**: = 55 + +___ + +### Key_8 + +• **Key_8**: = 56 + +___ + +### Key_9 + +• **Key_9**: = 57 + +___ + +### Key_A + +• **Key_A**: = 65 + +___ + +### Key_AE + +• **Key_AE**: = 198 + +___ + +### Key_Aacute + +• **Key_Aacute**: = 193 + +___ + +### Key_Acircumflex + +• **Key_Acircumflex**: = 194 + +___ + +### Key_AddFavorite + +• **Key_AddFavorite**: = 16777408 + +___ + +### Key_Adiaeresis + +• **Key_Adiaeresis**: = 196 + +___ + +### Key_Agrave + +• **Key_Agrave**: = 192 + +___ + +### Key_Alt + +• **Key_Alt**: = 16777251 + +___ + +### Key_AltGr + +• **Key_AltGr**: = 16781571 + +___ + +### Key_Ampersand + +• **Key_Ampersand**: = 38 + +___ + +### Key_Any + +• **Key_Any**: = 32 + +___ + +### Key_Apostrophe + +• **Key_Apostrophe**: = 39 + +___ + +### Key_ApplicationLeft + +• **Key_ApplicationLeft**: = 16777415 + +___ + +### Key_ApplicationRight + +• **Key_ApplicationRight**: = 16777416 + +___ + +### Key_Aring + +• **Key_Aring**: = 197 + +___ + +### Key_AsciiCircum + +• **Key_AsciiCircum**: = 94 + +___ + +### Key_AsciiTilde + +• **Key_AsciiTilde**: = 126 + +___ + +### Key_Asterisk + +• **Key_Asterisk**: = 42 + +___ + +### Key_At + +• **Key_At**: = 64 + +___ + +### Key_Atilde + +• **Key_Atilde**: = 195 + +___ + +### Key_AudioCycleTrack + +• **Key_AudioCycleTrack**: = 16777478 + +___ + +### Key_AudioForward + +• **Key_AudioForward**: = 16777474 + +___ + +### Key_AudioRandomPlay + +• **Key_AudioRandomPlay**: = 16777476 + +___ + +### Key_AudioRepeat + +• **Key_AudioRepeat**: = 16777475 + +___ + +### Key_AudioRewind + +• **Key_AudioRewind**: = 16777413 + +___ + +### Key_Away + +• **Key_Away**: = 16777464 + +___ + +### Key_B + +• **Key_B**: = 66 + +___ + +### Key_Back + +• **Key_Back**: = 16777313 + +___ + +### Key_BackForward + +• **Key_BackForward**: = 16777414 + +___ + +### Key_Backslash + +• **Key_Backslash**: = 92 + +___ + +### Key_Backspace + +• **Key_Backspace**: = 16777219 + +___ + +### Key_Backtab + +• **Key_Backtab**: = 16777218 + +___ + +### Key_Bar + +• **Key_Bar**: = 124 + +___ + +### Key_BassBoost + +• **Key_BassBoost**: = 16777331 + +___ + +### Key_BassDown + +• **Key_BassDown**: = 16777333 + +___ + +### Key_BassUp + +• **Key_BassUp**: = 16777332 + +___ + +### Key_Battery + +• **Key_Battery**: = 16777470 + +___ + +### Key_Blue + +• **Key_Blue**: = 16777495 + +___ + +### Key_Bluetooth + +• **Key_Bluetooth**: = 16777471 + +___ + +### Key_Book + +• **Key_Book**: = 16777417 + +___ + +### Key_BraceLeft + +• **Key_BraceLeft**: = 123 + +___ + +### Key_BraceRight + +• **Key_BraceRight**: = 125 + +___ + +### Key_BracketLeft + +• **Key_BracketLeft**: = 91 + +___ + +### Key_BracketRight + +• **Key_BracketRight**: = 93 + +___ + +### Key_BrightnessAdjust + +• **Key_BrightnessAdjust**: = 16777410 + +___ + +### Key_C + +• **Key_C**: = 67 + +___ + +### Key_CD + +• **Key_CD**: = 16777418 + +___ + +### Key_Calculator + +• **Key_Calculator**: = 16777419 + +___ + +### Key_Calendar + +• **Key_Calendar**: = 16777444 + +___ + +### Key_Call + +• **Key_Call**: = 17825796 + +___ + +### Key_Camera + +• **Key_Camera**: = 17825824 + +___ + +### Key_CameraFocus + +• **Key_CameraFocus**: = 17825825 + +___ + +### Key_Cancel + +• **Key_Cancel**: = 16908289 + +___ + +### Key_CapsLock + +• **Key_CapsLock**: = 16777252 + +___ + +### Key_Ccedilla + +• **Key_Ccedilla**: = 199 + +___ + +### Key_ChannelDown + +• **Key_ChannelDown**: = 16777497 + +___ + +### Key_ChannelUp + +• **Key_ChannelUp**: = 16777496 + +___ + +### Key_Clear + +• **Key_Clear**: = 16777227 + +___ + +### Key_ClearGrab + +• **Key_ClearGrab**: = 16777421 + +___ + +### Key_Close + +• **Key_Close**: = 16777422 + +___ + +### Key_Codeinput + +• **Key_Codeinput**: = 16781623 + +___ + +### Key_Colon + +• **Key_Colon**: = 58 + +___ + +### Key_Comma + +• **Key_Comma**: = 44 + +___ + +### Key_Community + +• **Key_Community**: = 16777412 + +___ + +### Key_Context1 + +• **Key_Context1**: = 17825792 + +___ + +### Key_Context2 + +• **Key_Context2**: = 17825793 + +___ + +### Key_Context3 + +• **Key_Context3**: = 17825794 + +___ + +### Key_Context4 + +• **Key_Context4**: = 17825795 + +___ + +### Key_ContrastAdjust + +• **Key_ContrastAdjust**: = 16777485 + +___ + +### Key_Control + +• **Key_Control**: = 16777249 + +___ + +### Key_Copy + +• **Key_Copy**: = 16777423 + +___ + +### Key_Cut + +• **Key_Cut**: = 16777424 + +___ + +### Key_D + +• **Key_D**: = 68 + +___ + +### Key_DOS + +• **Key_DOS**: = 16777426 + +___ + +### Key_Dead_A + +• **Key_Dead_A**: = 16781953 + +___ + +### Key_Dead_Abovecomma + +• **Key_Dead_Abovecomma**: = 16781924 + +___ + +### Key_Dead_Abovedot + +• **Key_Dead_Abovedot**: = 16781910 + +___ + +### Key_Dead_Abovereversedcomma + +• **Key_Dead_Abovereversedcomma**: = 16781925 + +___ + +### Key_Dead_Abovering + +• **Key_Dead_Abovering**: = 16781912 + +___ + +### Key_Dead_Aboveverticalline + +• **Key_Dead_Aboveverticalline**: = 16781969 + +___ + +### Key_Dead_Acute + +• **Key_Dead_Acute**: = 16781905 + +___ + +### Key_Dead_Belowbreve + +• **Key_Dead_Belowbreve**: = 16781931 + +___ + +### Key_Dead_Belowcircumflex + +• **Key_Dead_Belowcircumflex**: = 16781929 + +___ + +### Key_Dead_Belowcomma + +• **Key_Dead_Belowcomma**: = 16781934 + +___ + +### Key_Dead_Belowdiaeresis + +• **Key_Dead_Belowdiaeresis**: = 16781932 + +___ + +### Key_Dead_Belowdot + +• **Key_Dead_Belowdot**: = 16781920 + +___ + +### Key_Dead_Belowmacron + +• **Key_Dead_Belowmacron**: = 16781928 + +___ + +### Key_Dead_Belowring + +• **Key_Dead_Belowring**: = 16781927 + +___ + +### Key_Dead_Belowtilde + +• **Key_Dead_Belowtilde**: = 16781930 + +___ + +### Key_Dead_Belowverticalline + +• **Key_Dead_Belowverticalline**: = 16781970 + +___ + +### Key_Dead_Breve + +• **Key_Dead_Breve**: = 16781909 + +___ + +### Key_Dead_Capital_Schwa + +• **Key_Dead_Capital_Schwa**: = 16781963 + +___ + +### Key_Dead_Caron + +• **Key_Dead_Caron**: = 16781914 + +___ + +### Key_Dead_Cedilla + +• **Key_Dead_Cedilla**: = 16781915 + +___ + +### Key_Dead_Circumflex + +• **Key_Dead_Circumflex**: = 16781906 + +___ + +### Key_Dead_Currency + +• **Key_Dead_Currency**: = 16781935 + +___ + +### Key_Dead_Diaeresis + +• **Key_Dead_Diaeresis**: = 16781911 + +___ + +### Key_Dead_Doubleacute + +• **Key_Dead_Doubleacute**: = 16781913 + +___ + +### Key_Dead_Doublegrave + +• **Key_Dead_Doublegrave**: = 16781926 + +___ + +### Key_Dead_E + +• **Key_Dead_E**: = 16781955 + +___ + +### Key_Dead_Grave + +• **Key_Dead_Grave**: = 16781904 + +___ + +### Key_Dead_Greek + +• **Key_Dead_Greek**: = 16781964 + +___ + +### Key_Dead_Hook + +• **Key_Dead_Hook**: = 16781921 + +___ + +### Key_Dead_Horn + +• **Key_Dead_Horn**: = 16781922 + +___ + +### Key_Dead_I + +• **Key_Dead_I**: = 16781957 + +___ + +### Key_Dead_Invertedbreve + +• **Key_Dead_Invertedbreve**: = 16781933 + +___ + +### Key_Dead_Iota + +• **Key_Dead_Iota**: = 16781917 + +___ + +### Key_Dead_Longsolidusoverlay + +• **Key_Dead_Longsolidusoverlay**: = 16781971 + +___ + +### Key_Dead_Lowline + +• **Key_Dead_Lowline**: = 16781968 + +___ + +### Key_Dead_Macron + +• **Key_Dead_Macron**: = 16781908 + +___ + +### Key_Dead_O + +• **Key_Dead_O**: = 16781959 + +___ + +### Key_Dead_Ogonek + +• **Key_Dead_Ogonek**: = 16781916 + +___ + +### Key_Dead_Semivoiced_Sound + +• **Key_Dead_Semivoiced_Sound**: = 16781919 + +___ + +### Key_Dead_Small_Schwa + +• **Key_Dead_Small_Schwa**: = 16781962 + +___ + +### Key_Dead_Stroke + +• **Key_Dead_Stroke**: = 16781923 + +___ + +### Key_Dead_Tilde + +• **Key_Dead_Tilde**: = 16781907 + +___ + +### Key_Dead_U + +• **Key_Dead_U**: = 16781961 + +___ + +### Key_Dead_Voiced_Sound + +• **Key_Dead_Voiced_Sound**: = 16781918 + +___ + +### Key_Dead_a + +• **Key_Dead_a**: = 16781952 + +___ + +### Key_Dead_e + +• **Key_Dead_e**: = 16781954 + +___ + +### Key_Dead_i + +• **Key_Dead_i**: = 16781956 + +___ + +### Key_Dead_o + +• **Key_Dead_o**: = 16781958 + +___ + +### Key_Dead_u + +• **Key_Dead_u**: = 16781960 + +___ + +### Key_Delete + +• **Key_Delete**: = 16777223 + +___ + +### Key_Direction_L + +• **Key_Direction_L**: = 16777305 + +___ + +### Key_Direction_R + +• **Key_Direction_R**: = 16777312 + +___ + +### Key_Display + +• **Key_Display**: = 16777425 + +___ + +### Key_Documents + +• **Key_Documents**: = 16777427 + +___ + +### Key_Dollar + +• **Key_Dollar**: = 36 + +___ + +### Key_Down + +• **Key_Down**: = 16777237 + +___ + +### Key_E + +• **Key_E**: = 69 + +___ + +### Key_ETH + +• **Key_ETH**: = 208 + +___ + +### Key_Eacute + +• **Key_Eacute**: = 201 + +___ + +### Key_Ecircumflex + +• **Key_Ecircumflex**: = 202 + +___ + +### Key_Ediaeresis + +• **Key_Ediaeresis**: = 203 + +___ + +### Key_Egrave + +• **Key_Egrave**: = 200 + +___ + +### Key_Eisu_Shift + +• **Key_Eisu_Shift**: = 16781615 + +___ + +### Key_Eisu_toggle + +• **Key_Eisu_toggle**: = 16781616 + +___ + +### Key_Eject + +• **Key_Eject**: = 16777401 + +___ + +### Key_End + +• **Key_End**: = 16777233 + +___ + +### Key_Enter + +• **Key_Enter**: = 16777221 + +___ + +### Key_Equal + +• **Key_Equal**: = 61 + +___ + +### Key_Escape + +• **Key_Escape**: = 16777216 + +___ + +### Key_Excel + +• **Key_Excel**: = 16777428 + +___ + +### Key_Exclam + +• **Key_Exclam**: = 33 + +___ + +### Key_Execute + +• **Key_Execute**: = 16908291 + +___ + +### Key_Exit + +• **Key_Exit**: = 16908298 + +___ + +### Key_Explorer + +• **Key_Explorer**: = 16777429 + +___ + +### Key_F + +• **Key_F**: = 70 + +___ + +### Key_F1 + +• **Key_F1**: = 16777264 + +___ + +### Key_F10 + +• **Key_F10**: = 16777273 + +___ + +### Key_F11 + +• **Key_F11**: = 16777274 + +___ + +### Key_F12 + +• **Key_F12**: = 16777275 + +___ + +### Key_F13 + +• **Key_F13**: = 16777276 + +___ + +### Key_F14 + +• **Key_F14**: = 16777277 + +___ + +### Key_F15 + +• **Key_F15**: = 16777278 + +___ + +### Key_F16 + +• **Key_F16**: = 16777279 + +___ + +### Key_F17 + +• **Key_F17**: = 16777280 + +___ + +### Key_F18 + +• **Key_F18**: = 16777281 + +___ + +### Key_F19 + +• **Key_F19**: = 16777282 + +___ + +### Key_F2 + +• **Key_F2**: = 16777265 + +___ + +### Key_F20 + +• **Key_F20**: = 16777283 + +___ + +### Key_F21 + +• **Key_F21**: = 16777284 + +___ + +### Key_F22 + +• **Key_F22**: = 16777285 + +___ + +### Key_F23 + +• **Key_F23**: = 16777286 + +___ + +### Key_F24 + +• **Key_F24**: = 16777287 + +___ + +### Key_F25 + +• **Key_F25**: = 16777288 + +___ + +### Key_F26 + +• **Key_F26**: = 16777289 + +___ + +### Key_F27 + +• **Key_F27**: = 16777290 + +___ + +### Key_F28 + +• **Key_F28**: = 16777291 + +___ + +### Key_F29 + +• **Key_F29**: = 16777292 + +___ + +### Key_F3 + +• **Key_F3**: = 16777266 + +___ + +### Key_F30 + +• **Key_F30**: = 16777293 + +___ + +### Key_F31 + +• **Key_F31**: = 16777294 + +___ + +### Key_F32 + +• **Key_F32**: = 16777295 + +___ + +### Key_F33 + +• **Key_F33**: = 16777296 + +___ + +### Key_F34 + +• **Key_F34**: = 16777297 + +___ + +### Key_F35 + +• **Key_F35**: = 16777298 + +___ + +### Key_F4 + +• **Key_F4**: = 16777267 + +___ + +### Key_F5 + +• **Key_F5**: = 16777268 + +___ + +### Key_F6 + +• **Key_F6**: = 16777269 + +___ + +### Key_F7 + +• **Key_F7**: = 16777270 + +___ + +### Key_F8 + +• **Key_F8**: = 16777271 + +___ + +### Key_F9 + +• **Key_F9**: = 16777272 + +___ + +### Key_Favorites + +• **Key_Favorites**: = 16777361 + +___ + +### Key_Finance + +• **Key_Finance**: = 16777411 + +___ + +### Key_Find + +• **Key_Find**: = 16777506 + +___ + +### Key_Flip + +• **Key_Flip**: = 17825798 + +___ + +### Key_Forward + +• **Key_Forward**: = 16777314 + +___ + +### Key_G + +• **Key_G**: = 71 + +___ + +### Key_Game + +• **Key_Game**: = 16777430 + +___ + +### Key_Go + +• **Key_Go**: = 16777431 + +___ + +### Key_Greater + +• **Key_Greater**: = 62 + +___ + +### Key_Green + +• **Key_Green**: = 16777493 + +___ + +### Key_Guide + +• **Key_Guide**: = 16777498 + +___ + +### Key_H + +• **Key_H**: = 72 + +___ + +### Key_Hangul + +• **Key_Hangul**: = 16781617 + +___ + +### Key_Hangul_Banja + +• **Key_Hangul_Banja**: = 16781625 + +___ + +### Key_Hangul_End + +• **Key_Hangul_End**: = 16781619 + +___ + +### Key_Hangul_Hanja + +• **Key_Hangul_Hanja**: = 16781620 + +___ + +### Key_Hangul_Jamo + +• **Key_Hangul_Jamo**: = 16781621 + +___ + +### Key_Hangul_Jeonja + +• **Key_Hangul_Jeonja**: = 16781624 + +___ + +### Key_Hangul_PostHanja + +• **Key_Hangul_PostHanja**: = 16781627 + +___ + +### Key_Hangul_PreHanja + +• **Key_Hangul_PreHanja**: = 16781626 + +___ + +### Key_Hangul_Romaja + +• **Key_Hangul_Romaja**: = 16781622 + +___ + +### Key_Hangul_Special + +• **Key_Hangul_Special**: = 16781631 + +___ + +### Key_Hangul_Start + +• **Key_Hangul_Start**: = 16781618 + +___ + +### Key_Hangup + +• **Key_Hangup**: = 17825797 + +___ + +### Key_Hankaku + +• **Key_Hankaku**: = 16781609 + +___ + +### Key_Help + +• **Key_Help**: = 16777304 + +___ + +### Key_Henkan + +• **Key_Henkan**: = 16781603 + +___ + +### Key_Hibernate + +• **Key_Hibernate**: = 16777480 + +___ + +### Key_Hiragana + +• **Key_Hiragana**: = 16781605 + +___ + +### Key_Hiragana_Katakana + +• **Key_Hiragana_Katakana**: = 16781607 + +___ + +### Key_History + +• **Key_History**: = 16777407 + +___ + +### Key_Home + +• **Key_Home**: = 16777232 + +___ + +### Key_HomePage + +• **Key_HomePage**: = 16777360 + +___ + +### Key_HotLinks + +• **Key_HotLinks**: = 16777409 + +___ + +### Key_Hyper_L + +• **Key_Hyper_L**: = 16777302 + +___ + +### Key_Hyper_R + +• **Key_Hyper_R**: = 16777303 + +___ + +### Key_I + +• **Key_I**: = 73 + +___ + +### Key_Iacute + +• **Key_Iacute**: = 205 + +___ + +### Key_Icircumflex + +• **Key_Icircumflex**: = 206 + +___ + +### Key_Idiaeresis + +• **Key_Idiaeresis**: = 207 + +___ + +### Key_Igrave + +• **Key_Igrave**: = 204 + +___ + +### Key_Info + +• **Key_Info**: = 16777499 + +___ + +### Key_Insert + +• **Key_Insert**: = 16777222 + +___ + +### Key_J + +• **Key_J**: = 74 + +___ + +### Key_K + +• **Key_K**: = 75 + +___ + +### Key_Kana_Lock + +• **Key_Kana_Lock**: = 16781613 + +___ + +### Key_Kana_Shift + +• **Key_Kana_Shift**: = 16781614 + +___ + +### Key_Kanji + +• **Key_Kanji**: = 16781601 + +___ + +### Key_Katakana + +• **Key_Katakana**: = 16781606 + +___ + +### Key_KeyboardBrightnessDown + +• **Key_KeyboardBrightnessDown**: = 16777398 + +___ + +### Key_KeyboardBrightnessUp + +• **Key_KeyboardBrightnessUp**: = 16777397 + +___ + +### Key_KeyboardLightOnOff + +• **Key_KeyboardLightOnOff**: = 16777396 + +___ + +### Key_L + +• **Key_L**: = 76 + +___ + +### Key_LastNumberRedial + +• **Key_LastNumberRedial**: = 17825801 + +___ + +### Key_Launch0 + +• **Key_Launch0**: = 16777378 + +___ + +### Key_Launch1 + +• **Key_Launch1**: = 16777379 + +___ + +### Key_Launch2 + +• **Key_Launch2**: = 16777380 + +___ + +### Key_Launch3 + +• **Key_Launch3**: = 16777381 + +___ + +### Key_Launch4 + +• **Key_Launch4**: = 16777382 + +___ + +### Key_Launch5 + +• **Key_Launch5**: = 16777383 + +___ + +### Key_Launch6 + +• **Key_Launch6**: = 16777384 + +___ + +### Key_Launch7 + +• **Key_Launch7**: = 16777385 + +___ + +### Key_Launch8 + +• **Key_Launch8**: = 16777386 + +___ + +### Key_Launch9 + +• **Key_Launch9**: = 16777387 + +___ + +### Key_LaunchA + +• **Key_LaunchA**: = 16777388 + +___ + +### Key_LaunchB + +• **Key_LaunchB**: = 16777389 + +___ + +### Key_LaunchC + +• **Key_LaunchC**: = 16777390 + +___ + +### Key_LaunchD + +• **Key_LaunchD**: = 16777391 + +___ + +### Key_LaunchE + +• **Key_LaunchE**: = 16777392 + +___ + +### Key_LaunchF + +• **Key_LaunchF**: = 16777393 + +___ + +### Key_LaunchG + +• **Key_LaunchG**: = 16777486 + +___ + +### Key_LaunchH + +• **Key_LaunchH**: = 16777487 + +___ + +### Key_LaunchMail + +• **Key_LaunchMail**: = 16777376 + +___ + +### Key_LaunchMedia + +• **Key_LaunchMedia**: = 16777377 + +___ + +### Key_Left + +• **Key_Left**: = 16777234 + +___ + +### Key_Less + +• **Key_Less**: = 60 + +___ + +### Key_LightBulb + +• **Key_LightBulb**: = 16777405 + +___ + +### Key_LogOff + +• **Key_LogOff**: = 16777433 + +___ + +### Key_M + +• **Key_M**: = 77 + +___ + +### Key_MailForward + +• **Key_MailForward**: = 16777467 + +___ + +### Key_Market + +• **Key_Market**: = 16777434 + +___ + +### Key_Massyo + +• **Key_Massyo**: = 16781612 + +___ + +### Key_MediaLast + +• **Key_MediaLast**: = 16842751 + +___ + +### Key_MediaNext + +• **Key_MediaNext**: = 16777347 + +___ + +### Key_MediaPause + +• **Key_MediaPause**: = 16777349 + +___ + +### Key_MediaPlay + +• **Key_MediaPlay**: = 16777344 + +___ + +### Key_MediaPrevious + +• **Key_MediaPrevious**: = 16777346 + +___ + +### Key_MediaRecord + +• **Key_MediaRecord**: = 16777348 + +___ + +### Key_MediaStop + +• **Key_MediaStop**: = 16777345 + +___ + +### Key_MediaTogglePlayPause + +• **Key_MediaTogglePlayPause**: = 16777350 + +___ + +### Key_Meeting + +• **Key_Meeting**: = 16777435 + +___ + +### Key_Memo + +• **Key_Memo**: = 16777404 + +___ + +### Key_Menu + +• **Key_Menu**: = 16777301 + +___ + +### Key_MenuKB + +• **Key_MenuKB**: = 16777436 + +___ + +### Key_MenuPB + +• **Key_MenuPB**: = 16777437 + +___ + +### Key_Messenger + +• **Key_Messenger**: = 16777465 + +___ + +### Key_Meta + +• **Key_Meta**: = 16777250 + +___ + +### Key_MicMute + +• **Key_MicMute**: = 16777491 + +___ + +### Key_MicVolumeDown + +• **Key_MicVolumeDown**: = 16777502 + +___ + +### Key_MicVolumeUp + +• **Key_MicVolumeUp**: = 16777501 + +___ + +### Key_Minus + +• **Key_Minus**: = 45 + +___ + +### Key_Mode_switch + +• **Key_Mode_switch**: = 16781694 + +___ + +### Key_MonBrightnessDown + +• **Key_MonBrightnessDown**: = 16777395 + +___ + +### Key_MonBrightnessUp + +• **Key_MonBrightnessUp**: = 16777394 + +___ + +### Key_Muhenkan + +• **Key_Muhenkan**: = 16781602 + +___ + +### Key_Multi_key + +• **Key_Multi_key**: = 16781600 + +___ + +### Key_MultipleCandidate + +• **Key_MultipleCandidate**: = 16781629 + +___ + +### Key_Music + +• **Key_Music**: = 16777469 + +___ + +### Key_MySites + +• **Key_MySites**: = 16777438 + +___ + +### Key_N + +• **Key_N**: = 78 + +___ + +### Key_New + +• **Key_New**: = 16777504 + +___ + +### Key_News + +• **Key_News**: = 16777439 + +___ + +### Key_No + +• **Key_No**: = 16842754 + +___ + +### Key_Ntilde + +• **Key_Ntilde**: = 209 + +___ + +### Key_NumLock + +• **Key_NumLock**: = 16777253 + +___ + +### Key_NumberSign + +• **Key_NumberSign**: = 35 + +___ + +### Key_O + +• **Key_O**: = 79 + +___ + +### Key_Oacute + +• **Key_Oacute**: = 211 + +___ + +### Key_Ocircumflex + +• **Key_Ocircumflex**: = 212 + +___ + +### Key_Odiaeresis + +• **Key_Odiaeresis**: = 214 + +___ + +### Key_OfficeHome + +• **Key_OfficeHome**: = 16777440 + +___ + +### Key_Ograve + +• **Key_Ograve**: = 210 + +___ + +### Key_Ooblique + +• **Key_Ooblique**: = 216 + +___ + +### Key_Open + +• **Key_Open**: = 16777505 + +___ + +### Key_OpenUrl + +• **Key_OpenUrl**: = 16777364 + +___ + +### Key_Option + +• **Key_Option**: = 16777441 + +___ + +### Key_Otilde + +• **Key_Otilde**: = 213 + +___ + +### Key_P + +• **Key_P**: = 80 + +___ + +### Key_PageDown + +• **Key_PageDown**: = 16777239 + +___ + +### Key_PageUp + +• **Key_PageUp**: = 16777238 + +___ + +### Key_ParenLeft + +• **Key_ParenLeft**: = 40 + +___ + +### Key_ParenRight + +• **Key_ParenRight**: = 41 + +___ + +### Key_Paste + +• **Key_Paste**: = 16777442 + +___ + +### Key_Pause + +• **Key_Pause**: = 16777224 + +___ + +### Key_Percent + +• **Key_Percent**: = 37 + +___ + +### Key_Period + +• **Key_Period**: = 46 + +___ + +### Key_Phone + +• **Key_Phone**: = 16777443 + +___ + +### Key_Pictures + +• **Key_Pictures**: = 16777468 + +___ + +### Key_Play + +• **Key_Play**: = 16908293 + +___ + +### Key_Plus + +• **Key_Plus**: = 43 + +___ + +### Key_PowerDown + +• **Key_PowerDown**: = 16777483 + +___ + +### Key_PowerOff + +• **Key_PowerOff**: = 16777399 + +___ + +### Key_PreviousCandidate + +• **Key_PreviousCandidate**: = 16781630 + +___ + +### Key_Print + +• **Key_Print**: = 16777225 + +___ + +### Key_Printer + +• **Key_Printer**: = 16908290 + +___ + +### Key_Q + +• **Key_Q**: = 81 + +___ + +### Key_Question + +• **Key_Question**: = 63 + +___ + +### Key_QuoteDbl + +• **Key_QuoteDbl**: = 34 + +___ + +### Key_QuoteLeft + +• **Key_QuoteLeft**: = 96 + +___ + +### Key_R + +• **Key_R**: = 82 + +___ + +### Key_Red + +• **Key_Red**: = 16777492 + +___ + +### Key_Redo + +• **Key_Redo**: = 16777508 + +___ + +### Key_Refresh + +• **Key_Refresh**: = 16777316 + +___ + +### Key_Reload + +• **Key_Reload**: = 16777446 + +___ + +### Key_Reply + +• **Key_Reply**: = 16777445 + +___ + +### Key_Return + +• **Key_Return**: = 16777220 + +___ + +### Key_Right + +• **Key_Right**: = 16777236 + +___ + +### Key_Romaji + +• **Key_Romaji**: = 16781604 + +___ + +### Key_RotateWindows + +• **Key_RotateWindows**: = 16777447 + +___ + +### Key_RotationKB + +• **Key_RotationKB**: = 16777449 + +___ + +### Key_RotationPB + +• **Key_RotationPB**: = 16777448 + +___ + +### Key_S + +• **Key_S**: = 83 + +___ + +### Key_Save + +• **Key_Save**: = 16777450 + +___ + +### Key_ScreenSaver + +• **Key_ScreenSaver**: = 16777402 + +___ + +### Key_ScrollLock + +• **Key_ScrollLock**: = 16777254 + +___ + +### Key_Search + +• **Key_Search**: = 16777362 + +___ + +### Key_Select + +• **Key_Select**: = 16842752 + +___ + +### Key_Semicolon + +• **Key_Semicolon**: = 59 + +___ + +### Key_Send + +• **Key_Send**: = 16777451 + +___ + +### Key_Settings + +• **Key_Settings**: = 16777500 + +___ + +### Key_Shift + +• **Key_Shift**: = 16777248 + +___ + +### Key_Shop + +• **Key_Shop**: = 16777406 + +___ + +### Key_SingleCandidate + +• **Key_SingleCandidate**: = 16781628 + +___ + +### Key_Slash + +• **Key_Slash**: = 47 + +___ + +### Key_Sleep + +• **Key_Sleep**: = 16908292 + +___ + +### Key_Space + +• **Key_Space**: = 32 + +___ + +### Key_Spell + +• **Key_Spell**: = 16777452 + +___ + +### Key_SplitScreen + +• **Key_SplitScreen**: = 16777453 + +___ + +### Key_Standby + +• **Key_Standby**: = 16777363 + +___ + +### Key_Stop + +• **Key_Stop**: = 16777315 + +___ + +### Key_Subtitle + +• **Key_Subtitle**: = 16777477 + +___ + +### Key_Super_L + +• **Key_Super_L**: = 16777299 + +___ + +### Key_Super_R + +• **Key_Super_R**: = 16777300 + +___ + +### Key_Support + +• **Key_Support**: = 16777454 + +___ + +### Key_Suspend + +• **Key_Suspend**: = 16777484 + +___ + +### Key_SysReq + +• **Key_SysReq**: = 16777226 + +___ + +### Key_T + +• **Key_T**: = 84 + +___ + +### Key_THORN + +• **Key_THORN**: = 222 + +___ + +### Key_Tab + +• **Key_Tab**: = 16777217 + +___ + +### Key_TaskPane + +• **Key_TaskPane**: = 16777455 + +___ + +### Key_Terminal + +• **Key_Terminal**: = 16777456 + +___ + +### Key_Time + +• **Key_Time**: = 16777479 + +___ + +### Key_ToDoList + +• **Key_ToDoList**: = 16777420 + +___ + +### Key_ToggleCallHangup + +• **Key_ToggleCallHangup**: = 17825799 + +___ + +### Key_Tools + +• **Key_Tools**: = 16777457 + +___ + +### Key_TopMenu + +• **Key_TopMenu**: = 16777482 + +___ + +### Key_TouchpadOff + +• **Key_TouchpadOff**: = 16777490 + +___ + +### Key_TouchpadOn + +• **Key_TouchpadOn**: = 16777489 + +___ + +### Key_TouchpadToggle + +• **Key_TouchpadToggle**: = 16777488 + +___ + +### Key_Touroku + +• **Key_Touroku**: = 16781611 + +___ + +### Key_Travel + +• **Key_Travel**: = 16777458 + +___ + +### Key_TrebleDown + +• **Key_TrebleDown**: = 16777335 + +___ + +### Key_TrebleUp + +• **Key_TrebleUp**: = 16777334 + +___ + +### Key_U + +• **Key_U**: = 85 + +___ + +### Key_UWB + +• **Key_UWB**: = 16777473 + +___ + +### Key_Uacute + +• **Key_Uacute**: = 218 + +___ + +### Key_Ucircumflex + +• **Key_Ucircumflex**: = 219 + +___ + +### Key_Udiaeresis + +• **Key_Udiaeresis**: = 220 + +___ + +### Key_Ugrave + +• **Key_Ugrave**: = 217 + +___ + +### Key_Underscore + +• **Key_Underscore**: = 95 + +___ + +### Key_Undo + +• **Key_Undo**: = 16777507 + +___ + +### Key_Up + +• **Key_Up**: = 16777235 + +___ + +### Key_V + +• **Key_V**: = 86 + +___ + +### Key_Video + +• **Key_Video**: = 16777459 + +___ + +### Key_View + +• **Key_View**: = 16777481 + +___ + +### Key_VoiceDial + +• **Key_VoiceDial**: = 17825800 + +___ + +### Key_VolumeDown + +• **Key_VolumeDown**: = 16777328 + +___ + +### Key_VolumeMute + +• **Key_VolumeMute**: = 16777329 + +___ + +### Key_VolumeUp + +• **Key_VolumeUp**: = 16777330 + +___ + +### Key_W + +• **Key_W**: = 87 + +___ + +### Key_WLAN + +• **Key_WLAN**: = 16777472 + +___ + +### Key_WWW + +• **Key_WWW**: = 16777403 + +___ + +### Key_WakeUp + +• **Key_WakeUp**: = 16777400 + +___ + +### Key_WebCam + +• **Key_WebCam**: = 16777466 + +___ + +### Key_Word + +• **Key_Word**: = 16777460 + +___ + +### Key_X + +• **Key_X**: = 88 + +___ + +### Key_Xfer + +• **Key_Xfer**: = 16777461 + +___ + +### Key_Y + +• **Key_Y**: = 89 + +___ + +### Key_Yacute + +• **Key_Yacute**: = 221 + +___ + +### Key_Yellow + +• **Key_Yellow**: = 16777494 + +___ + +### Key_Yes + +• **Key_Yes**: = 16842753 + +___ + +### Key_Z + +• **Key_Z**: = 90 + +___ + +### Key_Zenkaku + +• **Key_Zenkaku**: = 16781608 + +___ + +### Key_Zenkaku_Hankaku + +• **Key_Zenkaku_Hankaku**: = 16781610 + +___ + +### Key_Zoom + +• **Key_Zoom**: = 16908294 + +___ + +### Key_ZoomIn + +• **Key_ZoomIn**: = 16777462 + +___ + +### Key_ZoomOut + +• **Key_ZoomOut**: = 16777463 + +___ + +### Key_acute + +• **Key_acute**: = 180 + +___ + +### Key_brokenbar + +• **Key_brokenbar**: = 166 + +___ + +### Key_cedilla + +• **Key_cedilla**: = 184 + +___ + +### Key_cent + +• **Key_cent**: = 162 + +___ + +### Key_copyright + +• **Key_copyright**: = 169 + +___ + +### Key_currency + +• **Key_currency**: = 164 + +___ + +### Key_degree + +• **Key_degree**: = 176 + +___ + +### Key_diaeresis + +• **Key_diaeresis**: = 168 + +___ + +### Key_division + +• **Key_division**: = 247 + +___ + +### Key_exclamdown + +• **Key_exclamdown**: = 161 + +___ + +### Key_guillemotleft + +• **Key_guillemotleft**: = 171 + +___ + +### Key_guillemotright + +• **Key_guillemotright**: = 187 + +___ + +### Key_hyphen + +• **Key_hyphen**: = 173 + +___ + +### Key_iTouch + +• **Key_iTouch**: = 16777432 + +___ + +### Key_macron + +• **Key_macron**: = 175 + +___ + +### Key_masculine + +• **Key_masculine**: = 186 + +___ + +### Key_mu + +• **Key_mu**: = 181 + +___ + +### Key_multiply + +• **Key_multiply**: = 215 + +___ + +### Key_nobreakspace + +• **Key_nobreakspace**: = 160 + +___ + +### Key_notsign + +• **Key_notsign**: = 172 + +___ + +### Key_onehalf + +• **Key_onehalf**: = 189 + +___ + +### Key_onequarter + +• **Key_onequarter**: = 188 + +___ + +### Key_onesuperior + +• **Key_onesuperior**: = 185 + +___ + +### Key_ordfeminine + +• **Key_ordfeminine**: = 170 + +___ + +### Key_paragraph + +• **Key_paragraph**: = 182 + +___ + +### Key_periodcentered + +• **Key_periodcentered**: = 183 + +___ + +### Key_plusminus + +• **Key_plusminus**: = 177 + +___ + +### Key_questiondown + +• **Key_questiondown**: = 191 + +___ + +### Key_registered + +• **Key_registered**: = 174 + +___ + +### Key_section + +• **Key_section**: = 167 + +___ + +### Key_ssharp + +• **Key_ssharp**: = 223 + +___ + +### Key_sterling + +• **Key_sterling**: = 163 + +___ + +### Key_threequarters + +• **Key_threequarters**: = 190 + +___ + +### Key_threesuperior + +• **Key_threesuperior**: = 179 + +___ + +### Key_twosuperior + +• **Key_twosuperior**: = 178 + +___ + +### Key_unknown + +• **Key_unknown**: = 33554431 + +___ + +### Key_ydiaeresis + +• **Key_ydiaeresis**: = 255 + +___ + +### Key_yen + +• **Key_yen**: = 165 diff --git a/website/docs/api/generated/enums/keyboardmodifier.md b/website/docs/api/generated/enums/keyboardmodifier.md new file mode 100644 index 000000000..6c77c541c --- /dev/null +++ b/website/docs/api/generated/enums/keyboardmodifier.md @@ -0,0 +1,59 @@ +--- +id: "keyboardmodifier" +title: "KeyboardModifier" +sidebar_label: "KeyboardModifier" +--- + +## Index + +### Enumeration members + +* [AltModifier](keyboardmodifier.md#altmodifier) +* [ControlModifier](keyboardmodifier.md#controlmodifier) +* [GroupSwitchModifier](keyboardmodifier.md#groupswitchmodifier) +* [KeypadModifier](keyboardmodifier.md#keypadmodifier) +* [MetaModifier](keyboardmodifier.md#metamodifier) +* [NoModifier](keyboardmodifier.md#nomodifier) +* [ShiftModifier](keyboardmodifier.md#shiftmodifier) + +## Enumeration members + +### AltModifier + +• **AltModifier**: = 134217728 + +___ + +### ControlModifier + +• **ControlModifier**: = 67108864 + +___ + +### GroupSwitchModifier + +• **GroupSwitchModifier**: = 1073741824 + +___ + +### KeypadModifier + +• **KeypadModifier**: = 536870912 + +___ + +### MetaModifier + +• **MetaModifier**: = 268435456 + +___ + +### NoModifier + +• **NoModifier**: = 0 + +___ + +### ShiftModifier + +• **ShiftModifier**: = 33554432 diff --git a/website/docs/api/generated/enums/layoutdirection.md b/website/docs/api/generated/enums/layoutdirection.md new file mode 100644 index 000000000..8b84a7b67 --- /dev/null +++ b/website/docs/api/generated/enums/layoutdirection.md @@ -0,0 +1,31 @@ +--- +id: "layoutdirection" +title: "LayoutDirection" +sidebar_label: "LayoutDirection" +--- + +## Index + +### Enumeration members + +* [LayoutDirectionAuto](layoutdirection.md#layoutdirectionauto) +* [LeftToRight](layoutdirection.md#lefttoright) +* [RightToLeft](layoutdirection.md#righttoleft) + +## Enumeration members + +### LayoutDirectionAuto + +• **LayoutDirectionAuto**: = 2 + +___ + +### LeftToRight + +• **LeftToRight**: = 0 + +___ + +### RightToLeft + +• **RightToLeft**: = 1 diff --git a/website/docs/api/generated/enums/linewrapmode.md b/website/docs/api/generated/enums/linewrapmode.md new file mode 100644 index 000000000..411133cb2 --- /dev/null +++ b/website/docs/api/generated/enums/linewrapmode.md @@ -0,0 +1,24 @@ +--- +id: "linewrapmode" +title: "LineWrapMode" +sidebar_label: "LineWrapMode" +--- + +## Index + +### Enumeration members + +* [NoWrap](linewrapmode.md#nowrap) +* [WidgetWidth](linewrapmode.md#widgetwidth) + +## Enumeration members + +### NoWrap + +• **NoWrap**: + +___ + +### WidgetWidth + +• **WidgetWidth**: diff --git a/website/docs/api/generated/enums/maskmode.md b/website/docs/api/generated/enums/maskmode.md new file mode 100644 index 000000000..1cf3910c7 --- /dev/null +++ b/website/docs/api/generated/enums/maskmode.md @@ -0,0 +1,24 @@ +--- +id: "maskmode" +title: "MaskMode" +sidebar_label: "MaskMode" +--- + +## Index + +### Enumeration members + +* [MaskInColor](maskmode.md#maskincolor) +* [MaskOutColor](maskmode.md#maskoutcolor) + +## Enumeration members + +### MaskInColor + +• **MaskInColor**: = 0 + +___ + +### MaskOutColor + +• **MaskOutColor**: = 1 diff --git a/website/docs/api/generated/enums/matchflag.md b/website/docs/api/generated/enums/matchflag.md new file mode 100644 index 000000000..99d33ecaf --- /dev/null +++ b/website/docs/api/generated/enums/matchflag.md @@ -0,0 +1,80 @@ +--- +id: "matchflag" +title: "MatchFlag" +sidebar_label: "MatchFlag" +--- + +## Index + +### Enumeration members + +* [MatchCaseSensitive](matchflag.md#matchcasesensitive) +* [MatchContains](matchflag.md#matchcontains) +* [MatchEndsWith](matchflag.md#matchendswith) +* [MatchExactly](matchflag.md#matchexactly) +* [MatchFixedString](matchflag.md#matchfixedstring) +* [MatchRecursive](matchflag.md#matchrecursive) +* [MatchRegExp](matchflag.md#matchregexp) +* [MatchStartsWith](matchflag.md#matchstartswith) +* [MatchWildcard](matchflag.md#matchwildcard) +* [MatchWrap](matchflag.md#matchwrap) + +## Enumeration members + +### MatchCaseSensitive + +• **MatchCaseSensitive**: = 16 + +___ + +### MatchContains + +• **MatchContains**: = 1 + +___ + +### MatchEndsWith + +• **MatchEndsWith**: = 3 + +___ + +### MatchExactly + +• **MatchExactly**: = 0 + +___ + +### MatchFixedString + +• **MatchFixedString**: = 8 + +___ + +### MatchRecursive + +• **MatchRecursive**: = 64 + +___ + +### MatchRegExp + +• **MatchRegExp**: = 4 + +___ + +### MatchStartsWith + +• **MatchStartsWith**: = 2 + +___ + +### MatchWildcard + +• **MatchWildcard**: = 5 + +___ + +### MatchWrap + +• **MatchWrap**: = 32 diff --git a/website/docs/api/generated/enums/modifier.md b/website/docs/api/generated/enums/modifier.md new file mode 100644 index 000000000..fe3e4d4a6 --- /dev/null +++ b/website/docs/api/generated/enums/modifier.md @@ -0,0 +1,45 @@ +--- +id: "modifier" +title: "Modifier" +sidebar_label: "Modifier" +--- + +## Index + +### Enumeration members + +* [ALT](modifier.md#alt) +* [CTRL](modifier.md#ctrl) +* [META](modifier.md#meta) +* [SHIFT](modifier.md#shift) +* [UNICODE_ACCEL](modifier.md#unicode_accel) + +## Enumeration members + +### ALT + +• **ALT**: = 134217728 + +___ + +### CTRL + +• **CTRL**: = 67108864 + +___ + +### META + +• **META**: = 268435456 + +___ + +### SHIFT + +• **SHIFT**: = 33554432 + +___ + +### UNICODE_ACCEL + +• **UNICODE_ACCEL**: = 0 diff --git a/website/docs/api/generated/enums/mousebutton.md b/website/docs/api/generated/enums/mousebutton.md new file mode 100644 index 000000000..a9efa3510 --- /dev/null +++ b/website/docs/api/generated/enums/mousebutton.md @@ -0,0 +1,255 @@ +--- +id: "mousebutton" +title: "MouseButton" +sidebar_label: "MouseButton" +--- + +## Index + +### Enumeration members + +* [AllButtons](mousebutton.md#allbuttons) +* [BackButton](mousebutton.md#backbutton) +* [ExtraButton1](mousebutton.md#extrabutton1) +* [ExtraButton10](mousebutton.md#extrabutton10) +* [ExtraButton11](mousebutton.md#extrabutton11) +* [ExtraButton12](mousebutton.md#extrabutton12) +* [ExtraButton13](mousebutton.md#extrabutton13) +* [ExtraButton14](mousebutton.md#extrabutton14) +* [ExtraButton15](mousebutton.md#extrabutton15) +* [ExtraButton16](mousebutton.md#extrabutton16) +* [ExtraButton17](mousebutton.md#extrabutton17) +* [ExtraButton18](mousebutton.md#extrabutton18) +* [ExtraButton19](mousebutton.md#extrabutton19) +* [ExtraButton2](mousebutton.md#extrabutton2) +* [ExtraButton20](mousebutton.md#extrabutton20) +* [ExtraButton21](mousebutton.md#extrabutton21) +* [ExtraButton22](mousebutton.md#extrabutton22) +* [ExtraButton23](mousebutton.md#extrabutton23) +* [ExtraButton24](mousebutton.md#extrabutton24) +* [ExtraButton3](mousebutton.md#extrabutton3) +* [ExtraButton4](mousebutton.md#extrabutton4) +* [ExtraButton5](mousebutton.md#extrabutton5) +* [ExtraButton6](mousebutton.md#extrabutton6) +* [ExtraButton7](mousebutton.md#extrabutton7) +* [ExtraButton8](mousebutton.md#extrabutton8) +* [ExtraButton9](mousebutton.md#extrabutton9) +* [ForwardButton](mousebutton.md#forwardbutton) +* [LeftButton](mousebutton.md#leftbutton) +* [MidButton](mousebutton.md#midbutton) +* [MiddleButton](mousebutton.md#middlebutton) +* [NoButton](mousebutton.md#nobutton) +* [RightButton](mousebutton.md#rightbutton) +* [TaskButton](mousebutton.md#taskbutton) +* [XButton1](mousebutton.md#xbutton1) +* [XButton2](mousebutton.md#xbutton2) + +## Enumeration members + +### AllButtons + +• **AllButtons**: = 134217727 + +___ + +### BackButton + +• **BackButton**: = 8 + +___ + +### ExtraButton1 + +• **ExtraButton1**: = 8 + +___ + +### ExtraButton10 + +• **ExtraButton10**: = 4096 + +___ + +### ExtraButton11 + +• **ExtraButton11**: = 8192 + +___ + +### ExtraButton12 + +• **ExtraButton12**: = 16384 + +___ + +### ExtraButton13 + +• **ExtraButton13**: = 32768 + +___ + +### ExtraButton14 + +• **ExtraButton14**: = 65536 + +___ + +### ExtraButton15 + +• **ExtraButton15**: = 131072 + +___ + +### ExtraButton16 + +• **ExtraButton16**: = 262144 + +___ + +### ExtraButton17 + +• **ExtraButton17**: = 524288 + +___ + +### ExtraButton18 + +• **ExtraButton18**: = 1048576 + +___ + +### ExtraButton19 + +• **ExtraButton19**: = 2097152 + +___ + +### ExtraButton2 + +• **ExtraButton2**: = 16 + +___ + +### ExtraButton20 + +• **ExtraButton20**: = 4194304 + +___ + +### ExtraButton21 + +• **ExtraButton21**: = 8388608 + +___ + +### ExtraButton22 + +• **ExtraButton22**: = 16777216 + +___ + +### ExtraButton23 + +• **ExtraButton23**: = 33554432 + +___ + +### ExtraButton24 + +• **ExtraButton24**: = 67108864 + +___ + +### ExtraButton3 + +• **ExtraButton3**: = 32 + +___ + +### ExtraButton4 + +• **ExtraButton4**: = 64 + +___ + +### ExtraButton5 + +• **ExtraButton5**: = 128 + +___ + +### ExtraButton6 + +• **ExtraButton6**: = 256 + +___ + +### ExtraButton7 + +• **ExtraButton7**: = 512 + +___ + +### ExtraButton8 + +• **ExtraButton8**: = 1024 + +___ + +### ExtraButton9 + +• **ExtraButton9**: = 2048 + +___ + +### ForwardButton + +• **ForwardButton**: = 16 + +___ + +### LeftButton + +• **LeftButton**: = 1 + +___ + +### MidButton + +• **MidButton**: = 4 + +___ + +### MiddleButton + +• **MiddleButton**: = 4 + +___ + +### NoButton + +• **NoButton**: = 0 + +___ + +### RightButton + +• **RightButton**: = 2 + +___ + +### TaskButton + +• **TaskButton**: = 32 + +___ + +### XButton1 + +• **XButton1**: = 8 + +___ + +### XButton2 + +• **XButton2**: = 16 diff --git a/website/docs/api/generated/enums/mouseeventflag.md b/website/docs/api/generated/enums/mouseeventflag.md new file mode 100644 index 000000000..3280f89eb --- /dev/null +++ b/website/docs/api/generated/enums/mouseeventflag.md @@ -0,0 +1,17 @@ +--- +id: "mouseeventflag" +title: "MouseEventFlag" +sidebar_label: "MouseEventFlag" +--- + +## Index + +### Enumeration members + +* [MouseEventCreatedDoubleClick](mouseeventflag.md#mouseeventcreateddoubleclick) + +## Enumeration members + +### MouseEventCreatedDoubleClick + +• **MouseEventCreatedDoubleClick**: = 1 diff --git a/website/docs/api/generated/enums/mouseeventsource.md b/website/docs/api/generated/enums/mouseeventsource.md new file mode 100644 index 000000000..3356dee12 --- /dev/null +++ b/website/docs/api/generated/enums/mouseeventsource.md @@ -0,0 +1,38 @@ +--- +id: "mouseeventsource" +title: "MouseEventSource" +sidebar_label: "MouseEventSource" +--- + +## Index + +### Enumeration members + +* [MouseEventNotSynthesized](mouseeventsource.md#mouseeventnotsynthesized) +* [MouseEventSynthesizedByApplication](mouseeventsource.md#mouseeventsynthesizedbyapplication) +* [MouseEventSynthesizedByQt](mouseeventsource.md#mouseeventsynthesizedbyqt) +* [MouseEventSynthesizedBySystem](mouseeventsource.md#mouseeventsynthesizedbysystem) + +## Enumeration members + +### MouseEventNotSynthesized + +• **MouseEventNotSynthesized**: = 0 + +___ + +### MouseEventSynthesizedByApplication + +• **MouseEventSynthesizedByApplication**: = 3 + +___ + +### MouseEventSynthesizedByQt + +• **MouseEventSynthesizedByQt**: = 2 + +___ + +### MouseEventSynthesizedBySystem + +• **MouseEventSynthesizedBySystem**: = 1 diff --git a/website/docs/api/generated/enums/moviestate.md b/website/docs/api/generated/enums/moviestate.md new file mode 100644 index 000000000..2727cd0b2 --- /dev/null +++ b/website/docs/api/generated/enums/moviestate.md @@ -0,0 +1,31 @@ +--- +id: "moviestate" +title: "MovieState" +sidebar_label: "MovieState" +--- + +## Index + +### Enumeration members + +* [NotRunning](moviestate.md#notrunning) +* [Paused](moviestate.md#paused) +* [Running](moviestate.md#running) + +## Enumeration members + +### NotRunning + +• **NotRunning**: + +___ + +### Paused + +• **Paused**: + +___ + +### Running + +• **Running**: diff --git a/website/docs/api/generated/enums/nativegesturetype.md b/website/docs/api/generated/enums/nativegesturetype.md new file mode 100644 index 000000000..8c06a3512 --- /dev/null +++ b/website/docs/api/generated/enums/nativegesturetype.md @@ -0,0 +1,59 @@ +--- +id: "nativegesturetype" +title: "NativeGestureType" +sidebar_label: "NativeGestureType" +--- + +## Index + +### Enumeration members + +* [BeginNativeGesture](nativegesturetype.md#beginnativegesture) +* [EndNativeGesture](nativegesturetype.md#endnativegesture) +* [PanNativeGesture](nativegesturetype.md#pannativegesture) +* [RotateNativeGesture](nativegesturetype.md#rotatenativegesture) +* [SmartZoomNativeGesture](nativegesturetype.md#smartzoomnativegesture) +* [SwipeNativeGesture](nativegesturetype.md#swipenativegesture) +* [ZoomNativeGesture](nativegesturetype.md#zoomnativegesture) + +## Enumeration members + +### BeginNativeGesture + +• **BeginNativeGesture**: = 0 + +___ + +### EndNativeGesture + +• **EndNativeGesture**: = 1 + +___ + +### PanNativeGesture + +• **PanNativeGesture**: = 2 + +___ + +### RotateNativeGesture + +• **RotateNativeGesture**: = 5 + +___ + +### SmartZoomNativeGesture + +• **SmartZoomNativeGesture**: = 4 + +___ + +### SwipeNativeGesture + +• **SwipeNativeGesture**: = 6 + +___ + +### ZoomNativeGesture + +• **ZoomNativeGesture**: = 3 diff --git a/website/docs/api/generated/enums/navigationmode.md b/website/docs/api/generated/enums/navigationmode.md new file mode 100644 index 000000000..82ce89fc8 --- /dev/null +++ b/website/docs/api/generated/enums/navigationmode.md @@ -0,0 +1,45 @@ +--- +id: "navigationmode" +title: "NavigationMode" +sidebar_label: "NavigationMode" +--- + +## Index + +### Enumeration members + +* [NavigationModeCursorAuto](navigationmode.md#navigationmodecursorauto) +* [NavigationModeCursorForceVisible](navigationmode.md#navigationmodecursorforcevisible) +* [NavigationModeKeypadDirectional](navigationmode.md#navigationmodekeypaddirectional) +* [NavigationModeKeypadTabOrder](navigationmode.md#navigationmodekeypadtaborder) +* [NavigationModeNone](navigationmode.md#navigationmodenone) + +## Enumeration members + +### NavigationModeCursorAuto + +• **NavigationModeCursorAuto**: = 3 + +___ + +### NavigationModeCursorForceVisible + +• **NavigationModeCursorForceVisible**: = 4 + +___ + +### NavigationModeKeypadDirectional + +• **NavigationModeKeypadDirectional**: = 2 + +___ + +### NavigationModeKeypadTabOrder + +• **NavigationModeKeypadTabOrder**: = 1 + +___ + +### NavigationModeNone + +• **NavigationModeNone**: = 0 diff --git a/website/docs/api/generated/enums/option.md b/website/docs/api/generated/enums/option.md new file mode 100644 index 000000000..ea5da77ec --- /dev/null +++ b/website/docs/api/generated/enums/option.md @@ -0,0 +1,66 @@ +--- +id: "option" +title: "Option" +sidebar_label: "Option" +--- + +## Index + +### Enumeration members + +* [DontConfirmOverwrite](option.md#dontconfirmoverwrite) +* [DontResolveSymlinks](option.md#dontresolvesymlinks) +* [DontUseCustomDirectoryIcons](option.md#dontusecustomdirectoryicons) +* [DontUseNativeDialog](option.md#dontusenativedialog) +* [DontUseSheet](option.md#dontusesheet) +* [HideNameFilterDetails](option.md#hidenamefilterdetails) +* [ReadOnly](option.md#readonly) +* [ShowDirsOnly](option.md#showdirsonly) + +## Enumeration members + +### DontConfirmOverwrite + +• **DontConfirmOverwrite**: = 4 + +___ + +### DontResolveSymlinks + +• **DontResolveSymlinks**: = 2 + +___ + +### DontUseCustomDirectoryIcons + +• **DontUseCustomDirectoryIcons**: = 128 + +___ + +### DontUseNativeDialog + +• **DontUseNativeDialog**: = 16 + +___ + +### DontUseSheet + +• **DontUseSheet**: = 8 + +___ + +### HideNameFilterDetails + +• **HideNameFilterDetails**: = 64 + +___ + +### ReadOnly + +• **ReadOnly**: = 32 + +___ + +### ShowDirsOnly + +• **ShowDirsOnly**: = 1 diff --git a/website/docs/api/generated/enums/orientation.md b/website/docs/api/generated/enums/orientation.md new file mode 100644 index 000000000..c99292473 --- /dev/null +++ b/website/docs/api/generated/enums/orientation.md @@ -0,0 +1,24 @@ +--- +id: "orientation" +title: "Orientation" +sidebar_label: "Orientation" +--- + +## Index + +### Enumeration members + +* [Horizontal](orientation.md#horizontal) +* [Vertical](orientation.md#vertical) + +## Enumeration members + +### Horizontal + +• **Horizontal**: = 1 + +___ + +### Vertical + +• **Vertical**: = 2 diff --git a/website/docs/api/generated/enums/parsingmode.md b/website/docs/api/generated/enums/parsingmode.md new file mode 100644 index 000000000..a28c850c6 --- /dev/null +++ b/website/docs/api/generated/enums/parsingmode.md @@ -0,0 +1,31 @@ +--- +id: "parsingmode" +title: "ParsingMode" +sidebar_label: "ParsingMode" +--- + +## Index + +### Enumeration members + +* [DecodedMode](parsingmode.md#decodedmode) +* [StrictMode](parsingmode.md#strictmode) +* [TolerantMode](parsingmode.md#tolerantmode) + +## Enumeration members + +### DecodedMode + +• **DecodedMode**: + +___ + +### StrictMode + +• **StrictMode**: + +___ + +### TolerantMode + +• **TolerantMode**: diff --git a/website/docs/api/generated/enums/penstyle.md b/website/docs/api/generated/enums/penstyle.md new file mode 100644 index 000000000..317d97246 --- /dev/null +++ b/website/docs/api/generated/enums/penstyle.md @@ -0,0 +1,59 @@ +--- +id: "penstyle" +title: "PenStyle" +sidebar_label: "PenStyle" +--- + +## Index + +### Enumeration members + +* [CustomDashLine](penstyle.md#customdashline) +* [DashDotDotLine](penstyle.md#dashdotdotline) +* [DashDotLine](penstyle.md#dashdotline) +* [DashLine](penstyle.md#dashline) +* [DotLine](penstyle.md#dotline) +* [NoPen](penstyle.md#nopen) +* [SolidLine](penstyle.md#solidline) + +## Enumeration members + +### CustomDashLine + +• **CustomDashLine**: + +___ + +### DashDotDotLine + +• **DashDotDotLine**: + +___ + +### DashDotLine + +• **DashDotLine**: + +___ + +### DashLine + +• **DashLine**: + +___ + +### DotLine + +• **DotLine**: + +___ + +### NoPen + +• **NoPen**: + +___ + +### SolidLine + +• **SolidLine**: diff --git a/website/docs/api/generated/enums/qclipboardmode.md b/website/docs/api/generated/enums/qclipboardmode.md new file mode 100644 index 000000000..3358b2b37 --- /dev/null +++ b/website/docs/api/generated/enums/qclipboardmode.md @@ -0,0 +1,31 @@ +--- +id: "qclipboardmode" +title: "QClipboardMode" +sidebar_label: "QClipboardMode" +--- + +## Index + +### Enumeration members + +* [Clipboard](qclipboardmode.md#clipboard) +* [FindBuffer](qclipboardmode.md#findbuffer) +* [Selection](qclipboardmode.md#selection) + +## Enumeration members + +### Clipboard + +• **Clipboard**: + +___ + +### FindBuffer + +• **FindBuffer**: + +___ + +### Selection + +• **Selection**: diff --git a/website/docs/api/generated/enums/qiconmode.md b/website/docs/api/generated/enums/qiconmode.md new file mode 100644 index 000000000..be66318fb --- /dev/null +++ b/website/docs/api/generated/enums/qiconmode.md @@ -0,0 +1,38 @@ +--- +id: "qiconmode" +title: "QIconMode" +sidebar_label: "QIconMode" +--- + +## Index + +### Enumeration members + +* [Active](qiconmode.md#active) +* [Disabled](qiconmode.md#disabled) +* [Normal](qiconmode.md#normal) +* [Selected](qiconmode.md#selected) + +## Enumeration members + +### Active + +• **Active**: + +___ + +### Disabled + +• **Disabled**: + +___ + +### Normal + +• **Normal**: + +___ + +### Selected + +• **Selected**: diff --git a/website/docs/api/generated/enums/qiconstate.md b/website/docs/api/generated/enums/qiconstate.md new file mode 100644 index 000000000..43d84282a --- /dev/null +++ b/website/docs/api/generated/enums/qiconstate.md @@ -0,0 +1,24 @@ +--- +id: "qiconstate" +title: "QIconState" +sidebar_label: "QIconState" +--- + +## Index + +### Enumeration members + +* [Off](qiconstate.md#off) +* [On](qiconstate.md#on) + +## Enumeration members + +### Off + +• **Off**: + +___ + +### On + +• **On**: diff --git a/website/docs/api/generated/enums/qstylepixelmetric.md b/website/docs/api/generated/enums/qstylepixelmetric.md new file mode 100644 index 000000000..e3473889d --- /dev/null +++ b/website/docs/api/generated/enums/qstylepixelmetric.md @@ -0,0 +1,318 @@ +--- +id: "qstylepixelmetric" +title: "QStylePixelMetric" +sidebar_label: "QStylePixelMetric" +--- + +## Index + +### Enumeration members + +* [PM_ButtonDefaultIndicator](qstylepixelmetric.md#pm_buttondefaultindicator) +* [PM_ButtonMargin](qstylepixelmetric.md#pm_buttonmargin) +* [PM_ButtonShiftHorizontal](qstylepixelmetric.md#pm_buttonshifthorizontal) +* [PM_ButtonShiftVertical](qstylepixelmetric.md#pm_buttonshiftvertical) +* [PM_CheckListButtonSize](qstylepixelmetric.md#pm_checklistbuttonsize) +* [PM_CheckListControllerSize](qstylepixelmetric.md#pm_checklistcontrollersize) +* [PM_ComboBoxFrameWidth](qstylepixelmetric.md#pm_comboboxframewidth) +* [PM_DefaultFrameWidth](qstylepixelmetric.md#pm_defaultframewidth) +* [PM_DockWidgetFrameWidth](qstylepixelmetric.md#pm_dockwidgetframewidth) +* [PM_DockWidgetHandleExtent](qstylepixelmetric.md#pm_dockwidgethandleextent) +* [PM_DockWidgetSeparatorExtent](qstylepixelmetric.md#pm_dockwidgetseparatorextent) +* [PM_ExclusiveIndicatorHeight](qstylepixelmetric.md#pm_exclusiveindicatorheight) +* [PM_ExclusiveIndicatorWidth](qstylepixelmetric.md#pm_exclusiveindicatorwidth) +* [PM_IndicatorHeight](qstylepixelmetric.md#pm_indicatorheight) +* [PM_IndicatorWidth](qstylepixelmetric.md#pm_indicatorwidth) +* [PM_MaximumDragDistance](qstylepixelmetric.md#pm_maximumdragdistance) +* [PM_MdiSubWindowFrameWidth](qstylepixelmetric.md#pm_mdisubwindowframewidth) +* [PM_MenuBarHMargin](qstylepixelmetric.md#pm_menubarhmargin) +* [PM_MenuBarItemSpacing](qstylepixelmetric.md#pm_menubaritemspacing) +* [PM_MenuBarPanelWidth](qstylepixelmetric.md#pm_menubarpanelwidth) +* [PM_MenuBarVMargin](qstylepixelmetric.md#pm_menubarvmargin) +* [PM_MenuButtonIndicator](qstylepixelmetric.md#pm_menubuttonindicator) +* [PM_MenuDesktopFrameWidth](qstylepixelmetric.md#pm_menudesktopframewidth) +* [PM_MenuHMargin](qstylepixelmetric.md#pm_menuhmargin) +* [PM_MenuPanelWidth](qstylepixelmetric.md#pm_menupanelwidth) +* [PM_MenuScrollerHeight](qstylepixelmetric.md#pm_menuscrollerheight) +* [PM_MenuTearoffHeight](qstylepixelmetric.md#pm_menutearoffheight) +* [PM_MenuVMargin](qstylepixelmetric.md#pm_menuvmargin) +* [PM_ProgressBarChunkWidth](qstylepixelmetric.md#pm_progressbarchunkwidth) +* [PM_ScrollBarExtent](qstylepixelmetric.md#pm_scrollbarextent) +* [PM_ScrollBarSliderMin](qstylepixelmetric.md#pm_scrollbarslidermin) +* [PM_SliderControlThickness](qstylepixelmetric.md#pm_slidercontrolthickness) +* [PM_SliderLength](qstylepixelmetric.md#pm_sliderlength) +* [PM_SliderSpaceAvailable](qstylepixelmetric.md#pm_sliderspaceavailable) +* [PM_SliderThickness](qstylepixelmetric.md#pm_sliderthickness) +* [PM_SliderTickmarkOffset](qstylepixelmetric.md#pm_slidertickmarkoffset) +* [PM_SpinBoxFrameWidth](qstylepixelmetric.md#pm_spinboxframewidth) +* [PM_SplitterWidth](qstylepixelmetric.md#pm_splitterwidth) +* [PM_TabBarBaseHeight](qstylepixelmetric.md#pm_tabbarbaseheight) +* [PM_TabBarBaseOverlap](qstylepixelmetric.md#pm_tabbarbaseoverlap) +* [PM_TabBarTabHSpace](qstylepixelmetric.md#pm_tabbartabhspace) +* [PM_TabBarTabOverlap](qstylepixelmetric.md#pm_tabbartaboverlap) +* [PM_TabBarTabVSpace](qstylepixelmetric.md#pm_tabbartabvspace) +* [PM_TitleBarHeight](qstylepixelmetric.md#pm_titlebarheight) + +## Enumeration members + +### PM_ButtonDefaultIndicator + +• **PM_ButtonDefaultIndicator**: = 1 + +___ + +### PM_ButtonMargin + +• **PM_ButtonMargin**: = 0 + +___ + +### PM_ButtonShiftHorizontal + +• **PM_ButtonShiftHorizontal**: = 3 + +___ + +### PM_ButtonShiftVertical + +• **PM_ButtonShiftVertical**: = 4 + +___ + +### PM_CheckListButtonSize + +• **PM_CheckListButtonSize**: = 41 + +___ + +### PM_CheckListControllerSize + +• **PM_CheckListControllerSize**: = 42 + +___ + +### PM_ComboBoxFrameWidth + +• **PM_ComboBoxFrameWidth**: = 7 + +___ + +### PM_DefaultFrameWidth + +• **PM_DefaultFrameWidth**: = 5 + +___ + +### PM_DockWidgetFrameWidth + +• **PM_DockWidgetFrameWidth**: = 18 + +___ + +### PM_DockWidgetHandleExtent + +• **PM_DockWidgetHandleExtent**: = 17 + +___ + +### PM_DockWidgetSeparatorExtent + +• **PM_DockWidgetSeparatorExtent**: = 16 + +___ + +### PM_ExclusiveIndicatorHeight + +• **PM_ExclusiveIndicatorHeight**: = 40 + +___ + +### PM_ExclusiveIndicatorWidth + +• **PM_ExclusiveIndicatorWidth**: = 39 + +___ + +### PM_IndicatorHeight + +• **PM_IndicatorHeight**: = 38 + +___ + +### PM_IndicatorWidth + +• **PM_IndicatorWidth**: = 37 + +___ + +### PM_MaximumDragDistance + +• **PM_MaximumDragDistance**: = 8 + +___ + +### PM_MdiSubWindowFrameWidth + +• **PM_MdiSubWindowFrameWidth**: = 46 + +___ + +### PM_MenuBarHMargin + +• **PM_MenuBarHMargin**: = 36 + +___ + +### PM_MenuBarItemSpacing + +• **PM_MenuBarItemSpacing**: = 34 + +___ + +### PM_MenuBarPanelWidth + +• **PM_MenuBarPanelWidth**: = 33 + +___ + +### PM_MenuBarVMargin + +• **PM_MenuBarVMargin**: = 35 + +___ + +### PM_MenuButtonIndicator + +• **PM_MenuButtonIndicator**: = 2 + +___ + +### PM_MenuDesktopFrameWidth + +• **PM_MenuDesktopFrameWidth**: = 32 + +___ + +### PM_MenuHMargin + +• **PM_MenuHMargin**: = 28 + +___ + +### PM_MenuPanelWidth + +• **PM_MenuPanelWidth**: = 30 + +___ + +### PM_MenuScrollerHeight + +• **PM_MenuScrollerHeight**: = 27 + +___ + +### PM_MenuTearoffHeight + +• **PM_MenuTearoffHeight**: = 31 + +___ + +### PM_MenuVMargin + +• **PM_MenuVMargin**: = 29 + +___ + +### PM_ProgressBarChunkWidth + +• **PM_ProgressBarChunkWidth**: = 24 + +___ + +### PM_ScrollBarExtent + +• **PM_ScrollBarExtent**: = 9 + +___ + +### PM_ScrollBarSliderMin + +• **PM_ScrollBarSliderMin**: = 10 + +___ + +### PM_SliderControlThickness + +• **PM_SliderControlThickness**: = 12 + +___ + +### PM_SliderLength + +• **PM_SliderLength**: = 13 + +___ + +### PM_SliderSpaceAvailable + +• **PM_SliderSpaceAvailable**: = 15 + +___ + +### PM_SliderThickness + +• **PM_SliderThickness**: = 11 + +___ + +### PM_SliderTickmarkOffset + +• **PM_SliderTickmarkOffset**: = 14 + +___ + +### PM_SpinBoxFrameWidth + +• **PM_SpinBoxFrameWidth**: = 6 + +___ + +### PM_SplitterWidth + +• **PM_SplitterWidth**: = 25 + +___ + +### PM_TabBarBaseHeight + +• **PM_TabBarBaseHeight**: = 22 + +___ + +### PM_TabBarBaseOverlap + +• **PM_TabBarBaseOverlap**: = 23 + +___ + +### PM_TabBarTabHSpace + +• **PM_TabBarTabHSpace**: = 20 + +___ + +### PM_TabBarTabOverlap + +• **PM_TabBarTabOverlap**: = 19 + +___ + +### PM_TabBarTabVSpace + +• **PM_TabBarTabVSpace**: = 21 + +___ + +### PM_TitleBarHeight + +• **PM_TitleBarHeight**: = 26 diff --git a/website/docs/api/generated/enums/qsystemtrayiconactivationreason.md b/website/docs/api/generated/enums/qsystemtrayiconactivationreason.md new file mode 100644 index 000000000..8a9010d1b --- /dev/null +++ b/website/docs/api/generated/enums/qsystemtrayiconactivationreason.md @@ -0,0 +1,45 @@ +--- +id: "qsystemtrayiconactivationreason" +title: "QSystemTrayIconActivationReason" +sidebar_label: "QSystemTrayIconActivationReason" +--- + +## Index + +### Enumeration members + +* [Context](qsystemtrayiconactivationreason.md#context) +* [DoubleClick](qsystemtrayiconactivationreason.md#doubleclick) +* [MiddleClick](qsystemtrayiconactivationreason.md#middleclick) +* [Trigger](qsystemtrayiconactivationreason.md#trigger) +* [Unknown](qsystemtrayiconactivationreason.md#unknown) + +## Enumeration members + +### Context + +• **Context**: = 1 + +___ + +### DoubleClick + +• **DoubleClick**: = 2 + +___ + +### MiddleClick + +• **MiddleClick**: = 4 + +___ + +### Trigger + +• **Trigger**: = 3 + +___ + +### Unknown + +• **Unknown**: = 0 diff --git a/website/docs/api/generated/enums/qtextoptionwrapmode.md b/website/docs/api/generated/enums/qtextoptionwrapmode.md new file mode 100644 index 000000000..dc7f7e56c --- /dev/null +++ b/website/docs/api/generated/enums/qtextoptionwrapmode.md @@ -0,0 +1,45 @@ +--- +id: "qtextoptionwrapmode" +title: "QTextOptionWrapMode" +sidebar_label: "QTextOptionWrapMode" +--- + +## Index + +### Enumeration members + +* [ManualWrap](qtextoptionwrapmode.md#manualwrap) +* [NoWrap](qtextoptionwrapmode.md#nowrap) +* [WordWrap](qtextoptionwrapmode.md#wordwrap) +* [WrapAnywhere](qtextoptionwrapmode.md#wrapanywhere) +* [WrapAtWordBoundaryOrAnywhere](qtextoptionwrapmode.md#wrapatwordboundaryoranywhere) + +## Enumeration members + +### ManualWrap + +• **ManualWrap**: + +___ + +### NoWrap + +• **NoWrap**: + +___ + +### WordWrap + +• **WordWrap**: + +___ + +### WrapAnywhere + +• **WrapAnywhere**: + +___ + +### WrapAtWordBoundaryOrAnywhere + +• **WrapAtWordBoundaryOrAnywhere**: diff --git a/website/docs/api/generated/enums/renderhint.md b/website/docs/api/generated/enums/renderhint.md new file mode 100644 index 000000000..ea324c48d --- /dev/null +++ b/website/docs/api/generated/enums/renderhint.md @@ -0,0 +1,59 @@ +--- +id: "renderhint" +title: "RenderHint" +sidebar_label: "RenderHint" +--- + +## Index + +### Enumeration members + +* [Antialiasing](renderhint.md#antialiasing) +* [HighQualityAntialiasing](renderhint.md#highqualityantialiasing) +* [LosslessImageRendering](renderhint.md#losslessimagerendering) +* [NonCosmeticDefaultPen](renderhint.md#noncosmeticdefaultpen) +* [Qt4CompatiblePainting](renderhint.md#qt4compatiblepainting) +* [SmoothPixmapTransform](renderhint.md#smoothpixmaptransform) +* [TextAntialiasing](renderhint.md#textantialiasing) + +## Enumeration members + +### Antialiasing + +• **Antialiasing**: = 1 + +___ + +### HighQualityAntialiasing + +• **HighQualityAntialiasing**: = 8 + +___ + +### LosslessImageRendering + +• **LosslessImageRendering**: = 64 + +___ + +### NonCosmeticDefaultPen + +• **NonCosmeticDefaultPen**: = 16 + +___ + +### Qt4CompatiblePainting + +• **Qt4CompatiblePainting**: = 32 + +___ + +### SmoothPixmapTransform + +• **SmoothPixmapTransform**: = 4 + +___ + +### TextAntialiasing + +• **TextAntialiasing**: = 2 diff --git a/website/docs/api/generated/enums/screenorientation.md b/website/docs/api/generated/enums/screenorientation.md new file mode 100644 index 000000000..8d0f84bb7 --- /dev/null +++ b/website/docs/api/generated/enums/screenorientation.md @@ -0,0 +1,45 @@ +--- +id: "screenorientation" +title: "ScreenOrientation" +sidebar_label: "ScreenOrientation" +--- + +## Index + +### Enumeration members + +* [InvertedLandscapeOrientation](screenorientation.md#invertedlandscapeorientation) +* [InvertedPortraitOrientation](screenorientation.md#invertedportraitorientation) +* [LandscapeOrientation](screenorientation.md#landscapeorientation) +* [PortraitOrientation](screenorientation.md#portraitorientation) +* [PrimaryOrientation](screenorientation.md#primaryorientation) + +## Enumeration members + +### InvertedLandscapeOrientation + +• **InvertedLandscapeOrientation**: = 8 + +___ + +### InvertedPortraitOrientation + +• **InvertedPortraitOrientation**: = 4 + +___ + +### LandscapeOrientation + +• **LandscapeOrientation**: = 2 + +___ + +### PortraitOrientation + +• **PortraitOrientation**: = 1 + +___ + +### PrimaryOrientation + +• **PrimaryOrientation**: = 0 diff --git a/website/docs/api/generated/enums/scrollbarpolicy.md b/website/docs/api/generated/enums/scrollbarpolicy.md new file mode 100644 index 000000000..db66506ab --- /dev/null +++ b/website/docs/api/generated/enums/scrollbarpolicy.md @@ -0,0 +1,31 @@ +--- +id: "scrollbarpolicy" +title: "ScrollBarPolicy" +sidebar_label: "ScrollBarPolicy" +--- + +## Index + +### Enumeration members + +* [ScrollBarAlwaysOff](scrollbarpolicy.md#scrollbaralwaysoff) +* [ScrollBarAlwaysOn](scrollbarpolicy.md#scrollbaralwayson) +* [ScrollBarAsNeeded](scrollbarpolicy.md#scrollbarasneeded) + +## Enumeration members + +### ScrollBarAlwaysOff + +• **ScrollBarAlwaysOff**: = 1 + +___ + +### ScrollBarAlwaysOn + +• **ScrollBarAlwaysOn**: = 2 + +___ + +### ScrollBarAsNeeded + +• **ScrollBarAsNeeded**: = 0 diff --git a/website/docs/api/generated/enums/scrollhint.md b/website/docs/api/generated/enums/scrollhint.md new file mode 100644 index 000000000..2714081df --- /dev/null +++ b/website/docs/api/generated/enums/scrollhint.md @@ -0,0 +1,38 @@ +--- +id: "scrollhint" +title: "ScrollHint" +sidebar_label: "ScrollHint" +--- + +## Index + +### Enumeration members + +* [EnsureVisible](scrollhint.md#ensurevisible) +* [PositionAtBottom](scrollhint.md#positionatbottom) +* [PositionAtCenter](scrollhint.md#positionatcenter) +* [PositionAtTop](scrollhint.md#positionattop) + +## Enumeration members + +### EnsureVisible + +• **EnsureVisible**: = 0 + +___ + +### PositionAtBottom + +• **PositionAtBottom**: = 2 + +___ + +### PositionAtCenter + +• **PositionAtCenter**: = 3 + +___ + +### PositionAtTop + +• **PositionAtTop**: = 1 diff --git a/website/docs/api/generated/enums/scrollphase.md b/website/docs/api/generated/enums/scrollphase.md new file mode 100644 index 000000000..3fa6907f3 --- /dev/null +++ b/website/docs/api/generated/enums/scrollphase.md @@ -0,0 +1,45 @@ +--- +id: "scrollphase" +title: "ScrollPhase" +sidebar_label: "ScrollPhase" +--- + +## Index + +### Enumeration members + +* [NoScrollPhase](scrollphase.md#noscrollphase) +* [ScrollBegin](scrollphase.md#scrollbegin) +* [ScrollEnd](scrollphase.md#scrollend) +* [ScrollMomentum](scrollphase.md#scrollmomentum) +* [ScrollUpdate](scrollphase.md#scrollupdate) + +## Enumeration members + +### NoScrollPhase + +• **NoScrollPhase**: = 0 + +___ + +### ScrollBegin + +• **ScrollBegin**: = 1 + +___ + +### ScrollEnd + +• **ScrollEnd**: = 3 + +___ + +### ScrollMomentum + +• **ScrollMomentum**: = 4 + +___ + +### ScrollUpdate + +• **ScrollUpdate**: = 2 diff --git a/website/docs/api/generated/enums/shortcutcontext.md b/website/docs/api/generated/enums/shortcutcontext.md new file mode 100644 index 000000000..d74dd01f7 --- /dev/null +++ b/website/docs/api/generated/enums/shortcutcontext.md @@ -0,0 +1,38 @@ +--- +id: "shortcutcontext" +title: "ShortcutContext" +sidebar_label: "ShortcutContext" +--- + +## Index + +### Enumeration members + +* [ApplicationShortcut](shortcutcontext.md#applicationshortcut) +* [WidgetShortcut](shortcutcontext.md#widgetshortcut) +* [WidgetWithChildrenShortcut](shortcutcontext.md#widgetwithchildrenshortcut) +* [WindowShortcut](shortcutcontext.md#windowshortcut) + +## Enumeration members + +### ApplicationShortcut + +• **ApplicationShortcut**: = 2 + +___ + +### WidgetShortcut + +• **WidgetShortcut**: = 0 + +___ + +### WidgetWithChildrenShortcut + +• **WidgetWithChildrenShortcut**: = 3 + +___ + +### WindowShortcut + +• **WindowShortcut**: = 1 diff --git a/website/docs/api/generated/enums/sizeadjustpolicy.md b/website/docs/api/generated/enums/sizeadjustpolicy.md new file mode 100644 index 000000000..fd5aafe40 --- /dev/null +++ b/website/docs/api/generated/enums/sizeadjustpolicy.md @@ -0,0 +1,38 @@ +--- +id: "sizeadjustpolicy" +title: "SizeAdjustPolicy" +sidebar_label: "SizeAdjustPolicy" +--- + +## Index + +### Enumeration members + +* [AdjustToContents](sizeadjustpolicy.md#adjusttocontents) +* [AdjustToContentsOnFirstShow](sizeadjustpolicy.md#adjusttocontentsonfirstshow) +* [AdjustToMinimumContentsLength](sizeadjustpolicy.md#adjusttominimumcontentslength) +* [AdjustToMinimumContentsLengthWithIcon](sizeadjustpolicy.md#adjusttominimumcontentslengthwithicon) + +## Enumeration members + +### AdjustToContents + +• **AdjustToContents**: = 0 + +___ + +### AdjustToContentsOnFirstShow + +• **AdjustToContentsOnFirstShow**: = 1 + +___ + +### AdjustToMinimumContentsLength + +• **AdjustToMinimumContentsLength**: = 2 + +___ + +### AdjustToMinimumContentsLengthWithIcon + +• **AdjustToMinimumContentsLengthWithIcon**: = 3 diff --git a/website/docs/api/generated/enums/sizehint.md b/website/docs/api/generated/enums/sizehint.md new file mode 100644 index 000000000..2d13162ff --- /dev/null +++ b/website/docs/api/generated/enums/sizehint.md @@ -0,0 +1,38 @@ +--- +id: "sizehint" +title: "SizeHint" +sidebar_label: "SizeHint" +--- + +## Index + +### Enumeration members + +* [MaximumSize](sizehint.md#maximumsize) +* [MinimumDescent](sizehint.md#minimumdescent) +* [MinimumSize](sizehint.md#minimumsize) +* [PreferredSize](sizehint.md#preferredsize) + +## Enumeration members + +### MaximumSize + +• **MaximumSize**: = 2 + +___ + +### MinimumDescent + +• **MinimumDescent**: = 3 + +___ + +### MinimumSize + +• **MinimumSize**: = 0 + +___ + +### PreferredSize + +• **PreferredSize**: = 1 diff --git a/website/docs/api/generated/enums/sizemode.md b/website/docs/api/generated/enums/sizemode.md new file mode 100644 index 000000000..cfe3d3fc0 --- /dev/null +++ b/website/docs/api/generated/enums/sizemode.md @@ -0,0 +1,24 @@ +--- +id: "sizemode" +title: "SizeMode" +sidebar_label: "SizeMode" +--- + +## Index + +### Enumeration members + +* [AbsoluteSize](sizemode.md#absolutesize) +* [RelativeSize](sizemode.md#relativesize) + +## Enumeration members + +### AbsoluteSize + +• **AbsoluteSize**: = 0 + +___ + +### RelativeSize + +• **RelativeSize**: = 1 diff --git a/website/docs/api/generated/enums/sortorder.md b/website/docs/api/generated/enums/sortorder.md new file mode 100644 index 000000000..749880cc2 --- /dev/null +++ b/website/docs/api/generated/enums/sortorder.md @@ -0,0 +1,24 @@ +--- +id: "sortorder" +title: "SortOrder" +sidebar_label: "SortOrder" +--- + +## Index + +### Enumeration members + +* [AscendingOrder](sortorder.md#ascendingorder) +* [DescendingOrder](sortorder.md#descendingorder) + +## Enumeration members + +### AscendingOrder + +• **AscendingOrder**: = 0 + +___ + +### DescendingOrder + +• **DescendingOrder**: = 1 diff --git a/website/docs/api/generated/enums/systemfont.md b/website/docs/api/generated/enums/systemfont.md new file mode 100644 index 000000000..ae21f95a7 --- /dev/null +++ b/website/docs/api/generated/enums/systemfont.md @@ -0,0 +1,38 @@ +--- +id: "systemfont" +title: "SystemFont" +sidebar_label: "SystemFont" +--- + +## Index + +### Enumeration members + +* [FixedFont](systemfont.md#fixedfont) +* [GeneralFont](systemfont.md#generalfont) +* [SmallestReadableFont](systemfont.md#smallestreadablefont) +* [TitleFont](systemfont.md#titlefont) + +## Enumeration members + +### FixedFont + +• **FixedFont**: + +___ + +### GeneralFont + +• **GeneralFont**: + +___ + +### SmallestReadableFont + +• **SmallestReadableFont**: + +___ + +### TitleFont + +• **TitleFont**: diff --git a/website/docs/api/generated/enums/tabfocusbehavior.md b/website/docs/api/generated/enums/tabfocusbehavior.md new file mode 100644 index 000000000..d47512ce0 --- /dev/null +++ b/website/docs/api/generated/enums/tabfocusbehavior.md @@ -0,0 +1,38 @@ +--- +id: "tabfocusbehavior" +title: "TabFocusBehavior" +sidebar_label: "TabFocusBehavior" +--- + +## Index + +### Enumeration members + +* [NoTabFocus](tabfocusbehavior.md#notabfocus) +* [TabFocusAllControls](tabfocusbehavior.md#tabfocusallcontrols) +* [TabFocusListControls](tabfocusbehavior.md#tabfocuslistcontrols) +* [TabFocusTextControls](tabfocusbehavior.md#tabfocustextcontrols) + +## Enumeration members + +### NoTabFocus + +• **NoTabFocus**: = 0 + +___ + +### TabFocusAllControls + +• **TabFocusAllControls**: = 255 + +___ + +### TabFocusListControls + +• **TabFocusListControls**: = 2 + +___ + +### TabFocusTextControls + +• **TabFocusTextControls**: = 1 diff --git a/website/docs/api/generated/enums/tabposition.md b/website/docs/api/generated/enums/tabposition.md new file mode 100644 index 000000000..415164142 --- /dev/null +++ b/website/docs/api/generated/enums/tabposition.md @@ -0,0 +1,38 @@ +--- +id: "tabposition" +title: "TabPosition" +sidebar_label: "TabPosition" +--- + +## Index + +### Enumeration members + +* [East](tabposition.md#east) +* [North](tabposition.md#north) +* [South](tabposition.md#south) +* [West](tabposition.md#west) + +## Enumeration members + +### East + +• **East**: = 3 + +___ + +### North + +• **North**: = 0 + +___ + +### South + +• **South**: = 1 + +___ + +### West + +• **West**: = 2 diff --git a/website/docs/api/generated/enums/textelidemode.md b/website/docs/api/generated/enums/textelidemode.md new file mode 100644 index 000000000..5bfff46d7 --- /dev/null +++ b/website/docs/api/generated/enums/textelidemode.md @@ -0,0 +1,38 @@ +--- +id: "textelidemode" +title: "TextElideMode" +sidebar_label: "TextElideMode" +--- + +## Index + +### Enumeration members + +* [ElideLeft](textelidemode.md#elideleft) +* [ElideMiddle](textelidemode.md#elidemiddle) +* [ElideNone](textelidemode.md#elidenone) +* [ElideRight](textelidemode.md#elideright) + +## Enumeration members + +### ElideLeft + +• **ElideLeft**: = 0 + +___ + +### ElideMiddle + +• **ElideMiddle**: = 2 + +___ + +### ElideNone + +• **ElideNone**: = 3 + +___ + +### ElideRight + +• **ElideRight**: = 1 diff --git a/website/docs/api/generated/enums/textflag.md b/website/docs/api/generated/enums/textflag.md new file mode 100644 index 000000000..81c6ae937 --- /dev/null +++ b/website/docs/api/generated/enums/textflag.md @@ -0,0 +1,80 @@ +--- +id: "textflag" +title: "TextFlag" +sidebar_label: "TextFlag" +--- + +## Index + +### Enumeration members + +* [TextDontClip](textflag.md#textdontclip) +* [TextDontPrint](textflag.md#textdontprint) +* [TextExpandTabs](textflag.md#textexpandtabs) +* [TextHideMnemonic](textflag.md#texthidemnemonic) +* [TextIncludeTrailingSpaces](textflag.md#textincludetrailingspaces) +* [TextJustificationForced](textflag.md#textjustificationforced) +* [TextShowMnemonic](textflag.md#textshowmnemonic) +* [TextSingleLine](textflag.md#textsingleline) +* [TextWordWrap](textflag.md#textwordwrap) +* [TextWrapAnywhere](textflag.md#textwrapanywhere) + +## Enumeration members + +### TextDontClip + +• **TextDontClip**: = 512 + +___ + +### TextDontPrint + +• **TextDontPrint**: = 16384 + +___ + +### TextExpandTabs + +• **TextExpandTabs**: = 1024 + +___ + +### TextHideMnemonic + +• **TextHideMnemonic**: = 32768 + +___ + +### TextIncludeTrailingSpaces + +• **TextIncludeTrailingSpaces**: = 134217728 + +___ + +### TextJustificationForced + +• **TextJustificationForced**: = 65536 + +___ + +### TextShowMnemonic + +• **TextShowMnemonic**: = 2048 + +___ + +### TextSingleLine + +• **TextSingleLine**: = 256 + +___ + +### TextWordWrap + +• **TextWordWrap**: = 4096 + +___ + +### TextWrapAnywhere + +• **TextWrapAnywhere**: = 8192 diff --git a/website/docs/api/generated/enums/textformat.md b/website/docs/api/generated/enums/textformat.md new file mode 100644 index 000000000..a5913baa1 --- /dev/null +++ b/website/docs/api/generated/enums/textformat.md @@ -0,0 +1,31 @@ +--- +id: "textformat" +title: "TextFormat" +sidebar_label: "TextFormat" +--- + +## Index + +### Enumeration members + +* [AutoText](textformat.md#autotext) +* [PlainText](textformat.md#plaintext) +* [RichText](textformat.md#richtext) + +## Enumeration members + +### AutoText + +• **AutoText**: = 2 + +___ + +### PlainText + +• **PlainText**: = 0 + +___ + +### RichText + +• **RichText**: = 1 diff --git a/website/docs/api/generated/enums/textinteractionflag.md b/website/docs/api/generated/enums/textinteractionflag.md new file mode 100644 index 000000000..2167e8bd7 --- /dev/null +++ b/website/docs/api/generated/enums/textinteractionflag.md @@ -0,0 +1,66 @@ +--- +id: "textinteractionflag" +title: "TextInteractionFlag" +sidebar_label: "TextInteractionFlag" +--- + +## Index + +### Enumeration members + +* [LinksAccessibleByKeyboard](textinteractionflag.md#linksaccessiblebykeyboard) +* [LinksAccessibleByMouse](textinteractionflag.md#linksaccessiblebymouse) +* [NoTextInteraction](textinteractionflag.md#notextinteraction) +* [TextBrowserInteraction](textinteractionflag.md#textbrowserinteraction) +* [TextEditable](textinteractionflag.md#texteditable) +* [TextEditorInteraction](textinteractionflag.md#texteditorinteraction) +* [TextSelectableByKeyboard](textinteractionflag.md#textselectablebykeyboard) +* [TextSelectableByMouse](textinteractionflag.md#textselectablebymouse) + +## Enumeration members + +### LinksAccessibleByKeyboard + +• **LinksAccessibleByKeyboard**: = 8 + +___ + +### LinksAccessibleByMouse + +• **LinksAccessibleByMouse**: = 4 + +___ + +### NoTextInteraction + +• **NoTextInteraction**: = 0 + +___ + +### TextBrowserInteraction + +• **TextBrowserInteraction**: = 13 + +___ + +### TextEditable + +• **TextEditable**: = 16 + +___ + +### TextEditorInteraction + +• **TextEditorInteraction**: = 19 + +___ + +### TextSelectableByKeyboard + +• **TextSelectableByKeyboard**: = 2 + +___ + +### TextSelectableByMouse + +• **TextSelectableByMouse**: = 1 diff --git a/website/docs/api/generated/enums/tilerule.md b/website/docs/api/generated/enums/tilerule.md new file mode 100644 index 000000000..d2c12881f --- /dev/null +++ b/website/docs/api/generated/enums/tilerule.md @@ -0,0 +1,31 @@ +--- +id: "tilerule" +title: "TileRule" +sidebar_label: "TileRule" +--- + +## Index + +### Enumeration members + +* [RepeatTile](tilerule.md#repeattile) +* [RoundTile](tilerule.md#roundtile) +* [StretchTile](tilerule.md#stretchtile) + +## Enumeration members + +### RepeatTile + +• **RepeatTile**: = 1 + +___ + +### RoundTile + +• **RoundTile**: = 2 + +___ + +### StretchTile + +• **StretchTile**: = 0 diff --git a/website/docs/api/generated/enums/timertype.md b/website/docs/api/generated/enums/timertype.md new file mode 100644 index 000000000..72a24edcc --- /dev/null +++ b/website/docs/api/generated/enums/timertype.md @@ -0,0 +1,31 @@ +--- +id: "timertype" +title: "TimerType" +sidebar_label: "TimerType" +--- + +## Index + +### Enumeration members + +* [CoarseTimer](timertype.md#coarsetimer) +* [PreciseTimer](timertype.md#precisetimer) +* [VeryCoarseTimer](timertype.md#verycoarsetimer) + +## Enumeration members + +### CoarseTimer + +• **CoarseTimer**: = 1 + +___ + +### PreciseTimer + +• **PreciseTimer**: = 0 + +___ + +### VeryCoarseTimer + +• **VeryCoarseTimer**: = 2 diff --git a/website/docs/api/generated/enums/timespec.md b/website/docs/api/generated/enums/timespec.md new file mode 100644 index 000000000..415de431d --- /dev/null +++ b/website/docs/api/generated/enums/timespec.md @@ -0,0 +1,38 @@ +--- +id: "timespec" +title: "TimeSpec" +sidebar_label: "TimeSpec" +--- + +## Index + +### Enumeration members + +* [LocalTime](timespec.md#localtime) +* [OffsetFromUTC](timespec.md#offsetfromutc) +* [TimeZone](timespec.md#timezone) +* [UTC](timespec.md#utc) + +## Enumeration members + +### LocalTime + +• **LocalTime**: = 0 + +___ + +### OffsetFromUTC + +• **OffsetFromUTC**: = 2 + +___ + +### TimeZone + +• **TimeZone**: = 3 + +___ + +### UTC + +• **UTC**: = 1 diff --git a/website/docs/api/generated/enums/toolbararea.md b/website/docs/api/generated/enums/toolbararea.md new file mode 100644 index 000000000..700fb487b --- /dev/null +++ b/website/docs/api/generated/enums/toolbararea.md @@ -0,0 +1,52 @@ +--- +id: "toolbararea" +title: "ToolBarArea" +sidebar_label: "ToolBarArea" +--- + +## Index + +### Enumeration members + +* [AllToolBarAreas](toolbararea.md#alltoolbarareas) +* [BottomToolBarArea](toolbararea.md#bottomtoolbararea) +* [LeftToolBarArea](toolbararea.md#lefttoolbararea) +* [NoToolBarArea](toolbararea.md#notoolbararea) +* [RightToolBarArea](toolbararea.md#righttoolbararea) +* [TopToolBarArea](toolbararea.md#toptoolbararea) + +## Enumeration members + +### AllToolBarAreas + +• **AllToolBarAreas**: = 15 + +___ + +### BottomToolBarArea + +• **BottomToolBarArea**: = 8 + +___ + +### LeftToolBarArea + +• **LeftToolBarArea**: = 1 + +___ + +### NoToolBarArea + +• **NoToolBarArea**: = 0 + +___ + +### RightToolBarArea + +• **RightToolBarArea**: = 2 + +___ + +### TopToolBarArea + +• **TopToolBarArea**: = 4 diff --git a/website/docs/api/generated/enums/toolbuttonpopupmode.md b/website/docs/api/generated/enums/toolbuttonpopupmode.md new file mode 100644 index 000000000..a50c5a94c --- /dev/null +++ b/website/docs/api/generated/enums/toolbuttonpopupmode.md @@ -0,0 +1,31 @@ +--- +id: "toolbuttonpopupmode" +title: "ToolButtonPopupMode" +sidebar_label: "ToolButtonPopupMode" +--- + +## Index + +### Enumeration members + +* [DelayedPopup](toolbuttonpopupmode.md#delayedpopup) +* [InstantPopup](toolbuttonpopupmode.md#instantpopup) +* [MenuButtonPopup](toolbuttonpopupmode.md#menubuttonpopup) + +## Enumeration members + +### DelayedPopup + +• **DelayedPopup**: + +___ + +### InstantPopup + +• **InstantPopup**: + +___ + +### MenuButtonPopup + +• **MenuButtonPopup**: diff --git a/website/docs/api/generated/enums/toolbuttonstyle.md b/website/docs/api/generated/enums/toolbuttonstyle.md new file mode 100644 index 000000000..c847ce60b --- /dev/null +++ b/website/docs/api/generated/enums/toolbuttonstyle.md @@ -0,0 +1,45 @@ +--- +id: "toolbuttonstyle" +title: "ToolButtonStyle" +sidebar_label: "ToolButtonStyle" +--- + +## Index + +### Enumeration members + +* [ToolButtonFollowStyle](toolbuttonstyle.md#toolbuttonfollowstyle) +* [ToolButtonIconOnly](toolbuttonstyle.md#toolbuttonicononly) +* [ToolButtonTextBesideIcon](toolbuttonstyle.md#toolbuttontextbesideicon) +* [ToolButtonTextOnly](toolbuttonstyle.md#toolbuttontextonly) +* [ToolButtonTextUnderIcon](toolbuttonstyle.md#toolbuttontextundericon) + +## Enumeration members + +### ToolButtonFollowStyle + +• **ToolButtonFollowStyle**: = 4 + +___ + +### ToolButtonIconOnly + +• **ToolButtonIconOnly**: = 0 + +___ + +### ToolButtonTextBesideIcon + +• **ToolButtonTextBesideIcon**: = 2 + +___ + +### ToolButtonTextOnly + +• **ToolButtonTextOnly**: = 1 + +___ + +### ToolButtonTextUnderIcon + +• **ToolButtonTextUnderIcon**: = 3 diff --git a/website/docs/api/generated/enums/touchpointstate.md b/website/docs/api/generated/enums/touchpointstate.md new file mode 100644 index 000000000..32a920742 --- /dev/null +++ b/website/docs/api/generated/enums/touchpointstate.md @@ -0,0 +1,38 @@ +--- +id: "touchpointstate" +title: "TouchPointState" +sidebar_label: "TouchPointState" +--- + +## Index + +### Enumeration members + +* [TouchPointMoved](touchpointstate.md#touchpointmoved) +* [TouchPointPressed](touchpointstate.md#touchpointpressed) +* [TouchPointReleased](touchpointstate.md#touchpointreleased) +* [TouchPointStationary](touchpointstate.md#touchpointstationary) + +## Enumeration members + +### TouchPointMoved + +• **TouchPointMoved**: = 2 + +___ + +### TouchPointPressed + +• **TouchPointPressed**: = 1 + +___ + +### TouchPointReleased + +• **TouchPointReleased**: = 8 + +___ + +### TouchPointStationary + +• **TouchPointStationary**: = 4 diff --git a/website/docs/api/generated/enums/transformationmode.md b/website/docs/api/generated/enums/transformationmode.md new file mode 100644 index 000000000..727c3178a --- /dev/null +++ b/website/docs/api/generated/enums/transformationmode.md @@ -0,0 +1,24 @@ +--- +id: "transformationmode" +title: "TransformationMode" +sidebar_label: "TransformationMode" +--- + +## Index + +### Enumeration members + +* [FastTransformation](transformationmode.md#fasttransformation) +* [SmoothTransformation](transformationmode.md#smoothtransformation) + +## Enumeration members + +### FastTransformation + +• **FastTransformation**: = 0 + +___ + +### SmoothTransformation + +• **SmoothTransformation**: = 1 diff --git a/website/docs/api/generated/enums/uieffect.md b/website/docs/api/generated/enums/uieffect.md new file mode 100644 index 000000000..375122cf1 --- /dev/null +++ b/website/docs/api/generated/enums/uieffect.md @@ -0,0 +1,52 @@ +--- +id: "uieffect" +title: "UIEffect" +sidebar_label: "UIEffect" +--- + +## Index + +### Enumeration members + +* [UI_AnimateCombo](uieffect.md#ui_animatecombo) +* [UI_AnimateMenu](uieffect.md#ui_animatemenu) +* [UI_AnimateToolBox](uieffect.md#ui_animatetoolbox) +* [UI_AnimateTooltip](uieffect.md#ui_animatetooltip) +* [UI_FadeMenu](uieffect.md#ui_fademenu) +* [UI_FadeTooltip](uieffect.md#ui_fadetooltip) + +## Enumeration members + +### UI_AnimateCombo + +• **UI_AnimateCombo**: = 3 + +___ + +### UI_AnimateMenu + +• **UI_AnimateMenu**: = 1 + +___ + +### UI_AnimateToolBox + +• **UI_AnimateToolBox**: = 6 + +___ + +### UI_AnimateTooltip + +• **UI_AnimateTooltip**: = 4 + +___ + +### UI_FadeMenu + +• **UI_FadeMenu**: = 2 + +___ + +### UI_FadeTooltip + +• **UI_FadeTooltip**: = 5 diff --git a/website/docs/api/generated/enums/viewmode.md b/website/docs/api/generated/enums/viewmode.md new file mode 100644 index 000000000..3a1d55e4b --- /dev/null +++ b/website/docs/api/generated/enums/viewmode.md @@ -0,0 +1,24 @@ +--- +id: "viewmode" +title: "ViewMode" +sidebar_label: "ViewMode" +--- + +## Index + +### Enumeration members + +* [Detail](viewmode.md#detail) +* [List](viewmode.md#list) + +## Enumeration members + +### Detail + +• **Detail**: = 0 + +___ + +### List + +• **List**: = 1 diff --git a/website/docs/api/generated/enums/whitespacemode.md b/website/docs/api/generated/enums/whitespacemode.md new file mode 100644 index 000000000..87c31668e --- /dev/null +++ b/website/docs/api/generated/enums/whitespacemode.md @@ -0,0 +1,31 @@ +--- +id: "whitespacemode" +title: "WhiteSpaceMode" +sidebar_label: "WhiteSpaceMode" +--- + +## Index + +### Enumeration members + +* [WhiteSpaceNoWrap](whitespacemode.md#whitespacenowrap) +* [WhiteSpaceNormal](whitespacemode.md#whitespacenormal) +* [WhiteSpacePre](whitespacemode.md#whitespacepre) + +## Enumeration members + +### WhiteSpaceNoWrap + +• **WhiteSpaceNoWrap**: = 2 + +___ + +### WhiteSpaceNormal + +• **WhiteSpaceNormal**: = 0 + +___ + +### WhiteSpacePre + +• **WhiteSpacePre**: = 1 diff --git a/website/docs/api/generated/enums/widgetattribute.md b/website/docs/api/generated/enums/widgetattribute.md new file mode 100644 index 000000000..a80225346 --- /dev/null +++ b/website/docs/api/generated/enums/widgetattribute.md @@ -0,0 +1,598 @@ +--- +id: "widgetattribute" +title: "WidgetAttribute" +sidebar_label: "WidgetAttribute" +--- + +## Index + +### Enumeration members + +* [WA_AcceptDrops](widgetattribute.md#wa_acceptdrops) +* [WA_AcceptTouchEvents](widgetattribute.md#wa_accepttouchevents) +* [WA_AlwaysShowToolTips](widgetattribute.md#wa_alwaysshowtooltips) +* [WA_AlwaysStackOnTop](widgetattribute.md#wa_alwaysstackontop) +* [WA_ContentsMarginsRespectsSafeArea](widgetattribute.md#wa_contentsmarginsrespectssafearea) +* [WA_ContentsPropagated](widgetattribute.md#wa_contentspropagated) +* [WA_CustomWhatsThis](widgetattribute.md#wa_customwhatsthis) +* [WA_DeleteOnClose](widgetattribute.md#wa_deleteonclose) +* [WA_Disabled](widgetattribute.md#wa_disabled) +* [WA_DontCreateNativeAncestors](widgetattribute.md#wa_dontcreatenativeancestors) +* [WA_DontShowOnScreen](widgetattribute.md#wa_dontshowonscreen) +* [WA_ForceDisabled](widgetattribute.md#wa_forcedisabled) +* [WA_ForceUpdatesDisabled](widgetattribute.md#wa_forceupdatesdisabled) +* [WA_GroupLeader](widgetattribute.md#wa_groupleader) +* [WA_Hover](widgetattribute.md#wa_hover) +* [WA_InputMethodEnabled](widgetattribute.md#wa_inputmethodenabled) +* [WA_KeyCompression](widgetattribute.md#wa_keycompression) +* [WA_KeyboardFocusChange](widgetattribute.md#wa_keyboardfocuschange) +* [WA_LayoutOnEntireRect](widgetattribute.md#wa_layoutonentirerect) +* [WA_LayoutUsesWidgetRect](widgetattribute.md#wa_layoutuseswidgetrect) +* [WA_MSWindowsUseDirect3D](widgetattribute.md#wa_mswindowsusedirect3d) +* [WA_MacAlwaysShowToolWindow](widgetattribute.md#wa_macalwaysshowtoolwindow) +* [WA_MacBrushedMetal](widgetattribute.md#wa_macbrushedmetal) +* [WA_MacFrameworkScaled](widgetattribute.md#wa_macframeworkscaled) +* [WA_MacMiniSize](widgetattribute.md#wa_macminisize) +* [WA_MacNoClickThrough](widgetattribute.md#wa_macnoclickthrough) +* [WA_MacNormalSize](widgetattribute.md#wa_macnormalsize) +* [WA_MacOpaqueSizeGrip](widgetattribute.md#wa_macopaquesizegrip) +* [WA_MacShowFocusRect](widgetattribute.md#wa_macshowfocusrect) +* [WA_MacSmallSize](widgetattribute.md#wa_macsmallsize) +* [WA_MacVariableSize](widgetattribute.md#wa_macvariablesize) +* [WA_Mapped](widgetattribute.md#wa_mapped) +* [WA_MouseNoMask](widgetattribute.md#wa_mousenomask) +* [WA_MouseTracking](widgetattribute.md#wa_mousetracking) +* [WA_Moved](widgetattribute.md#wa_moved) +* [WA_NativeWindow](widgetattribute.md#wa_nativewindow) +* [WA_NoBackground](widgetattribute.md#wa_nobackground) +* [WA_NoChildEventsForParent](widgetattribute.md#wa_nochildeventsforparent) +* [WA_NoChildEventsFromChildren](widgetattribute.md#wa_nochildeventsfromchildren) +* [WA_NoMousePropagation](widgetattribute.md#wa_nomousepropagation) +* [WA_NoMouseReplay](widgetattribute.md#wa_nomousereplay) +* [WA_NoSystemBackground](widgetattribute.md#wa_nosystembackground) +* [WA_OpaquePaintEvent](widgetattribute.md#wa_opaquepaintevent) +* [WA_OutsideWSRange](widgetattribute.md#wa_outsidewsrange) +* [WA_PaintOnScreen](widgetattribute.md#wa_paintonscreen) +* [WA_PaintUnclipped](widgetattribute.md#wa_paintunclipped) +* [WA_PendingMoveEvent](widgetattribute.md#wa_pendingmoveevent) +* [WA_PendingResizeEvent](widgetattribute.md#wa_pendingresizeevent) +* [WA_QuitOnClose](widgetattribute.md#wa_quitonclose) +* [WA_Resized](widgetattribute.md#wa_resized) +* [WA_RightToLeft](widgetattribute.md#wa_righttoleft) +* [WA_SetCursor](widgetattribute.md#wa_setcursor) +* [WA_SetFont](widgetattribute.md#wa_setfont) +* [WA_SetLocale](widgetattribute.md#wa_setlocale) +* [WA_SetPalette](widgetattribute.md#wa_setpalette) +* [WA_SetStyle](widgetattribute.md#wa_setstyle) +* [WA_ShowModal](widgetattribute.md#wa_showmodal) +* [WA_ShowWithoutActivating](widgetattribute.md#wa_showwithoutactivating) +* [WA_StaticContents](widgetattribute.md#wa_staticcontents) +* [WA_StyleSheet](widgetattribute.md#wa_stylesheet) +* [WA_StyleSheetTarget](widgetattribute.md#wa_stylesheettarget) +* [WA_StyledBackground](widgetattribute.md#wa_styledbackground) +* [WA_TabletTracking](widgetattribute.md#wa_tablettracking) +* [WA_TouchPadAcceptSingleTouchEvents](widgetattribute.md#wa_touchpadacceptsingletouchevents) +* [WA_TranslucentBackground](widgetattribute.md#wa_translucentbackground) +* [WA_TransparentForMouseEvents](widgetattribute.md#wa_transparentformouseevents) +* [WA_UnderMouse](widgetattribute.md#wa_undermouse) +* [WA_UpdatesDisabled](widgetattribute.md#wa_updatesdisabled) +* [WA_WindowModified](widgetattribute.md#wa_windowmodified) +* [WA_WindowPropagation](widgetattribute.md#wa_windowpropagation) +* [WA_X11DoNotAcceptFocus](widgetattribute.md#wa_x11donotacceptfocus) +* [WA_X11NetWmWindowTypeCombo](widgetattribute.md#wa_x11netwmwindowtypecombo) +* [WA_X11NetWmWindowTypeDND](widgetattribute.md#wa_x11netwmwindowtypednd) +* [WA_X11NetWmWindowTypeDesktop](widgetattribute.md#wa_x11netwmwindowtypedesktop) +* [WA_X11NetWmWindowTypeDialog](widgetattribute.md#wa_x11netwmwindowtypedialog) +* [WA_X11NetWmWindowTypeDock](widgetattribute.md#wa_x11netwmwindowtypedock) +* [WA_X11NetWmWindowTypeDropDownMenu](widgetattribute.md#wa_x11netwmwindowtypedropdownmenu) +* [WA_X11NetWmWindowTypeMenu](widgetattribute.md#wa_x11netwmwindowtypemenu) +* [WA_X11NetWmWindowTypeNotification](widgetattribute.md#wa_x11netwmwindowtypenotification) +* [WA_X11NetWmWindowTypePopupMenu](widgetattribute.md#wa_x11netwmwindowtypepopupmenu) +* [WA_X11NetWmWindowTypeSplash](widgetattribute.md#wa_x11netwmwindowtypesplash) +* [WA_X11NetWmWindowTypeToolBar](widgetattribute.md#wa_x11netwmwindowtypetoolbar) +* [WA_X11NetWmWindowTypeToolTip](widgetattribute.md#wa_x11netwmwindowtypetooltip) +* [WA_X11NetWmWindowTypeUtility](widgetattribute.md#wa_x11netwmwindowtypeutility) + +## Enumeration members + +### WA_AcceptDrops + +• **WA_AcceptDrops**: = 78 + +___ + +### WA_AcceptTouchEvents + +• **WA_AcceptTouchEvents**: = 121 + +___ + +### WA_AlwaysShowToolTips + +• **WA_AlwaysShowToolTips**: = 84 + +___ + +### WA_AlwaysStackOnTop + +• **WA_AlwaysStackOnTop**: = 128 + +___ + +### WA_ContentsMarginsRespectsSafeArea + +• **WA_ContentsMarginsRespectsSafeArea**: = 130 + +___ + +### WA_ContentsPropagated + +• **WA_ContentsPropagated**: = 3 + +___ + +### WA_CustomWhatsThis + +• **WA_CustomWhatsThis**: = 47 + +___ + +### WA_DeleteOnClose + +• **WA_DeleteOnClose**: = 55 + +___ + +### WA_Disabled + +• **WA_Disabled**: = 0 + +___ + +### WA_DontCreateNativeAncestors + +• **WA_DontCreateNativeAncestors**: = 101 + +___ + +### WA_DontShowOnScreen + +• **WA_DontShowOnScreen**: = 103 + +___ + +### WA_ForceDisabled + +• **WA_ForceDisabled**: = 32 + +___ + +### WA_ForceUpdatesDisabled + +• **WA_ForceUpdatesDisabled**: = 59 + +___ + +### WA_GroupLeader + +• **WA_GroupLeader**: = 72 + +___ + +### WA_Hover + +• **WA_Hover**: = 74 + +___ + +### WA_InputMethodEnabled + +• **WA_InputMethodEnabled**: = 14 + +___ + +### WA_KeyCompression + +• **WA_KeyCompression**: = 33 + +___ + +### WA_KeyboardFocusChange + +• **WA_KeyboardFocusChange**: = 77 + +___ + +### WA_LayoutOnEntireRect + +• **WA_LayoutOnEntireRect**: = 48 + +___ + +### WA_LayoutUsesWidgetRect + +• **WA_LayoutUsesWidgetRect**: = 92 + +___ + +### WA_MSWindowsUseDirect3D + +• **WA_MSWindowsUseDirect3D**: = 94 + +___ + +### WA_MacAlwaysShowToolWindow + +• **WA_MacAlwaysShowToolWindow**: = 96 + +___ + +### WA_MacBrushedMetal + +• **WA_MacBrushedMetal**: = 46 + +___ + +### WA_MacFrameworkScaled + +• **WA_MacFrameworkScaled**: = 117 + +___ + +### WA_MacMiniSize + +• **WA_MacMiniSize**: = 91 + +___ + +### WA_MacNoClickThrough + +• **WA_MacNoClickThrough**: = 12 + +___ + +### WA_MacNormalSize + +• **WA_MacNormalSize**: = 89 + +___ + +### WA_MacOpaqueSizeGrip + +• **WA_MacOpaqueSizeGrip**: = 85 + +___ + +### WA_MacShowFocusRect + +• **WA_MacShowFocusRect**: = 88 + +___ + +### WA_MacSmallSize + +• **WA_MacSmallSize**: = 90 + +___ + +### WA_MacVariableSize + +• **WA_MacVariableSize**: = 102 + +___ + +### WA_Mapped + +• **WA_Mapped**: = 11 + +___ + +### WA_MouseNoMask + +• **WA_MouseNoMask**: = 71 + +___ + +### WA_MouseTracking + +• **WA_MouseTracking**: = 2 + +___ + +### WA_Moved + +• **WA_Moved**: = 43 + +___ + +### WA_NativeWindow + +• **WA_NativeWindow**: = 100 + +___ + +### WA_NoBackground + +• **WA_NoBackground**: = 4 + +___ + +### WA_NoChildEventsForParent + +• **WA_NoChildEventsForParent**: = 58 + +___ + +### WA_NoChildEventsFromChildren + +• **WA_NoChildEventsFromChildren**: = 39 + +___ + +### WA_NoMousePropagation + +• **WA_NoMousePropagation**: = 73 + +___ + +### WA_NoMouseReplay + +• **WA_NoMouseReplay**: = 54 + +___ + +### WA_NoSystemBackground + +• **WA_NoSystemBackground**: = 9 + +___ + +### WA_OpaquePaintEvent + +• **WA_OpaquePaintEvent**: = 4 + +___ + +### WA_OutsideWSRange + +• **WA_OutsideWSRange**: = 49 + +___ + +### WA_PaintOnScreen + +• **WA_PaintOnScreen**: = 8 + +___ + +### WA_PaintUnclipped + +• **WA_PaintUnclipped**: = 52 + +___ + +### WA_PendingMoveEvent + +• **WA_PendingMoveEvent**: = 34 + +___ + +### WA_PendingResizeEvent + +• **WA_PendingResizeEvent**: = 35 + +___ + +### WA_QuitOnClose + +• **WA_QuitOnClose**: = 76 + +___ + +### WA_Resized + +• **WA_Resized**: = 42 + +___ + +### WA_RightToLeft + +• **WA_RightToLeft**: = 56 + +___ + +### WA_SetCursor + +• **WA_SetCursor**: = 38 + +___ + +### WA_SetFont + +• **WA_SetFont**: = 37 + +___ + +### WA_SetLocale + +• **WA_SetLocale**: = 87 + +___ + +### WA_SetPalette + +• **WA_SetPalette**: = 36 + +___ + +### WA_SetStyle + +• **WA_SetStyle**: = 86 + +___ + +### WA_ShowModal + +• **WA_ShowModal**: = 70 + +___ + +### WA_ShowWithoutActivating + +• **WA_ShowWithoutActivating**: = 98 + +___ + +### WA_StaticContents + +• **WA_StaticContents**: = 5 + +___ + +### WA_StyleSheet + +• **WA_StyleSheet**: = 97 + +___ + +### WA_StyleSheetTarget + +• **WA_StyleSheetTarget**: = 131 + +___ + +### WA_StyledBackground + +• **WA_StyledBackground**: = 93 + +___ + +### WA_TabletTracking + +• **WA_TabletTracking**: = 129 + +___ + +### WA_TouchPadAcceptSingleTouchEvents + +• **WA_TouchPadAcceptSingleTouchEvents**: = 123 + +___ + +### WA_TranslucentBackground + +• **WA_TranslucentBackground**: = 120 + +___ + +### WA_TransparentForMouseEvents + +• **WA_TransparentForMouseEvents**: = 51 + +___ + +### WA_UnderMouse + +• **WA_UnderMouse**: = 1 + +___ + +### WA_UpdatesDisabled + +• **WA_UpdatesDisabled**: = 10 + +___ + +### WA_WindowModified + +• **WA_WindowModified**: = 41 + +___ + +### WA_WindowPropagation + +• **WA_WindowPropagation**: = 80 + +___ + +### WA_X11DoNotAcceptFocus + +• **WA_X11DoNotAcceptFocus**: = 126 + +___ + +### WA_X11NetWmWindowTypeCombo + +• **WA_X11NetWmWindowTypeCombo**: = 115 + +___ + +### WA_X11NetWmWindowTypeDND + +• **WA_X11NetWmWindowTypeDND**: = 116 + +___ + +### WA_X11NetWmWindowTypeDesktop + +• **WA_X11NetWmWindowTypeDesktop**: = 104 + +___ + +### WA_X11NetWmWindowTypeDialog + +• **WA_X11NetWmWindowTypeDialog**: = 110 + +___ + +### WA_X11NetWmWindowTypeDock + +• **WA_X11NetWmWindowTypeDock**: = 105 + +___ + +### WA_X11NetWmWindowTypeDropDownMenu + +• **WA_X11NetWmWindowTypeDropDownMenu**: = 111 + +___ + +### WA_X11NetWmWindowTypeMenu + +• **WA_X11NetWmWindowTypeMenu**: = 107 + +___ + +### WA_X11NetWmWindowTypeNotification + +• **WA_X11NetWmWindowTypeNotification**: = 114 + +___ + +### WA_X11NetWmWindowTypePopupMenu + +• **WA_X11NetWmWindowTypePopupMenu**: = 112 + +___ + +### WA_X11NetWmWindowTypeSplash + +• **WA_X11NetWmWindowTypeSplash**: = 109 + +___ + +### WA_X11NetWmWindowTypeToolBar + +• **WA_X11NetWmWindowTypeToolBar**: = 106 + +___ + +### WA_X11NetWmWindowTypeToolTip + +• **WA_X11NetWmWindowTypeToolTip**: = 113 + +___ + +### WA_X11NetWmWindowTypeUtility + +• **WA_X11NetWmWindowTypeUtility**: = 108 diff --git a/website/docs/api/generated/enums/widgeteventtypes.md b/website/docs/api/generated/enums/widgeteventtypes.md new file mode 100644 index 000000000..1236e8e94 --- /dev/null +++ b/website/docs/api/generated/enums/widgeteventtypes.md @@ -0,0 +1,1025 @@ +--- +id: "widgeteventtypes" +title: "WidgetEventTypes" +sidebar_label: "WidgetEventTypes" +--- + +## Index + +### Enumeration members + +* [ActionAdded](widgeteventtypes.md#actionadded) +* [ActionChanged](widgeteventtypes.md#actionchanged) +* [ActionRemoved](widgeteventtypes.md#actionremoved) +* [ActivationChange](widgeteventtypes.md#activationchange) +* [ApplicationActivate](widgeteventtypes.md#applicationactivate) +* [ApplicationActivated](widgeteventtypes.md#applicationactivated) +* [ApplicationDeactivate](widgeteventtypes.md#applicationdeactivate) +* [ApplicationFontChange](widgeteventtypes.md#applicationfontchange) +* [ApplicationLayoutDirectionChange](widgeteventtypes.md#applicationlayoutdirectionchange) +* [ApplicationPaletteChange](widgeteventtypes.md#applicationpalettechange) +* [ApplicationStateChange](widgeteventtypes.md#applicationstatechange) +* [ApplicationWindowIconChange](widgeteventtypes.md#applicationwindowiconchange) +* [ChildAdded](widgeteventtypes.md#childadded) +* [ChildPolished](widgeteventtypes.md#childpolished) +* [ChildRemoved](widgeteventtypes.md#childremoved) +* [Clipboard](widgeteventtypes.md#clipboard) +* [Close](widgeteventtypes.md#close) +* [CloseSoftwareInputPanel](widgeteventtypes.md#closesoftwareinputpanel) +* [ContentsRectChange](widgeteventtypes.md#contentsrectchange) +* [ContextMenu](widgeteventtypes.md#contextmenu) +* [CursorChange](widgeteventtypes.md#cursorchange) +* [DeferredDelete](widgeteventtypes.md#deferreddelete) +* [DragEnter](widgeteventtypes.md#dragenter) +* [DragLeave](widgeteventtypes.md#dragleave) +* [DragMove](widgeteventtypes.md#dragmove) +* [Drop](widgeteventtypes.md#drop) +* [DynamicPropertyChange](widgeteventtypes.md#dynamicpropertychange) +* [EnabledChange](widgeteventtypes.md#enabledchange) +* [Enter](widgeteventtypes.md#enter) +* [EnterWhatsThisMode](widgeteventtypes.md#enterwhatsthismode) +* [Expose](widgeteventtypes.md#expose) +* [FileOpen](widgeteventtypes.md#fileopen) +* [FocusAboutToChange](widgeteventtypes.md#focusabouttochange) +* [FocusIn](widgeteventtypes.md#focusin) +* [FocusOut](widgeteventtypes.md#focusout) +* [FontChange](widgeteventtypes.md#fontchange) +* [Gesture](widgeteventtypes.md#gesture) +* [GestureOverride](widgeteventtypes.md#gestureoverride) +* [GrabKeyboard](widgeteventtypes.md#grabkeyboard) +* [GrabMouse](widgeteventtypes.md#grabmouse) +* [GraphicsSceneContextMenu](widgeteventtypes.md#graphicsscenecontextmenu) +* [GraphicsSceneDragEnter](widgeteventtypes.md#graphicsscenedragenter) +* [GraphicsSceneDragLeave](widgeteventtypes.md#graphicsscenedragleave) +* [GraphicsSceneDragMove](widgeteventtypes.md#graphicsscenedragmove) +* [GraphicsSceneDrop](widgeteventtypes.md#graphicsscenedrop) +* [GraphicsSceneHelp](widgeteventtypes.md#graphicsscenehelp) +* [GraphicsSceneHoverEnter](widgeteventtypes.md#graphicsscenehoverenter) +* [GraphicsSceneHoverLeave](widgeteventtypes.md#graphicsscenehoverleave) +* [GraphicsSceneHoverMove](widgeteventtypes.md#graphicsscenehovermove) +* [GraphicsSceneMouseDoubleClick](widgeteventtypes.md#graphicsscenemousedoubleclick) +* [GraphicsSceneMouseMove](widgeteventtypes.md#graphicsscenemousemove) +* [GraphicsSceneMousePress](widgeteventtypes.md#graphicsscenemousepress) +* [GraphicsSceneMouseRelease](widgeteventtypes.md#graphicsscenemouserelease) +* [GraphicsSceneMove](widgeteventtypes.md#graphicsscenemove) +* [GraphicsSceneResize](widgeteventtypes.md#graphicssceneresize) +* [GraphicsSceneWheel](widgeteventtypes.md#graphicsscenewheel) +* [Hide](widgeteventtypes.md#hide) +* [HideToParent](widgeteventtypes.md#hidetoparent) +* [HoverEnter](widgeteventtypes.md#hoverenter) +* [HoverLeave](widgeteventtypes.md#hoverleave) +* [HoverMove](widgeteventtypes.md#hovermove) +* [IconDrag](widgeteventtypes.md#icondrag) +* [IconTextChange](widgeteventtypes.md#icontextchange) +* [InputMethod](widgeteventtypes.md#inputmethod) +* [InputMethodQuery](widgeteventtypes.md#inputmethodquery) +* [KeyPress](widgeteventtypes.md#keypress) +* [KeyRelease](widgeteventtypes.md#keyrelease) +* [KeyboardLayoutChange](widgeteventtypes.md#keyboardlayoutchange) +* [LanguageChange](widgeteventtypes.md#languagechange) +* [LayoutDirectionChange](widgeteventtypes.md#layoutdirectionchange) +* [LayoutRequest](widgeteventtypes.md#layoutrequest) +* [Leave](widgeteventtypes.md#leave) +* [LeaveWhatsThisMode](widgeteventtypes.md#leavewhatsthismode) +* [LocaleChange](widgeteventtypes.md#localechange) +* [MacSizeChange](widgeteventtypes.md#macsizechange) +* [MetaCall](widgeteventtypes.md#metacall) +* [ModifiedChange](widgeteventtypes.md#modifiedchange) +* [MouseButtonDblClick](widgeteventtypes.md#mousebuttondblclick) +* [MouseButtonPress](widgeteventtypes.md#mousebuttonpress) +* [MouseButtonRelease](widgeteventtypes.md#mousebuttonrelease) +* [MouseMove](widgeteventtypes.md#mousemove) +* [MouseTrackingChange](widgeteventtypes.md#mousetrackingchange) +* [Move](widgeteventtypes.md#move) +* [NativeGesture](widgeteventtypes.md#nativegesture) +* [NonClientAreaMouseButtonDblClick](widgeteventtypes.md#nonclientareamousebuttondblclick) +* [NonClientAreaMouseButtonPress](widgeteventtypes.md#nonclientareamousebuttonpress) +* [NonClientAreaMouseButtonRelease](widgeteventtypes.md#nonclientareamousebuttonrelease) +* [NonClientAreaMouseMove](widgeteventtypes.md#nonclientareamousemove) +* [None](widgeteventtypes.md#none) +* [OrientationChange](widgeteventtypes.md#orientationchange) +* [Paint](widgeteventtypes.md#paint) +* [PaletteChange](widgeteventtypes.md#palettechange) +* [ParentAboutToChange](widgeteventtypes.md#parentabouttochange) +* [ParentChange](widgeteventtypes.md#parentchange) +* [PlatformPanel](widgeteventtypes.md#platformpanel) +* [PlatformSurface](widgeteventtypes.md#platformsurface) +* [Polish](widgeteventtypes.md#polish) +* [PolishRequest](widgeteventtypes.md#polishrequest) +* [QueryWhatsThis](widgeteventtypes.md#querywhatsthis) +* [ReadOnlyChange](widgeteventtypes.md#readonlychange) +* [RequestSoftwareInputPanel](widgeteventtypes.md#requestsoftwareinputpanel) +* [Resize](widgeteventtypes.md#resize) +* [Scroll](widgeteventtypes.md#scroll) +* [ScrollPrepare](widgeteventtypes.md#scrollprepare) +* [Shortcut](widgeteventtypes.md#shortcut) +* [ShortcutOverride](widgeteventtypes.md#shortcutoverride) +* [Show](widgeteventtypes.md#show) +* [ShowToParent](widgeteventtypes.md#showtoparent) +* [SockAct](widgeteventtypes.md#sockact) +* [StateMachineSignal](widgeteventtypes.md#statemachinesignal) +* [StateMachineWrapped](widgeteventtypes.md#statemachinewrapped) +* [StatusTip](widgeteventtypes.md#statustip) +* [StyleChange](widgeteventtypes.md#stylechange) +* [TabletEnterProximity](widgeteventtypes.md#tabletenterproximity) +* [TabletLeaveProximity](widgeteventtypes.md#tabletleaveproximity) +* [TabletMove](widgeteventtypes.md#tabletmove) +* [TabletPress](widgeteventtypes.md#tabletpress) +* [TabletRelease](widgeteventtypes.md#tabletrelease) +* [TabletTrackingChange](widgeteventtypes.md#tablettrackingchange) +* [ThreadChange](widgeteventtypes.md#threadchange) +* [Timer](widgeteventtypes.md#timer) +* [ToolBarChange](widgeteventtypes.md#toolbarchange) +* [ToolTip](widgeteventtypes.md#tooltip) +* [ToolTipChange](widgeteventtypes.md#tooltipchange) +* [TouchBegin](widgeteventtypes.md#touchbegin) +* [TouchCancel](widgeteventtypes.md#touchcancel) +* [TouchEnd](widgeteventtypes.md#touchend) +* [TouchUpdate](widgeteventtypes.md#touchupdate) +* [UngrabKeyboard](widgeteventtypes.md#ungrabkeyboard) +* [UngrabMouse](widgeteventtypes.md#ungrabmouse) +* [UpdateLater](widgeteventtypes.md#updatelater) +* [UpdateRequest](widgeteventtypes.md#updaterequest) +* [WhatsThis](widgeteventtypes.md#whatsthis) +* [WhatsThisClicked](widgeteventtypes.md#whatsthisclicked) +* [Wheel](widgeteventtypes.md#wheel) +* [WinEventAct](widgeteventtypes.md#wineventact) +* [WinIdChange](widgeteventtypes.md#winidchange) +* [WindowActivate](widgeteventtypes.md#windowactivate) +* [WindowBlocked](widgeteventtypes.md#windowblocked) +* [WindowDeactivate](widgeteventtypes.md#windowdeactivate) +* [WindowIconChange](widgeteventtypes.md#windowiconchange) +* [WindowStateChange](widgeteventtypes.md#windowstatechange) +* [WindowTitleChange](widgeteventtypes.md#windowtitlechange) +* [WindowUnblocked](widgeteventtypes.md#windowunblocked) +* [ZOrderChange](widgeteventtypes.md#zorderchange) + +## Enumeration members + +### ActionAdded + +• **ActionAdded**: = "ActionAdded" + +___ + +### ActionChanged + +• **ActionChanged**: = "ActionChanged" + +___ + +### ActionRemoved + +• **ActionRemoved**: = "ActionRemoved" + +___ + +### ActivationChange + +• **ActivationChange**: = "ActivationChange" + +___ + +### ApplicationActivate + +• **ApplicationActivate**: = "ApplicationActivate" + +___ + +### ApplicationActivated + +• **ApplicationActivated**: = "ApplicationActivated" + +___ + +### ApplicationDeactivate + +• **ApplicationDeactivate**: = "ApplicationDeactivate" + +___ + +### ApplicationFontChange + +• **ApplicationFontChange**: = "ApplicationFontChange" + +___ + +### ApplicationLayoutDirectionChange + +• **ApplicationLayoutDirectionChange**: = "ApplicationLayoutDirectionChange" + +___ + +### ApplicationPaletteChange + +• **ApplicationPaletteChange**: = "ApplicationPaletteChange" + +___ + +### ApplicationStateChange + +• **ApplicationStateChange**: = "ApplicationStateChange" + +___ + +### ApplicationWindowIconChange + +• **ApplicationWindowIconChange**: = "ApplicationWindowIconChange" + +___ + +### ChildAdded + +• **ChildAdded**: = "ChildAdded" + +___ + +### ChildPolished + +• **ChildPolished**: = "ChildPolished" + +___ + +### ChildRemoved + +• **ChildRemoved**: = "ChildRemoved" + +___ + +### Clipboard + +• **Clipboard**: = "Clipboard" + +___ + +### Close + +• **Close**: = "Close" + +___ + +### CloseSoftwareInputPanel + +• **CloseSoftwareInputPanel**: = "CloseSoftwareInputPanel" + +___ + +### ContentsRectChange + +• **ContentsRectChange**: = "ContentsRectChange" + +___ + +### ContextMenu + +• **ContextMenu**: = "ContextMenu" + +___ + +### CursorChange + +• **CursorChange**: = "CursorChange" + +___ + +### DeferredDelete + +• **DeferredDelete**: = "DeferredDelete" + +___ + +### DragEnter + +• **DragEnter**: = "DragEnter" + +___ + +### DragLeave + +• **DragLeave**: = "DragLeave" + +___ + +### DragMove + +• **DragMove**: = "DragMove" + +___ + +### Drop + +• **Drop**: = "Drop" + +___ + +### DynamicPropertyChange + +• **DynamicPropertyChange**: = "DynamicPropertyChange" + +___ + +### EnabledChange + +• **EnabledChange**: = "EnabledChange" + +___ + +### Enter + +• **Enter**: = "Enter" + +___ + +### EnterWhatsThisMode + +• **EnterWhatsThisMode**: = "EnterWhatsThisMode" + +___ + +### Expose + +• **Expose**: = "Expose" + +___ + +### FileOpen + +• **FileOpen**: = "FileOpen" + +___ + +### FocusAboutToChange + +• **FocusAboutToChange**: = "FocusAboutToChange" + +___ + +### FocusIn + +• **FocusIn**: = "FocusIn" + +___ + +### FocusOut + +• **FocusOut**: = "FocusOut" + +___ + +### FontChange + +• **FontChange**: = "FontChange" + +___ + +### Gesture + +• **Gesture**: = "Gesture" + +___ + +### GestureOverride + +• **GestureOverride**: = "GestureOverride" + +___ + +### GrabKeyboard + +• **GrabKeyboard**: = "GrabKeyboard" + +___ + +### GrabMouse + +• **GrabMouse**: = "GrabMouse" + +___ + +### GraphicsSceneContextMenu + +• **GraphicsSceneContextMenu**: = "GraphicsSceneContextMenu" + +___ + +### GraphicsSceneDragEnter + +• **GraphicsSceneDragEnter**: = "GraphicsSceneDragEnter" + +___ + +### GraphicsSceneDragLeave + +• **GraphicsSceneDragLeave**: = "GraphicsSceneDragLeave" + +___ + +### GraphicsSceneDragMove + +• **GraphicsSceneDragMove**: = "GraphicsSceneDragMove" + +___ + +### GraphicsSceneDrop + +• **GraphicsSceneDrop**: = "GraphicsSceneDrop" + +___ + +### GraphicsSceneHelp + +• **GraphicsSceneHelp**: = "GraphicsSceneHelp" + +___ + +### GraphicsSceneHoverEnter + +• **GraphicsSceneHoverEnter**: = "GraphicsSceneHoverEnter" + +___ + +### GraphicsSceneHoverLeave + +• **GraphicsSceneHoverLeave**: = "GraphicsSceneHoverLeave" + +___ + +### GraphicsSceneHoverMove + +• **GraphicsSceneHoverMove**: = "GraphicsSceneHoverMove" + +___ + +### GraphicsSceneMouseDoubleClick + +• **GraphicsSceneMouseDoubleClick**: = "GraphicsSceneMouseDoubleClick" + +___ + +### GraphicsSceneMouseMove + +• **GraphicsSceneMouseMove**: = "GraphicsSceneMouseMove" + +___ + +### GraphicsSceneMousePress + +• **GraphicsSceneMousePress**: = "GraphicsSceneMousePress" + +___ + +### GraphicsSceneMouseRelease + +• **GraphicsSceneMouseRelease**: = "GraphicsSceneMouseRelease" + +___ + +### GraphicsSceneMove + +• **GraphicsSceneMove**: = "GraphicsSceneMove" + +___ + +### GraphicsSceneResize + +• **GraphicsSceneResize**: = "GraphicsSceneResize" + +___ + +### GraphicsSceneWheel + +• **GraphicsSceneWheel**: = "GraphicsSceneWheel" + +___ + +### Hide + +• **Hide**: = "Hide" + +___ + +### HideToParent + +• **HideToParent**: = "HideToParent" + +___ + +### HoverEnter + +• **HoverEnter**: = "HoverEnter" + +___ + +### HoverLeave + +• **HoverLeave**: = "HoverLeave" + +___ + +### HoverMove + +• **HoverMove**: = "HoverMove" + +___ + +### IconDrag + +• **IconDrag**: = "IconDrag" + +___ + +### IconTextChange + +• **IconTextChange**: = "IconTextChange" + +___ + +### InputMethod + +• **InputMethod**: = "InputMethod" + +___ + +### InputMethodQuery + +• **InputMethodQuery**: = "InputMethodQuery" + +___ + +### KeyPress + +• **KeyPress**: = "KeyPress" + +___ + +### KeyRelease + +• **KeyRelease**: = "KeyRelease" + +___ + +### KeyboardLayoutChange + +• **KeyboardLayoutChange**: = "KeyboardLayoutChange" + +___ + +### LanguageChange + +• **LanguageChange**: = "LanguageChange" + +___ + +### LayoutDirectionChange + +• **LayoutDirectionChange**: = "LayoutDirectionChange" + +___ + +### LayoutRequest + +• **LayoutRequest**: = "LayoutRequest" + +___ + +### Leave + +• **Leave**: = "Leave" + +___ + +### LeaveWhatsThisMode + +• **LeaveWhatsThisMode**: = "LeaveWhatsThisMode" + +___ + +### LocaleChange + +• **LocaleChange**: = "LocaleChange" + +___ + +### MacSizeChange + +• **MacSizeChange**: = "MacSizeChange" + +___ + +### MetaCall + +• **MetaCall**: = "MetaCall" + +___ + +### ModifiedChange + +• **ModifiedChange**: = "ModifiedChange" + +___ + +### MouseButtonDblClick + +• **MouseButtonDblClick**: = "MouseButtonDblClick" + +___ + +### MouseButtonPress + +• **MouseButtonPress**: = "MouseButtonPress" + +___ + +### MouseButtonRelease + +• **MouseButtonRelease**: = "MouseButtonRelease" + +___ + +### MouseMove + +• **MouseMove**: = "MouseMove" + +___ + +### MouseTrackingChange + +• **MouseTrackingChange**: = "MouseTrackingChange" + +___ + +### Move + +• **Move**: = "Move" + +___ + +### NativeGesture + +• **NativeGesture**: = "NativeGesture" + +___ + +### NonClientAreaMouseButtonDblClick + +• **NonClientAreaMouseButtonDblClick**: = "NonClientAreaMouseButtonDblClick" + +___ + +### NonClientAreaMouseButtonPress + +• **NonClientAreaMouseButtonPress**: = "NonClientAreaMouseButtonPress" + +___ + +### NonClientAreaMouseButtonRelease + +• **NonClientAreaMouseButtonRelease**: = "NonClientAreaMouseButtonRelease" + +___ + +### NonClientAreaMouseMove + +• **NonClientAreaMouseMove**: = "NonClientAreaMouseMove" + +___ + +### None + +• **None**: = "None" + +___ + +### OrientationChange + +• **OrientationChange**: = "OrientationChange" + +___ + +### Paint + +• **Paint**: = "Paint" + +___ + +### PaletteChange + +• **PaletteChange**: = "PaletteChange" + +___ + +### ParentAboutToChange + +• **ParentAboutToChange**: = "ParentAboutToChange" + +___ + +### ParentChange + +• **ParentChange**: = "ParentChange" + +___ + +### PlatformPanel + +• **PlatformPanel**: = "PlatformPanel" + +___ + +### PlatformSurface + +• **PlatformSurface**: = "PlatformSurface" + +___ + +### Polish + +• **Polish**: = "Polish" + +___ + +### PolishRequest + +• **PolishRequest**: = "PolishRequest" + +___ + +### QueryWhatsThis + +• **QueryWhatsThis**: = "QueryWhatsThis" + +___ + +### ReadOnlyChange + +• **ReadOnlyChange**: = "ReadOnlyChange" + +___ + +### RequestSoftwareInputPanel + +• **RequestSoftwareInputPanel**: = "RequestSoftwareInputPanel" + +___ + +### Resize + +• **Resize**: = "Resize" + +___ + +### Scroll + +• **Scroll**: = "Scroll" + +___ + +### ScrollPrepare + +• **ScrollPrepare**: = "ScrollPrepare" + +___ + +### Shortcut + +• **Shortcut**: = "Shortcut" + +___ + +### ShortcutOverride + +• **ShortcutOverride**: = "ShortcutOverride" + +___ + +### Show + +• **Show**: = "Show" + +___ + +### ShowToParent + +• **ShowToParent**: = "ShowToParent" + +___ + +### SockAct + +• **SockAct**: = "SockAct" + +___ + +### StateMachineSignal + +• **StateMachineSignal**: = "StateMachineSignal" + +___ + +### StateMachineWrapped + +• **StateMachineWrapped**: = "StateMachineWrapped" + +___ + +### StatusTip + +• **StatusTip**: = "StatusTip" + +___ + +### StyleChange + +• **StyleChange**: = "StyleChange" + +___ + +### TabletEnterProximity + +• **TabletEnterProximity**: = "TabletEnterProximity" + +___ + +### TabletLeaveProximity + +• **TabletLeaveProximity**: = "TabletLeaveProximity" + +___ + +### TabletMove + +• **TabletMove**: = "TabletMove" + +___ + +### TabletPress + +• **TabletPress**: = "TabletPress" + +___ + +### TabletRelease + +• **TabletRelease**: = "TabletRelease" + +___ + +### TabletTrackingChange + +• **TabletTrackingChange**: = "TabletTrackingChange" + +___ + +### ThreadChange + +• **ThreadChange**: = "ThreadChange" + +___ + +### Timer + +• **Timer**: = "Timer" + +___ + +### ToolBarChange + +• **ToolBarChange**: = "ToolBarChange" + +___ + +### ToolTip + +• **ToolTip**: = "ToolTip" + +___ + +### ToolTipChange + +• **ToolTipChange**: = "ToolTipChange" + +___ + +### TouchBegin + +• **TouchBegin**: = "TouchBegin" + +___ + +### TouchCancel + +• **TouchCancel**: = "TouchCancel" + +___ + +### TouchEnd + +• **TouchEnd**: = "TouchEnd" + +___ + +### TouchUpdate + +• **TouchUpdate**: = "TouchUpdate" + +___ + +### UngrabKeyboard + +• **UngrabKeyboard**: = "UngrabKeyboard" + +___ + +### UngrabMouse + +• **UngrabMouse**: = "UngrabMouse" + +___ + +### UpdateLater + +• **UpdateLater**: = "UpdateLater" + +___ + +### UpdateRequest + +• **UpdateRequest**: = "UpdateRequest" + +___ + +### WhatsThis + +• **WhatsThis**: = "WhatsThis" + +___ + +### WhatsThisClicked + +• **WhatsThisClicked**: = "WhatsThisClicked" + +___ + +### Wheel + +• **Wheel**: = "Wheel" + +___ + +### WinEventAct + +• **WinEventAct**: = "WinEventAct" + +___ + +### WinIdChange + +• **WinIdChange**: = "WinIdChange" + +___ + +### WindowActivate + +• **WindowActivate**: = "WindowActivate" + +___ + +### WindowBlocked + +• **WindowBlocked**: = "WindowBlocked" + +___ + +### WindowDeactivate + +• **WindowDeactivate**: = "WindowDeactivate" + +___ + +### WindowIconChange + +• **WindowIconChange**: = "WindowIconChange" + +___ + +### WindowStateChange + +• **WindowStateChange**: = "WindowStateChange" + +___ + +### WindowTitleChange + +• **WindowTitleChange**: = "WindowTitleChange" + +___ + +### WindowUnblocked + +• **WindowUnblocked**: = "WindowUnblocked" + +___ + +### ZOrderChange + +• **ZOrderChange**: = "ZOrderChange" diff --git a/website/docs/api/generated/enums/windowframesection.md b/website/docs/api/generated/enums/windowframesection.md new file mode 100644 index 000000000..cda24d1dd --- /dev/null +++ b/website/docs/api/generated/enums/windowframesection.md @@ -0,0 +1,80 @@ +--- +id: "windowframesection" +title: "WindowFrameSection" +sidebar_label: "WindowFrameSection" +--- + +## Index + +### Enumeration members + +* [BottomLeftSection](windowframesection.md#bottomleftsection) +* [BottomRightSection](windowframesection.md#bottomrightsection) +* [BottomSection](windowframesection.md#bottomsection) +* [LeftSection](windowframesection.md#leftsection) +* [NoSection](windowframesection.md#nosection) +* [RightSection](windowframesection.md#rightsection) +* [TitleBarArea](windowframesection.md#titlebararea) +* [TopLeftSection](windowframesection.md#topleftsection) +* [TopRightSection](windowframesection.md#toprightsection) +* [TopSection](windowframesection.md#topsection) + +## Enumeration members + +### BottomLeftSection + +• **BottomLeftSection**: = 8 + +___ + +### BottomRightSection + +• **BottomRightSection**: = 6 + +___ + +### BottomSection + +• **BottomSection**: = 7 + +___ + +### LeftSection + +• **LeftSection**: = 1 + +___ + +### NoSection + +• **NoSection**: = 0 + +___ + +### RightSection + +• **RightSection**: = 5 + +___ + +### TitleBarArea + +• **TitleBarArea**: = 9 + +___ + +### TopLeftSection + +• **TopLeftSection**: = 2 + +___ + +### TopRightSection + +• **TopRightSection**: = 4 + +___ + +### TopSection + +• **TopSection**: = 3 diff --git a/website/docs/api/generated/enums/windowmodality.md b/website/docs/api/generated/enums/windowmodality.md new file mode 100644 index 000000000..30a3d6678 --- /dev/null +++ b/website/docs/api/generated/enums/windowmodality.md @@ -0,0 +1,31 @@ +--- +id: "windowmodality" +title: "WindowModality" +sidebar_label: "WindowModality" +--- + +## Index + +### Enumeration members + +* [ApplicationModal](windowmodality.md#applicationmodal) +* [NonModal](windowmodality.md#nonmodal) +* [WindowModal](windowmodality.md#windowmodal) + +## Enumeration members + +### ApplicationModal + +• **ApplicationModal**: = 2 + +___ + +### NonModal + +• **NonModal**: = 0 + +___ + +### WindowModal + +• **WindowModal**: = 1 diff --git a/website/docs/api/generated/enums/windowstate.md b/website/docs/api/generated/enums/windowstate.md new file mode 100644 index 000000000..a081d2c92 --- /dev/null +++ b/website/docs/api/generated/enums/windowstate.md @@ -0,0 +1,45 @@ +--- +id: "windowstate" +title: "WindowState" +sidebar_label: "WindowState" +--- + +## Index + +### Enumeration members + +* [WindowActive](windowstate.md#windowactive) +* [WindowFullScreen](windowstate.md#windowfullscreen) +* [WindowMaximized](windowstate.md#windowmaximized) +* [WindowMinimized](windowstate.md#windowminimized) +* [WindowNoState](windowstate.md#windownostate) + +## Enumeration members + +### WindowActive + +• **WindowActive**: = 8 + +___ + +### WindowFullScreen + +• **WindowFullScreen**: = 4 + +___ + +### WindowMaximized + +• **WindowMaximized**: = 2 + +___ + +### WindowMinimized + +• **WindowMinimized**: = 1 + +___ + +### WindowNoState + +• **WindowNoState**: = 0 diff --git a/website/docs/api/generated/enums/windowtype.md b/website/docs/api/generated/enums/windowtype.md new file mode 100644 index 000000000..9c4547934 --- /dev/null +++ b/website/docs/api/generated/enums/windowtype.md @@ -0,0 +1,276 @@ +--- +id: "windowtype" +title: "WindowType" +sidebar_label: "WindowType" +--- + +## Index + +### Enumeration members + +* [BypassGraphicsProxyWidget](windowtype.md#bypassgraphicsproxywidget) +* [BypassWindowManagerHint](windowtype.md#bypasswindowmanagerhint) +* [CoverWindow](windowtype.md#coverwindow) +* [CustomizeWindowHint](windowtype.md#customizewindowhint) +* [Desktop](windowtype.md#desktop) +* [Dialog](windowtype.md#dialog) +* [Drawer](windowtype.md#drawer) +* [ForeignWindow](windowtype.md#foreignwindow) +* [FramelessWindowHint](windowtype.md#framelesswindowhint) +* [MSWindowsFixedSizeDialogHint](windowtype.md#mswindowsfixedsizedialoghint) +* [MSWindowsOwnDC](windowtype.md#mswindowsowndc) +* [MacWindowToolBarButtonHint](windowtype.md#macwindowtoolbarbuttonhint) +* [MaximizeUsingFullscreenGeometryHint](windowtype.md#maximizeusingfullscreengeometryhint) +* [NoDropShadowWindowHint](windowtype.md#nodropshadowwindowhint) +* [Popup](windowtype.md#popup) +* [Sheet](windowtype.md#sheet) +* [SplashScreen](windowtype.md#splashscreen) +* [SubWindow](windowtype.md#subwindow) +* [Tool](windowtype.md#tool) +* [ToolTip](windowtype.md#tooltip) +* [Widget](windowtype.md#widget) +* [Window](windowtype.md#window) +* [WindowCloseButtonHint](windowtype.md#windowclosebuttonhint) +* [WindowContextHelpButtonHint](windowtype.md#windowcontexthelpbuttonhint) +* [WindowDoesNotAcceptFocus](windowtype.md#windowdoesnotacceptfocus) +* [WindowFullscreenButtonHint](windowtype.md#windowfullscreenbuttonhint) +* [WindowMaximizeButtonHint](windowtype.md#windowmaximizebuttonhint) +* [WindowMinMaxButtonsHint](windowtype.md#windowminmaxbuttonshint) +* [WindowMinimizeButtonHint](windowtype.md#windowminimizebuttonhint) +* [WindowOverridesSystemGestures](windowtype.md#windowoverridessystemgestures) +* [WindowShadeButtonHint](windowtype.md#windowshadebuttonhint) +* [WindowStaysOnBottomHint](windowtype.md#windowstaysonbottomhint) +* [WindowStaysOnTopHint](windowtype.md#windowstaysontophint) +* [WindowSystemMenuHint](windowtype.md#windowsystemmenuhint) +* [WindowTitleHint](windowtype.md#windowtitlehint) +* [WindowTransparentForInput](windowtype.md#windowtransparentforinput) +* [WindowType_Mask](windowtype.md#windowtype_mask) +* [X11BypassWindowManagerHint](windowtype.md#x11bypasswindowmanagerhint) + +## Enumeration members + +### BypassGraphicsProxyWidget + +• **BypassGraphicsProxyWidget**: = 536870912 + +___ + +### BypassWindowManagerHint + +• **BypassWindowManagerHint**: = 1024 + +___ + +### CoverWindow + +• **CoverWindow**: = 65 + +___ + +### CustomizeWindowHint + +• **CustomizeWindowHint**: = 33554432 + +___ + +### Desktop + +• **Desktop**: = 17 + +___ + +### Dialog + +• **Dialog**: = 3 + +___ + +### Drawer + +• **Drawer**: = 8 + +___ + +### ForeignWindow + +• **ForeignWindow**: = 33 + +___ + +### FramelessWindowHint + +• **FramelessWindowHint**: = 2048 + +___ + +### MSWindowsFixedSizeDialogHint + +• **MSWindowsFixedSizeDialogHint**: = 256 + +___ + +### MSWindowsOwnDC + +• **MSWindowsOwnDC**: = 512 + +___ + +### MacWindowToolBarButtonHint + +• **MacWindowToolBarButtonHint**: = 268435456 + +___ + +### MaximizeUsingFullscreenGeometryHint + +• **MaximizeUsingFullscreenGeometryHint**: = 4194304 + +___ + +### NoDropShadowWindowHint + +• **NoDropShadowWindowHint**: = 1073741824 + +___ + +### Popup + +• **Popup**: = 9 + +___ + +### Sheet + +• **Sheet**: = 5 + +___ + +### SplashScreen + +• **SplashScreen**: = 23 + +___ + +### SubWindow + +• **SubWindow**: = 18 + +___ + +### Tool + +• **Tool**: = 18 + +___ + +### ToolTip + +• **ToolTip**: = 20 + +___ + +### Widget + +• **Widget**: = 0 + +___ + +### Window + +• **Window**: = 1 + +___ + +### WindowCloseButtonHint + +• **WindowCloseButtonHint**: = 134217728 + +___ + +### WindowContextHelpButtonHint + +• **WindowContextHelpButtonHint**: = 65536 + +___ + +### WindowDoesNotAcceptFocus + +• **WindowDoesNotAcceptFocus**: = 2097152 + +___ + +### WindowFullscreenButtonHint + +• **WindowFullscreenButtonHint**: = 2147483648 + +___ + +### WindowMaximizeButtonHint + +• **WindowMaximizeButtonHint**: = 32768 + +___ + +### WindowMinMaxButtonsHint + +• **WindowMinMaxButtonsHint**: = 73728 + +___ + +### WindowMinimizeButtonHint + +• **WindowMinimizeButtonHint**: = 16384 + +___ + +### WindowOverridesSystemGestures + +• **WindowOverridesSystemGestures**: = 1048576 + +___ + +### WindowShadeButtonHint + +• **WindowShadeButtonHint**: = 131072 + +___ + +### WindowStaysOnBottomHint + +• **WindowStaysOnBottomHint**: = 67108864 + +___ + +### WindowStaysOnTopHint + +• **WindowStaysOnTopHint**: = 262144 + +___ + +### WindowSystemMenuHint + +• **WindowSystemMenuHint**: = 8192 + +___ + +### WindowTitleHint + +• **WindowTitleHint**: = 4096 + +___ + +### WindowTransparentForInput + +• **WindowTransparentForInput**: = 524288 + +___ + +### WindowType_Mask + +• **WindowType_Mask**: = 255 + +___ + +### X11BypassWindowManagerHint + +• **X11BypassWindowManagerHint**: = 1024 diff --git a/website/docs/api/generated/enums/writingsystem.md b/website/docs/api/generated/enums/writingsystem.md new file mode 100644 index 000000000..dc468d5c2 --- /dev/null +++ b/website/docs/api/generated/enums/writingsystem.md @@ -0,0 +1,255 @@ +--- +id: "writingsystem" +title: "WritingSystem" +sidebar_label: "WritingSystem" +--- + +## Index + +### Enumeration members + +* [Any](writingsystem.md#any) +* [Arabic](writingsystem.md#arabic) +* [Armenian](writingsystem.md#armenian) +* [Bengali](writingsystem.md#bengali) +* [Cyrillic](writingsystem.md#cyrillic) +* [Devanagari](writingsystem.md#devanagari) +* [Georgian](writingsystem.md#georgian) +* [Greek](writingsystem.md#greek) +* [Gujaratin](writingsystem.md#gujaratin) +* [Gurmukhi](writingsystem.md#gurmukhi) +* [Hebrew](writingsystem.md#hebrew) +* [Japanese](writingsystem.md#japanese) +* [Kannada](writingsystem.md#kannada) +* [Khmer](writingsystem.md#khmer) +* [Korean](writingsystem.md#korean) +* [Lao](writingsystem.md#lao) +* [Latin](writingsystem.md#latin) +* [Malayalam](writingsystem.md#malayalam) +* [Myanmar](writingsystem.md#myanmar) +* [Nko](writingsystem.md#nko) +* [Ogham](writingsystem.md#ogham) +* [Oriya](writingsystem.md#oriya) +* [Other](writingsystem.md#other) +* [Runic](writingsystem.md#runic) +* [SimplifiedChinese](writingsystem.md#simplifiedchinese) +* [Sinhala](writingsystem.md#sinhala) +* [Symbol](writingsystem.md#symbol) +* [Syriac](writingsystem.md#syriac) +* [Tamil](writingsystem.md#tamil) +* [Telugu](writingsystem.md#telugu) +* [Thaana](writingsystem.md#thaana) +* [Thai](writingsystem.md#thai) +* [Tibetan](writingsystem.md#tibetan) +* [TraditionalChinese](writingsystem.md#traditionalchinese) +* [Vietnamese](writingsystem.md#vietnamese) + +## Enumeration members + +### Any + +• **Any**: = 0 + +___ + +### Arabic + +• **Arabic**: = 6 + +___ + +### Armenian + +• **Armenian**: = 4 + +___ + +### Bengali + +• **Bengali**: = 10 + +___ + +### Cyrillic + +• **Cyrillic**: = 3 + +___ + +### Devanagari + +• **Devanagari**: = 9 + +___ + +### Georgian + +• **Georgian**: = 23 + +___ + +### Greek + +• **Greek**: = 2 + +___ + +### Gujaratin + +• **Gujaratin**: = 12 + +___ + +### Gurmukhi + +• **Gurmukhi**: = 11 + +___ + +### Hebrew + +• **Hebrew**: = 5 + +___ + +### Japanese + +• **Japanese**: = 27 + +___ + +### Kannada + +• **Kannada**: = 16 + +___ + +### Khmer + +• **Khmer**: = 24 + +___ + +### Korean + +• **Korean**: = 28 + +___ + +### Lao + +• **Lao**: = 20 + +___ + +### Latin + +• **Latin**: = 1 + +___ + +### Malayalam + +• **Malayalam**: = 17 + +___ + +### Myanmar + +• **Myanmar**: = 22 + +___ + +### Nko + +• **Nko**: = 33 + +___ + +### Ogham + +• **Ogham**: = 31 + +___ + +### Oriya + +• **Oriya**: = 13 + +___ + +### Other + +• **Other**: = Symbol + +___ + +### Runic + +• **Runic**: = 32 + +___ + +### SimplifiedChinese + +• **SimplifiedChinese**: = 25 + +___ + +### Sinhala + +• **Sinhala**: = 18 + +___ + +### Symbol + +• **Symbol**: = 30 + +___ + +### Syriac + +• **Syriac**: = 7 + +___ + +### Tamil + +• **Tamil**: = 14 + +___ + +### Telugu + +• **Telugu**: = 15 + +___ + +### Thaana + +• **Thaana**: = 8 + +___ + +### Thai + +• **Thai**: = 19 + +___ + +### Tibetan + +• **Tibetan**: = 21 + +___ + +### TraditionalChinese + +• **TraditionalChinese**: = 26 + +___ + +### Vietnamese + +• **Vietnamese**: = 29 diff --git a/website/docs/api/generated/globals.md b/website/docs/api/generated/globals.md new file mode 100644 index 000000000..39621fb76 --- /dev/null +++ b/website/docs/api/generated/globals.md @@ -0,0 +1,376 @@ +--- +id: "globals" +title: "@nodegui/nodegui" +sidebar_label: "Globals" +--- + +## Index + +### Enumerations + +* [AcceptMode](enums/acceptmode.md) +* [AlignmentFlag](enums/alignmentflag.md) +* [AnchorPoint](enums/anchorpoint.md) +* [ApplicationAttribute](enums/applicationattribute.md) +* [ApplicationState](enums/applicationstate.md) +* [ArrowType](enums/arrowtype.md) +* [AspectRatioMode](enums/aspectratiomode.md) +* [Axis](enums/axis.md) +* [BGMode](enums/bgmode.md) +* [BrushStyle](enums/brushstyle.md) +* [CacheMode](enums/cachemode.md) +* [CaseSensitivity](enums/casesensitivity.md) +* [CheckState](enums/checkstate.md) +* [ChecksumType](enums/checksumtype.md) +* [ClipOperation](enums/clipoperation.md) +* [ConnectionType](enums/connectiontype.md) +* [ContextMenuPolicy](enums/contextmenupolicy.md) +* [CoordinateSystem](enums/coordinatesystem.md) +* [Corner](enums/corner.md) +* [CursorMoveStyle](enums/cursormovestyle.md) +* [CursorShape](enums/cursorshape.md) +* [DateFormat](enums/dateformat.md) +* [DayOfWeek](enums/dayofweek.md) +* [DialogLabel](enums/dialoglabel.md) +* [Direction](enums/direction.md) +* [DockWidgetArea](enums/dockwidgetarea.md) +* [DropAction](enums/dropaction.md) +* [EchoMode](enums/echomode.md) +* [Edge](enums/edge.md) +* [EnterKeyType](enums/enterkeytype.md) +* [EventPriority](enums/eventpriority.md) +* [FileMode](enums/filemode.md) +* [FillRule](enums/fillrule.md) +* [FindChildOption](enums/findchildoption.md) +* [FocusPolicy](enums/focuspolicy.md) +* [FocusReason](enums/focusreason.md) +* [GestureFlag](enums/gestureflag.md) +* [GestureState](enums/gesturestate.md) +* [GestureType](enums/gesturetype.md) +* [GlobalColor](enums/globalcolor.md) +* [HitTestAccuracy](enums/hittestaccuracy.md) +* [ImageConversionFlag](enums/imageconversionflag.md) +* [ImageReaderError](enums/imagereadererror.md) +* [InputMethodHint](enums/inputmethodhint.md) +* [InputMethodQuery](enums/inputmethodquery.md) +* [InsertPolicy](enums/insertpolicy.md) +* [ItemDataRole](enums/itemdatarole.md) +* [ItemFlag](enums/itemflag.md) +* [ItemSelectionMode](enums/itemselectionmode.md) +* [ItemSelectionOperation](enums/itemselectionoperation.md) +* [Key](enums/key.md) +* [KeyboardModifier](enums/keyboardmodifier.md) +* [LayoutDirection](enums/layoutdirection.md) +* [LineWrapMode](enums/linewrapmode.md) +* [MaskMode](enums/maskmode.md) +* [MatchFlag](enums/matchflag.md) +* [Modifier](enums/modifier.md) +* [MouseButton](enums/mousebutton.md) +* [MouseEventFlag](enums/mouseeventflag.md) +* [MouseEventSource](enums/mouseeventsource.md) +* [MovieState](enums/moviestate.md) +* [NativeGestureType](enums/nativegesturetype.md) +* [NavigationMode](enums/navigationmode.md) +* [Option](enums/option.md) +* [Orientation](enums/orientation.md) +* [ParsingMode](enums/parsingmode.md) +* [PenStyle](enums/penstyle.md) +* [QClipboardMode](enums/qclipboardmode.md) +* [QIconMode](enums/qiconmode.md) +* [QIconState](enums/qiconstate.md) +* [QStylePixelMetric](enums/qstylepixelmetric.md) +* [QSystemTrayIconActivationReason](enums/qsystemtrayiconactivationreason.md) +* [QTextOptionWrapMode](enums/qtextoptionwrapmode.md) +* [RenderHint](enums/renderhint.md) +* [ScreenOrientation](enums/screenorientation.md) +* [ScrollBarPolicy](enums/scrollbarpolicy.md) +* [ScrollHint](enums/scrollhint.md) +* [ScrollPhase](enums/scrollphase.md) +* [ShortcutContext](enums/shortcutcontext.md) +* [SizeAdjustPolicy](enums/sizeadjustpolicy.md) +* [SizeHint](enums/sizehint.md) +* [SizeMode](enums/sizemode.md) +* [SortOrder](enums/sortorder.md) +* [SystemFont](enums/systemfont.md) +* [TabFocusBehavior](enums/tabfocusbehavior.md) +* [TabPosition](enums/tabposition.md) +* [TextElideMode](enums/textelidemode.md) +* [TextFlag](enums/textflag.md) +* [TextFormat](enums/textformat.md) +* [TextInteractionFlag](enums/textinteractionflag.md) +* [TileRule](enums/tilerule.md) +* [TimeSpec](enums/timespec.md) +* [TimerType](enums/timertype.md) +* [ToolBarArea](enums/toolbararea.md) +* [ToolButtonPopupMode](enums/toolbuttonpopupmode.md) +* [ToolButtonStyle](enums/toolbuttonstyle.md) +* [TouchPointState](enums/touchpointstate.md) +* [TransformationMode](enums/transformationmode.md) +* [UIEffect](enums/uieffect.md) +* [ViewMode](enums/viewmode.md) +* [WhiteSpaceMode](enums/whitespacemode.md) +* [WidgetAttribute](enums/widgetattribute.md) +* [WidgetEventTypes](enums/widgeteventtypes.md) +* [WindowFrameSection](enums/windowframesection.md) +* [WindowModality](enums/windowmodality.md) +* [WindowState](enums/windowstate.md) +* [WindowType](enums/windowtype.md) +* [WritingSystem](enums/writingsystem.md) + +### Classes + +* [Component](classes/component.md) +* [EventWidget](classes/eventwidget.md) +* [FlexLayout](classes/flexlayout.md) +* [NodeLayout](classes/nodelayout.md) +* [NodeObject](classes/nodeobject.md) +* [NodeWidget](classes/nodewidget.md) +* [QAbstractButton](classes/qabstractbutton.md) +* [QAbstractScrollArea](classes/qabstractscrollarea.md) +* [QAbstractSlider](classes/qabstractslider.md) +* [QAction](classes/qaction.md) +* [QApplication](classes/qapplication.md) +* [QBoxLayout](classes/qboxlayout.md) +* [QCheckBox](classes/qcheckbox.md) +* [QClipboard](classes/qclipboard.md) +* [QColor](classes/qcolor.md) +* [QComboBox](classes/qcombobox.md) +* [QCursor](classes/qcursor.md) +* [QDial](classes/qdial.md) +* [QFileDialog](classes/qfiledialog.md) +* [QFontDatabase](classes/qfontdatabase.md) +* [QGridLayout](classes/qgridlayout.md) +* [QGroupBox](classes/qgroupbox.md) +* [QIcon](classes/qicon.md) +* [QKeyEvent](classes/qkeyevent.md) +* [QKeySequence](classes/qkeysequence.md) +* [QLabel](classes/qlabel.md) +* [QLineEdit](classes/qlineedit.md) +* [QMainWindow](classes/qmainwindow.md) +* [QMenu](classes/qmenu.md) +* [QMenuBar](classes/qmenubar.md) +* [QMouseEvent](classes/qmouseevent.md) +* [QMovie](classes/qmovie.md) +* [QObject](classes/qobject.md) +* [QPainter](classes/qpainter.md) +* [QPixmap](classes/qpixmap.md) +* [QPlainTextEdit](classes/qplaintextedit.md) +* [QPoint](classes/qpoint.md) +* [QProgressBar](classes/qprogressbar.md) +* [QPushButton](classes/qpushbutton.md) +* [QRadioButton](classes/qradiobutton.md) +* [QRect](classes/qrect.md) +* [QScrollArea](classes/qscrollarea.md) +* [QShortcut](classes/qshortcut.md) +* [QSize](classes/qsize.md) +* [QSpinBox](classes/qspinbox.md) +* [QStackedWidget](classes/qstackedwidget.md) +* [QStyle](classes/qstyle.md) +* [QSystemTrayIcon](classes/qsystemtrayicon.md) +* [QTabWidget](classes/qtabwidget.md) +* [QTableWidget](classes/qtablewidget.md) +* [QTableWidgetItem](classes/qtablewidgetitem.md) +* [QToolButton](classes/qtoolbutton.md) +* [QTreeWidget](classes/qtreewidget.md) +* [QTreeWidgetItem](classes/qtreewidgetitem.md) +* [QUrl](classes/qurl.md) +* [QVariant](classes/qvariant.md) +* [QWidget](classes/qwidget.md) +* [StyleSheet](classes/stylesheet.md) +* [YogaWidget](classes/yogawidget.md) + +### Interfaces + +* [QAbstractButtonSignals](interfaces/qabstractbuttonsignals.md) +* [QAbstractSliderSignals](interfaces/qabstractslidersignals.md) +* [QActionSignals](interfaces/qactionsignals.md) +* [QComboBoxSignals](interfaces/qcomboboxsignals.md) +* [QFileDialogSignals](interfaces/qfiledialogsignals.md) +* [QGroupBoxSignals](interfaces/qgroupboxsignals.md) +* [QLineEditSignals](interfaces/qlineeditsignals.md) +* [QMovieSignals](interfaces/qmoviesignals.md) +* [QObjectSignals](interfaces/qobjectsignals.md) +* [QPlainTextEditSignals](interfaces/qplaintexteditsignals.md) +* [QProgressBarSignals](interfaces/qprogressbarsignals.md) +* [QShortcutSignals](interfaces/qshortcutsignals.md) +* [QSpinBoxSignals](interfaces/qspinboxsignals.md) +* [QStackedWidgetSignals](interfaces/qstackedwidgetsignals.md) +* [QSystemTrayIconSignals](interfaces/qsystemtrayiconsignals.md) +* [QTabWidgetSignals](interfaces/qtabwidgetsignals.md) +* [QTableWidgetSignals](interfaces/qtablewidgetsignals.md) +* [QToolButtonSignals](interfaces/qtoolbuttonsignals.md) +* [QTreeWidgetSignals](interfaces/qtreewidgetsignals.md) +* [QWidgetSignals](interfaces/qwidgetsignals.md) + +### Type aliases + +* [FlexLayoutSignals](globals.md#flexlayoutsignals) +* [FlexNode](globals.md#flexnode) +* [ImageFormats](globals.md#imageformats) +* [NativeElement](globals.md#nativeelement) +* [QAbstractScrollAreaSignals](globals.md#qabstractscrollareasignals) +* [QBoxLayoutSignals](globals.md#qboxlayoutsignals) +* [QCheckBoxSignals](globals.md#qcheckboxsignals) +* [QDialSignals](globals.md#qdialsignals) +* [QGridLayoutSignals](globals.md#qgridlayoutsignals) +* [QLabelSignals](globals.md#qlabelsignals) +* [QLayoutSignals](globals.md#qlayoutsignals) +* [QMainWindowSignals](globals.md#qmainwindowsignals) +* [QMenuBarSignals](globals.md#qmenubarsignals) +* [QMenuSignals](globals.md#qmenusignals) +* [QPushButtonSignals](globals.md#qpushbuttonsignals) +* [QRadioButtonSignals](globals.md#qradiobuttonsignals) +* [QScrollAreaSignals](globals.md#qscrollareasignals) +* [QVariantType](globals.md#qvarianttype) + +### Functions + +* [checkIfNativeElement](globals.md#checkifnativeelement) +* [prepareInlineStyleSheet](globals.md#prepareinlinestylesheet) + +## Type aliases + +### FlexLayoutSignals + +Ƭ **FlexLayoutSignals**: *[QLayoutSignals](globals.md#qlayoutsignals)* + +___ + +### FlexNode + +Ƭ **FlexNode**: *object* + +#### Type declaration: + +___ + +### ImageFormats + +Ƭ **ImageFormats**: *"BMP" | "GIF" | "JPG" | "JPEG" | "PNG" | "PBM" | "PGM" | "PPM" | "XBM" | "XPM" | "SVG"* + +___ + +### NativeElement + +Ƭ **NativeElement**: *object* + +#### Type declaration: + +* \[ **key**: *string*\]: any + +___ + +### QAbstractScrollAreaSignals + +Ƭ **QAbstractScrollAreaSignals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)* + +___ + +### QBoxLayoutSignals + +Ƭ **QBoxLayoutSignals**: *[QLayoutSignals](globals.md#qlayoutsignals)* + +___ + +### QCheckBoxSignals + +Ƭ **QCheckBoxSignals**: *[QAbstractButtonSignals](interfaces/qabstractbuttonsignals.md)* + +___ + +### QDialSignals + +Ƭ **QDialSignals**: *[QAbstractSliderSignals](interfaces/qabstractslidersignals.md)* + +___ + +### QGridLayoutSignals + +Ƭ **QGridLayoutSignals**: *[QLayoutSignals](globals.md#qlayoutsignals)* + +___ + +### QLabelSignals + +Ƭ **QLabelSignals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)* + +___ + +### QLayoutSignals + +Ƭ **QLayoutSignals**: *[QObjectSignals](interfaces/qobjectsignals.md)* + +___ + +### QMainWindowSignals + +Ƭ **QMainWindowSignals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)* + +___ + +### QMenuBarSignals + +Ƭ **QMenuBarSignals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)* + +___ + +### QMenuSignals + +Ƭ **QMenuSignals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)* + +___ + +### QPushButtonSignals + +Ƭ **QPushButtonSignals**: *[QAbstractButtonSignals](interfaces/qabstractbuttonsignals.md)* + +___ + +### QRadioButtonSignals + +Ƭ **QRadioButtonSignals**: *[QAbstractButtonSignals](interfaces/qabstractbuttonsignals.md)* + +___ + +### QScrollAreaSignals + +Ƭ **QScrollAreaSignals**: *[QAbstractScrollAreaSignals](globals.md#qabstractscrollareasignals)* + +___ + +### QVariantType + +Ƭ **QVariantType**: *[NativeElement](globals.md#nativeelement) | string | number | boolean* + +## Functions + +### checkIfNativeElement + +▸ **checkIfNativeElement**(`arg`: any): *boolean* + +**Parameters:** + +Name | Type | +------ | ------ | +`arg` | any | + +**Returns:** *boolean* + +___ + +### prepareInlineStyleSheet + +▸ **prepareInlineStyleSheet**<**Signals**>(`widget`: [NodeWidget](classes/nodewidget.md)‹Signals›, `rawStyle`: string): *string* + +**Type parameters:** + +▪ **Signals**: *[QWidgetSignals](interfaces/qwidgetsignals.md)* + +**Parameters:** + +Name | Type | +------ | ------ | +`widget` | [NodeWidget](classes/nodewidget.md)‹Signals› | +`rawStyle` | string | + +**Returns:** *string* diff --git a/website/docs/api/generated/index.md b/website/docs/api/generated/index.md new file mode 100644 index 000000000..5567467ef --- /dev/null +++ b/website/docs/api/generated/index.md @@ -0,0 +1,196 @@ +--- +id: "index" +title: "@nodegui/nodegui" +sidebar_label: "README" +--- + +# NodeGui + +[![Join the NodeGUI community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/nodegui) +[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors) +[![JS Party #96](https://img.shields.io/badge/JS%20Party-%2396-FFCD00.svg)](https://changelog.com/jsparty/96) + +[![Build and Test status](https://github.com/nodegui/nodegui/workflows/.github/workflows/test.yml/badge.svg)](https://github.com/nodegui/nodegui/actions) + +Build **performant**, **native** and **cross-platform** desktop applications with **Node.js** and **CSS like styling**.🚀 + +NodeGUI is powered by **Qt5** 💚 which makes it CPU and memory efficient as compared to other chromium based solutions like electron. + +If you are looking for **React** based version, check out: **[React NodeGUI](https://github.com/nodegui/react-nodegui)**. + +Visit: https://nodegui.github.io/nodegui for docs. + +logo + +> This project is in active development. It should be okay for smaller projects but anything complex - electron is the way to go for now. 🚧 + +## How does it look? + +
+demo_linux +demo_win +demo_mac +
+ +
kitchendemo_macdemo_win +
+ +**More screenshots?** + +### More Examples: + +https://github.com/nodegui/examples + +--- + +## Features + +- 🧬 Cross platform. Should work on major Linux flavours, Windows and MacOS. +- 📉 Low CPU and memory footprint. Current CPU stays at 0% on idle and memory usage is under 20mb for a hello world program. +- 💅 Styling with CSS (includes actual cascading). Also has full support for Flexbox layout (thanks to Yoga). +- ✅ Complete Nodejs api support (Currently runs on Node v12.x - and is easily upgradable). Hence has access to all nodejs compatible npm modules. +- 🎪 Native widget event listener support. Supports all events available from Qt / NodeJs. +- 💸 Can be used for Commercial applications. +- 🕵️‍♂️ Good Devtools support. +- 📚 Good documentation and website. +- 🧙‍♂️ Good documentation for contributors. +- 🦹🏻‍♀️ Good support for dark mode (Thanks to QT). +- 🏅First class Typescript support. (Works on regular JS projects too 😉). + +## Getting Started + +- Check out [nodegui-starter](https://github.com/nodegui/nodegui-starter) to get up and running with your own React NodeGUI app! +- Read through the [docs](https://nodegui.github.io/nodegui). +- Checkout the examples: https://github.com/nodegui/examples . + +## Installation + +To install latest stable release: + +``` +npm install @nodegui/nodegui +``` + +To install the latest version available on master branch: + +``` +npm install https://github.com/nodegui/nodegui/releases/download/latest-master/nodegui-master.tgz +``` + +**Community guides** + +- https://blog.logrocket.com/electron-alternatives-exploring-nodegui-and-react-nodegui/ - Electron alternatives: Exploring NodeGUI and React NodeGUI by [Siegfried Grimbeek](https://blog.logrocket.com/author/siegfriedgrimbeek/). +- https://hibbard.eu/node-gui/ - Excellent guide from [James Hibbard](https://github.com/jameshibbard). + +**Talks/Podcasts** + +- [NodeGui and React NodeGui at KarmaJS Nov 2019 meetup: https://www.youtube.com/watch?v=8jH5gaEEDv4](https://www.youtube.com/watch?v=8jH5gaEEDv4) + +-

JS Party 96: Performant Node desktop apps with NodeGUI – Listen on Changelog.com

+ +## Docs for contributing + +``` +It is easier than you think, try it +``` + +Looking to contribute? If you wish to implement a new widget/add more features and need help understanding the codebase, you can start here: [Contributing developer docs](https://github.com/nodegui/nodegui/tree/master/website/docs/development). + +Please read https://github.com/nodegui/.github/blob/master/CONTRIBUTING.md + +## Building + +`npm run build` + +Optionally set `QT_INSTALL_DIR='/path/to/qt'` environment variable to build using your own version of Qt. + +## Funding + +NodeGUI is an open source project and requires your support. If you like this project, please consider supporting my work by clicking on the Sponsor button on this Github repository or via Ko-Fi. +Alternatively, Issues on NodeGui can be funded by anyone via Issuehunt and the amount will be distributed to respective contributors. + +

+Buy Me a Coffee at ko-fi.com    issuehunt +

+ +## Special Thanks + +- [Logo: Thanks to Vishwas Shetty from the Noun Project.](https://github.com/nodegui/nodegui/blob/master/extras/legal/logo/thanks.md) + +## Code of Conduct + +https://github.com/nodegui/.github/blob/master/CODE_OF_CONDUCT.md + +## License + +MIT + +## Backers 🚀 + +Thanks goes to these wonderful people. + + + + + + + + + +
Yuriy Yazlovytskyy
Yuriy Yazlovytskyy		John Susek
John Susek		Marc Dijoux
Marc Dijoux		Stephen Belanger
Stephen Belanger
+ +## Maintainers ✨ + +People maintaining this project. + + + + + + + +
Atul R
Atul R		Dimitar
Dimitar Nestorov
+ +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Lucas Ramage
📖
Denis Sikuler
📖
Nahuel José
💬
Kakul Gupta
💻
Rahul Gaba
💻
Paweł Borecki
💻
Marcus S. Abildskov
⚠️

Átila Camurça Alves
📖
James Hibbard
💻
Soonwoo Hong
💻
Roy Sommer
💻
Paulo Coghi
🤔
Balthild Ires
💻
Dimitar Nestorov
💻

Mikko Sairio
💻
Pepijn
💻
slidinghotdog
💻
Bundyo (Kamen Bundev)
💻
feng8848
💻
Maksim Karelov
💻
mspencer92
💻
+ + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/website/docs/api/generated/interfaces/qabstractbuttonsignals.md b/website/docs/api/generated/interfaces/qabstractbuttonsignals.md new file mode 100644 index 000000000..f9d9be1d2 --- /dev/null +++ b/website/docs/api/generated/interfaces/qabstractbuttonsignals.md @@ -0,0 +1,150 @@ +--- +id: "qabstractbuttonsignals" +title: "QAbstractButtonSignals" +sidebar_label: "QAbstractButtonSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QAbstractButtonSignals** + + ↳ [QToolButtonSignals](qtoolbuttonsignals.md) + +## Index + +### Properties + +* [clicked](qabstractbuttonsignals.md#clicked) +* [customContextMenuRequested](qabstractbuttonsignals.md#customcontextmenurequested) +* [objectNameChanged](qabstractbuttonsignals.md#objectnamechanged) +* [pressed](qabstractbuttonsignals.md#pressed) +* [released](qabstractbuttonsignals.md#released) +* [toggled](qabstractbuttonsignals.md#toggled) +* [windowIconChanged](qabstractbuttonsignals.md#windowiconchanged) +* [windowTitleChanged](qabstractbuttonsignals.md#windowtitlechanged) + +## Properties + +### clicked + +• **clicked**: *function* + +#### Type declaration: + +▸ (`checked`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`checked` | boolean | + +___ + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### objectNameChanged + +• **objectNameChanged**: *function* + +*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +___ + +### pressed + +• **pressed**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### released + +• **released**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### toggled + +• **toggled**: *function* + +#### Type declaration: + +▸ (`checked`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`checked` | boolean | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qabstractslidersignals.md b/website/docs/api/generated/interfaces/qabstractslidersignals.md new file mode 100644 index 000000000..b7329786f --- /dev/null +++ b/website/docs/api/generated/interfaces/qabstractslidersignals.md @@ -0,0 +1,183 @@ +--- +id: "qabstractslidersignals" +title: "QAbstractSliderSignals" +sidebar_label: "QAbstractSliderSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QAbstractSliderSignals** + +## Index + +### Properties + +* [actionTriggered](qabstractslidersignals.md#actiontriggered) +* [customContextMenuRequested](qabstractslidersignals.md#customcontextmenurequested) +* [objectNameChanged](qabstractslidersignals.md#objectnamechanged) +* [rangeChanged](qabstractslidersignals.md#rangechanged) +* [sliderMoved](qabstractslidersignals.md#slidermoved) +* [sliderPressed](qabstractslidersignals.md#sliderpressed) +* [sliderReleased](qabstractslidersignals.md#sliderreleased) +* [valueChanged](qabstractslidersignals.md#valuechanged) +* [windowIconChanged](qabstractslidersignals.md#windowiconchanged) +* [windowTitleChanged](qabstractslidersignals.md#windowtitlechanged) + +## Properties + +### actionTriggered + +• **actionTriggered**: *function* + +#### Type declaration: + +▸ (`action`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`action` | number | + +___ + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### objectNameChanged + +• **objectNameChanged**: *function* + +*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +___ + +### rangeChanged + +• **rangeChanged**: *function* + +#### Type declaration: + +▸ (`min`: number, `max`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`min` | number | +`max` | number | + +___ + +### sliderMoved + +• **sliderMoved**: *function* + +#### Type declaration: + +▸ (`value`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | number | + +___ + +### sliderPressed + +• **sliderPressed**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### sliderReleased + +• **sliderReleased**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qactionsignals.md b/website/docs/api/generated/interfaces/qactionsignals.md new file mode 100644 index 000000000..63ed93fe3 --- /dev/null +++ b/website/docs/api/generated/interfaces/qactionsignals.md @@ -0,0 +1,91 @@ +--- +id: "qactionsignals" +title: "QActionSignals" +sidebar_label: "QActionSignals" +--- + +## Hierarchy + +* [QObjectSignals](qobjectsignals.md) + + ↳ **QActionSignals** + +## Index + +### Properties + +* [changed](qactionsignals.md#changed) +* [hovered](qactionsignals.md#hovered) +* [objectNameChanged](qactionsignals.md#objectnamechanged) +* [toggled](qactionsignals.md#toggled) +* [triggered](qactionsignals.md#triggered) + +## Properties + +### changed + +• **changed**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### hovered + +• **hovered**: *function* + +#### 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 | + +___ + +### toggled + +• **toggled**: *function* + +#### Type declaration: + +▸ (`checked`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`checked` | boolean | + +___ + +### triggered + +• **triggered**: *function* + +#### Type declaration: + +▸ (`checked`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`checked` | boolean | diff --git a/website/docs/api/generated/interfaces/qcomboboxsignals.md b/website/docs/api/generated/interfaces/qcomboboxsignals.md new file mode 100644 index 000000000..aab79e726 --- /dev/null +++ b/website/docs/api/generated/interfaces/qcomboboxsignals.md @@ -0,0 +1,143 @@ +--- +id: "qcomboboxsignals" +title: "QComboBoxSignals" +sidebar_label: "QComboBoxSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QComboBoxSignals** + +## Index + +### Properties + +* [currentIndexChanged](qcomboboxsignals.md#currentindexchanged) +* [currentTextChanged](qcomboboxsignals.md#currenttextchanged) +* [customContextMenuRequested](qcomboboxsignals.md#customcontextmenurequested) +* [editTextChanged](qcomboboxsignals.md#edittextchanged) +* [objectNameChanged](qcomboboxsignals.md#objectnamechanged) +* [windowIconChanged](qcomboboxsignals.md#windowiconchanged) +* [windowTitleChanged](qcomboboxsignals.md#windowtitlechanged) + +## Properties + +### currentIndexChanged + +• **currentIndexChanged**: *function* + +#### Type declaration: + +▸ (`index`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`index` | number | + +___ + +### currentTextChanged + +• **currentTextChanged**: *function* + +#### Type declaration: + +▸ (`text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +___ + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### editTextChanged + +• **editTextChanged**: *function* + +#### Type declaration: + +▸ (`text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +___ + +### objectNameChanged + +• **objectNameChanged**: *function* + +*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qfiledialogsignals.md b/website/docs/api/generated/interfaces/qfiledialogsignals.md new file mode 100644 index 000000000..c753434ba --- /dev/null +++ b/website/docs/api/generated/interfaces/qfiledialogsignals.md @@ -0,0 +1,245 @@ +--- +id: "qfiledialogsignals" +title: "QFileDialogSignals" +sidebar_label: "QFileDialogSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QFileDialogSignals** + +## Index + +### Properties + +* [currentChanged](qfiledialogsignals.md#currentchanged) +* [currentUrlChanged](qfiledialogsignals.md#currenturlchanged) +* [customContextMenuRequested](qfiledialogsignals.md#customcontextmenurequested) +* [directoryEntered](qfiledialogsignals.md#directoryentered) +* [directoryUrlEntered](qfiledialogsignals.md#directoryurlentered) +* [fileSelected](qfiledialogsignals.md#fileselected) +* [filesSelected](qfiledialogsignals.md#filesselected) +* [filterSelected](qfiledialogsignals.md#filterselected) +* [objectNameChanged](qfiledialogsignals.md#objectnamechanged) +* [urlSelected](qfiledialogsignals.md#urlselected) +* [urlsSelected](qfiledialogsignals.md#urlsselected) +* [windowIconChanged](qfiledialogsignals.md#windowiconchanged) +* [windowTitleChanged](qfiledialogsignals.md#windowtitlechanged) + +## Properties + +### currentChanged + +• **currentChanged**: *function* + +#### Type declaration: + +▸ (`path`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`path` | string | + +___ + +### currentUrlChanged + +• **currentUrlChanged**: *function* + +#### Type declaration: + +▸ (`url`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`url` | string | + +___ + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### directoryEntered + +• **directoryEntered**: *function* + +#### Type declaration: + +▸ (`directory`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`directory` | string | + +___ + +### directoryUrlEntered + +• **directoryUrlEntered**: *function* + +#### Type declaration: + +▸ (`url`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`url` | string | + +___ + +### fileSelected + +• **fileSelected**: *function* + +#### Type declaration: + +▸ (`file`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`file` | string | + +___ + +### filesSelected + +• **filesSelected**: *function* + +#### Type declaration: + +▸ (`selected`: string[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`selected` | string[] | + +___ + +### filterSelected + +• **filterSelected**: *function* + +#### Type declaration: + +▸ (`filter`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`filter` | string | + +___ + +### objectNameChanged + +• **objectNameChanged**: *function* + +*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +___ + +### urlSelected + +• **urlSelected**: *function* + +#### Type declaration: + +▸ (`url`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`url` | string | + +___ + +### urlsSelected + +• **urlsSelected**: *function* + +#### Type declaration: + +▸ (`urls`: string[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`urls` | string[] | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qgroupboxsignals.md b/website/docs/api/generated/interfaces/qgroupboxsignals.md new file mode 100644 index 000000000..ac5ed0782 --- /dev/null +++ b/website/docs/api/generated/interfaces/qgroupboxsignals.md @@ -0,0 +1,126 @@ +--- +id: "qgroupboxsignals" +title: "QGroupBoxSignals" +sidebar_label: "QGroupBoxSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QGroupBoxSignals** + +## Index + +### Properties + +* [clicked](qgroupboxsignals.md#clicked) +* [customContextMenuRequested](qgroupboxsignals.md#customcontextmenurequested) +* [objectNameChanged](qgroupboxsignals.md#objectnamechanged) +* [toggled](qgroupboxsignals.md#toggled) +* [windowIconChanged](qgroupboxsignals.md#windowiconchanged) +* [windowTitleChanged](qgroupboxsignals.md#windowtitlechanged) + +## Properties + +### clicked + +• **clicked**: *function* + +#### Type declaration: + +▸ (`checked`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`checked` | boolean | + +___ + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### objectNameChanged + +• **objectNameChanged**: *function* + +*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +___ + +### toggled + +• **toggled**: *function* + +#### Type declaration: + +▸ (`on`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`on` | boolean | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qlineeditsignals.md b/website/docs/api/generated/interfaces/qlineeditsignals.md new file mode 100644 index 000000000..cf52a1e6c --- /dev/null +++ b/website/docs/api/generated/interfaces/qlineeditsignals.md @@ -0,0 +1,188 @@ +--- +id: "qlineeditsignals" +title: "QLineEditSignals" +sidebar_label: "QLineEditSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QLineEditSignals** + +## Index + +### Properties + +* [cursorPositionChanged](qlineeditsignals.md#cursorpositionchanged) +* [customContextMenuRequested](qlineeditsignals.md#customcontextmenurequested) +* [editingFinished](qlineeditsignals.md#editingfinished) +* [inputRejected](qlineeditsignals.md#inputrejected) +* [objectNameChanged](qlineeditsignals.md#objectnamechanged) +* [returnPressed](qlineeditsignals.md#returnpressed) +* [selectionChanged](qlineeditsignals.md#selectionchanged) +* [textChanged](qlineeditsignals.md#textchanged) +* [textEdited](qlineeditsignals.md#textedited) +* [windowIconChanged](qlineeditsignals.md#windowiconchanged) +* [windowTitleChanged](qlineeditsignals.md#windowtitlechanged) + +## Properties + +### cursorPositionChanged + +• **cursorPositionChanged**: *function* + +#### Type declaration: + +▸ (`oldPos`: number, `newPos`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`oldPos` | number | +`newPos` | number | + +___ + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### editingFinished + +• **editingFinished**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### inputRejected + +• **inputRejected**: *function* + +#### 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 | + +___ + +### returnPressed + +• **returnPressed**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### selectionChanged + +• **selectionChanged**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### textChanged + +• **textChanged**: *function* + +#### Type declaration: + +▸ (`text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +___ + +### textEdited + +• **textEdited**: *function* + +#### Type declaration: + +▸ (`text`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`text` | string | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qmoviesignals.md b/website/docs/api/generated/interfaces/qmoviesignals.md new file mode 100644 index 000000000..94e38d62d --- /dev/null +++ b/website/docs/api/generated/interfaces/qmoviesignals.md @@ -0,0 +1,142 @@ +--- +id: "qmoviesignals" +title: "QMovieSignals" +sidebar_label: "QMovieSignals" +--- + +## Hierarchy + +* [QObjectSignals](qobjectsignals.md) + + ↳ **QMovieSignals** + +## Index + +### Properties + +* [error](qmoviesignals.md#error) +* [finished](qmoviesignals.md#finished) +* [frameChanged](qmoviesignals.md#framechanged) +* [objectNameChanged](qmoviesignals.md#objectnamechanged) +* [resized](qmoviesignals.md#resized) +* [started](qmoviesignals.md#started) +* [stateChanged](qmoviesignals.md#statechanged) +* [updated](qmoviesignals.md#updated) + +## Properties + +### error + +• **error**: *function* + +#### Type declaration: + +▸ (`error`: [ImageReaderError](../enums/imagereadererror.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`error` | [ImageReaderError](../enums/imagereadererror.md) | + +___ + +### finished + +• **finished**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### frameChanged + +• **frameChanged**: *function* + +#### Type declaration: + +▸ (`frameNumber?`: undefined | number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`frameNumber?` | undefined | number | + +___ + +### objectNameChanged + +• **objectNameChanged**: *function* + +*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +___ + +### resized + +• **resized**: *function* + +#### Type declaration: + +▸ (`qSizeNative?`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`qSizeNative?` | [NativeElement](../globals.md#nativeelement) | + +___ + +### started + +• **started**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### stateChanged + +• **stateChanged**: *function* + +#### Type declaration: + +▸ (`state`: [MovieState](../enums/moviestate.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`state` | [MovieState](../enums/moviestate.md) | + +___ + +### updated + +• **updated**: *function* + +#### Type declaration: + +▸ (`qRectNative`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`qRectNative` | [NativeElement](../globals.md#nativeelement) | diff --git a/website/docs/api/generated/interfaces/qobjectsignals.md b/website/docs/api/generated/interfaces/qobjectsignals.md new file mode 100644 index 000000000..0e4ddf600 --- /dev/null +++ b/website/docs/api/generated/interfaces/qobjectsignals.md @@ -0,0 +1,41 @@ +--- +id: "qobjectsignals" +title: "QObjectSignals" +sidebar_label: "QObjectSignals" +--- + +## Hierarchy + +* **QObjectSignals** + + ↳ [QMovieSignals](qmoviesignals.md) + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ [QActionSignals](qactionsignals.md) + + ↳ [QSystemTrayIconSignals](qsystemtrayiconsignals.md) + + ↳ [QShortcutSignals](qshortcutsignals.md) + +## Index + +### Properties + +* [objectNameChanged](qobjectsignals.md#objectnamechanged) + +## Properties + +### objectNameChanged + +• **objectNameChanged**: *function* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | diff --git a/website/docs/api/generated/interfaces/qplaintexteditsignals.md b/website/docs/api/generated/interfaces/qplaintexteditsignals.md new file mode 100644 index 000000000..904cc6c42 --- /dev/null +++ b/website/docs/api/generated/interfaces/qplaintexteditsignals.md @@ -0,0 +1,210 @@ +--- +id: "qplaintexteditsignals" +title: "QPlainTextEditSignals" +sidebar_label: "QPlainTextEditSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QPlainTextEditSignals** + +## Index + +### Properties + +* [blockCountChanged](qplaintexteditsignals.md#blockcountchanged) +* [copyAvailable](qplaintexteditsignals.md#copyavailable) +* [cursorPositionChanged](qplaintexteditsignals.md#cursorpositionchanged) +* [customContextMenuRequested](qplaintexteditsignals.md#customcontextmenurequested) +* [modificationChanged](qplaintexteditsignals.md#modificationchanged) +* [objectNameChanged](qplaintexteditsignals.md#objectnamechanged) +* [redoAvailable](qplaintexteditsignals.md#redoavailable) +* [selectionChanged](qplaintexteditsignals.md#selectionchanged) +* [textChanged](qplaintexteditsignals.md#textchanged) +* [undoAvailable](qplaintexteditsignals.md#undoavailable) +* [windowIconChanged](qplaintexteditsignals.md#windowiconchanged) +* [windowTitleChanged](qplaintexteditsignals.md#windowtitlechanged) + +## Properties + +### blockCountChanged + +• **blockCountChanged**: *function* + +#### Type declaration: + +▸ (`blockCount`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`blockCount` | number | + +___ + +### copyAvailable + +• **copyAvailable**: *function* + +#### Type declaration: + +▸ (`yes`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`yes` | boolean | + +___ + +### cursorPositionChanged + +• **cursorPositionChanged**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### modificationChanged + +• **modificationChanged**: *function* + +#### Type declaration: + +▸ (`changed`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`changed` | boolean | + +___ + +### objectNameChanged + +• **objectNameChanged**: *function* + +*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +___ + +### redoAvailable + +• **redoAvailable**: *function* + +#### Type declaration: + +▸ (`available`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`available` | boolean | + +___ + +### selectionChanged + +• **selectionChanged**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### textChanged + +• **textChanged**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### undoAvailable + +• **undoAvailable**: *function* + +#### Type declaration: + +▸ (`available`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`available` | boolean | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qprogressbarsignals.md b/website/docs/api/generated/interfaces/qprogressbarsignals.md new file mode 100644 index 000000000..022f3c98a --- /dev/null +++ b/website/docs/api/generated/interfaces/qprogressbarsignals.md @@ -0,0 +1,109 @@ +--- +id: "qprogressbarsignals" +title: "QProgressBarSignals" +sidebar_label: "QProgressBarSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QProgressBarSignals** + +## Index + +### Properties + +* [customContextMenuRequested](qprogressbarsignals.md#customcontextmenurequested) +* [objectNameChanged](qprogressbarsignals.md#objectnamechanged) +* [valueChanged](qprogressbarsignals.md#valuechanged) +* [windowIconChanged](qprogressbarsignals.md#windowiconchanged) +* [windowTitleChanged](qprogressbarsignals.md#windowtitlechanged) + +## Properties + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qshortcutsignals.md b/website/docs/api/generated/interfaces/qshortcutsignals.md new file mode 100644 index 000000000..4c3a94136 --- /dev/null +++ b/website/docs/api/generated/interfaces/qshortcutsignals.md @@ -0,0 +1,57 @@ +--- +id: "qshortcutsignals" +title: "QShortcutSignals" +sidebar_label: "QShortcutSignals" +--- + +## Hierarchy + +* [QObjectSignals](qobjectsignals.md) + + ↳ **QShortcutSignals** + +## Index + +### Properties + +* [activated](qshortcutsignals.md#activated) +* [activatedAmbiguously](qshortcutsignals.md#activatedambiguously) +* [objectNameChanged](qshortcutsignals.md#objectnamechanged) + +## Properties + +### activated + +• **activated**: *function* + +#### Type declaration: + +▸ (): *void* + +___ + +### activatedAmbiguously + +• **activatedAmbiguously**: *function* + +#### 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 | diff --git a/website/docs/api/generated/interfaces/qspinboxsignals.md b/website/docs/api/generated/interfaces/qspinboxsignals.md new file mode 100644 index 000000000..ed1b403f5 --- /dev/null +++ b/website/docs/api/generated/interfaces/qspinboxsignals.md @@ -0,0 +1,109 @@ +--- +id: "qspinboxsignals" +title: "QSpinBoxSignals" +sidebar_label: "QSpinBoxSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QSpinBoxSignals** + +## Index + +### Properties + +* [customContextMenuRequested](qspinboxsignals.md#customcontextmenurequested) +* [objectNameChanged](qspinboxsignals.md#objectnamechanged) +* [valueChanged](qspinboxsignals.md#valuechanged) +* [windowIconChanged](qspinboxsignals.md#windowiconchanged) +* [windowTitleChanged](qspinboxsignals.md#windowtitlechanged) + +## Properties + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qstackedwidgetsignals.md b/website/docs/api/generated/interfaces/qstackedwidgetsignals.md new file mode 100644 index 000000000..ca992df1d --- /dev/null +++ b/website/docs/api/generated/interfaces/qstackedwidgetsignals.md @@ -0,0 +1,109 @@ +--- +id: "qstackedwidgetsignals" +title: "QStackedWidgetSignals" +sidebar_label: "QStackedWidgetSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QStackedWidgetSignals** + +## Index + +### Properties + +* [currentChanged](qstackedwidgetsignals.md#currentchanged) +* [customContextMenuRequested](qstackedwidgetsignals.md#customcontextmenurequested) +* [objectNameChanged](qstackedwidgetsignals.md#objectnamechanged) +* [windowIconChanged](qstackedwidgetsignals.md#windowiconchanged) +* [windowTitleChanged](qstackedwidgetsignals.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:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### objectNameChanged + +• **objectNameChanged**: *function* + +*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qsystemtrayiconsignals.md b/website/docs/api/generated/interfaces/qsystemtrayiconsignals.md new file mode 100644 index 000000000..9c9869a99 --- /dev/null +++ b/website/docs/api/generated/interfaces/qsystemtrayiconsignals.md @@ -0,0 +1,63 @@ +--- +id: "qsystemtrayiconsignals" +title: "QSystemTrayIconSignals" +sidebar_label: "QSystemTrayIconSignals" +--- + +## Hierarchy + +* [QObjectSignals](qobjectsignals.md) + + ↳ **QSystemTrayIconSignals** + +## Index + +### Properties + +* [activated](qsystemtrayiconsignals.md#activated) +* [messageClicked](qsystemtrayiconsignals.md#messageclicked) +* [objectNameChanged](qsystemtrayiconsignals.md#objectnamechanged) + +## Properties + +### activated + +• **activated**: *function* + +#### Type declaration: + +▸ (`reason`: [QSystemTrayIconActivationReason](../enums/qsystemtrayiconactivationreason.md)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`reason` | [QSystemTrayIconActivationReason](../enums/qsystemtrayiconactivationreason.md) | + +___ + +### messageClicked + +• **messageClicked**: *function* + +#### 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 | diff --git a/website/docs/api/generated/interfaces/qtablewidgetsignals.md b/website/docs/api/generated/interfaces/qtablewidgetsignals.md new file mode 100644 index 000000000..dd223c391 --- /dev/null +++ b/website/docs/api/generated/interfaces/qtablewidgetsignals.md @@ -0,0 +1,220 @@ +--- +id: "qtablewidgetsignals" +title: "QTableWidgetSignals" +sidebar_label: "QTableWidgetSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QTableWidgetSignals** + +## Index + +### Properties + +* [cellActivated](qtablewidgetsignals.md#cellactivated) +* [cellChanged](qtablewidgetsignals.md#cellchanged) +* [cellClicked](qtablewidgetsignals.md#cellclicked) +* [cellDoubleClicked](qtablewidgetsignals.md#celldoubleclicked) +* [cellEntered](qtablewidgetsignals.md#cellentered) +* [cellPressed](qtablewidgetsignals.md#cellpressed) +* [currentCellChanged](qtablewidgetsignals.md#currentcellchanged) +* [customContextMenuRequested](qtablewidgetsignals.md#customcontextmenurequested) +* [objectNameChanged](qtablewidgetsignals.md#objectnamechanged) +* [windowIconChanged](qtablewidgetsignals.md#windowiconchanged) +* [windowTitleChanged](qtablewidgetsignals.md#windowtitlechanged) + +## Properties + +### cellActivated + +• **cellActivated**: *function* + +#### Type declaration: + +▸ (`row`: number, `col`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | +`col` | number | + +___ + +### cellChanged + +• **cellChanged**: *function* + +#### Type declaration: + +▸ (`row`: number, `col`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | +`col` | number | + +___ + +### cellClicked + +• **cellClicked**: *function* + +#### Type declaration: + +▸ (`row`: number, `col`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | +`col` | number | + +___ + +### cellDoubleClicked + +• **cellDoubleClicked**: *function* + +#### Type declaration: + +▸ (`row`: number, `col`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | +`col` | number | + +___ + +### cellEntered + +• **cellEntered**: *function* + +#### Type declaration: + +▸ (`row`: number, `col`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | +`col` | number | + +___ + +### cellPressed + +• **cellPressed**: *function* + +#### Type declaration: + +▸ (`row`: number, `col`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`row` | number | +`col` | number | + +___ + +### currentCellChanged + +• **currentCellChanged**: *function* + +#### Type declaration: + +▸ (`currentRow`: number, `currentColumn`: number, `previousRow`: number, `previousColumn`: number): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`currentRow` | number | +`currentColumn` | number | +`previousRow` | number | +`previousColumn` | number | + +___ + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### objectNameChanged + +• **objectNameChanged**: *function* + +*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qtabwidgetsignals.md b/website/docs/api/generated/interfaces/qtabwidgetsignals.md new file mode 100644 index 000000000..192d5019c --- /dev/null +++ b/website/docs/api/generated/interfaces/qtabwidgetsignals.md @@ -0,0 +1,160 @@ +--- +id: "qtabwidgetsignals" +title: "QTabWidgetSignals" +sidebar_label: "QTabWidgetSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QTabWidgetSignals** + +## Index + +### Properties + +* [currentChanged](qtabwidgetsignals.md#currentchanged) +* [customContextMenuRequested](qtabwidgetsignals.md#customcontextmenurequested) +* [objectNameChanged](qtabwidgetsignals.md#objectnamechanged) +* [tabBarClicked](qtabwidgetsignals.md#tabbarclicked) +* [tabBarDoubleClicked](qtabwidgetsignals.md#tabbardoubleclicked) +* [tabCloseRequested](qtabwidgetsignals.md#tabcloserequested) +* [windowIconChanged](qtabwidgetsignals.md#windowiconchanged) +* [windowTitleChanged](qtabwidgetsignals.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:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### 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 | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qtoolbuttonsignals.md b/website/docs/api/generated/interfaces/qtoolbuttonsignals.md new file mode 100644 index 000000000..42354ea5f --- /dev/null +++ b/website/docs/api/generated/interfaces/qtoolbuttonsignals.md @@ -0,0 +1,173 @@ +--- +id: "qtoolbuttonsignals" +title: "QToolButtonSignals" +sidebar_label: "QToolButtonSignals" +--- + +## Hierarchy + + ↳ [QAbstractButtonSignals](qabstractbuttonsignals.md) + + ↳ **QToolButtonSignals** + +## Index + +### Properties + +* [clicked](qtoolbuttonsignals.md#clicked) +* [customContextMenuRequested](qtoolbuttonsignals.md#customcontextmenurequested) +* [objectNameChanged](qtoolbuttonsignals.md#objectnamechanged) +* [pressed](qtoolbuttonsignals.md#pressed) +* [released](qtoolbuttonsignals.md#released) +* [toggled](qtoolbuttonsignals.md#toggled) +* [triggered](qtoolbuttonsignals.md#triggered) +* [windowIconChanged](qtoolbuttonsignals.md#windowiconchanged) +* [windowTitleChanged](qtoolbuttonsignals.md#windowtitlechanged) + +## Properties + +### clicked + +• **clicked**: *function* + +*Inherited from [QAbstractButtonSignals](qabstractbuttonsignals.md).[clicked](qabstractbuttonsignals.md#clicked)* + +#### Type declaration: + +▸ (`checked`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`checked` | boolean | + +___ + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### objectNameChanged + +• **objectNameChanged**: *function* + +*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +___ + +### pressed + +• **pressed**: *function* + +*Inherited from [QAbstractButtonSignals](qabstractbuttonsignals.md).[pressed](qabstractbuttonsignals.md#pressed)* + +#### Type declaration: + +▸ (): *void* + +___ + +### released + +• **released**: *function* + +*Inherited from [QAbstractButtonSignals](qabstractbuttonsignals.md).[released](qabstractbuttonsignals.md#released)* + +#### Type declaration: + +▸ (): *void* + +___ + +### toggled + +• **toggled**: *function* + +*Inherited from [QAbstractButtonSignals](qabstractbuttonsignals.md).[toggled](qabstractbuttonsignals.md#toggled)* + +#### Type declaration: + +▸ (`checked`: boolean): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`checked` | boolean | + +___ + +### triggered + +• **triggered**: *function* + +#### Type declaration: + +▸ (`nativeAction`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`nativeAction` | [NativeElement](../globals.md#nativeelement) | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qtreewidgetsignals.md b/website/docs/api/generated/interfaces/qtreewidgetsignals.md new file mode 100644 index 000000000..cb7bfbf86 --- /dev/null +++ b/website/docs/api/generated/interfaces/qtreewidgetsignals.md @@ -0,0 +1,103 @@ +--- +id: "qtreewidgetsignals" +title: "QTreeWidgetSignals" +sidebar_label: "QTreeWidgetSignals" +--- + +## Hierarchy + + ↳ [QWidgetSignals](qwidgetsignals.md) + + ↳ **QTreeWidgetSignals** + +## Index + +### Properties + +* [customContextMenuRequested](qtreewidgetsignals.md#customcontextmenurequested) +* [itemSelectionChanged](qtreewidgetsignals.md#itemselectionchanged) +* [objectNameChanged](qtreewidgetsignals.md#objectnamechanged) +* [windowIconChanged](qtreewidgetsignals.md#windowiconchanged) +* [windowTitleChanged](qtreewidgetsignals.md#windowtitlechanged) + +## Properties + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +*Inherited from [QWidgetSignals](qwidgetsignals.md).[customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested)* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### itemSelectionChanged + +• **itemSelectionChanged**: *function* + +#### 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 | + +___ + +### 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 | diff --git a/website/docs/api/generated/interfaces/qwidgetsignals.md b/website/docs/api/generated/interfaces/qwidgetsignals.md new file mode 100644 index 000000000..e2b53e9b9 --- /dev/null +++ b/website/docs/api/generated/interfaces/qwidgetsignals.md @@ -0,0 +1,112 @@ +--- +id: "qwidgetsignals" +title: "QWidgetSignals" +sidebar_label: "QWidgetSignals" +--- + +## Hierarchy + +* [QObjectSignals](qobjectsignals.md) + + ↳ **QWidgetSignals** + + ↳ [QAbstractSliderSignals](qabstractslidersignals.md) + + ↳ [QAbstractButtonSignals](qabstractbuttonsignals.md) + + ↳ [QFileDialogSignals](qfiledialogsignals.md) + + ↳ [QLineEditSignals](qlineeditsignals.md) + + ↳ [QProgressBarSignals](qprogressbarsignals.md) + + ↳ [QComboBoxSignals](qcomboboxsignals.md) + + ↳ [QSpinBoxSignals](qspinboxsignals.md) + + ↳ [QStackedWidgetSignals](qstackedwidgetsignals.md) + + ↳ [QTabWidgetSignals](qtabwidgetsignals.md) + + ↳ [QTableWidgetSignals](qtablewidgetsignals.md) + + ↳ [QPlainTextEditSignals](qplaintexteditsignals.md) + + ↳ [QTreeWidgetSignals](qtreewidgetsignals.md) + + ↳ [QGroupBoxSignals](qgroupboxsignals.md) + +## Index + +### Properties + +* [customContextMenuRequested](qwidgetsignals.md#customcontextmenurequested) +* [objectNameChanged](qwidgetsignals.md#objectnamechanged) +* [windowIconChanged](qwidgetsignals.md#windowiconchanged) +* [windowTitleChanged](qwidgetsignals.md#windowtitlechanged) + +## Properties + +### customContextMenuRequested + +• **customContextMenuRequested**: *function* + +#### Type declaration: + +▸ (`pos`: object): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`pos` | object | + +___ + +### objectNameChanged + +• **objectNameChanged**: *function* + +*Inherited from [QObjectSignals](qobjectsignals.md).[objectNameChanged](qobjectsignals.md#objectnamechanged)* + +#### Type declaration: + +▸ (`objectName`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`objectName` | string | + +___ + +### windowIconChanged + +• **windowIconChanged**: *function* + +#### Type declaration: + +▸ (`iconNative`: [NativeElement](../globals.md#nativeelement)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`iconNative` | [NativeElement](../globals.md#nativeelement) | + +___ + +### windowTitleChanged + +• **windowTitleChanged**: *function* + +#### Type declaration: + +▸ (`title`: string): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`title` | string | diff --git a/website/docs/api/process.md b/website/docs/api/manual/process.md similarity index 100% rename from website/docs/api/process.md rename to website/docs/api/manual/process.md diff --git a/website/docs/api/synopsis.md b/website/docs/api/manual/synopsis.md similarity index 100% rename from website/docs/api/synopsis.md rename to website/docs/api/manual/synopsis.md diff --git a/website/docs/api/sidebar-gen.js b/website/docs/api/sidebar-gen.js new file mode 100644 index 000000000..19aee76f0 --- /dev/null +++ b/website/docs/api/sidebar-gen.js @@ -0,0 +1,197 @@ +module.exports = { + "docs": { + "Classes": [ + "api/generated/classes/component", + "api/generated/classes/eventwidget", + "api/generated/classes/flexlayout", + "api/generated/classes/nodelayout", + "api/generated/classes/nodeobject", + "api/generated/classes/nodewidget", + "api/generated/classes/qabstractbutton", + "api/generated/classes/qabstractscrollarea", + "api/generated/classes/qabstractslider", + "api/generated/classes/qaction", + "api/generated/classes/qapplication", + "api/generated/classes/qboxlayout", + "api/generated/classes/qcheckbox", + "api/generated/classes/qclipboard", + "api/generated/classes/qcolor", + "api/generated/classes/qcombobox", + "api/generated/classes/qcursor", + "api/generated/classes/qdial", + "api/generated/classes/qfiledialog", + "api/generated/classes/qfontdatabase", + "api/generated/classes/qgridlayout", + "api/generated/classes/qgroupbox", + "api/generated/classes/qicon", + "api/generated/classes/qkeyevent", + "api/generated/classes/qkeysequence", + "api/generated/classes/qlabel", + "api/generated/classes/qlineedit", + "api/generated/classes/qmainwindow", + "api/generated/classes/qmenu", + "api/generated/classes/qmenubar", + "api/generated/classes/qmouseevent", + "api/generated/classes/qmovie", + "api/generated/classes/qobject", + "api/generated/classes/qpainter", + "api/generated/classes/qpixmap", + "api/generated/classes/qplaintextedit", + "api/generated/classes/qpoint", + "api/generated/classes/qprogressbar", + "api/generated/classes/qpushbutton", + "api/generated/classes/qradiobutton", + "api/generated/classes/qrect", + "api/generated/classes/qscrollarea", + "api/generated/classes/qshortcut", + "api/generated/classes/qsize", + "api/generated/classes/qspinbox", + "api/generated/classes/qstackedwidget", + "api/generated/classes/qstyle", + "api/generated/classes/qsystemtrayicon", + "api/generated/classes/qtabwidget", + "api/generated/classes/qtablewidget", + "api/generated/classes/qtablewidgetitem", + "api/generated/classes/qtoolbutton", + "api/generated/classes/qtreewidget", + "api/generated/classes/qtreewidgetitem", + "api/generated/classes/qurl", + "api/generated/classes/qvariant", + "api/generated/classes/qwidget", + "api/generated/classes/stylesheet", + "api/generated/classes/yogawidget" + ], + "Enums": [ + "api/generated/enums/acceptmode", + "api/generated/enums/alignmentflag", + "api/generated/enums/anchorpoint", + "api/generated/enums/applicationattribute", + "api/generated/enums/applicationstate", + "api/generated/enums/arrowtype", + "api/generated/enums/aspectratiomode", + "api/generated/enums/axis", + "api/generated/enums/bgmode", + "api/generated/enums/brushstyle", + "api/generated/enums/cachemode", + "api/generated/enums/casesensitivity", + "api/generated/enums/checkstate", + "api/generated/enums/checksumtype", + "api/generated/enums/clipoperation", + "api/generated/enums/connectiontype", + "api/generated/enums/contextmenupolicy", + "api/generated/enums/coordinatesystem", + "api/generated/enums/corner", + "api/generated/enums/cursormovestyle", + "api/generated/enums/cursorshape", + "api/generated/enums/dateformat", + "api/generated/enums/dayofweek", + "api/generated/enums/dialoglabel", + "api/generated/enums/direction", + "api/generated/enums/dockwidgetarea", + "api/generated/enums/dropaction", + "api/generated/enums/echomode", + "api/generated/enums/edge", + "api/generated/enums/enterkeytype", + "api/generated/enums/eventpriority", + "api/generated/enums/filemode", + "api/generated/enums/fillrule", + "api/generated/enums/findchildoption", + "api/generated/enums/focuspolicy", + "api/generated/enums/focusreason", + "api/generated/enums/gestureflag", + "api/generated/enums/gesturestate", + "api/generated/enums/gesturetype", + "api/generated/enums/globalcolor", + "api/generated/enums/hittestaccuracy", + "api/generated/enums/imageconversionflag", + "api/generated/enums/imagereadererror", + "api/generated/enums/inputmethodhint", + "api/generated/enums/inputmethodquery", + "api/generated/enums/insertpolicy", + "api/generated/enums/itemdatarole", + "api/generated/enums/itemflag", + "api/generated/enums/itemselectionmode", + "api/generated/enums/itemselectionoperation", + "api/generated/enums/key", + "api/generated/enums/keyboardmodifier", + "api/generated/enums/layoutdirection", + "api/generated/enums/linewrapmode", + "api/generated/enums/maskmode", + "api/generated/enums/matchflag", + "api/generated/enums/modifier", + "api/generated/enums/mousebutton", + "api/generated/enums/mouseeventflag", + "api/generated/enums/mouseeventsource", + "api/generated/enums/moviestate", + "api/generated/enums/nativegesturetype", + "api/generated/enums/navigationmode", + "api/generated/enums/option", + "api/generated/enums/orientation", + "api/generated/enums/parsingmode", + "api/generated/enums/penstyle", + "api/generated/enums/qclipboardmode", + "api/generated/enums/qiconmode", + "api/generated/enums/qiconstate", + "api/generated/enums/qstylepixelmetric", + "api/generated/enums/qsystemtrayiconactivationreason", + "api/generated/enums/qtextoptionwrapmode", + "api/generated/enums/renderhint", + "api/generated/enums/screenorientation", + "api/generated/enums/scrollbarpolicy", + "api/generated/enums/scrollhint", + "api/generated/enums/scrollphase", + "api/generated/enums/shortcutcontext", + "api/generated/enums/sizeadjustpolicy", + "api/generated/enums/sizehint", + "api/generated/enums/sizemode", + "api/generated/enums/sortorder", + "api/generated/enums/systemfont", + "api/generated/enums/tabfocusbehavior", + "api/generated/enums/tabposition", + "api/generated/enums/textelidemode", + "api/generated/enums/textflag", + "api/generated/enums/textformat", + "api/generated/enums/textinteractionflag", + "api/generated/enums/tilerule", + "api/generated/enums/timespec", + "api/generated/enums/timertype", + "api/generated/enums/toolbararea", + "api/generated/enums/toolbuttonpopupmode", + "api/generated/enums/toolbuttonstyle", + "api/generated/enums/touchpointstate", + "api/generated/enums/transformationmode", + "api/generated/enums/uieffect", + "api/generated/enums/viewmode", + "api/generated/enums/whitespacemode", + "api/generated/enums/widgetattribute", + "api/generated/enums/widgeteventtypes", + "api/generated/enums/windowframesection", + "api/generated/enums/windowmodality", + "api/generated/enums/windowstate", + "api/generated/enums/windowtype", + "api/generated/enums/writingsystem" + ], + "Interfaces": [ + "api/generated/interfaces/qabstractbuttonsignals", + "api/generated/interfaces/qabstractslidersignals", + "api/generated/interfaces/qactionsignals", + "api/generated/interfaces/qcomboboxsignals", + "api/generated/interfaces/qfiledialogsignals", + "api/generated/interfaces/qgroupboxsignals", + "api/generated/interfaces/qlineeditsignals", + "api/generated/interfaces/qmoviesignals", + "api/generated/interfaces/qobjectsignals", + "api/generated/interfaces/qplaintexteditsignals", + "api/generated/interfaces/qprogressbarsignals", + "api/generated/interfaces/qshortcutsignals", + "api/generated/interfaces/qspinboxsignals", + "api/generated/interfaces/qstackedwidgetsignals", + "api/generated/interfaces/qsystemtrayiconsignals", + "api/generated/interfaces/qtabwidgetsignals", + "api/generated/interfaces/qtablewidgetsignals", + "api/generated/interfaces/qtoolbuttonsignals", + "api/generated/interfaces/qtreewidgetsignals", + "api/generated/interfaces/qwidgetsignals" + ] + } +}; \ No newline at end of file diff --git a/website/docs/doc1.md b/website/docs/doc1.md deleted file mode 100755 index a350ace5a..000000000 --- a/website/docs/doc1.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -id: doc1 -title: Style Guide -sidebar_label: Style Guide ---- - -You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/). - -## Markdown Syntax - -To serve as an example page when styling markdown based Docusaurus sites. - -## Headers - -# H1 - Create the best documentation - -## H2 - Create the best documentation - -### H3 - Create the best documentation - -#### H4 - Create the best documentation - -##### H5 - Create the best documentation - -###### H6 - Create the best documentation - ---- - -## Emphasis - -Emphasis, aka italics, with _asterisks_ or _underscores_. - -Strong emphasis, aka bold, with **asterisks** or **underscores**. - -Combined emphasis with **asterisks and _underscores_**. - -Strikethrough uses two tildes. ~~Scratch this.~~ - ---- - -## Lists - -1. First ordered list item -1. Another item ⋅⋅\* Unordered sub-list. -1. Actual numbers don't matter, just that it's a number ⋅⋅1. Ordered sub-list -1. And another item. - -⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown). - -⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ ⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅ ⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.) - -- Unordered list can use asterisks - -* Or minuses - -- Or pluses - ---- - -## Links - -[I'm an inline-style link](https://www.google.com) - -[I'm an inline-style link with title](https://www.google.com "Google's Homepage") - -[I'm a reference-style link][arbitrary case-insensitive reference text] - -[I'm a relative reference to a repository file](../blob/master/LICENSE) - -[You can use numbers for reference-style link definitions][1] - -Or leave it empty and use the [link text itself]. - -URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or and sometimes example.com (but not on Github, for example). - -Some text to show that the reference links can follow later. - -[arbitrary case-insensitive reference text]: https://www.mozilla.org -[1]: http://slashdot.org -[link text itself]: http://www.reddit.com - ---- - -## Images - -Here's our logo (hover to see the title text): - -Inline-style: ![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 1') - -Reference-style: ![alt text][logo] - -[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 2' - ---- - -## Code - -```javascript -var s = 'JavaScript syntax highlighting'; -alert(s); -``` - -```python -s = "Python syntax highlighting" -print s -``` - -``` -No language indicated, so no syntax highlighting. -But let's throw in a tag. -``` - ---- - -## Tables - -Colons can be used to align columns. - -| Tables | Are | Cool | -| ------------- | :-----------: | -----: | -| col 3 is | right-aligned | \$1600 | -| col 2 is | centered | \$12 | -| zebra stripes | are neat | \$1 | - -There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown. - -| Markdown | Less | Pretty | -| -------- | --------- | ---------- | -| _Still_ | `renders` | **nicely** | -| 1 | 2 | 3 | - ---- - -## Blockquotes - -> Blockquotes are very handy in email to emulate reply text. This line is part of the same quote. - -Quote break. - -> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can _put_ **Markdown** into a blockquote. - ---- - -## Inline HTML - -
-
Definition list
-
Is something people use sometimes.
- -
Markdown in HTML
-
Does *not* work **very** well. Use HTML tags.
-
- ---- - -## Line Breaks - -Here's a line for us to start with. - -This line is separated from the one above by two newlines, so it will be a _separate paragraph_. - -This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the _same paragraph_. diff --git a/website/docs/mdx.md b/website/docs/mdx.md deleted file mode 100755 index dd222e2c1..000000000 --- a/website/docs/mdx.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: mdx -title: Powered by MDX ---- - -You can write JSX and use React components within your Markdown thanks to [MDX](https://mdxjs.com/). - -export const Highlight = ({children, color}) => ( - - {children} - -); - -Docusaurus green and Facebook blue are my favorite colors. - -I can write **Markdown** alongside my _JSX_! diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index a9b89ef56..d84541676 100755 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -1,92 +1,91 @@ module.exports = { - title: "NodeGui", - tagline: - "Build performant, native, cross platform desktop apps with JavaScript and CSS 🚀", - url: "https://nodegui.org", - baseUrl: "/", - favicon: "img/favicon.ico", - organizationName: "nodegui", // Usually your GitHub org/user name. - projectName: "nodegui", // Usually your repo name. - themeConfig: { - navbar: { - title: "NodeGui", - logo: { - alt: "NodeGui Logo", - src: "img/logo-circle.png" - }, - links: [ - { to: "docs/guides/getting-started", label: "Docs", position: "right" }, - { to: "docs/api/QApplication", label: "API", position: "right" }, - { to: "blog", label: "Blog", position: "right" }, - { - href: "https://github.com/nodegui/nodegui", - label: "GitHub", - position: "right" - } - ] + title: 'NodeGui', + tagline: 'Build performant, native, cross platform desktop apps with JavaScript and CSS 🚀', + url: 'https://nodegui.org', + baseUrl: '/', + favicon: 'img/favicon.ico', + organizationName: 'nodegui', // Usually your GitHub org/user name. + projectName: 'nodegui', // Usually your repo name. + themeConfig: { + navbar: { + title: 'NodeGui', + logo: { + alt: 'NodeGui Logo', + src: 'img/logo-circle.png', + }, + links: [ + { to: 'docs/guides/getting-started', label: 'Docs', position: 'right' }, + { to: 'docs/api/manual/synopsis', label: 'API', position: 'right' }, + { to: 'blog', label: 'Blog', position: 'right' }, + { + href: 'https://github.com/nodegui/nodegui', + label: 'GitHub', + position: 'right', + }, + ], + }, + footer: { + style: 'dark', + links: [ + { + title: 'Docs', + items: [ + { to: 'docs/guides/getting-started', label: 'Getting Started' }, + { to: 'docs/api/manual/synopsis', label: 'API' }, + ], + }, + { + title: 'Community', + items: [ + { + label: 'Spectrum', + href: 'https://spectrum.chat/nodegui', + }, + { + label: 'Twitter', + to: 'https://twitter.com/node_gui', + }, + { + label: 'Medium', + to: 'https://medium.com/nodegui', + }, + ], + }, + { + title: 'More', + items: [ + { + label: 'Blog', + to: 'blog', + }, + { + label: 'React NodeGui', + to: 'https://react.nodegui.org', + }, + { + label: 'FAQ', + to: 'docs/faq', + }, + ], + }, + ], + copyright: `Copyright © ${new Date().getFullYear()} NodeGui`, + }, + googleAnalytics: { + trackingID: 'UA-145065218-1', + }, }, - footer: { - style: "dark", - links: [ - { - title: "Docs", - items: [ - { to: "docs/guides/getting-started", label: "Getting Started" }, - { to: "docs/api/QApplication", label: "API" } - ] - }, - { - title: "Community", - items: [ + presets: [ + [ + '@docusaurus/preset-classic', { - label: "Spectrum", - href: "https://spectrum.chat/nodegui" + docs: { + sidebarPath: require.resolve('./sidebars.js'), + }, + theme: { + customCss: require.resolve('./src/css/custom.css'), + }, }, - { - label: "Twitter", - to: "https://twitter.com/node_gui" - }, - { - label: "Medium", - to: "https://medium.com/nodegui" - } - ] - }, - { - title: "More", - items: [ - { - label: "Blog", - to: "blog" - }, - { - label: "React NodeGui", - to: "https://react.nodegui.org" - }, - { - label: "FAQ", - to: "docs/faq" - } - ] - } - ], - copyright: `Copyright © ${new Date().getFullYear()} NodeGui` - }, - googleAnalytics: { - trackingID: "UA-145065218-1" - } - }, - presets: [ - [ - "@docusaurus/preset-classic", - { - docs: { - sidebarPath: require.resolve("./sidebars.js") - }, - theme: { - customCss: require.resolve("./src/css/custom.css") - } - } - ] - ] + ], + ], }; diff --git a/website/sidebars.js b/website/sidebars.js index 643c49c8f..d1ce6b1a5 100755 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -1,64 +1,28 @@ +const generated = require('./docs/api/sidebar-gen'); + module.exports = { - api: { - General: ["api/synopsis"], - Widgets: [ - "api/QApplication", - "api/QCheckBox", - "api/QDial", - "api/QLabel", - "api/QLineEdit", - "api/QMainWindow", - "api/QPlainTextEdit", - "api/QProgressBar", - "api/QPushButton", - "api/QRadioButton", - "api/QScrollArea", - "api/QSpinBox", - "api/QTabWidget", - "api/QWidget", - "api/QMenu", - "api/QMenuBar" - ], - Layouts: ["api/FlexLayout", "api/QGridLayout"], - Modules: [ - "api/QClipboard", - "api/QCursor", - "api/QPixmap", - "api/QtEnums", - "api/QShortcut", - "api/QAction", - "api/QKeySequence", - "api/QIcon", - "api/QSystemTrayIcon" - ], - "Internal Modules": [ - "api/Component", - "api/EventWidget", - "api/NodeLayout", - "api/NodeWidget", - "api/YogaWidget", - "api/QAbstractScrollArea", - "api/QAbstractSlider" - ], - APIs: ["api/process"] - }, - guides: { - "The Basics": [ - "guides/getting-started", - "guides/tutorial", - "guides/styling", - "guides/layout", - "guides/handle-events", - "guides/scroll-view", - "guides/images", - "guides/networking" - ], - Guides: [ - "guides/nodegui-architecture", - "guides/debugging", - "guides/debugging-in-vscode", - "guides/using-native-node-modules", - "guides/custom-nodegui-native-plugin" - ] - } + api: { + Intro: ['api/manual/synopsis'], + ...generated.docs, + Others: ['api/manual/process'], + }, + guides: { + 'The Basics': [ + 'guides/getting-started', + 'guides/tutorial', + 'guides/styling', + 'guides/layout', + 'guides/handle-events', + 'guides/scroll-view', + 'guides/images', + 'guides/networking', + ], + Guides: [ + 'guides/nodegui-architecture', + 'guides/debugging', + 'guides/debugging-in-vscode', + 'guides/using-native-node-modules', + 'guides/custom-nodegui-native-plugin', + ], + }, }; diff --git a/website/src/components/Features.js b/website/src/components/Features.js index 5dbaff0ea..1c56977dc 100644 --- a/website/src/components/Features.js +++ b/website/src/components/Features.js @@ -1,63 +1,48 @@ -import React from "react"; -import withBaseUrl from "@docusaurus/withBaseUrl"; -import styles from "../pages/styles.module.css"; -import classnames from "classnames"; +import React from 'react'; +import useBaseUrl from '@docusaurus/useBaseUrl'; +import styles from '../pages/styles.module.css'; +import classnames from 'classnames'; const features = [ - { - title: <>Web Technologies, - imageUrl: "img/undraw_website_setup.svg", - description: ( - <> - With NodeGui, you can build your app with familiar web technologies like - CSS and JavaScript. There is even a{" "} - React based version. - - ) - }, - { - title: <>Open Source, - imageUrl: "img/undraw_code_review.svg", - description: ( - <> - NodeGui is an open source project maintained by an active community of - contributors. - - ) - }, - { - title: <> Cross Platform, - imageUrl: "img/undraw_windows.svg", - description: ( - <> - Compatible with Mac, Windows, and Linux, NodeGui apps build and run on - three platforms. - - ) - } + { + title: <>Web Technologies, + imageUrl: 'img/undraw_website_setup.svg', + description: ( + <> + With NodeGui, you can build your app with familiar web technologies like CSS and JavaScript. There is + even a React based version. + + ), + }, + { + title: <>Open Source, + imageUrl: 'img/undraw_code_review.svg', + description: <>NodeGui is an open source project maintained by an active community of contributors., + }, + { + title: <> Cross Platform, + imageUrl: 'img/undraw_windows.svg', + description: <>Compatible with Mac, Windows, and Linux, NodeGui apps build and run on three platforms., + }, ]; export const Features = () => { - return ( -
-
-
- {features.map(({ imageUrl, title, description }, idx) => ( -
- {imageUrl && ( -
- {title} + return ( +
+
+
+ {features.map(({ imageUrl, title, description }, idx) => ( +
+ {imageUrl && ( +
+ {title} +
+ )} +

{title}

+

{description}

+
+ ))}
- )} -

{title}

-

{description}

- ))} -
-
-
- ); + + ); }; diff --git a/website/src/components/Hero.js b/website/src/components/Hero.js index 0dc3e1830..50c28c79d 100644 --- a/website/src/components/Hero.js +++ b/website/src/components/Hero.js @@ -1,15 +1,15 @@ -import React from "react"; -import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; -import styled from "styled-components"; -import { Header, Container, H1, Center } from "./common"; -import styles from "../pages/styles.module.css"; -import withBaseUrl from "@docusaurus/withBaseUrl"; +import React from 'react'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; +import styled from 'styled-components'; +import { Header, Container, H1, Center } from './common'; +import styles from '../pages/styles.module.css'; +import useBaseUrl from '@docusaurus/useBaseUrl'; const ActionButton = styled.a` - ${props => { - switch (props.type) { - case "primary": - return ` + ${props => { + switch (props.type) { + case 'primary': + return ` color: white; background: var(--ifm-color-primary); &:hover { @@ -18,8 +18,8 @@ const ActionButton = styled.a` background: var(--ifm-color-primary-dark); } `; - case "secondary": - return ` + case 'secondary': + return ` &::after { content: "›"; font-size: 24px; @@ -27,59 +27,55 @@ const ActionButton = styled.a` text-align: center; } `; - } - }} - padding: 0.7rem 1.1rem; - font-size: 1.2em; + } + }} + padding: 0.7rem 1.1rem; + font-size: 1.2em; `; const Title = styled(H1)` - font-size: 3em; - font-weight: 600; + font-size: 3em; + font-weight: 600; `; const Tagline = styled.p` - font-size: 1.6em; - text-align: center; + font-size: 1.6em; + text-align: center; `; const MainLogo = styled.img` - max-width: 170px; + max-width: 170px; `; const MainHeader = styled(Header)` - padding-bottom: 40px; + padding-bottom: 40px; `; function ActionContainer() { - return ( -
- - Quick start - - - Learn basics - -
- ); + return ( +
+ + Quick start + + + Learn basics + +
+ ); } export const Hero = () => { - const context = useDocusaurusContext(); - const { siteConfig = {} } = context; - return ( - - -
- - {siteConfig.title} - {siteConfig.tagline} -
- -
-
- - - ); + const context = useDocusaurusContext(); + const { siteConfig = {} } = context; + return ( + + +
+ + {siteConfig.title} + {siteConfig.tagline} +
+ +
+
+ + + ); }; diff --git a/website/src/components/Try.js b/website/src/components/Try.js index e6121eaf6..649738fe3 100644 --- a/website/src/components/Try.js +++ b/website/src/components/Try.js @@ -1,76 +1,76 @@ -import React from "react"; -import styled from "styled-components"; -import { Section, Container, Center, H2, H4 } from "../components/common"; +import React from 'react'; +import styled from 'styled-components'; +import { Section, Container, Center, H2, H4 } from '../components/common'; const Code = styled.code` - color: white !important; - font-size: 14px; - position: relative; - &::before { - content: "$"; - position: absolute; - left: -13px; - color: gray; - } + color: white !important; + font-size: 14px; + position: relative; + &::before { + content: '$'; + position: absolute; + left: -13px; + color: gray; + } `; const Terminal = styled.div` - background: black; - display: flex; - flex-direction: column; - border: 1px solid gray; - border-bottom: none; - border-top-left-radius: 10px; - border-top-right-radius: 10px; - padding: 50px 30px 30px 30px; - width: 600px; - max-width: 100%; - position: relative; - margin-bottom: 20px; - &::before { - content: "○ ○ ○"; - color: gray; - font-size: 14px; - position: absolute; - left: 15px; - top: 5px; - } + background: black; + display: flex; + flex-direction: column; + border: 1px solid gray; + border-bottom: none; + border-top-left-radius: 10px; + border-top-right-radius: 10px; + padding: 50px 30px 30px 30px; + width: 600px; + max-width: 100%; + position: relative; + margin-bottom: 20px; + &::before { + content: '○ ○ ○'; + color: gray; + font-size: 14px; + position: absolute; + left: 15px; + top: 5px; + } `; const SubTitle = styled.h4` - font-weight: 400; + font-weight: 400; `; const Description = styled.div` - width: 600px; - max-width: 100%; + width: 600px; + max-width: 100%; `; export const Try = () => { - return ( -
- -
-

Give it a try

- - 1. Run these commands - - git clone https://github.com/nodegui/nodegui-starter - cd nodegui-starter - npm install - npm start - - - 2.{" "} - - Learn the basics - {" "} - or dive deeper and take a{" "} - - look at the APIs. - - - -
- -
- ); + return ( +
+ +
+

Give it a try

+ + 1. Run these commands + + git clone https://github.com/nodegui/nodegui-starter + cd nodegui-starter + npm install + npm start + + + 2.{' '} + + Learn the basics + {' '} + or dive deeper and take a{' '} + + look at the APIs. + + + +
+ +
+ ); };