@gtkx/ffi 0.1.44 → 0.1.46

package/dist/generated/gdk/toplevel.d.ts

@@ -4,30 +4,218 @@ import { Device } from "./device.js";
 import { Event } from "./event.js";
 import { Surface } from "./surface.js";
 import { Texture } from "./texture.js";
+/**
+ * A freestanding toplevel surface.
+ *
+ * The `GdkToplevel` interface provides useful APIs for interacting with
+ * the windowing system, such as controlling maximization and size of the
+ * surface, setting icons and transient parents for dialogs.
+ */
 export declare class Toplevel {
     ptr: unknown;
     protected constructor(ptr: unknown);
     static fromPtr(ptr: unknown): Toplevel;
+    /**
+     * Begins an interactive move operation.
+     *
+     * You might use this function to implement draggable titlebars.
+     * @param device - the device used for the operation
+     * @param button - the button being used to drag, or 0 for a keyboard-initiated drag
+     * @param x - surface X coordinate of mouse click that began the drag
+     * @param y - surface Y coordinate of mouse click that began the drag
+     * @param timestamp - timestamp of mouse click that began the drag (use
+     */
     beginMove(device: Device, button: number, x: number, y: number, timestamp: number): void;
+    /**
+     * Begins an interactive resize operation.
+     *
+     * You might use this function to implement a “window resize grip.”
+     * @param edge - the edge or corner from which the drag is started
+     * @param device - the device used for the operation
+     * @param button - the button being used to drag, or 0 for a keyboard-initiated drag
+     * @param x - surface X coordinate of mouse click that began the drag
+     * @param y - surface Y coordinate of mouse click that began the drag
+     * @param timestamp - timestamp of mouse click that began the drag (use
+     */
     beginResize(edge: SurfaceEdge, button: number, x: number, y: number, timestamp: number, device?: Device | null): void;
+    /**
+     * Sets keyboard focus to @surface.
+     *
+     * In most cases, gtk_window_present_with_time()
+     * should be used on a GtkWindow, rather than
+     * calling this function.
+     * @param timestamp - timestamp of the event triggering the surface focus
+     */
     focus(timestamp: number): void;
+    /**
+     * The capabilities that are available for this toplevel.
+     */
     getCapabilities(): ToplevelCapabilities;
+    /**
+     * Returns the gravity that is used when changing the toplevel
+     * size programmatically.
+     */
     getGravity(): Gravity;
+    /**
+     * Gets the bitwise or of the currently active surface state flags,
+     * from the `GdkToplevelState` enumeration.
+     */
     getState(): ToplevelState;
+    /**
+     * Requests that the `toplevel` inhibit the system shortcuts.
+     *
+     * This is asking the desktop environment/windowing system to let all
+     * keyboard events reach the surface, as long as it is focused, instead
+     * of triggering system actions.
+     *
+     * If granted, the rerouting remains active until the default shortcuts
+     * processing is restored with [method@Gdk.Toplevel.restore_system_shortcuts],
+     * or the request is revoked by the desktop environment, windowing system
+     * or the user.
+     *
+     * A typical use case for this API is remote desktop or virtual machine
+     * viewers which need to inhibit the default system keyboard shortcuts
+     * so that the remote session or virtual host gets those instead of the
+     * local environment.
+     *
+     * The windowing system or desktop environment may ask the user to grant
+     * or deny the request or even choose to ignore the request entirely.
+     *
+     * The caller can be notified whenever the request is granted or revoked
+     * by listening to the [property@Gdk.Toplevel:shortcuts-inhibited] property.
+     * @param event - the `GdkEvent` that is triggering the inhibit
+     */
     inhibitSystemShortcuts(event?: Event | null): void;
+    /**
+     * Asks to lower the `toplevel` below other windows.
+     *
+     * The windowing system may choose to ignore the request.
+     */
     lower(): boolean;
+    /**
+     * Asks to minimize the @toplevel.
+     *
+     * The windowing system may choose to ignore the request.
+     */
     minimize(): boolean;
+    /**
+     * Present `toplevel` after having processed the `GdkToplevelLayout` rules.
+     *
+     * If the toplevel was previously not showing, it will be showed,
+     * otherwise it will change layout according to @layout.
+     *
+     * GDK may emit the [signal@Gdk.Toplevel::compute-size] signal to let
+     * the user of this toplevel compute the preferred size of the toplevel
+     * surface.
+     *
+     * Presenting is asynchronous and the specified layout parameters are not
+     * guaranteed to be respected.
+     * @param layout - the `GdkToplevelLayout` object used to layout
+     */
     present(layout: ToplevelLayout): void;
+    /**
+     * Restore default system keyboard shortcuts which were previously
+     * inhibited.
+     *
+     * This undoes the effect of [method@Gdk.Toplevel.inhibit_system_shortcuts].
+     */
     restoreSystemShortcuts(): void;
+    /**
+     * Sets the toplevel to be decorated.
+     *
+     * Setting `decorated` to %FALSE hints the desktop environment
+     * that the surface has its own, client-side decorations and
+     * does not need to have window decorations added.
+     * @param decorated - %TRUE to request decorations
+     */
     setDecorated(decorated: boolean): void;
+    /**
+     * Sets the toplevel to be deletable.
+     *
+     * Setting `deletable` to %TRUE hints the desktop environment
+     * that it should offer the user a way to close the surface.
+     * @param deletable - %TRUE to request a delete button
+     */
     setDeletable(deletable: boolean): void;
+    /**
+     * Sets the gravity that is used when changing the toplevel
+     * size programmatically.
+     * @param gravity - the new gravity
+     */
     setGravity(gravity: Gravity): void;
+    /**
+     * Sets a list of icons for the surface.
+     *
+     * One of these will be used to represent the surface in iconic form.
+     * The icon may be shown in window lists or task bars. Which icon
+     * size is shown depends on the window manager. The window manager
+     * can scale the icon but setting several size icons can give better
+     * image quality.
+     *
+     * Note that some platforms don't support surface icons.
+     * @param surfaces - A list of textures to use as icon, of different sizes
+     */
     setIconList(surfaces: Texture[]): void;
+    /**
+     * Sets the toplevel to be modal.
+     *
+     * The application can use this hint to tell the
+     * window manager that a certain surface has modal
+     * behaviour. The window manager can use this information
+     * to handle modal surfaces in a special way.
+     *
+     * You should only use this on surfaces for which you have
+     * previously called [method@Gdk.Toplevel.set_transient_for].
+     * @param modal - %TRUE if the surface is modal, %FALSE otherwise.
+     */
     setModal(modal: boolean): void;
+    /**
+     * Sets the startup notification ID.
+     *
+     * When using GTK, typically you should use
+     * gtk_window_set_startup_id()
+     * instead of this low-level function.
+     * @param startupId - a string with startup-notification identifier
+     */
     setStartupId(startupId: string): void;
+    /**
+     * Sets the title of a toplevel surface.
+     *
+     * The title maybe be displayed in the titlebar,
+     * in lists of windows, etc.
+     * @param title - title of @surface
+     */
     setTitle(title: string): void;
+    /**
+     * Sets a transient-for parent.
+     *
+     * Indicates to the window manager that `surface` is a transient
+     * dialog associated with the application surface @parent. This
+     * allows the window manager to do things like center `surface` on `parent` and keep `surface` above @parent.
+     *
+     * See gtk_window_set_transient_for()
+     * if you’re using GtkWindow.
+     * @param parent - another toplevel `GdkSurface`
+     */
     setTransientFor(parent: Surface): void;
+    /**
+     * Asks the windowing system to show the window menu.
+     *
+     * The window menu is the menu shown when right-clicking the titlebar
+     * on traditional windows managed by the window manager. This is useful
+     * for windows using client-side decorations, activating it with a
+     * right-click on the window decorations.
+     * @param event - a `GdkEvent` to show the menu for
+     */
     showWindowMenu(event: Event): boolean;
+    /**
+     * Returns whether the desktop environment supports
+     * tiled window states.
+     */
     supportsEdgeConstraints(): boolean;
+    /**
+     * Performs a title bar gesture.
+     * @param gesture - a `GdkTitlebarGesture`
+     */
     titlebarGesture(gesture: TitlebarGesture): boolean;
 }

