slint-ui 0.3.2 → 0.3.4

package/LICENSE.md

@@ -1,6 +1,6 @@
 # Slint License
 
-Slint is available under either a [commercial license](LICENSES/LicenseRef-Slint-commercial.md)
-or [GNU GPLv3](LICENSES/GPL-3.0-only.txt), at your choice.
+Slint is available under either a [proprietary license](LICENSES/LicenseRef-Slint-commercial.md)
+or [GNU GPLv3](LICENSES/GPL-3.0-only.txt).
 
 Third party licenses listed in the `LICENSES` folder also apply to parts of the product.

package/LICENSES/LicenseRef-Slint-commercial.md

@@ -43,9 +43,9 @@ The Licensed Software includes
     treaties. The Licensed Software is licensed, not sold.
 
 2. The Licensed Software may provide links to third Party libraries or code
-    (collectively **Third Party Libraries**) to implement various functions.
-    Third Party Libraries do not comprise part of the Licensed Software. In some
-    cases, access to Third Party Libraries may be included along with the
+    (collectively **Third-Party Libraries**) to implement various functions.
+    Third-Party Libraries do not comprise part of the Licensed Software. In some
+    cases, access to Third-Party Libraries may be included along with the
     Licensed Software delivery as a convenience for development and testing
     only. You acknowledge:
 
@@ -54,7 +54,7 @@ The Licensed Software includes
 
     2. that distribution of any of the Licensed Software referencing any portion
         of a Third-Party Library may require appropriate licensing from such
-        third parties. All such Third Party Libraries, along with applicable
+        third parties. All such Third-Party Libraries, along with applicable
         copyright notices and licenses, will be listed and made available to
         you.
 
@@ -67,89 +67,88 @@ The Licensed Software includes
 
     3. your contact details.
 
-    In case of any changes or deviations to the information noted in the License
+4. In case of any changes or deviations to the information noted in the License
     Certificate, you are obliged to notify us in writing, not later than 7 days
-    after any such change or deviation has occured.
+    after any such change or deviation has occurred.
 
-4. The Term of this Agreement shall begin on the date mentioned in the License
+5. The Term of this Agreement shall begin on the date mentioned in the License
     Certificate (**Effective Date**) and shall continue unless terminated
     earlier as herein provided (**Term**).
 
-5. New releases of the Licensed Software (**Updates**) will be made available
+6. New releases of the Licensed Software (**Updates**) will be made available
     to you for the period (**Maintenance Period**) specified in the License
     Certificate. Such Updates may be bound by additional license terms. You
     consent to any such additional license terms, without which you may not
     install, copy, or otherwise use such Updates.
 
-6. The Licensed Software is to be used exclusively with your software
+7. The Licensed Software is to be used exclusively with your software
     products (**Products**) specified in the License Certificate.
 
-7. We grant you a perpetual, non-exclusive, non-transferable right to use the
+8. We grant you a perpetual, non-exclusive, non-transferable right to use the
     Licensed Software, including making modifications, for the sole purposes of
     designing, developing, and testing your Products during the Term. The number
-    of **Users** using the Licensed Software to design, develop and test your
+    of **Users** using the Licensed Software to design, develop, and test your
     Products is limited to the amount of **User Seats** specified in the License
     Certificate. For clarity, each unique User is counted as one User Seat.
 
-8. We grant you a perpetual, non-exclusive, non-transferable right to reproduce
+9. We grant you a perpetual, non-exclusive, non-transferable right to reproduce
     and distribute the object code form of the Licensed Software, including any
     modifications made to the Licensed Software, during the Term. Such
-    distributions is permitted only with your Products and limited to the amount
+    distributions are permitted only with your Products and limited to the number
     of **Distributions** specified in the License Certificate.
 
-9. The license grants are conditional on the full and timely payment of all
+10. The license grants are conditional on the full and timely payment of all
     applicable **Fees**; if said Fees are not paid in full and by their due
     date, the license shall not be granted and your Products shall be deemed as
     made in breach of the Agreement ex tunc.
 
