@gtkx/ffi 0.6.1 → 0.7.0

package/dist/generated/gtk/no-selection.js

@@ -1,5 +1,6 @@
-import { call, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, getObject, getBoxed, getInterface, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
+import * as Gio from "../gio/index.js";
 /**
  * A selection model that does not allow selecting anything.
  *
@@ -45,7 +46,7 @@ export class NoSelection extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, Gio.ListModel);
     }
     /**
      * Sets the model that `self` should wrap.
@@ -66,6 +67,114 @@ export class NoSelection extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the type of the items in @list.
+     *
+     * All items returned from g_list_model_get_item() are of the type
+     * returned by this function, or a subtype, or if the type is an
+     * interface, they are an implementation of that interface.
+     *
+     * The item type of a #GListModel can not change during the life of the
+     * model.
+     */
+    getItemType() {
+        return call("libgtk-4.so.1", "g_list_model_get_item_type", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "int", size: 64, unsigned: true });
+    }
+    /**
+     * Gets the number of items in @list.
+     *
+     * Depending on the model implementation, calling this function may be
+     * less efficient than iterating the list with increasing values for
+     * `position` until g_list_model_get_item() returns %NULL.
+     */
+    getNItems() {
+        return call("libgtk-4.so.1", "g_list_model_get_n_items", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "int", size: 32, unsigned: true });
+    }
+    /**
+     * Get the item at @position.
+     *
+     * If `position` is greater than the number of items in @list, %NULL is
+     * returned.
+     *
+     * %NULL is never returned for an index that is smaller than the length
+     * of the list.
+     *
+     * This function is meant to be used by language bindings in place
+     * of g_list_model_get_item().
+     *
+     * See also: g_list_model_get_n_items()
+     * @param position - the position of the item to fetch
+     */
+    getObject(position) {
+        const ptr = call("libgtk-4.so.1", "g_list_model_get_object", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "int", size: 32, unsigned: true },
+                value: position,
+            },
+        ], { type: "gobject", borrowed: true });
+        if (ptr === null)
+            return null;
+        return getObject(ptr);
+    }
+    /**
+     * Emits the #GListModel::items-changed signal on @list.
+     *
+     * This function should only be called by classes implementing
+     * #GListModel. It has to be called after the internal representation
+     * of `list` has been updated, because handlers connected to this signal
+     * might query the new state of the list.
+     *
+     * Implementations must only make changes to the model (as visible to
+     * its consumer) in places that will not cause problems for that
+     * consumer.  For models that are driven directly by a write API (such
+     * as #GListStore), changes can be reported in response to uses of that
+     * API.  For models that represent remote data, changes should only be
+     * made from a fresh mainloop dispatch.  It is particularly not
+     * permitted to make changes in response to a call to the #GListModel
+     * consumer API.
+     *
+     * Stated another way: in general, it is assumed that code making a
+     * series of accesses to the model via the API, without returning to the
+     * mainloop, and without calling other code, will continue to view the
+     * same contents of the model.
+     * @param position - the position at which `list` changed
+     * @param removed - the number of items removed
+     * @param added - the number of items added
+     */
+    itemsChanged(position, removed, added) {
+        call("libgtk-4.so.1", "g_list_model_items_changed", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "int", size: 32, unsigned: true },
+                value: position,
+            },
+            {
+                type: { type: "int", size: 32, unsigned: true },
+                value: removed,
+            },
+            {
+                type: { type: "int", size: 32, unsigned: true },
+                value: added,
+            },
+        ], { type: "undefined" });
+    }
     /**
      * Query the section that covers the given position. The number of
      * items in the section can be computed by `out_end - out_start`.
@@ -156,7 +265,7 @@ export class NoSelection extends GObject.GObject {
             innerType: "GtkBitset",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GtkBitset");
     }
     /**
      * Gets the set of selected items in a range.
@@ -189,7 +298,7 @@ export class NoSelection extends GObject.GObject {
             innerType: "GtkBitset",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GtkBitset");
     }
     /**
      * Checks if the given item is selected.

package/dist/generated/gtk/notebook.js

@@ -1,5 +1,6 @@
-import { call, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, getObject, getInterface, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
 import { Tooltip } from "./tooltip.js";
+import * as Gio from "../gio/index.js";
 import { Widget } from "./widget.js";
 /**
  * Switches between children using tabs.
@@ -447,7 +448,7 @@ export class Notebook extends Widget {
                 value: this.id,
             },
         ], { type: "gobject", borrowed: true });
-        return getObject(ptr);
+        return getInterface(ptr, Gio.ListModel);
     }
     /**
      * Returns whether the tab label area has arrows for scrolling.

package/dist/generated/gtk/page-setup.js

@@ -1,4 +1,4 @@
-import { call, NativeError, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, NativeError, getObject, getBoxed, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
 /**
  * Stores page size, orientation and margins for printing.
@@ -74,12 +74,27 @@ export class PageSetup extends GObject.GObject {
      * @param fileName - the filename to read the page setup from
      */
     static setupNewFromFile(fileName) {
+        const error = { value: null };
         const ptr = call("libgtk-4.so.1", "gtk_page_setup_new_from_file", [
             {
                 type: { type: "string" },
                 value: fileName,
             },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "boxed",
+                        innerType: "GError",
+                        lib: "libglib-2.0.so.0",
+                    },
+                },
+                value: error,
+            },
         ], { type: "gobject", borrowed: false });
