@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtk/assistant.js

@@ -4,6 +4,44 @@ import { AssistantPage } from "./assistant-page.js";
 import { Widget } from "./widget.js";
 import * as Gio from "../gio/index.js";
 import { Window } from "./window.js";
+/**
+ * `GtkAssistant` is used to represent a complex as a series of steps.
+ *
+ *
+ *
+ * Each step consists of one or more pages. `GtkAssistant` guides the user
+ * through the pages, and controls the page flow to collect the data needed
+ * for the operation.
+ *
+ * `GtkAssistant` handles which buttons to show and to make sensitive based
+ * on page sequence knowledge and the [enum@Gtk.AssistantPageType] of each
+ * page in addition to state information like the *completed* and *committed*
+ * page statuses.
+ *
+ * If you have a case that doesn’t quite fit in `GtkAssistant`s way of
+ * handling buttons, you can use the %GTK_ASSISTANT_PAGE_CUSTOM page
+ * type and handle buttons yourself.
+ *
+ * `GtkAssistant` maintains a `GtkAssistantPage` object for each added
+ * child, which holds additional per-child properties. You
+ * obtain the `GtkAssistantPage` for a child with [method@Gtk.Assistant.get_page].
+ *
+ * # GtkAssistant as GtkBuildable
+ *
+ * The `GtkAssistant` implementation of the `GtkBuildable` interface
+ * exposes the `action_area` as internal children with the name
+ * “action_area”.
+ *
+ * To add pages to an assistant in `GtkBuilder`, simply add it as a
+ * child to the `GtkAssistant` object. If you need to set per-object
+ * properties, create a `GtkAssistantPage` object explicitly, and
+ * set the child widget as a property on it.
+ *
+ * # CSS nodes
+ *
+ * `GtkAssistant` has a single CSS node with the name window and style
+ * class .assistant.
+ */
 const SIGNAL_META = {
     apply: { params: [], returnType: { type: "undefined" } },
     cancel: { params: [], returnType: { type: "undefined" } },
@@ -25,6 +63,9 @@ const SIGNAL_META = {
     "keys-changed": { params: [], returnType: { type: "undefined" } },
 };
 export class Assistant extends Window {
+    /**
+     * Creates a new `GtkAssistant`.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -34,6 +75,10 @@ export class Assistant extends Window {
             borrowed: true,
         });
     }
+    /**
+     * Adds a widget to the action area of a `GtkAssistant`.
+     * @param child - a `GtkWidget`
+     */
     addActionWidget(child) {
         call("libgtk-4.so.1", "gtk_assistant_add_action_widget", [
             {
@@ -46,6 +91,10 @@ export class Assistant extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Appends a page to the @assistant.
+     * @param page - a `GtkWidget`
+     */
     appendPage(page) {
         return call("libgtk-4.so.1", "gtk_assistant_append_page", [
             {
@@ -58,6 +107,18 @@ export class Assistant extends Window {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Erases the visited page history.
+     *
+     * GTK will then hide the back button on the current page,
+     * and removes the cancel button from subsequent pages.
+     *
+     * Use this when the information provided up to the current
+     * page is hereafter deemed permanent and cannot be modified
+     * or undone. For example, showing a progress page to track
+     * a long-running, unreversible operation after the user has
+     * clicked apply on a confirmation page.
+     */
     commit() {
         call("libgtk-4.so.1", "gtk_assistant_commit", [
             {
@@ -66,6 +127,9 @@ export class Assistant extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Returns the page number of the current page.
+     */
     getCurrentPage() {
         return call("libgtk-4.so.1", "gtk_assistant_get_current_page", [
             {
@@ -74,6 +138,9 @@ export class Assistant extends Window {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the number of pages in the @assistant
+     */
     getNPages() {
         return call("libgtk-4.so.1", "gtk_assistant_get_n_pages", [
             {
@@ -82,6 +149,10 @@ export class Assistant extends Window {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the child widget contained in page number @page_num.
+     * @param pageNum - the index of a page in the @assistant,
+     */
     getNthPage(pageNum) {
         const ptr = call("libgtk-4.so.1", "gtk_assistant_get_nth_page", [
             {
@@ -97,6 +168,10 @@ export class Assistant extends Window {
             return null;
         return getObject(ptr, Widget);
     }
+    /**
+     * Returns the `GtkAssistantPage` object for @child.
+     * @param child - a child of @assistant
+     */
     getPage(child) {
         const ptr = call("libgtk-4.so.1", "gtk_assistant_get_page", [
             {
@@ -110,6 +185,10 @@ export class Assistant extends Window {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, AssistantPage);
     }
+    /**
+     * Gets whether `page` is complete.
+     * @param page - a page of @assistant
+     */
     getPageComplete(page) {
         return call("libgtk-4.so.1", "gtk_assistant_get_page_complete", [
             {
@@ -122,6 +201,10 @@ export class Assistant extends Window {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the title for @page.
+     * @param page - a page of @assistant
+     */
     getPageTitle(page) {
         return call("libgtk-4.so.1", "gtk_assistant_get_page_title", [
             {
@@ -134,6 +217,10 @@ export class Assistant extends Window {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets the page type of @page.
+     * @param page - a page of @assistant
+     */
     getPageType(page) {
         return call("libgtk-4.so.1", "gtk_assistant_get_page_type", [
             {
@@ -146,6 +233,9 @@ export class Assistant extends Window {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets a list model of the assistant pages.
+     */
     getPages() {
         const ptr = call("libgtk-4.so.1", "gtk_assistant_get_pages", [
             {
@@ -155,6 +245,11 @@ export class Assistant extends Window {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Gio.ListModel);
     }
+    /**
+     * Inserts a page in the `assistant` at a given position.
+     * @param page - a `GtkWidget`
+     * @param position - the index (starting at 0) at which to insert the page,
+     */
     insertPage(page, position) {
         return call("libgtk-4.so.1", "gtk_assistant_insert_page", [
             {
@@ -171,6 +266,15 @@ export class Assistant extends Window {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Navigate to the next page.
+     *
+     * It is a programming error to call this function when
+     * there is no next page.
+     *
+     * This function is for use when creating pages of the
+     * %GTK_ASSISTANT_PAGE_CUSTOM type.
+     */
     nextPage() {
         call("libgtk-4.so.1", "gtk_assistant_next_page", [
             {
@@ -179,6 +283,10 @@ export class Assistant extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Prepends a page to the @assistant.
+     * @param page - a `GtkWidget`
+     */
     prependPage(page) {
         return call("libgtk-4.so.1", "gtk_assistant_prepend_page", [
             {
@@ -191,6 +299,15 @@ export class Assistant extends Window {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Navigate to the previous visited page.
+     *
+     * It is a programming error to call this function when
+     * no previous page is available.
+     *
+     * This function is for use when creating pages of the
+     * %GTK_ASSISTANT_PAGE_CUSTOM type.
+     */
     previousPage() {
         call("libgtk-4.so.1", "gtk_assistant_previous_page", [
             {
@@ -199,6 +316,10 @@ export class Assistant extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes a widget from the action area of a `GtkAssistant`.
+     * @param child - a `GtkWidget`
+     */
     removeActionWidget(child) {
         call("libgtk-4.so.1", "gtk_assistant_remove_action_widget", [
             {
@@ -211,6 +332,10 @@ export class Assistant extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes the @page_num’s page from @assistant.
+     * @param pageNum - the index of a page in the @assistant,
+     */
     removePage(pageNum) {
         call("libgtk-4.so.1", "gtk_assistant_remove_page", [
             {
@@ -223,6 +348,14 @@ export class Assistant extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Switches the page to @page_num.
+     *
+     * Note that this will only be necessary in custom buttons,
+     * as the `assistant` flow can be set with
+     * gtk_assistant_set_forward_page_func().
+     * @param pageNum - index of the page to switch to, starting from 0.
+     */
     setCurrentPage(pageNum) {
         call("libgtk-4.so.1", "gtk_assistant_set_current_page", [
             {
@@ -235,6 +368,18 @@ export class Assistant extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the page forwarding function to be @page_func.
+     *
+     * This function will be used to determine what will be
+     * the next page when the user presses the forward button.
+     * Setting `page_func` to %NULL will make the assistant to
+     * use the default forward function, which just goes to the
+     * next visible page.
+     * @param pageFunc - the `GtkAssistantPageFunc`, or %NULL
+     * @param data - user data for @page_func
+     * @param destroy - destroy notifier for @data
+     */
     setForwardPageFunc(destroy, pageFunc, data) {
         call("libgtk-4.so.1", "gtk_assistant_set_forward_page_func", [
             {
@@ -257,6 +402,14 @@ export class Assistant extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether `page` contents are complete.
+     *
+     * This will make `assistant` update the buttons state
+     * to be able to continue the task.
+     * @param page - a page of @assistant
+     * @param complete - the completeness status of the page
+     */
     setPageComplete(page, complete) {
         call("libgtk-4.so.1", "gtk_assistant_set_page_complete", [
             {
@@ -273,6 +426,14 @@ export class Assistant extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets a title for @page.
+     *
+     * The title is displayed in the header area of the assistant
+     * when `page` is the current page.
+     * @param page - a page of @assistant
+     * @param title - the new title for @page
+     */
     setPageTitle(page, title) {
         call("libgtk-4.so.1", "gtk_assistant_set_page_title", [
             {
@@ -289,6 +450,13 @@ export class Assistant extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the page type for @page.
+     *
+     * The page type determines the page behavior in the @assistant.
+     * @param page - a page of @assistant
+     * @param type - the new type for @page
+     */
     setPageType(page, type) {
         call("libgtk-4.so.1", "gtk_assistant_set_page_type", [
             {
@@ -305,6 +473,17 @@ export class Assistant extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Forces `assistant` to recompute the buttons state.
+     *
+     * GTK automatically takes care of this in most situations,
+     * e.g. when the user goes to a different page, or when the
+     * visibility or completeness of a page changes.
+     *
+     * One situation where it can be necessary to call this
+     * function is when changing a value on the current page
+     * affects the future page flow of the assistant.
+     */
     updateButtonsState() {
         call("libgtk-4.so.1", "gtk_assistant_update_buttons_state", [
             {

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

@@ -3,10 +3,26 @@ import { Accessible } from "./accessible.js";
 import * as GObject from "../gobject/index.js";
 import * as Gdk from "../gdk/index.js";
 export declare class ATContext extends GObject.GObject {
+    /**
+     * Creates a new `GtkATContext` instance for the given accessible role,
+     * accessible instance, and display connection.
+     *
+     * The `GtkATContext` implementation being instantiated will depend on the
+     * platform.
+     * @param accessibleRole - the accessible role used by the `GtkATContext`
+     * @param accessible - the `GtkAccessible` implementation using the `GtkATContext`
+     * @param display - the `GdkDisplay` used by the `GtkATContext`
+     */
     constructor(accessibleRole: AccessibleRole, accessible: Accessible, display: Gdk.Display);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Retrieves the `GtkAccessible` using this context.
+     */
     getAccessible(): Accessible;
+    /**
+     * Retrieves the accessible role of this context.
+     */
     getAccessibleRole(): AccessibleRole;
     connect(signal: "state-change", handler: (self: ATContext) => void, after?: boolean): number;
     connect(signal: "notify", handler: (self: ATContext, pspec: GObject.ParamSpec) => void, after?: boolean): number;

package/dist/generated/gtk/atcontext.js

@@ -2,6 +2,13 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Accessible } from "./accessible.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * Communicates with platform-specific assistive technologies API.
+ *
+ * Each platform supported by GTK implements a `GtkATContext` subclass, and
+ * is responsible for updating the accessible state in response to state
+ * changes in `GtkAccessible`.
+ */
 const SIGNAL_META = {
     "state-change": { params: [], returnType: { type: "undefined" } },
 };
@@ -26,6 +33,9 @@ export class ATContext extends GObject.GObject {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Retrieves the `GtkAccessible` using this context.
+     */
     getAccessible() {
         const ptr = call("libgtk-4.so.1", "gtk_at_context_get_accessible", [
             {
@@ -35,6 +45,9 @@ export class ATContext extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Accessible);
     }
+    /**
+     * Retrieves the accessible role of this context.
+     */
     getAccessibleRole() {
         return call("libgtk-4.so.1", "gtk_at_context_get_accessible_role", [
             {

package/dist/generated/gtk/bin-layout.d.ts

@@ -1,5 +1,16 @@
 import { LayoutManager } from "./layout-manager.js";
+/**
+ * A layout manager for widgets with a single child.
+ *
+ * `GtkBinLayout` will stack each child of a widget on top of each other,
+ * using the [property@Gtk.Widget:hexpand], [property@Gtk.Widget:vexpand],
+ * [property@Gtk.Widget:halign], and [property@Gtk.Widget:valign] properties
+ * of each child to determine where they should be positioned.
+ */
 export declare class BinLayout extends LayoutManager {
+    /**
+     * Creates a new `GtkBinLayout` instance.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
 }

package/dist/generated/gtk/bin-layout.js

@@ -1,6 +1,17 @@
 import { call } from "@gtkx/native";
 import { LayoutManager } from "./layout-manager.js";
+/**
+ * A layout manager for widgets with a single child.
+ *
+ * `GtkBinLayout` will stack each child of a widget on top of each other,
+ * using the [property@Gtk.Widget:hexpand], [property@Gtk.Widget:vexpand],
+ * [property@Gtk.Widget:halign], and [property@Gtk.Widget:valign] properties
+ * of each child to determine where they should be positioned.
+ */
 export class BinLayout extends LayoutManager {
+    /**
+     * Creates a new `GtkBinLayout` instance.
+     */
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gtk/bitset-iter.d.ts

@@ -1,14 +1,74 @@
 import { Ref } from "@gtkx/native";
 import { Bitset } from "./bitset.js";
+/**
+ * Iterates over the elements of a [struct@Gtk.Bitset].
+ *
+ * `GtkBitSetIter is an opaque, stack-allocated struct.
+ *
+ * Before a `GtkBitsetIter` can be used, it needs to be initialized with
+ * [func@Gtk.BitsetIter.init_first], [func@Gtk.BitsetIter.init_last]
+ * or [func@Gtk.BitsetIter.init_at].
+ */
 export declare class BitsetIter {
     ptr: unknown;
     constructor();
     protected createPtr(_init: Record<string, unknown>): unknown;
+    /**
+     * Initializes `iter` to point to @target.
+     *
+     * If `target` is not found, finds the next value after it.
+     * If no value >= `target` exists in @set, this function returns %FALSE.
+     * @param iter - a pointer to an uninitialized `GtkBitsetIter`
+     * @param set - a `GtkBitset`
+     * @param target - target value to start iterating at
+     * @param value - Set to the found value in @set
+     */
     static initAt(iter: Ref<BitsetIter>, set: Bitset, target: number, value?: Ref<number> | null): boolean;
+    /**
+     * Initializes an iterator for `set` and points it to the first
+     * value in @set.
+     *
+     * If `set` is empty, %FALSE is returned and `value` is set to %G_MAXUINT.
+     * @param iter - a pointer to an uninitialized `GtkBitsetIter`
+     * @param set - a `GtkBitset`
+     * @param value - Set to the first value in @set
+     */
     static initFirst(iter: Ref<BitsetIter>, set: Bitset, value?: Ref<number> | null): boolean;
+    /**
+     * Initializes an iterator for `set` and points it to the last
+     * value in @set.
+     *
+     * If `set` is empty, %FALSE is returned.
+     * @param iter - a pointer to an uninitialized `GtkBitsetIter`
+     * @param set - a `GtkBitset`
+     * @param value - Set to the last value in @set
+     */
     static initLast(iter: Ref<BitsetIter>, set: Bitset, value?: Ref<number> | null): boolean;
+    /**
+     * Gets the current value that `iter` points to.
+     *
+     * If `iter` is not valid and [method@Gtk.BitsetIter.is_valid]
+     * returns %FALSE, this function returns 0.
+     */
     getValue(): number;
+    /**
+     * Checks if `iter` points to a valid value.
+     */
     isValid(): boolean;
+    /**
+     * Moves `iter` to the next value in the set.
+     *
+     * If it was already pointing to the last value in the set,
+     * %FALSE is returned and `iter` is invalidated.
+     * @param value - Set to the next value
+     */
     next(value?: Ref<number> | null): boolean;
+    /**
+     * Moves `iter` to the previous value in the set.
+     *
+     * If it was already pointing to the first value in the set,
+     * %FALSE is returned and `iter` is invalidated.
+     * @param value - Set to the previous value
+     */
     previous(value?: Ref<number> | null): boolean;
 }

package/dist/generated/gtk/bitset-iter.js

@@ -1,4 +1,13 @@
 import { alloc, call } from "@gtkx/native";
+/**
+ * Iterates over the elements of a [struct@Gtk.Bitset].
+ *
+ * `GtkBitSetIter is an opaque, stack-allocated struct.
+ *
+ * Before a `GtkBitsetIter` can be used, it needs to be initialized with
+ * [func@Gtk.BitsetIter.init_first], [func@Gtk.BitsetIter.init_last]
+ * or [func@Gtk.BitsetIter.init_at].
+ */
 export class BitsetIter {
     ptr;
     constructor() {
@@ -7,6 +16,16 @@ export class BitsetIter {
     createPtr(_init) {
         return alloc(0, "GtkBitsetIter", "libgtk-4.so.1");
     }
+    /**
+     * Initializes `iter` to point to @target.
+     *
+     * If `target` is not found, finds the next value after it.
+     * If no value >= `target` exists in @set, this function returns %FALSE.
+     * @param iter - a pointer to an uninitialized `GtkBitsetIter`
+     * @param set - a `GtkBitset`
+     * @param target - target value to start iterating at
+     * @param value - Set to the found value in @set
+     */
     static initAt(iter, set, target, value) {
         return call("libgtk-4.so.1", "gtk_bitset_iter_init_at", [
             {
@@ -43,6 +62,15 @@ export class BitsetIter {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Initializes an iterator for `set` and points it to the first
+     * value in @set.
+     *
+     * If `set` is empty, %FALSE is returned and `value` is set to %G_MAXUINT.
+     * @param iter - a pointer to an uninitialized `GtkBitsetIter`
+     * @param set - a `GtkBitset`
+     * @param value - Set to the first value in @set
+     */
     static initFirst(iter, set, value) {
         return call("libgtk-4.so.1", "gtk_bitset_iter_init_first", [
             {
@@ -75,6 +103,15 @@ export class BitsetIter {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Initializes an iterator for `set` and points it to the last
+     * value in @set.
+     *
+     * If `set` is empty, %FALSE is returned.
+     * @param iter - a pointer to an uninitialized `GtkBitsetIter`
+     * @param set - a `GtkBitset`
+     * @param value - Set to the last value in @set
+     */
     static initLast(iter, set, value) {
         return call("libgtk-4.so.1", "gtk_bitset_iter_init_last", [
             {
@@ -107,6 +144,12 @@ export class BitsetIter {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the current value that `iter` points to.
+     *
+     * If `iter` is not valid and [method@Gtk.BitsetIter.is_valid]
+     * returns %FALSE, this function returns 0.
+     */
     getValue() {
         return call("libgtk-4.so.1", "gtk_bitset_iter_get_value", [
             {
@@ -115,6 +158,9 @@ export class BitsetIter {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Checks if `iter` points to a valid value.
+     */
     isValid() {
         return call("libgtk-4.so.1", "gtk_bitset_iter_is_valid", [
             {
@@ -123,6 +169,13 @@ export class BitsetIter {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Moves `iter` to the next value in the set.
+     *
+     * If it was already pointing to the last value in the set,
+     * %FALSE is returned and `iter` is invalidated.
+     * @param value - Set to the next value
+     */
     next(value) {
         return call("libgtk-4.so.1", "gtk_bitset_iter_next", [
             {
@@ -139,6 +192,13 @@ export class BitsetIter {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Moves `iter` to the previous value in the set.
+     *
+     * If it was already pointing to the first value in the set,
+     * %FALSE is returned and `iter` is invalidated.
+     * @param value - Set to the previous value
+     */
     previous(value) {
         return call("libgtk-4.so.1", "gtk_bitset_iter_previous", [
             {