-10. Clause 9 above shall not apply if the license has been granted to you under
+11. Clause 10 above shall not apply if the license has been granted to you under
     the **Ambassador** program. Instead, the license grants shall be conditional
-    on the fullfilment of the obligations as specified herein. If said
+    on the fulfillment of the obligations as specified herein. If said
     obligations are not fulfilled, the license shall not be granted and your
     Products shall be deemed as made in breach of the Agreement ex tunc. The
     obligations are as follows:
 
-    1. Showcase: You grant us the right to use your name, logo and your
+    1. Showcase: You grant us the right to use your name, logo, and your
         Products in our marketing materials,
 
-    2. Spread the word: You will include reasonably visible notices in the
-        documentation, marketing materials and social media channels related to
-        your Products that such were built with the Licensed Software,
+    2. Spread the word: You will include visible notices in the documentation,
+        marketing materials, and social media channels related to your Products
+        that such were built with the Licensed Software,
 
-    3. Give feedback: You agree to provide relevant feedback that would
-        help us improve the Licensed Software. We may use any such
-        feedback in testimonials.
+    3. Give feedback: You agree to provide feedback that would help us improve
+        the Licensed Software. We may use any such feedback in testimonials.
 
-11. The Fees and any other charges under this Agreement shall be paid by
+12. The Fees and any other charges under this Agreement shall be paid by
     you no later than thirty (30) days from the date of the applicable
-    invoice from us. A late payment charge of the lower of (a) one percent
-    per month; or (b) the interest rate stipulated by applicable law, shall be
-    charged on any unpaid balances that remain past due and which have not been
-    disputed by you in good faith.
+    invoice from us. A late payment charge of five percent per month over and
+    above the interest rate stipulated by applicable law shall be charged on any
+    unpaid balances that remain past due and which have not been disputed by you
+    in good faith.
 
-12. The Fees and any other charges payable under this Agreement are gross
+13. The Fees and any other charges payable under this Agreement are gross
     amounts but exclusive of any value added tax, use tax, sales tax,
     withholding tax and other taxes, duties or tariffs levied directly for the
-    sale, delivery or use of the Licensed Software pursuant to any applicable
+    sale, delivery, or use of the Licensed Software pursuant to any applicable
     law.
 
-13. The Parties also agree to all of the following conditions:
+14. The Parties also agree to all the following conditions:
 
-    1. You may not remove or alter any copyright, trademark or other
+    1. You may not remove or alter any copyright, trademark, or other
         proprietary rights notice contained in any portion of the Licensed
         Software,
 
     2. Your Products may not compete with the Licensed Software,
 
-    3. You will indemnify and hold us, our affiliated companies and our
+    3. You will indemnify and hold us, our affiliated companies, and our
         suppliers, harmless from and against any claims or liabilities
-        arising out of the use, reproduction or distribution of your
-        Products, except as set out in clause 13.4. immediately below,
+        arising out of the use, reproduction, or distribution of your
+        Products, except as set out in clause 14.4. immediately below,
 
     4. We shall indemnify and hold you harmless from and against any
         claims from third parties alleging that the use of the Licensed Software
         as set out in this Agreement infringes or will infringe such third
-        parties intellectual property rights or other rights,
+        parties' intellectual property rights or other rights,
 
     5. A Party shall promptly notify the other Party if it receives a claim that
         the other Party shall or may be obliged to indemnify. The Parties shall
@@ -169,17 +168,17 @@ The Licensed Software includes
         the indemnifying Party, such consent not to be unreasonably withheld or
         delayed.
 
-14. The Licensed Software is licensed to you "as is". To the maximum extent
+15. The Licensed Software is licensed to you "as is". To the maximum extent
     permitted by applicable law, we on behalf of us and our suppliers,
     disclaim all warranties and conditions, either express or implied,
     including, but not limited to, any implied warranties of merchantability or
-    fitness for a particular purpose, title and non-infringement with regard to
+    fitness for a particular purpose, title, and non-infringement with regard to
     the Licensed Software. The warranty disclaimer in the foregoing
     notwithstanding, you may have specific legal rights which may vary from
     state/jurisdiction to state/jurisdiction; as far as legally permissible, you
     waive any such legal rights vis-à-vis us.
 
