@gtkx/ffi 0.1.45 → 0.1.46

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

@@ -4,6 +4,7 @@ import { Accessible } from "./accessible.js";
 import { ATContext } from "./atcontext.js";
 import { Widget } from "./widget.js";
 import * as GObject from "../gobject/index.js";
+/** An auxiliary class used by `GtkStack`. */
 export class StackPage extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -19,6 +20,9 @@ export class StackPage extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Returns the stack child to which `self` belongs.
+     */
     getChild() {
         const ptr = call("libgtk-4.so.1", "gtk_stack_page_get_child", [
             {
@@ -28,6 +32,9 @@ export class StackPage extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Widget);
     }
+    /**
+     * Returns the icon name of the page.
+     */
     getIconName() {
         return call("libgtk-4.so.1", "gtk_stack_page_get_icon_name", [
             {
@@ -36,6 +43,9 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the name of the page.
+     */
     getName() {
         return call("libgtk-4.so.1", "gtk_stack_page_get_name", [
             {
@@ -44,6 +54,9 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns whether the page is marked as “needs attention”.
+     */
     getNeedsAttention() {
         return call("libgtk-4.so.1", "gtk_stack_page_get_needs_attention", [
             {
@@ -52,6 +65,9 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the page title.
+     */
     getTitle() {
         return call("libgtk-4.so.1", "gtk_stack_page_get_title", [
             {
@@ -60,6 +76,9 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets whether underlines in the page title indicate mnemonics.
+     */
     getUseUnderline() {
         return call("libgtk-4.so.1", "gtk_stack_page_get_use_underline", [
             {
@@ -68,6 +87,12 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether `page` is visible in its `GtkStack`.
+     *
+     * This is independent from the [property@Gtk.Widget:visible]
+     * property of its widget.
+     */
     getVisible() {
         return call("libgtk-4.so.1", "gtk_stack_page_get_visible", [
             {
@@ -76,6 +101,10 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets the icon name of the page.
+     * @param setting - the new value to set
+     */
     setIconName(setting) {
         call("libgtk-4.so.1", "gtk_stack_page_set_icon_name", [
             {
@@ -88,6 +117,10 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the name of the page.
+     * @param setting - the new value to set
+     */
     setName(setting) {
         call("libgtk-4.so.1", "gtk_stack_page_set_name", [
             {
@@ -100,6 +133,10 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the page is marked as “needs attention”.
+     * @param setting - the new value to set
+     */
     setNeedsAttention(setting) {
         call("libgtk-4.so.1", "gtk_stack_page_set_needs_attention", [
             {
@@ -112,6 +149,10 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the page title.
+     * @param setting - the new value to set
+     */
     setTitle(setting) {
         call("libgtk-4.so.1", "gtk_stack_page_set_title", [
             {
@@ -124,6 +165,10 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether underlines in the page title indicate mnemonics.
+     * @param setting - the new value to set
+     */
     setUseUnderline(setting) {
         call("libgtk-4.so.1", "gtk_stack_page_set_use_underline", [
             {
@@ -136,6 +181,10 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether `page` is visible in its `GtkStack`.
+     * @param visible - The new property value
+     */
     setVisible(visible) {
         call("libgtk-4.so.1", "gtk_stack_page_set_visible", [
             {
@@ -148,6 +197,19 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Requests the user's screen reader to announce the given message.
+     *
+     * This kind of notification is useful for messages that
+     * either have only a visual representation or that are not
+     * exposed visually at all, e.g. a notification about a
+     * successful operation.
+     *
+     * Also, by using this API, you can ensure that the message
+     * does not interrupts the user's current screen reader output.
+     * @param message - the string to announce
+     * @param priority - the priority of the announcement
+     */
     announce(message, priority) {
         call("libgtk-4.so.1", "gtk_accessible_announce", [
             {
@@ -164,6 +226,11 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the accessible parent for an accessible object.
+     *
+     * This function returns `NULL` for top level widgets.
+     */
     getAccessibleParent() {
         const ptr = call("libgtk-4.so.1", "gtk_accessible_get_accessible_parent", [
             {
@@ -175,6 +242,9 @@ export class StackPage extends GObject.GObject {
             return null;
         return getObject(ptr, Accessible);
     }
+    /**
+     * Retrieves the accessible role of an accessible object.
+     */
     getAccessibleRole() {
         return call("libgtk-4.so.1", "gtk_accessible_get_accessible_role", [
             {
@@ -183,6 +253,9 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Retrieves the implementation for the given accessible object.
+     */
     getAtContext() {
         const ptr = call("libgtk-4.so.1", "gtk_accessible_get_at_context", [
             {
@@ -192,6 +265,17 @@ export class StackPage extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, ATContext);
     }
+    /**
+     * Queries the coordinates and dimensions of this accessible
+     *
+     * This functionality can be overridden by `GtkAccessible`
+     * implementations, e.g. to get the bounds from an ignored
+     * child widget.
+     * @param x - the x coordinate of the top left corner of the accessible
+     * @param y - the y coordinate of the top left corner of the widget
+     * @param width - the width of the accessible object
+     * @param height - the height of the accessible object
+     */
     getBounds(x, y, width, height) {
         return call("libgtk-4.so.1", "gtk_accessible_get_bounds", [
             {
@@ -228,6 +312,9 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Retrieves the first accessible child of an accessible object.
+     */
     getFirstAccessibleChild() {
         const ptr = call("libgtk-4.so.1", "gtk_accessible_get_first_accessible_child", [
             {
@@ -239,6 +326,9 @@ export class StackPage extends GObject.GObject {
             return null;
         return getObject(ptr, Accessible);
     }
+    /**
+     * Retrieves the next accessible sibling of an accessible object
+     */
     getNextAccessibleSibling() {
         const ptr = call("libgtk-4.so.1", "gtk_accessible_get_next_accessible_sibling", [
             {
@@ -250,6 +340,14 @@ export class StackPage extends GObject.GObject {
             return null;
         return getObject(ptr, Accessible);
     }
+    /**
+     * Queries a platform state, such as focus.
+     *
+     * This functionality can be overridden by `GtkAccessible`
+     * implementations, e.g. to get platform state from an ignored
+     * child widget, as is the case for `GtkText` wrappers.
+     * @param state - platform state to query
+     */
     getPlatformState(state) {
         return call("libgtk-4.so.1", "gtk_accessible_get_platform_state", [
             {
@@ -262,6 +360,10 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Resets the accessible property to its default value.
+     * @param property - the accessible property
+     */
     resetProperty(property) {
         call("libgtk-4.so.1", "gtk_accessible_reset_property", [
             {
@@ -274,6 +376,10 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Resets the accessible relation to its default value.
+     * @param relation - the accessible relation
+     */
     resetRelation(relation) {
         call("libgtk-4.so.1", "gtk_accessible_reset_relation", [
             {
@@ -286,6 +392,10 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Resets the accessible state to its default value.
+     * @param state - the accessible state
+     */
     resetState(state) {
         call("libgtk-4.so.1", "gtk_accessible_reset_state", [
             {
@@ -298,6 +408,19 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the parent and sibling of an accessible object.
+     *
+     * This function is meant to be used by accessible implementations that are
+     * not part of the widget hierarchy, and but act as a logical bridge between
+     * widgets. For instance, if a widget creates an object that holds metadata
+     * for each child, and you want that object to implement the `GtkAccessible`
+     * interface, you will use this function to ensure that the parent of each
+     * child widget is the metadata object, and the parent of each metadata
+     * object is the container widget.
+     * @param parent - the parent accessible object
+     * @param nextSibling - the sibling accessible object
+     */
     setAccessibleParent(parent, nextSibling) {
         call("libgtk-4.so.1", "gtk_accessible_set_accessible_parent", [
             {
@@ -316,6 +439,13 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Updates the next accessible sibling.
+     *
+     * That might be useful when a new child of a custom accessible
+     * is created, and it needs to be linked to a previous child.
+     * @param newSibling - the new next accessible sibling to set
+     */
     updateNextAccessibleSibling(newSibling) {
         call("libgtk-4.so.1", "gtk_accessible_update_next_accessible_sibling", [
             {
@@ -329,6 +459,14 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Informs ATs that the platform state has changed.
+     *
+     * This function should be used by `GtkAccessible` implementations that
+     * have a platform state but are not widgets. Widgets handle platform
+     * states automatically.
+     * @param state - the platform state to update
+     */
     updatePlatformState(state) {
         call("libgtk-4.so.1", "gtk_accessible_update_platform_state", [
             {
@@ -341,6 +479,17 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Updates an array of accessible properties.
+     *
+     * This function should be called by `GtkWidget` types whenever an accessible
+     * property change must be communicated to assistive technologies.
+     *
+     * This function is meant to be used by language bindings.
+     * @param nProperties - the number of accessible properties to set
+     * @param properties - an array of accessible properties
+     * @param values - an array of `GValues`, one for each property
+     */
     updatePropertyValue(nProperties, properties, values) {
         call("libgtk-4.so.1", "gtk_accessible_update_property_value", [
             {
@@ -371,6 +520,17 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Updates an array of accessible relations.
+     *
+     * This function should be called by `GtkWidget` types whenever an accessible
+     * relation change must be communicated to assistive technologies.
+     *
+     * This function is meant to be used by language bindings.
+     * @param nRelations - the number of accessible relations to set
+     * @param relations - an array of accessible relations
+     * @param values - an array of `GValues`, one for each relation
+     */
     updateRelationValue(nRelations, relations, values) {
         call("libgtk-4.so.1", "gtk_accessible_update_relation_value", [
             {
@@ -401,6 +561,17 @@ export class StackPage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Updates an array of accessible states.
+     *
+     * This function should be called by `GtkWidget` types whenever an accessible
+     * state change must be communicated to assistive technologies.
+     *
+     * This function is meant to be used by language bindings.
+     * @param nStates - the number of accessible states to set
+     * @param states - an array of accessible states
+     * @param values - an array of `GValues`, one for each state
+     */
     updateStateValue(nStates, states, values) {
         call("libgtk-4.so.1", "gtk_accessible_update_state_value", [
             {

package/dist/generated/gtk/stack-sidebar.d.ts

@@ -1,10 +1,42 @@
 import { Stack } from "./stack.js";
 import * as GObject from "../gobject/index.js";
 import { Widget } from "./widget.js";
+/**
+ * Uses a sidebar to switch between `GtkStack` pages.
+ *
+ *
+ *
+ * In order to use a `GtkStackSidebar`, you simply use a `GtkStack` to
+ * organize your UI flow, and add the sidebar to your sidebar area. You
+ * can use [method@Gtk.StackSidebar.set_stack] to connect the `GtkStackSidebar`
+ * to the `GtkStack`.
+ *
+ * # CSS nodes
+ *
+ * `GtkStackSidebar` has a single CSS node with name stacksidebar and
+ * style class .sidebar.
+ *
+ * When circumstances require it, `GtkStackSidebar` adds the
+ * .needs-attention style class to the widgets representing the stack
+ * pages.
+ */
 export declare class StackSidebar extends Widget {
+    /**
+     * Creates a new `GtkStackSidebar`.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Retrieves the stack.
+     */
     getStack(): Stack | null;
+    /**
+     * Set the `GtkStack` associated with this `GtkStackSidebar`.
+     *
+     * The sidebar widget will automatically update according to
+     * the order and items within the given `GtkStack`.
+     * @param stack - a `GtkStack`
+     */
     setStack(stack: Stack): void;
     connect(signal: "notify", handler: (self: StackSidebar, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtk/stack-sidebar.js

@@ -2,7 +2,29 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Stack } from "./stack.js";
 import { Widget } from "./widget.js";
+/**
+ * Uses a sidebar to switch between `GtkStack` pages.
+ *
+ *
+ *
+ * In order to use a `GtkStackSidebar`, you simply use a `GtkStack` to
+ * organize your UI flow, and add the sidebar to your sidebar area. You
+ * can use [method@Gtk.StackSidebar.set_stack] to connect the `GtkStackSidebar`
+ * to the `GtkStack`.
+ *
+ * # CSS nodes
+ *
+ * `GtkStackSidebar` has a single CSS node with name stacksidebar and
+ * style class .sidebar.
+ *
+ * When circumstances require it, `GtkStackSidebar` adds the
+ * .needs-attention style class to the widgets representing the stack
+ * pages.
+ */
 export class StackSidebar extends Widget {
+    /**
+     * Creates a new `GtkStackSidebar`.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -12,6 +34,9 @@ export class StackSidebar extends Widget {
             borrowed: true,
         });
     }
+    /**
+     * Retrieves the stack.
+     */
     getStack() {
         const ptr = call("libgtk-4.so.1", "gtk_stack_sidebar_get_stack", [
             {
@@ -23,6 +48,13 @@ export class StackSidebar extends Widget {
             return null;
         return getObject(ptr, Stack);
     }
+    /**
+     * Set the `GtkStack` associated with this `GtkStackSidebar`.
+     *
+     * The sidebar widget will automatically update according to
+     * the order and items within the given `GtkStack`.
+     * @param stack - a `GtkStack`
+     */
     setStack(stack) {
         call("libgtk-4.so.1", "gtk_stack_sidebar_set_stack", [
             {

package/dist/generated/gtk/stack-switcher.d.ts

@@ -2,12 +2,63 @@ import { Orientation } from "./enums.js";
 import { Stack } from "./stack.js";
 import * as GObject from "../gobject/index.js";
 import { Widget } from "./widget.js";
+/**
+ * Shows a row of buttons to switch between `GtkStack` pages.
+ *
+ *
+ *
+ * It acts as a controller for the associated `GtkStack`.
+ *
+ * All the content for the buttons comes from the properties of the stacks
+ * [class@Gtk.StackPage] objects; the button visibility in a `GtkStackSwitcher`
+ * widget is controlled by the visibility of the child in the `GtkStack`.
+ *
+ * It is possible to associate multiple `GtkStackSwitcher` widgets
+ * with the same `GtkStack` widget.
+ *
+ * # CSS nodes
+ *
+ * `GtkStackSwitcher` has a single CSS node named stackswitcher and
+ * style class .stack-switcher.
+ *
+ * When circumstances require it, `GtkStackSwitcher` adds the
+ * .needs-attention style class to the widgets representing the
+ * stack pages.
+ *
+ * # Accessibility
+ *
+ * `GtkStackSwitcher` uses the [enum@Gtk.AccessibleRole.tab_list] role
+ * and uses the [enum@Gtk.AccessibleRole.tab] role for its buttons.
+ *
+ * # Orientable
+ *
+ * Since GTK 4.4, `GtkStackSwitcher` implements `GtkOrientable` allowing
+ * the stack switcher to be made vertical with
+ * `gtk_orientable_set_orientation()`.
+ */
 export declare class StackSwitcher extends Widget {
+    /**
+     * Create a new `GtkStackSwitcher`.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Retrieves the stack.
+     */
     getStack(): Stack | null;
+    /**
+     * Sets the stack to control.
+     * @param stack - a `GtkStack`
+     */
     setStack(stack?: Stack | null): void;
+    /**
+     * Retrieves the orientation of the @orientable.
+     */
     getOrientation(): Orientation;
+    /**
+     * Sets the orientation of the @orientable.
+     * @param orientation - the orientable’s new orientation
+     */
     setOrientation(orientation: Orientation): void;
     connect(signal: "notify", handler: (self: StackSwitcher, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtk/stack-switcher.js

@@ -2,7 +2,44 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Stack } from "./stack.js";
 import { Widget } from "./widget.js";
+/**
+ * Shows a row of buttons to switch between `GtkStack` pages.
+ *
+ *
+ *
+ * It acts as a controller for the associated `GtkStack`.
+ *
+ * All the content for the buttons comes from the properties of the stacks
+ * [class@Gtk.StackPage] objects; the button visibility in a `GtkStackSwitcher`
+ * widget is controlled by the visibility of the child in the `GtkStack`.
+ *
+ * It is possible to associate multiple `GtkStackSwitcher` widgets
+ * with the same `GtkStack` widget.
+ *
+ * # CSS nodes
+ *
+ * `GtkStackSwitcher` has a single CSS node named stackswitcher and
+ * style class .stack-switcher.
+ *
+ * When circumstances require it, `GtkStackSwitcher` adds the
+ * .needs-attention style class to the widgets representing the
+ * stack pages.
+ *
+ * # Accessibility
+ *
+ * `GtkStackSwitcher` uses the [enum@Gtk.AccessibleRole.tab_list] role
+ * and uses the [enum@Gtk.AccessibleRole.tab] role for its buttons.
+ *
+ * # Orientable
+ *
+ * Since GTK 4.4, `GtkStackSwitcher` implements `GtkOrientable` allowing
+ * the stack switcher to be made vertical with
+ * `gtk_orientable_set_orientation()`.
+ */
 export class StackSwitcher extends Widget {
+    /**
+     * Create a new `GtkStackSwitcher`.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -12,6 +49,9 @@ export class StackSwitcher extends Widget {
             borrowed: true,
         });
     }
+    /**
+     * Retrieves the stack.
+     */
     getStack() {
         const ptr = call("libgtk-4.so.1", "gtk_stack_switcher_get_stack", [
             {
@@ -23,6 +63,10 @@ export class StackSwitcher extends Widget {
             return null;
         return getObject(ptr, Stack);
     }
+    /**
+     * Sets the stack to control.
+     * @param stack - a `GtkStack`
+     */
     setStack(stack) {
         call("libgtk-4.so.1", "gtk_stack_switcher_set_stack", [
             {
@@ -36,6 +80,9 @@ export class StackSwitcher extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the orientation of the @orientable.
+     */
     getOrientation() {
         return call("libgtk-4.so.1", "gtk_orientable_get_orientation", [
             {
@@ -44,6 +91,10 @@ export class StackSwitcher extends Widget {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Sets the orientation of the @orientable.
+     * @param orientation - the orientable’s new orientation
+     */
     setOrientation(orientation) {
         call("libgtk-4.so.1", "gtk_orientable_set_orientation", [
             {