@gtkx/ffi 0.6.1 → 0.7.0

package/dist/generated/gtk/icon-paintable.d.ts

@@ -1,3 +1,5 @@
+import { Ref } from "@gtkx/native";
+import { Snapshot } from "./snapshot.js";
 import * as GObject from "../gobject/index.js";
 import * as Gdk from "../gdk/index.js";
 import * as Gio from "../gio/index.js";
@@ -43,6 +45,124 @@ export declare class IconPaintable extends GObject.GObject {
      * for determining this. This behaviour may change in the future.
      */
     isSymbolic(): boolean;
+    /**
+     * Compute a concrete size for the `GdkPaintable`.
+     *
+     * Applies the sizing algorithm outlined in the
+     * [CSS Image spec](https://drafts.csswg.org/css-images-3/#default-sizing)
+     * to the given @paintable. See that link for more details.
+     *
+     * It is not necessary to call this function when both `specified_width` and `specified_height` are known, but it is useful to call this
+     * function in GtkWidget:measure implementations to compute the
+     * other dimension when only one dimension is given.
+     * @param specifiedWidth - the width `paintable` could be drawn into or
+     * @param specifiedHeight - the height `paintable` could be drawn into or
+     * @param defaultWidth - the width `paintable` would be drawn into if
+     * @param defaultHeight - the height `paintable` would be drawn into if
+     * @param concreteWidth - will be set to the concrete width computed
+     * @param concreteHeight - will be set to the concrete height computed
+     */
+    computeConcreteSize(specifiedWidth: number, specifiedHeight: number, defaultWidth: number, defaultHeight: number, concreteWidth: Ref<number>, concreteHeight: Ref<number>): void;
+    /**
+     * Gets an immutable paintable for the current contents displayed by @paintable.
+     *
+     * This is useful when you want to retain the current state of an animation,
+     * for example to take a screenshot of a running animation.
+     *
+     * If the `paintable` is already immutable, it will return itself.
+     */
+    getCurrentImage(): Gdk.Paintable;
+    /**
+     * Get flags for the paintable.
+     *
+     * This is oftentimes useful for optimizations.
+     *
+     * See [flags@Gdk.PaintableFlags] for the flags and what they mean.
+     */
+    getFlags(): Gdk.PaintableFlags;
+    /**
+     * Gets the preferred aspect ratio the `paintable` would like to be displayed at.
+     *
+     * The aspect ratio is the width divided by the height, so a value of 0.5
+     * means that the `paintable` prefers to be displayed twice as high as it
+     * is wide. Consumers of this interface can use this to preserve aspect
+     * ratio when displaying the paintable.
+     *
+     * This is a purely informational value and does not in any way limit the
+     * values that may be passed to [method@Gdk.Paintable.snapshot].
+     *
+     * Usually when a `paintable` returns nonzero values from
+     * [method@Gdk.Paintable.get_intrinsic_width] and
+     * [method@Gdk.Paintable.get_intrinsic_height] the aspect ratio
+     * should conform to those values, though that is not required.
+     *
+     * If the `paintable` does not have a preferred aspect ratio,
+     * it returns 0. Negative values are never returned.
+     */
+    getIntrinsicAspectRatio(): number;
+    /**
+     * Gets the preferred height the `paintable` would like to be displayed at.
+     *
+     * Consumers of this interface can use this to reserve enough space to draw
+     * the paintable.
+     *
+     * This is a purely informational value and does not in any way limit the
+     * values that may be passed to [method@Gdk.Paintable.snapshot].
+     *
+     * If the `paintable` does not have a preferred height, it returns 0.
+     * Negative values are never returned.
+     */
+    getIntrinsicHeight(): number;
+    /**
+     * Gets the preferred width the `paintable` would like to be displayed at.
+     *
+     * Consumers of this interface can use this to reserve enough space to draw
+     * the paintable.
+     *
+     * This is a purely informational value and does not in any way limit the
+     * values that may be passed to [method@Gdk.Paintable.snapshot].
+     *
+     * If the `paintable` does not have a preferred width, it returns 0.
+     * Negative values are never returned.
+     */
+    getIntrinsicWidth(): number;
+    /**
+     * Called by implementations of `GdkPaintable` to invalidate their contents.
+     *
+     * Unless the contents are invalidated, implementations must guarantee that
+     * multiple calls of [method@Gdk.Paintable.snapshot] produce the same output.
+     *
+     * This function will emit the [signal@Gdk.Paintable::invalidate-contents]
+     * signal.
+     *
+     * If a `paintable` reports the %GDK_PAINTABLE_STATIC_CONTENTS flag,
+     * it must not call this function.
+     */
+    invalidateContents(): void;
+    /**
+     * Called by implementations of `GdkPaintable` to invalidate their size.
+     *
+     * As long as the size is not invalidated, `paintable` must return the same
+     * values for its intrinsic width, height and aspect ratio.
+     *
+     * This function will emit the [signal@Gdk.Paintable::invalidate-size]
+     * signal.
+     *
+     * If a `paintable` reports the %GDK_PAINTABLE_STATIC_SIZE flag,
+     * it must not call this function.
+     */
+    invalidateSize(): void;
+    /**
+     * Snapshots the given paintable with the given `width` and @height.
+     *
+     * The paintable is drawn at the current (0,0) offset of the @snapshot.
+     * If `width` and `height` are not larger than zero, this function will
+     * do nothing.
+     * @param snapshot - a `GdkSnapshot` to snapshot to
+     * @param width - width to snapshot in
+     * @param height - height to snapshot in
+     */
+    snapshot(snapshot: Snapshot, width: number, height: number): void;
     /**
      * Snapshots the paintable with the given colors.
      *

package/dist/generated/gtk/icon-paintable.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 * as GObject from "../gobject/index.js";
+import * as Gdk from "../gdk/index.js";
+import * as Gio from "../gio/index.js";
 /**
  * Contains information found when looking up an icon in `GtkIconTheme`
  * or loading it from a file.
@@ -56,7 +58,7 @@ export class IconPaintable extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, Gio.File);
     }
     /**
      * Get the icon name being used for this icon.
@@ -91,6 +93,224 @@ export class IconPaintable extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Compute a concrete size for the `GdkPaintable`.
+     *
+     * Applies the sizing algorithm outlined in the
+     * [CSS Image spec](https://drafts.csswg.org/css-images-3/#default-sizing)
+     * to the given @paintable. See that link for more details.
+     *
+     * It is not necessary to call this function when both `specified_width` and `specified_height` are known, but it is useful to call this
+     * function in GtkWidget:measure implementations to compute the
+     * other dimension when only one dimension is given.
+     * @param specifiedWidth - the width `paintable` could be drawn into or
+     * @param specifiedHeight - the height `paintable` could be drawn into or
+     * @param defaultWidth - the width `paintable` would be drawn into if
+     * @param defaultHeight - the height `paintable` would be drawn into if
+     * @param concreteWidth - will be set to the concrete width computed
+     * @param concreteHeight - will be set to the concrete height computed
+     */
+    computeConcreteSize(specifiedWidth, specifiedHeight, defaultWidth, defaultHeight, concreteWidth, concreteHeight) {
+        call("libgtk-4.so.1", "gdk_paintable_compute_concrete_size", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "float", size: 64 },
+                value: specifiedWidth,
+            },
+            {
+                type: { type: "float", size: 64 },
+                value: specifiedHeight,
+            },
+            {
+                type: { type: "float", size: 64 },
+                value: defaultWidth,
+            },
+            {
+                type: { type: "float", size: 64 },
+                value: defaultHeight,
+            },
+            {
+                type: { type: "ref", innerType: { type: "float", size: 64 } },
+                value: concreteWidth,
+            },
+            {
+                type: { type: "ref", innerType: { type: "float", size: 64 } },
+                value: concreteHeight,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Gets an immutable paintable for the current contents displayed by @paintable.
+     *
+     * This is useful when you want to retain the current state of an animation,
+     * for example to take a screenshot of a running animation.
+     *
+     * If the `paintable` is already immutable, it will return itself.
+     */
+    getCurrentImage() {
+        const ptr = call("libgtk-4.so.1", "gdk_paintable_get_current_image", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "gobject", borrowed: true });
+        return getInterface(ptr, Gdk.Paintable);
+    }
+    /**
+     * Get flags for the paintable.
+     *
+     * This is oftentimes useful for optimizations.
+     *
+     * See [flags@Gdk.PaintableFlags] for the flags and what they mean.
+     */
+    getFlags() {
+        return call("libgtk-4.so.1", "gdk_paintable_get_flags", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "int", size: 32, unsigned: false });
+    }
+    /**
+     * Gets the preferred aspect ratio the `paintable` would like to be displayed at.
+     *
+     * The aspect ratio is the width divided by the height, so a value of 0.5
+     * means that the `paintable` prefers to be displayed twice as high as it
+     * is wide. Consumers of this interface can use this to preserve aspect
+     * ratio when displaying the paintable.
+     *
+     * This is a purely informational value and does not in any way limit the
+     * values that may be passed to [method@Gdk.Paintable.snapshot].
+     *
+     * Usually when a `paintable` returns nonzero values from
+     * [method@Gdk.Paintable.get_intrinsic_width] and
+     * [method@Gdk.Paintable.get_intrinsic_height] the aspect ratio
+     * should conform to those values, though that is not required.
+     *
+     * If the `paintable` does not have a preferred aspect ratio,
+     * it returns 0. Negative values are never returned.
+     */
+    getIntrinsicAspectRatio() {
+        return call("libgtk-4.so.1", "gdk_paintable_get_intrinsic_aspect_ratio", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "float", size: 64 });
+    }
+    /**
+     * Gets the preferred height the `paintable` would like to be displayed at.
+     *
+     * Consumers of this interface can use this to reserve enough space to draw
+     * the paintable.
+     *
+     * This is a purely informational value and does not in any way limit the
+     * values that may be passed to [method@Gdk.Paintable.snapshot].
+     *
+     * If the `paintable` does not have a preferred height, it returns 0.
+     * Negative values are never returned.
+     */
+    getIntrinsicHeight() {
+        return call("libgtk-4.so.1", "gdk_paintable_get_intrinsic_height", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "int", size: 32, unsigned: false });
+    }
+    /**
+     * Gets the preferred width the `paintable` would like to be displayed at.
+     *
+     * Consumers of this interface can use this to reserve enough space to draw
+     * the paintable.
+     *
+     * This is a purely informational value and does not in any way limit the
+     * values that may be passed to [method@Gdk.Paintable.snapshot].
+     *
+     * If the `paintable` does not have a preferred width, it returns 0.
+     * Negative values are never returned.
+     */
+    getIntrinsicWidth() {
+        return call("libgtk-4.so.1", "gdk_paintable_get_intrinsic_width", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "int", size: 32, unsigned: false });
+    }
+    /**
+     * Called by implementations of `GdkPaintable` to invalidate their contents.
+     *
+     * Unless the contents are invalidated, implementations must guarantee that
+     * multiple calls of [method@Gdk.Paintable.snapshot] produce the same output.
+     *
+     * This function will emit the [signal@Gdk.Paintable::invalidate-contents]
+     * signal.
+     *
+     * If a `paintable` reports the %GDK_PAINTABLE_STATIC_CONTENTS flag,
+     * it must not call this function.
+     */
+    invalidateContents() {
+        call("libgtk-4.so.1", "gdk_paintable_invalidate_contents", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Called by implementations of `GdkPaintable` to invalidate their size.
+     *
+     * As long as the size is not invalidated, `paintable` must return the same
+     * values for its intrinsic width, height and aspect ratio.
+     *
+     * This function will emit the [signal@Gdk.Paintable::invalidate-size]
+     * signal.
+     *
+     * If a `paintable` reports the %GDK_PAINTABLE_STATIC_SIZE flag,
+     * it must not call this function.
+     */
+    invalidateSize() {
+        call("libgtk-4.so.1", "gdk_paintable_invalidate_size", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Snapshots the given paintable with the given `width` and @height.
+     *
+     * The paintable is drawn at the current (0,0) offset of the @snapshot.
+     * If `width` and `height` are not larger than zero, this function will
+     * do nothing.
+     * @param snapshot - a `GdkSnapshot` to snapshot to
+     * @param width - width to snapshot in
+     * @param height - height to snapshot in
+     */
+    snapshot(snapshot, width, height) {
+        call("libgtk-4.so.1", "gdk_paintable_snapshot", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "gobject", borrowed: true },
+                value: snapshot?.id ?? snapshot,
+            },
+            {
+                type: { type: "float", size: 64 },
+                value: width,
+            },
+            {
+                type: { type: "float", size: 64 },
+                value: height,
+            },
+        ], { type: "undefined" });
+    }
     /**
      * Snapshots the paintable with the given colors.
      *

package/dist/generated/gtk/icon-view.js

@@ -1,5 +1,7 @@
-import { call, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, getObject, getBoxed, getInterface, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { TreeModel } from "./tree-model.js";
 import { Tooltip } from "./tooltip.js";
+import * as Gdk from "../gdk/index.js";
 import { Widget } from "./widget.js";
 /**
  * `GtkIconView` is a widget which displays data in a grid of icons.
@@ -158,7 +160,7 @@ export class IconView extends Widget {
         ], { type: "gobject", borrowed: true });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, Gdk.Paintable);
     }
     /**
      * Turns `icon_view` into a drop destination for automatic DND. Calling this
@@ -326,7 +328,7 @@ export class IconView extends Widget {
             },
         ], { type: "boolean" });
         if (path)
-            path.value = getObject(path.value);
+            path.value = getBoxed(path.value, "GtkTreePath");
         if (cell)
             cell.value = getObject(cell.value);
         return result;
@@ -374,7 +376,7 @@ export class IconView extends Widget {
             },
         ], { type: "boolean" });
         if (path)
-            path.value = getObject(path.value);
+            path.value = getBoxed(path.value, "GtkTreePath");
         return result;
     }
     /**
@@ -410,7 +412,7 @@ export class IconView extends Widget {
             },
         ], { type: "undefined" });
         if (path)
-            path.value = getObject(path.value);
+            path.value = getBoxed(path.value, "GtkTreePath");
     }
     /**
      * Gets the path and cell for the icon at the given position.
@@ -452,7 +454,7 @@ export class IconView extends Widget {
             },
         ], { type: "boolean" });
         if (path)
-            path.value = getObject(path.value);
+            path.value = getBoxed(path.value, "GtkTreePath");
         if (cell)
             cell.value = getObject(cell.value);
         return result;
@@ -570,7 +572,7 @@ export class IconView extends Widget {
         ], { type: "gobject", borrowed: true });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, TreeModel);
     }
     /**
      * Gets the path for the icon at the given position.
@@ -599,7 +601,7 @@ export class IconView extends Widget {
         });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getBoxed(ptr, "GtkTreePath");
     }
     /**
      * Returns the column with pixbufs for @icon_view.
@@ -783,7 +785,7 @@ export class IconView extends Widget {
         if (model)
             model.value = getObject(model.value);
         if (path)
-            path.value = getObject(path.value);
+            path.value = getBoxed(path.value, "GtkTreePath");
         return result;
     }
     /**
@@ -826,9 +828,9 @@ export class IconView extends Widget {
             },
         ], { type: "boolean" });
         if (startPath)
-            startPath.value = getObject(startPath.value);
+            startPath.value = getBoxed(startPath.value, "GtkTreePath");
         if (endPath)
-            endPath.value = getObject(endPath.value);
+            endPath.value = getBoxed(endPath.value, "GtkTreePath");
         return result;
     }
     /**

package/dist/generated/gtk/image.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 an image.
@@ -267,7 +269,7 @@ export class Image extends Widget {
         ], { type: "gobject", borrowed: true });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, Gio.Icon);
     }
     /**
      * Gets the icon name and size being displayed by the `GtkImage`.
@@ -313,7 +315,7 @@ export class Image extends Widget {
         ], { type: "gobject", borrowed: true });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, Gdk.Paintable);
     }
     /**
      * Gets the pixel size used for named icons.

package/dist/generated/gtk/imcontext.js

@@ -1,4 +1,4 @@
-import { call, getObject, registerType } from "@gtkx/ffi";
+import { call, getObject, getBoxed, registerType } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
 /**
  * The interface for GTK input methods.
@@ -247,7 +247,7 @@ export class IMContext extends GObject.GObject {
                 value: cursorPos,
             },
         ], { type: "undefined" });
-        attrs.value = getObject(attrs.value);
+        attrs.value = getBoxed(attrs.value, "PangoAttrList");
     }
     /**
      * Retrieves context around the insertion point.

package/dist/generated/gtk/index.d.ts

@@ -308,3 +308,4 @@ export * from "./tree-drag-source.js";
 export * from "./tree-model.js";
 export * from "./tree-sortable.js";
 export * from "./functions.js";
+export * from "./constants.js";

package/dist/generated/gtk/index.js

@@ -308,3 +308,4 @@ export * from "./tree-drag-source.js";
 export * from "./tree-model.js";
 export * from "./tree-sortable.js";
 export * from "./functions.js";
+export * from "./constants.js";

package/dist/generated/gtk/inscription.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 { Tooltip } from "./tooltip.js";
 import { Widget } from "./widget.js";
 /**
@@ -99,7 +99,7 @@ export class Inscription extends Widget {
         });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getBoxed(ptr, "PangoAttrList");
     }
     /**
      * Gets the `min-chars` of the inscription.

package/dist/generated/gtk/label.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 { Tooltip } from "./tooltip.js";
 import { Widget } from "./widget.js";
 /**
@@ -346,7 +346,7 @@ export class Label extends Widget {
         });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getBoxed(ptr, "PangoAttrList");
     }
     /**
      * Returns the URI for the active link in the label.
@@ -618,7 +618,7 @@ export class Label extends Widget {
         });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getBoxed(ptr, "PangoTabArray");
     }
     /**
      * Gets the text of the label.

package/dist/generated/gtk/list-box-row.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 { Tooltip } from "./tooltip.js";
 import { Widget } from "./widget.js";
 /**
@@ -272,7 +272,7 @@ export class ListBoxRow extends Widget {
         });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getBoxed(ptr, "GVariant");
     }
     /**
      * Specifies the name of the action with which this widget should be

package/dist/generated/gtk/list-store.js

@@ -1,4 +1,5 @@
-import { call, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { call, getObject, getBoxed, getInterface, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { TreeModel } from "./tree-model.js";
 import * as GObject from "../gobject/index.js";
 /**
  * A list-like data structure that can be used with the [class@Gtk.TreeView].
@@ -857,7 +858,7 @@ export class ListStore extends GObject.GObject {
                 optional: true,
             },
         ], { type: "gobject", borrowed: true });
-        return getObject(ptr);
+        return getInterface(ptr, TreeModel);
     }
     /**
      * Calls `func` on each node in model in a depth-first fashion.
@@ -1040,7 +1041,7 @@ export class ListStore extends GObject.GObject {
             innerType: "GtkTreePath",
             lib: "libgtk-4.so.1",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "GtkTreePath");
     }
     /**
      * Generates a string representation of the iter.

package/dist/generated/gtk/list-view.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 { SelectionModel } from "./selection-model.js";
 import { Tooltip } from "./tooltip.js";
 import { ListBase } from "./list-base.js";
 /**
@@ -239,7 +240,7 @@ export class ListView extends ListBase {
         ], { type: "gobject", borrowed: true });
         if (ptr === null)
             return null;
-        return getObject(ptr);
+        return getInterface(ptr, SelectionModel);
     }
     /**
      * Returns whether the listview should show separators