+        if (error.value !== null) {
+            throw new NativeError(error.value);
+        }
         return getObject(ptr);
     }
     /**
@@ -113,6 +128,7 @@ export class PageSetup extends GObject.GObject {
      * @param groupName - the name of the group in the key_file to read
      */
     static setupNewFromKeyFile(keyFile, groupName) {
+        const error = { value: null };
         const ptr = call("libgtk-4.so.1", "gtk_page_setup_new_from_key_file", [
             {
                 type: {
@@ -128,7 +144,21 @@ export class PageSetup extends GObject.GObject {
                 value: groupName,
                 optional: true,
             },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "boxed",
+                        innerType: "GError",
+                        lib: "libglib-2.0.so.0",
+                    },
+                },
+                value: error,
+            },
         ], { type: "gobject", borrowed: false });
+        if (error.value !== null) {
+            throw new NativeError(error.value);
+        }
         return getObject(ptr);
     }
     /**
@@ -261,7 +291,7 @@ export class PageSetup extends GObject.GObject {
             innerType: "GtkPaperSize",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GtkPaperSize");
     }
     /**
      * Returns the paper width in units of @unit.
@@ -586,7 +616,7 @@ export class PageSetup extends GObject.GObject {
             innerType: "GVariant",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GVariant");
     }
     /**
      * This function adds the page setup from `setup` to @key_file.

package/dist/generated/gtk/paper-size.js

@@ -1,4 +1,4 @@
-import { call, getObject, registerType } from "@gtkx/ffi";
+import { call, getObject, getBoxed, registerType } from "@gtkx/ffi";
 /**
  * `GtkPaperSize` handles paper sizes.
  *
@@ -221,7 +221,7 @@ export class PaperSize {
             innerType: "GtkPaperSize",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GtkPaperSize");
     }
     /**
      * Free the given `GtkPaperSize` object.
@@ -525,7 +525,7 @@ export class PaperSize {
             innerType: "GVariant",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GVariant");
     }
     /**
      * This function adds the paper size from `size` to @key_file.

package/dist/generated/gtk/password-entry.js

@@ -1,4 +1,5 @@
-import { call, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, getObject, getInterface, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { Editable } from "./editable.js";
 import { Tooltip } from "./tooltip.js";
 import { Widget } from "./widget.js";
 /**
@@ -314,7 +315,7 @@ export class PasswordEntry extends Widget {
         ], { type: "gobject", borrowed: true });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, Editable);
     }
     /**
      * Retrieves whether `editable` is editable.

package/dist/generated/gtk/picture.js

@@ -1,5 +1,7 @@
-import { call, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, getObject, getInterface, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
 import { Tooltip } from "./tooltip.js";
+import * as Gdk from "../gdk/index.js";
+import * as Gio from "../gio/index.js";
 import { Widget } from "./widget.js";
 /**
  * Displays a `GdkPaintable`.
@@ -251,7 +253,7 @@ export class Picture extends Widget {
         ], { type: "gobject", borrowed: true });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, Gio.File);
     }
     /**
      * Returns whether the `GtkPicture` preserves its contents aspect ratio.
@@ -276,7 +278,7 @@ export class Picture extends Widget {
         ], { type: "gobject", borrowed: true });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, Gdk.Paintable);
     }
     /**
      * Sets an alternative textual description for the picture contents.

package/dist/generated/gtk/print-context.js

@@ -1,4 +1,4 @@
-import { call, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, getObject, getBoxed, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
 /**
  * Encapsulates context information that is required when
@@ -136,7 +136,7 @@ export class PrintContext extends GObject.GObject {
             innerType: "CairoContext",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "CairoContext");
     }
     /**
      * Obtains the horizontal resolution of the `GtkPrintContext`,

package/dist/generated/gtk/print-dialog.js

@@ -1,4 +1,4 @@
-import { call, NativeError, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, NativeError, getObject, getBoxed, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
 /**
  * Asynchronous API to present a print dialog to the user.
@@ -283,7 +283,7 @@ export class PrintDialog extends GObject.GObject {
                     if (error.value !== null) {
                         throw new NativeError(error.value);
                     }
-                    resolve(getObject(ptr));
+                    resolve(getBoxed(ptr, "GtkPrintSetup"));
                 }
                 catch (err) {
                     reject(err);

package/dist/generated/gtk/print-job.js

@@ -1,4 +1,4 @@
-import { call, NativeError, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, NativeError, getObject, getBoxed, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
 /**
  * Represents a job that is sent to a printer.
@@ -238,7 +238,7 @@ export class PrintJob extends GObject.GObject {
         if (error.value !== null) {
             throw new NativeError(error.value);
         }
-        return getObject(ptr);
+        return getBoxed(ptr, "CairoSurface");
     }
     /**
      * Gets the job title.

package/dist/generated/gtk/print-settings.js

@@ -1,4 +1,4 @@
-import { call, NativeError, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, NativeError, getObject, getBoxed, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
 /**
  * Collects the settings of a print dialog in a system-independent way.
@@ -45,12 +45,27 @@ export class PrintSettings extends GObject.GObject {
      * @param fileName - the filename to read the settings from
      */
     static settingsNewFromFile(fileName) {
+        const error = { value: null };
         const ptr = call("libgtk-4.so.1", "gtk_print_settings_new_from_file", [
             {
                 type: { type: "string" },
                 value: fileName,
             },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "boxed",
+                        innerType: "GError",
+                        lib: "libglib-2.0.so.0",
+                    },
+                },
+                value: error,
+            },
         ], { type: "gobject", borrowed: false });