package/dist/generated/gdk/toplevel.js

@@ -1,4 +1,11 @@
 import { call } from "@gtkx/native";
+/**
+ * A freestanding toplevel surface.
+ *
+ * The `GdkToplevel` interface provides useful APIs for interacting with
+ * the windowing system, such as controlling maximization and size of the
+ * surface, setting icons and transient parents for dialogs.
+ */
 export class Toplevel {
     ptr;
     constructor(ptr) {
@@ -7,6 +14,16 @@ export class Toplevel {
     static fromPtr(ptr) {
         return new Toplevel(ptr);
     }
+    /**
+     * Begins an interactive move operation.
+     *
+     * You might use this function to implement draggable titlebars.
+     * @param device - the device used for the operation
+     * @param button - the button being used to drag, or 0 for a keyboard-initiated drag
+     * @param x - surface X coordinate of mouse click that began the drag
+     * @param y - surface Y coordinate of mouse click that began the drag
+     * @param timestamp - timestamp of mouse click that began the drag (use
+     */
     beginMove(device, button, x, y, timestamp) {
         call("libgtk-4.so.1", "gdk_toplevel_begin_move", [
             {
@@ -35,6 +52,17 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Begins an interactive resize operation.
+     *
+     * You might use this function to implement a “window resize grip.”
+     * @param edge - the edge or corner from which the drag is started
+     * @param device - the device used for the operation
+     * @param button - the button being used to drag, or 0 for a keyboard-initiated drag
+     * @param x - surface X coordinate of mouse click that began the drag
+     * @param y - surface Y coordinate of mouse click that began the drag
+     * @param timestamp - timestamp of mouse click that began the drag (use
+     */
     beginResize(edge, button, x, y, timestamp, device) {
         call("libgtk-4.so.1", "gdk_toplevel_begin_resize", [
             {
@@ -68,6 +96,14 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets keyboard focus to @surface.
+     *
+     * In most cases, gtk_window_present_with_time()
+     * should be used on a GtkWindow, rather than
+     * calling this function.
+     * @param timestamp - timestamp of the event triggering the surface focus
+     */
     focus(timestamp) {
         call("libgtk-4.so.1", "gdk_toplevel_focus", [
             {
@@ -80,6 +116,9 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * The capabilities that are available for this toplevel.
+     */
     getCapabilities() {
         return call("libgtk-4.so.1", "gdk_toplevel_get_capabilities", [
             {
@@ -88,6 +127,10 @@ export class Toplevel {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the gravity that is used when changing the toplevel
+     * size programmatically.
+     */
     getGravity() {
         return call("libgtk-4.so.1", "gdk_toplevel_get_gravity", [
             {
@@ -96,6 +139,10 @@ export class Toplevel {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the bitwise or of the currently active surface state flags,
+     * from the `GdkToplevelState` enumeration.
+     */
     getState() {
         return call("libgtk-4.so.1", "gdk_toplevel_get_state", [
             {
@@ -104,6 +151,30 @@ export class Toplevel {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Requests that the `toplevel` inhibit the system shortcuts.
+     *
+     * This is asking the desktop environment/windowing system to let all
+     * keyboard events reach the surface, as long as it is focused, instead
+     * of triggering system actions.
+     *
+     * If granted, the rerouting remains active until the default shortcuts
+     * processing is restored with [method@Gdk.Toplevel.restore_system_shortcuts],
+     * or the request is revoked by the desktop environment, windowing system
+     * or the user.
+     *
+     * A typical use case for this API is remote desktop or virtual machine
+     * viewers which need to inhibit the default system keyboard shortcuts
+     * so that the remote session or virtual host gets those instead of the
+     * local environment.
+     *
+     * The windowing system or desktop environment may ask the user to grant
+     * or deny the request or even choose to ignore the request entirely.
+     *
+     * The caller can be notified whenever the request is granted or revoked
+     * by listening to the [property@Gdk.Toplevel:shortcuts-inhibited] property.
+     * @param event - the `GdkEvent` that is triggering the inhibit
+     */
     inhibitSystemShortcuts(event) {
         call("libgtk-4.so.1", "gdk_toplevel_inhibit_system_shortcuts", [
             {
@@ -117,6 +188,11 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Asks to lower the `toplevel` below other windows.
+     *
+     * The windowing system may choose to ignore the request.
+     */
     lower() {
         return call("libgtk-4.so.1", "gdk_toplevel_lower", [
             {
@@ -125,6 +201,11 @@ export class Toplevel {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Asks to minimize the @toplevel.
+     *
+     * The windowing system may choose to ignore the request.
+     */
     minimize() {
         return call("libgtk-4.so.1", "gdk_toplevel_minimize", [
             {
@@ -133,6 +214,20 @@ export class Toplevel {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Present `toplevel` after having processed the `GdkToplevelLayout` rules.
+     *
+     * If the toplevel was previously not showing, it will be showed,
+     * otherwise it will change layout according to @layout.
+     *
+     * GDK may emit the [signal@Gdk.Toplevel::compute-size] signal to let
+     * the user of this toplevel compute the preferred size of the toplevel
+     * surface.
+     *
+     * Presenting is asynchronous and the specified layout parameters are not
+     * guaranteed to be respected.
+     * @param layout - the `GdkToplevelLayout` object used to layout
+     */
     present(layout) {
         call("libgtk-4.so.1", "gdk_toplevel_present", [
             {
@@ -150,6 +245,12 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Restore default system keyboard shortcuts which were previously
+     * inhibited.
+     *
+     * This undoes the effect of [method@Gdk.Toplevel.inhibit_system_shortcuts].
+     */
     restoreSystemShortcuts() {
         call("libgtk-4.so.1", "gdk_toplevel_restore_system_shortcuts", [
             {
@@ -158,6 +259,14 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the toplevel to be decorated.
+     *
+     * Setting `decorated` to %FALSE hints the desktop environment
+     * that the surface has its own, client-side decorations and
+     * does not need to have window decorations added.
+     * @param decorated - %TRUE to request decorations
+     */
     setDecorated(decorated) {
         call("libgtk-4.so.1", "gdk_toplevel_set_decorated", [
             {
@@ -170,6 +279,13 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the toplevel to be deletable.
+     *
+     * Setting `deletable` to %TRUE hints the desktop environment
+     * that it should offer the user a way to close the surface.
+     * @param deletable - %TRUE to request a delete button
+     */
     setDeletable(deletable) {
         call("libgtk-4.so.1", "gdk_toplevel_set_deletable", [
             {
@@ -182,6 +298,11 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the gravity that is used when changing the toplevel
+     * size programmatically.
+     * @param gravity - the new gravity
+     */
     setGravity(gravity) {
         call("libgtk-4.so.1", "gdk_toplevel_set_gravity", [
             {
@@ -194,6 +315,18 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets a list of icons for the surface.
+     *
+     * One of these will be used to represent the surface in iconic form.
+     * The icon may be shown in window lists or task bars. Which icon
+     * size is shown depends on the window manager. The window manager
+     * can scale the icon but setting several size icons can give better
+     * image quality.
+     *
+     * Note that some platforms don't support surface icons.
+     * @param surfaces - A list of textures to use as icon, of different sizes
+     */
     setIconList(surfaces) {
         call("libgtk-4.so.1", "gdk_toplevel_set_icon_list", [
             {
@@ -210,6 +343,18 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the toplevel to be modal.
+     *
+     * The application can use this hint to tell the
+     * window manager that a certain surface has modal
+     * behaviour. The window manager can use this information
+     * to handle modal surfaces in a special way.
+     *
+     * You should only use this on surfaces for which you have
+     * previously called [method@Gdk.Toplevel.set_transient_for].
+     * @param modal - %TRUE if the surface is modal, %FALSE otherwise.
+     */
     setModal(modal) {
         call("libgtk-4.so.1", "gdk_toplevel_set_modal", [
             {
@@ -222,6 +367,14 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the startup notification ID.
+     *
+     * When using GTK, typically you should use
+     * gtk_window_set_startup_id()
+     * instead of this low-level function.
+     * @param startupId - a string with startup-notification identifier
+     */
     setStartupId(startupId) {
         call("libgtk-4.so.1", "gdk_toplevel_set_startup_id", [
             {
@@ -234,6 +387,13 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the title of a toplevel surface.
+     *
+     * The title maybe be displayed in the titlebar,
+     * in lists of windows, etc.
+     * @param title - title of @surface
+     */
     setTitle(title) {
         call("libgtk-4.so.1", "gdk_toplevel_set_title", [
             {
@@ -246,6 +406,17 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets a transient-for parent.
+     *
+     * Indicates to the window manager that `surface` is a transient
+     * dialog associated with the application surface @parent. This
+     * allows the window manager to do things like center `surface` on `parent` and keep `surface` above @parent.
+     *
+     * See gtk_window_set_transient_for()
+     * if you’re using GtkWindow.
+     * @param parent - another toplevel `GdkSurface`
+     */
     setTransientFor(parent) {
         call("libgtk-4.so.1", "gdk_toplevel_set_transient_for", [
             {
@@ -258,6 +429,15 @@ export class Toplevel {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Asks the windowing system to show the window menu.
+     *
+     * The window menu is the menu shown when right-clicking the titlebar
+     * on traditional windows managed by the window manager. This is useful
+     * for windows using client-side decorations, activating it with a
+     * right-click on the window decorations.
+     * @param event - a `GdkEvent` to show the menu for
+     */
     showWindowMenu(event) {
         return call("libgtk-4.so.1", "gdk_toplevel_show_window_menu", [
             {
@@ -270,6 +450,10 @@ export class Toplevel {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the desktop environment supports
+     * tiled window states.
+     */
     supportsEdgeConstraints() {
         return call("libgtk-4.so.1", "gdk_toplevel_supports_edge_constraints", [
             {
@@ -278,6 +462,10 @@ export class Toplevel {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Performs a title bar gesture.
+     * @param gesture - a `GdkTitlebarGesture`
+     */
     titlebarGesture(gesture) {
         return call("libgtk-4.so.1", "gdk_toplevel_titlebar_gesture", [
             {

package/dist/generated/gdk/touch-event.d.ts

@@ -1,6 +1,10 @@
 import { Event } from "./event.js";
+/** An event related to a touch-based device. */
 export declare class TouchEvent extends Event {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Extracts whether a touch event is emulating a pointer event.
+     */
     getEmulatingPointer(): boolean;
 }

package/dist/generated/gdk/touch-event.js

@@ -1,5 +1,6 @@
 import { call } from "@gtkx/native";
 import { Event } from "./event.js";
+/** An event related to a touch-based device. */
 export class TouchEvent extends Event {
     constructor(...args) {
         super(...args);
@@ -15,6 +16,9 @@ export class TouchEvent extends Event {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Extracts whether a touch event is emulating a pointer event.
+     */
     getEmulatingPointer() {
         return call("libgtk-4.so.1", "gdk_touch_event_get_emulating_pointer", [
             {

package/dist/generated/gdk/touchpad-event.d.ts

@@ -1,12 +1,37 @@
 import { Ref } from "@gtkx/native";
 import { TouchpadGesturePhase } from "./enums.js";
 import { Event } from "./event.js";
+/**
+ * An event related to a gesture on a touchpad device.
+ *
+ * Unlike touchscreens, where the windowing system sends basic
+ * sequences of begin, update, end events, and leaves gesture
+ * recognition to the clients, touchpad gestures are typically
+ * processed by the system, resulting in these events.
+ */
 export declare class TouchpadEvent extends Event {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Extracts delta information from a touchpad event.
+     * @param dx - return location for x
+     * @param dy - return location for y
+     */
     getDeltas(dx: Ref<number>, dy: Ref<number>): void;
+    /**
+     * Extracts the touchpad gesture phase from a touchpad event.
+     */
     getGesturePhase(): TouchpadGesturePhase;
+    /**
+     * Extracts the number of fingers from a touchpad event.
+     */
     getNFingers(): number;
+    /**
+     * Extracts the angle delta from a touchpad pinch event.
+     */
     getPinchAngleDelta(): number;
+    /**
+     * Extracts the scale from a touchpad pinch event.
+     */
     getPinchScale(): number;
 }

package/dist/generated/gdk/touchpad-event.js

@@ -1,5 +1,13 @@
 import { call } from "@gtkx/native";
 import { Event } from "./event.js";
+/**
+ * An event related to a gesture on a touchpad device.
+ *
+ * Unlike touchscreens, where the windowing system sends basic
+ * sequences of begin, update, end events, and leaves gesture
+ * recognition to the clients, touchpad gestures are typically
+ * processed by the system, resulting in these events.
+ */
 export class TouchpadEvent extends Event {
     constructor(...args) {
         super(...args);
@@ -15,6 +23,11 @@ export class TouchpadEvent extends Event {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Extracts delta information from a touchpad event.
+     * @param dx - return location for x
+     * @param dy - return location for y
+     */
     getDeltas(dx, dy) {
         call("libgtk-4.so.1", "gdk_touchpad_event_get_deltas", [
             {
@@ -31,6 +44,9 @@ export class TouchpadEvent extends Event {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Extracts the touchpad gesture phase from a touchpad event.
+     */
     getGesturePhase() {
         return call("libgtk-4.so.1", "gdk_touchpad_event_get_gesture_phase", [
             {
@@ -39,6 +55,9 @@ export class TouchpadEvent extends Event {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Extracts the number of fingers from a touchpad event.
+     */
     getNFingers() {
         return call("libgtk-4.so.1", "gdk_touchpad_event_get_n_fingers", [
             {
@@ -47,6 +66,9 @@ export class TouchpadEvent extends Event {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Extracts the angle delta from a touchpad pinch event.
+     */
     getPinchAngleDelta() {
         return call("libgtk-4.so.1", "gdk_touchpad_event_get_pinch_angle_delta", [
             {
@@ -55,6 +77,9 @@ export class TouchpadEvent extends Event {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Extracts the scale from a touchpad pinch event.
+     */
     getPinchScale() {
         return call("libgtk-4.so.1", "gdk_touchpad_event_get_pinch_scale", [
             {