@@ -12,10 +12,8 @@ npm i -s qml-raub
1212```
1313
1414** QML** interoperation addon for ** Node.js** .
15- ** QML** is a declarative language that allows user interfaces to be described
16- in terms of their visual components and how they interact and relate with one another.
1715See [ Qt Documentation] ( https://doc.qt.io/qt-5/qmlapplications.html )
18- for additional details on QML features and syntax.
16+ for QML features and syntax.
1917
2018![ Example] ( examples/screenshot.png )
2119
@@ -31,20 +29,21 @@ const ui = new View({ width, height, file: 'gui.qml' });
3129```
3230
3331The QML engine must be initialized first. Then, new View instances can be created.
34- See [ TypeScript declarations] ( /index.d.ts ) for more details.
32+
33+ * See [ TypeScript declarations] ( /index.d.ts ) for more details.
34+ * See [ example] ( /examples/main.ts ) for a complete setup.
3535
3636QML views can process input events. Mouse and keyboard events can be sent to a view.
3737Unhandled (unused) events are re-emitted by the view.
38-
3938Changing the event flow from ` window -> app ` to ` window -> ui -> app ` allows blocking
4039the handled events. For example, when a QML button is pressed, a 3D scene
4140behind the button won't receive any mouse event. Or when a QML input is
4241focused, the app's hotkeys won't be triggered by typing text.
4342
4443
45- ### class View
44+ ## View
4645
47- Loads and manages a QML file.
46+ Main class that loads and manages a QML file.
4847
4948When the file is loaded and whenever the QML scene is resized a new GL
5049** Texture** (id) is created and reported in an event (type 'reset').
@@ -71,9 +70,9 @@ be generated from QML side.
7170
7271---
7372
74- ### class Property
73+ ## Property
7574
76- Helper to access QML data. Automates reading and writing QML objects. A QML object should
75+ Helper class to access QML data. Automates reading and writing QML objects. A QML object should
7776have ` objectName ` and the target property. The value must be serializable.
7877
7978```
@@ -85,9 +84,9 @@ See [TypeScript declarations](/index.d.ts) for more details.
8584
8685---
8786
88- ### class Method
87+ ## Method
8988
90- Helper to call a QML method. A QML object should have ` objectName `
89+ Helper class to call a QML method. A QML object should have ` objectName `
9190and the target method.
9291
9392```
0 commit comments