+        if (error.value !== null) {
+            throw new NativeError(error.value);
+        }
         return getObject(ptr);
     }
     /**
@@ -84,6 +99,7 @@ export class PrintSettings extends GObject.GObject {
      * @param groupName - the name of the group to use, or %NULL to use
      */
     static settingsNewFromKeyFile(keyFile, groupName) {
+        const error = { value: null };
         const ptr = call("libgtk-4.so.1", "gtk_print_settings_new_from_key_file", [
             {
                 type: {
@@ -99,7 +115,21 @@ export class PrintSettings extends GObject.GObject {
                 value: groupName,
                 optional: true,
             },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "boxed",
+                        innerType: "GError",
+                        lib: "libglib-2.0.so.0",
+                    },
+                },
+                value: error,
+            },
         ], { type: "gobject", borrowed: false });
+        if (error.value !== null) {
+            throw new NativeError(error.value);
+        }
         return getObject(ptr);
     }
     /**
@@ -463,7 +493,7 @@ export class PrintSettings extends GObject.GObject {
         });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getBoxed(ptr, "GtkPaperSize");
     }
     /**
      * Gets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH,
@@ -1290,7 +1320,7 @@ export class PrintSettings extends GObject.GObject {
             innerType: "GVariant",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GVariant");
     }
     /**
      * This function adds the print settings from `settings` to @key_file.

package/dist/generated/gtk/print-setup.js

@@ -1,4 +1,4 @@
-import { call, getObject, registerType } from "@gtkx/ffi";
+import { call, getObject, getBoxed, registerType } from "@gtkx/ffi";
 /**
  * An auxiliary object for printing that allows decoupling the setup from the printing.
  *
@@ -79,7 +79,7 @@ export class PrintSetup {
             innerType: "GtkPrintSetup",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GtkPrintSetup");
     }
     /**
      * Decrease the reference count of @setup.

package/dist/generated/gtk/recent-info.js

@@ -1,4 +1,5 @@
-import { call, NativeError, getObject, registerType } from "@gtkx/ffi";
+import { call, NativeError, getBoxed, getInterface, registerType, } from "@gtkx/ffi";
+import * as Gio from "../gio/index.js";
 /**
  * Contains the metadata associated with an item in the
  * recently used files list.
@@ -53,7 +54,7 @@ export class RecentInfo {
         }
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, Gio.AppInfo);
     }
     /**
      * Checks whether the resource pointed by `info` still exists.
@@ -94,7 +95,7 @@ export class RecentInfo {
             innerType: "GDateTime",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GDateTime");
     }
     /**
      * Gets the number of days elapsed since the last update
@@ -162,7 +163,7 @@ export class RecentInfo {
                 value: stamp,
             },
         ], { type: "boolean" });
-        stamp.value = getObject(stamp.value);
+        stamp.value = getBoxed(stamp.value, "GDateTime");
         return result;
     }
     /**
@@ -242,7 +243,7 @@ export class RecentInfo {
         ], { type: "gobject", borrowed: true });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, Gio.Icon);
     }
     /**
      * Returns all groups registered for the recently used item @info.
@@ -309,7 +310,7 @@ export class RecentInfo {
             innerType: "GDateTime",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GDateTime");
     }
     /**
      * Gets the value of the “private” flag.
@@ -408,7 +409,7 @@ export class RecentInfo {
             innerType: "GDateTime",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GDateTime");
     }
     /**
      * Checks whether an application registered this resource using @app_name.
@@ -533,7 +534,7 @@ export class RecentInfo {
             innerType: "GtkRecentInfo",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GtkRecentInfo");
     }
     /**
      * Decreases the reference count of `info` by one.

package/dist/generated/gtk/recent-manager.js

@@ -1,4 +1,4 @@
-import { call, NativeError, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, NativeError, getObject, getBoxed, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
 /**
  * Manages and looks up recently used files.
@@ -241,7 +241,7 @@ export class RecentManager extends GObject.GObject {
         }
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getBoxed(ptr, "GtkRecentInfo");
     }
     /**
      * Changes the location of a recently used resource from `uri` to @new_uri.

package/dist/generated/gtk/requisition.js

@@ -1,5 +1,5 @@
 import { read, write } from "@gtkx/native";
-import { call, getObject, registerType } from "@gtkx/ffi";
+import { call, getBoxed, registerType } from "@gtkx/ffi";
 /**
  * Represents the desired size of a widget.
  *
@@ -44,7 +44,7 @@ export class Requisition {
             innerType: "GtkRequisition",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GtkRequisition");
     }
     /**
      * Frees a `GtkRequisition`.

package/dist/generated/gtk/scroll-info.js

@@ -1,4 +1,4 @@
-import { call, getObject, registerType } from "@gtkx/ffi";
+import { call, getBoxed, registerType } from "@gtkx/ffi";
 /**
  * Provides detailed information on how a scroll operation should be performed.
  *
@@ -73,7 +73,7 @@ export class ScrollInfo {
             innerType: "GtkScrollInfo",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GtkScrollInfo");
     }
     /**
      * Turns horizontal scrolling on or off.

package/dist/generated/gtk/search-entry.js

@@ -1,4 +1,5 @@
-import { call, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, getObject, getInterface, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { Editable } from "./editable.js";
 import { Tooltip } from "./tooltip.js";
 import { Widget } from "./widget.js";
 /**
@@ -434,7 +435,7 @@ export class SearchEntry extends Widget {
         ], { type: "gobject", borrowed: true });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, Editable);
     }
     /**
      * Retrieves whether `editable` is editable.

package/dist/generated/gtk/selection-filter-model.d.ts

@@ -23,6 +23,67 @@ export declare class SelectionFilterModel extends GObject.GObject {
      * @param model - The model to be filtered
      */
     setModel(model?: SelectionModel | null): void;