-15. We shall not under any circumstances be liable to you based on failure of
+16. We shall not under any circumstances be liable to you based on failure of
     the Licensed Software if the failure resulted from your changing of the
     Licensed Software, from your accident, abuse or misapplication, nor shall
     we except in case of gross negligence or willful misconduct be
@@ -188,7 +187,7 @@ The Licensed Software includes
     nor shall any award of damages exceed the total amount you paid to us in
     connection with this Agreement.
 
-16. Each Party shall hold Confidential Information of the other Party, its
+17. Each Party shall hold Confidential Information of the other Party, its
     customers, and licensors in confidence, and without written permission from
     will not disclose to any person or use for its own benefit, any such
     information. **Confidential Information** includes without limitation the
@@ -200,7 +199,7 @@ The Licensed Software includes
     licensors, or customers as proprietary or confidential, or which would
     reasonably be understood under the circumstances to be confidential. All
     Confidential Information shall remain the sole property of each respective
-    Party. Information will not be considered to be Confidential Information if
+    Party. Information will not be considered as Confidential Information if
 
     1. available to the public other than by a breach of this Agreement;
 
@@ -220,21 +219,20 @@ The Licensed Software includes
         remedies available, each Party shall be entitled to enforcement of such
         obligations by court injunction.
 
-17. During the Term, an independent, certified auditor on our behalf, may, upon
+18. During the Term, an independent, certified auditor on our behalf, may, upon
     its reasonable request, with 30 (thirty) days written notice, and at its
     sole expense, examine your books and records solely with respect to your use
     of the Licensed Software. Any such audit shall be conducted during regular
     business hours at your facilities and shall not unreasonably interfere with
     your business activities. Our auditor shall not remove, copy, or
-    redistribute any electronic material during the course of an audit. If an
-    audit reveals that you are using the Licensed Software in a way that is in
-    material violation of the terms of this Agreement, then you shall pay us
-    reasonable costs of conducting the audit. Our auditor shall only be allowed
-    to report violations of the terms of this Agreement, with a copy to you. You
-    shall be provided the right to provide comments to the report before it is
-    finalized.
-
-18. If you materially breach this Agreement, we will provide a 60 (sixty) days
+    redistribute any electronic material during an audit. If an audit reveals that
+    you are using the Licensed Software in a way that is in material violation
+    of the terms of this Agreement, then you shall pay us reasonable costs of
+    conducting the audit. Our auditor shall only be allowed to report violations
+    of the terms of this Agreement, with a copy to you. You shall be provided
+    the right to provide comments to the report before it is finalized.
+
+19. If you materially breach this Agreement, we will provide a 60 (sixty) days
     written notice to you during which any such breach(es) may be cured, failing
     which we will terminate the agreement. You undertake to pay a contractual
     penalty for each case of negligent breach of this Agreement of EUR 10000
@@ -243,32 +241,32 @@ The Licensed Software includes
     other claims. The amount of contractual penalty shall be offset against
     claims for damages, if any.
 
-19. You may terminate this Agreement at any time for any reason upon 90 (ninety)
+20. You may terminate this Agreement at any time for any reason upon 90 (ninety)
     days notice to us and upon payment of all applicable fees and contractual
     penalties, if any, in connection with the use of the Licensed Software.
 
-20. Both Parties shall comply with all applicable laws and regulations relating
+21. Both Parties shall comply with all applicable laws and regulations relating
     to the Licensed Software in the countries in which the Parties use or modify
     the Licensed Software.
 
-21. All notices and communications between the Parties shall be in writing and
+22. All notices and communications between the Parties shall be in writing and
     shall be deemed given when received. For avoidance of doubt, email is
     considered a written form of communication.
 
-22. This Agreement shall be construed, interpreted and governed by the laws of
+23. This Agreement shall be construed, interpreted, and governed by the laws of
     the Federal Republic of Germany.
 