+    /**
+     * Gets the type of the items in @list.
+     *
+     * All items returned from g_list_model_get_item() are of the type
+     * returned by this function, or a subtype, or if the type is an
+     * interface, they are an implementation of that interface.
+     *
+     * The item type of a #GListModel can not change during the life of the
+     * model.
+     */
+    getItemType(): number;
+    /**
+     * Gets the number of items in @list.
+     *
+     * Depending on the model implementation, calling this function may be
+     * less efficient than iterating the list with increasing values for
+     * `position` until g_list_model_get_item() returns %NULL.
+     */
+    getNItems(): number;
+    /**
+     * Get the item at @position.
+     *
+     * If `position` is greater than the number of items in @list, %NULL is
+     * returned.
+     *
+     * %NULL is never returned for an index that is smaller than the length
+     * of the list.
+     *
+     * This function is meant to be used by language bindings in place
+     * of g_list_model_get_item().
+     *
+     * See also: g_list_model_get_n_items()
+     * @param position - the position of the item to fetch
+     */
+    getObject(position: number): GObject.GObject | null;
+    /**
+     * Emits the #GListModel::items-changed signal on @list.
+     *
+     * This function should only be called by classes implementing
+     * #GListModel. It has to be called after the internal representation
+     * of `list` has been updated, because handlers connected to this signal
+     * might query the new state of the list.
+     *
+     * Implementations must only make changes to the model (as visible to
+     * its consumer) in places that will not cause problems for that
+     * consumer.  For models that are driven directly by a write API (such
+     * as #GListStore), changes can be reported in response to uses of that
+     * API.  For models that represent remote data, changes should only be
+     * made from a fresh mainloop dispatch.  It is particularly not
+     * permitted to make changes in response to a call to the #GListModel
+     * consumer API.
+     *
+     * Stated another way: in general, it is assumed that code making a
+     * series of accesses to the model via the API, without returning to the
+     * mainloop, and without calling other code, will continue to view the
+     * same contents of the model.
+     * @param position - the position at which `list` changed
+     * @param removed - the number of items removed
+     * @param added - the number of items added
+     */
+    itemsChanged(position: number, removed: number, added: number): void;
     connect(signal: "notify", handler: (self: SelectionFilterModel, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;
 }