-23. No term or condition contained in your purchase order will apply unless
+24. No term or condition contained in your purchase order will apply unless
     expressly accepted by us in writing.
 
-24. You may assign this Agreement, in whole or in part (whether by operation of
+25. You may assign this Agreement, in whole or in part (whether by operation of
     law or otherwise), with prior consent from us, which shall not be
     unreasonably withheld or delayed. We may assign this Agreement or any of its
     rights hereunder or delegate any of its obligations hereunder with prior
     notice to you. Any attempt to assign this Agreement other than in accordance
     with this provision shall be null and void.
 
-25. This Agreement constitutes the complete agreement between the Parties and
+26. This Agreement constitutes the complete agreement between the Parties and
     supersedes all prior or contemporaneous discussions, representations, and
     proposals, written or oral, with respect to the subject matters discussed
     herein. No modification of this Agreement will be effective unless contained

package/dist/index.d.ts

@@ -0,0 +1,172 @@
+/**
+ * @hidden
+ */
+declare function load_native_lib(): any;
+/**
+ * @hidden
+ */
+declare let native: any;
+/**
+ * @hidden
+ */
+declare class Component {
+    protected comp: any;
+    constructor(comp: any);
+    run(): void;
+    show(): void;
+    hide(): void;
+    get window(): SlintWindow;
+    send_mouse_click(x: number, y: number): void;
+    send_keyboard_string_sequence(s: String): void;
+}
+interface Point {
+    x: number;
+    y: number;
+}
+interface Size {
+    width: number;
+    height: number;
+}
+interface SlintWindow {
+    show(): void;
+    hide(): void;
+    is_visible: boolean;
+    logical_position: Point;
+    physical_position: Point;
+    logical_size: Size;
+    physical_size: Size;
+}
+/**
+ * @hidden
+ */
+declare class WindowAPI implements SlintWindow {
+    protected impl: any;
+    constructor(impl: any);
+    show(): void;
+    hide(): void;
+    get is_visible(): boolean;
+    get logical_position(): Point;
+    set logical_position(pos: Point);
+    get physical_position(): Point;
+    set physical_position(pos: Point);
+    get logical_size(): Size;
+    set logical_size(size: Size);
+    get physical_size(): Size;
+    set physical_size(size: Size);
+}
+/**
+ * @hidden
+ */
+interface Callback {
+    (): any;
+    setHandler(cb: any): void;
+}
+/**
+ * ModelPeer is the interface that the run-time implements. An instance is
+ * set on dynamic Model<T> instances and can be used to notify the run-time
+ * of changes in the structure or data of the model.
+ */
+interface ModelPeer {
+    /**
+     * Call this function from our own model to notify that fields of data
+     * in the specified row have changed.
+     * @argument row
+     */
+    rowDataChanged(row: number): void;
+    /**
+     * Call this function from your own model to notify that one or multiple
+     * rows were added to the model, starting at the specified row.
+     * @param row
+     * @param count
+     */
+    rowAdded(row: number, count: number): void;
+    /**
+     * Call this function from your own model to notify that one or multiple
+     * rows were removed from the model, starting at the specified row.
+     * @param row
+     * @param count
+     */
+    rowRemoved(row: number, count: number): void;
+    /**
+     * Call this function from your own model to notify that the model has been
+     * changed and everything must be reloaded
+     */
+    reset(): void;
+}
+/**
+ * Model<T> is the interface for feeding dynamic data into
+ * `.slint` views.
+ *
+ * A model is organized like a table with rows of data. The
+ * fields of the data type T behave like columns.
+ */
+interface Model<T> {
+    /**
+     * Implementations of this function must return the current number of rows.
+     */
+    rowCount(): number;
+    /**
+     * Implementations of this function must return the data at the specified row.
+     * @param row
+     */
+    rowData(row: number): T;
+    /**
+     * Implementations of this function must store the provided data parameter
+     * in the model at the specified row.
+     * @param row
+     * @param data
+     */
+    setRowData(row: number, data: T): void;
+    /**
+     * This public member is set by the run-time and implementation must use this
+     * to notify the run-time of changes in the model.
+     */
+    notify: ModelPeer;
+}
+/**
+ * @hidden
+ */
+declare class NullPeer implements ModelPeer {
+    rowDataChanged(row: number): void;
+    rowAdded(row: number, count: number): void;
+    rowRemoved(row: number, count: number): void;
+    reset(): void;
+}
+/**
+ * ArrayModel wraps a JavaScript array for use in `.slint` views. The underlying
+ * array can be modified with the [[ArrayModel.push]] and [[ArrayModel.remove]] methods.
+ */
+declare class ArrayModel<T> implements Model<T> {
+    /**
+     * @hidden
+     */
+    private a;
+    notify: ModelPeer;
+    /**
+     * Creates a new ArrayModel.
+     *
+     * @param arr
+     */
+    constructor(arr: Array<T>);
+    rowCount(): number;
+    rowData(row: number): T;
+    setRowData(row: number, data: T): void;
+    /**
+     * Pushes new values to the array that's backing the model and notifies
+     * the run-time about the added rows.
+     * @param values
+     */
+    push(...values: T[]): void;
+    /**
+     * Removes the specified number of element from the array that's backing
+     * the model, starting at the specified index. This is equivalent to calling
+     * Array.slice() on the array and notifying the run-time about the removed
+     * rows.
+     * @param index
+     * @param size
+     */
+    remove(index: number, size: number): void;
+    get length(): number;
+    values(): IterableIterator<T>;
+    entries(): IterableIterator<[number, T]>;
+}

package/dist/index.js

@@ -0,0 +1,184 @@
+"use strict";
+// Copyright © SixtyFPS GmbH <info@slint-ui.com>
+// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-commercial
+// Load the native library with `process.dlopen` instead of with `require`.
+// This is only done for autotest that do not require nom or neon_cli to
+// copy the lib to its right place
+/**
+ * @hidden
+ */
+function load_native_lib() {
+    const os = require('os');
+    process.dlopen(module, process.env.SLINT_NODE_NATIVE_LIB, os.constants.dlopen.RTLD_NOW);
+    return module.exports;
+}
+/**
+ * @hidden
+ */
+let native = !process.env.SLINT_NODE_NATIVE_LIB ? require('../native/index.node') : load_native_lib();
+/**
+ * @hidden
+ */
+class Component {
+    constructor(comp) {
+        this.comp = comp;
+    }
+    run() {
+        this.comp.run();
+    }
+    show() {
+        this.window.show();
+    }
+    hide() {
+        this.window.hide();
+    }
+    get window() {
+        return new WindowAPI(this.comp.window());
+    }
+    send_mouse_click(x, y) {
+        this.comp.send_mouse_click(x, y);
+    }
+    send_keyboard_string_sequence(s) {
+        this.comp.send_keyboard_string_sequence(s);
+    }
+}
+/**
+ * @hidden
+ */
+class WindowAPI {
+    constructor(impl) {
+        this.impl = impl;
+    }
+    show() {
+        this.impl.show();
+    }
+    hide() {
+        this.impl.hide();
+    }
+    get is_visible() {
+        return this.impl.get_is_visible();
+    }
+    get logical_position() {
+        return this.impl.get_logical_position();
+    }
+    set logical_position(pos) {
+        this.impl.set_logical_position(pos);
+    }
+    get physical_position() {
+        return this.impl.get_physical_position();
+    }
+    set physical_position(pos) {
+        this.impl.set_physical_position(pos);
+    }
+    get logical_size() {
+        return this.impl.get_logical_size();
+    }
+    set logical_size(size) {
+        this.impl.set_logical_size(size);
+    }
+    get physical_size() {
+        return this.impl.get_physical_size();
+    }
+    set physical_size(size) {
+        this.impl.set_physical_size(size);
+    }
+}
+require.extensions['.60'] = require.extensions['.slint'] =
+    function (module, filename) {
+        var c = native.load(filename);
+        module.exports[c.name().replace(/-/g, '_')] = function (init_properties) {
+            let comp = c.create(init_properties);
+            let ret = new Component(comp);
+            c.properties().forEach((x) => {
+                Object.defineProperty(ret, x.replace(/-/g, '_'), {
+                    get() { return comp.get_property(x); },
+                    set(newValue) { comp.set_property(x, newValue); },
+                    enumerable: true,
+                });
+            });
+            c.callbacks().forEach((x) => {
+                Object.defineProperty(ret, x.replace(/-/g, '_'), {
+                    get() {
+                        let callback = function () { return comp.invoke_callback(x, [...arguments]); };
+                        callback.setHandler = function (callback) { comp.connect_callback(x, callback); };
+                        return callback;
+                    },
+                    enumerable: true,
+                });
+            });
+            return ret;
+        };
+    };
+/**
+ * @hidden
+ */
+class NullPeer {
+    rowDataChanged(row) { }
+    rowAdded(row, count) { }
+    rowRemoved(row, count) { }
+    reset() { }
+}
+/**
+ * ArrayModel wraps a JavaScript array for use in `.slint` views. The underlying
+ * array can be modified with the [[ArrayModel.push]] and [[ArrayModel.remove]] methods.
+ */
+class ArrayModel {
+    /**
+     * Creates a new ArrayModel.
+     *
+     * @param arr
+     */
+    constructor(arr) {
+        this.a = arr;
+        this.notify = new NullPeer();
+    }
+    rowCount() {
+        return this.a.length;
+    }
+    rowData(row) {
+        return this.a[row];
+    }
+    setRowData(row, data) {
+        this.a[row] = data;
+        this.notify.rowDataChanged(row);
+    }
+    /**
+     * Pushes new values to the array that's backing the model and notifies
+     * the run-time about the added rows.
+     * @param values
+     */
+    push(...values) {
+        let size = this.a.length;
+        Array.prototype.push.apply(this.a, values);
+        this.notify.rowAdded(size, arguments.length);
+    }
+    // FIXME: should this be named splice and have the splice api?
+    /**
+     * Removes the specified number of element from the array that's backing
+     * the model, starting at the specified index. This is equivalent to calling
+     * Array.slice() on the array and notifying the run-time about the removed
+     * rows.
+     * @param index
+     * @param size
+     */
+    remove(index, size) {
+        let r = this.a.splice(index, size);
+        this.notify.rowRemoved(index, size);
+    }
+    get length() {
+        return this.a.length;
+    }
+    values() {
+        return this.a.values();
+    }
+    entries() {
+        return this.a.entries();
+    }
+}
+module.exports = {
+    private_api: native,
+    ArrayModel: ArrayModel,
+    Timer: {
+        singleShot: native.singleshot_timer,
+    },
+};

package/native/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "slint-node"
-version = "0.3.2"
+version = "0.3.4"
 authors = ["Slint Developers <info@slint-ui.com>"]
 edition = "2021"
 build = "build.rs"
@@ -20,9 +20,9 @@ crate-type = ["cdylib"]
 name = "slint_node_native"
 
 [dependencies]
-i-slint-compiler = { version = "=0.3.2"}
-i-slint-core = { version = "=0.3.2"}
-slint-interpreter = { version = "=0.3.2",  features = ["display-diagnostics"] }
+i-slint-compiler = { version = "=0.3.4"}
+i-slint-core = { version = "=0.3.4"}
+slint-interpreter = { version = "=0.3.4",  features = ["display-diagnostics"] }
 
 vtable = { version = "0.1.6"}
 

package/native/lib.rs

@@ -422,7 +422,7 @@ declare_types! {
             };
 
             let res = run_scoped(&mut cx,this.downcast().unwrap(), || {
-                component.invoke_callback(callback_name.as_str(), args.as_slice())
+                component.invoke(callback_name.as_str(), args.as_slice())
                     .map_err(|_| "Cannot emit callback".to_string())
             })?;
             to_js_value(res, &mut cx, &persistent_context)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "slint-ui",
-    "version": "0.3.2",
+    "version": "0.3.4",
     "homepage": "https://github.com/slint-ui/slint",
     "license": "SEE LICENSE IN LICENSE.md",
     "repository": {