@gtkx/ffi 0.1.45 → 0.1.46

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

@@ -3,31 +3,231 @@ import { SelectionModel } from "./selection-model.js";
 import { StackPage } from "./stack-page.js";
 import * as GObject from "../gobject/index.js";
 import { Widget } from "./widget.js";
+/**
+ * Shows one of its children at a time.
+ *
+ *
+ *
+ * In contrast to `GtkNotebook`, `GtkStack` does not provide a means
+ * for users to change the visible child. Instead, a separate widget
+ * such as [class@Gtk.StackSwitcher] or [class@Gtk.StackSidebar] can
+ * be used with `GtkStack` to provide this functionality.
+ *
+ * Transitions between pages can be animated as slides or fades. This
+ * can be controlled with [method@Gtk.Stack.set_transition_type].
+ * These animations respect the [property@Gtk.Settings:gtk-enable-animations]
+ * setting.
+ *
+ * `GtkStack` maintains a [class@Gtk.StackPage] object for each added
+ * child, which holds additional per-child properties. You
+ * obtain the `GtkStackPage` for a child with [method@Gtk.Stack.get_page]
+ * and you can obtain a `GtkSelectionModel` containing all the pages
+ * with [method@Gtk.Stack.get_pages].
+ *
+ * # GtkStack as GtkBuildable
+ *
+ * To set child-specific properties in a .ui file, create `GtkStackPage`
+ * objects explicitly, and set the child widget as a property on it:
+ *
+ * ```xml
+ * <object class="GtkStack" id="stack">
+ * <child>
+ * <object class="GtkStackPage">
+ * <property name="name">page1</property>
+ * <property name="title">In the beginning…</property>
+ * <property name="child">
+ * <object class="GtkLabel">
+ * <property name="label">It was dark</property>
+ * </object>
+ * </property>
+ * </object>
+ * </child>
+ * ```
+ *
+ * # CSS nodes
+ *
+ * `GtkStack` has a single CSS node named stack.
+ *
+ * # Accessibility
+ *
+ * `GtkStack` uses the [enum@Gtk.AccessibleRole.tab_panel] role for the stack
+ * pages, which are the accessible parent objects of the child widgets.
+ */
 export declare class Stack extends Widget {
+    /**
+     * Creates a new `GtkStack`.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Adds a child to @stack.
+     * @param child - the widget to add
+     */
     addChild(child: Widget): StackPage;
+    /**
+     * Adds a child to @stack.
+     *
+     * The child is identified by the @name.
+     * @param child - the widget to add
+     * @param name - the name for @child
+     */
     addNamed(child: Widget, name?: string | null): StackPage;
+    /**
+     * Adds a child to @stack.
+     *
+     * The child is identified by the @name. The `title` will be used by `GtkStackSwitcher` to represent
+     * `child` in a tab bar, so it should be short.
+     * @param child - the widget to add
+     * @param name - the name for @child
+     * @param title - a human-readable title for @child
+     */
     addTitled(child: Widget, title: string, name?: string | null): StackPage;
+    /**
+     * Finds the child with the name given as the argument.
+     *
+     * Returns %NULL if there is no child with this name.
+     * @param name - the name of the child to find
+     */
     getChildByName(name: string): Widget | null;
+    /**
+     * Gets whether `stack` is horizontally homogeneous.
+     */
     getHhomogeneous(): boolean;
+    /**
+     * Returns whether the `GtkStack` is set up to interpolate between
+     * the sizes of children on page switch.
+     */
     getInterpolateSize(): boolean;
+    /**
+     * Returns the `GtkStackPage` object for @child.
+     * @param child - a child of @stack
+     */
     getPage(child: Widget): StackPage;
+    /**
+     * Returns a `GListModel` that contains the pages of the stack.
+     *
+     * This can be used to keep an up-to-date view. The model also
+     * implements [iface@Gtk.SelectionModel] and can be used to track
+     * and modify the visible page.
+     */
     getPages(): SelectionModel;
+    /**
+     * Returns the amount of time (in milliseconds) that
+     * transitions between pages in `stack` will take.
+     */
     getTransitionDuration(): number;
+    /**
+     * Returns whether the `stack` is currently in a transition from one page to
+     * another.
+     */
     getTransitionRunning(): boolean;
+    /**
+     * Gets the type of animation that will be used
+     * for transitions between pages in @stack.
+     */
     getTransitionType(): StackTransitionType;
+    /**
+     * Gets whether `stack` is vertically homogeneous.
+     */
     getVhomogeneous(): boolean;
+    /**
+     * Gets the currently visible child of @stack.
+     *
+     * Returns %NULL if there are no visible children.
+     */
     getVisibleChild(): Widget | null;
+    /**
+     * Returns the name of the currently visible child of @stack.
+     *
+     * Returns %NULL if there is no visible child.
+     */
     getVisibleChildName(): string | null;
+    /**
+     * Removes a child widget from @stack.
+     * @param child - the child to remove
+     */
     remove(child: Widget): void;
+    /**
+     * Sets the `GtkStack` to be horizontally homogeneous or not.
+     *
+     * If it is homogeneous, the `GtkStack` will request the same
+     * width for all its children. If it isn't, the stack
+     * may change width when a different child becomes visible.
+     * @param hhomogeneous - %TRUE to make `stack` horizontally homogeneous
+     */
     setHhomogeneous(hhomogeneous: boolean): void;
+    /**
+     * Sets whether or not `stack` will interpolate its size when
+     * changing the visible child.
+     *
+     * If the [property@Gtk.Stack:interpolate-size] property is set
+     * to %TRUE, `stack` will interpolate its size between the current
+     * one and the one it'll take after changing the visible child,
+     * according to the set transition duration.
+     * @param interpolateSize - the new value
+     */
     setInterpolateSize(interpolateSize: boolean): void;
+    /**
+     * Sets the duration that transitions between pages in `stack` will take.
+     * @param duration - the new duration, in milliseconds
+     */
     setTransitionDuration(duration: number): void;
+    /**
+     * Sets the type of animation that will be used for
+     * transitions between pages in @stack.
+     *
+     * Available types include various kinds of fades and slides.
+     *
+     * The transition type can be changed without problems
+     * at runtime, so it is possible to change the animation
+     * based on the page that is about to become current.
+     * @param transition - the new transition type
+     */
     setTransitionType(transition: StackTransitionType): void;
+    /**
+     * Sets the `GtkStack` to be vertically homogeneous or not.
+     *
+     * If it is homogeneous, the `GtkStack` will request the same
+     * height for all its children. If it isn't, the stack
+     * may change height when a different child becomes visible.
+     * @param vhomogeneous - %TRUE to make `stack` vertically homogeneous
+     */
     setVhomogeneous(vhomogeneous: boolean): void;
+    /**
+     * Makes `child` the visible child of @stack.
+     *
+     * If `child` is different from the currently visible child,
+     * the transition between the two will be animated with the
+     * current transition type of @stack.
+     *
+     * Note that the `child` widget has to be visible itself
+     * (see [method@Gtk.Widget.show]) in order to become the visible
+     * child of @stack.
+     * @param child - a child of @stack
+     */
     setVisibleChild(child: Widget): void;
+    /**
+     * Makes the child with the given name visible.
+     *
+     * Note that the child widget has to be visible itself
+     * (see [method@Gtk.Widget.show]) in order to become the visible
+     * child of @stack.
+     * @param name - the name of the child to make visible
+     * @param transition - the transition type to use
+     */
     setVisibleChildFull(name: string, transition: StackTransitionType): void;
+    /**
+     * Makes the child with the given name visible.
+     *
+     * If `child` is different from the currently visible child,
+     * the transition between the two will be animated with the
+     * current transition type of @stack.
+     *
+     * Note that the child widget has to be visible itself
+     * (see [method@Gtk.Widget.show]) in order to become the visible
+     * child of @stack.
+     * @param name - the name of the child to make visible
+     */
     setVisibleChildName(name: string): void;
     connect(signal: "notify", handler: (self: Stack, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtk/stack.js

@@ -3,7 +3,60 @@ import { getObject } from "@gtkx/ffi";
 import { SelectionModel } from "./selection-model.js";
 import { StackPage } from "./stack-page.js";
 import { Widget } from "./widget.js";
+/**
+ * Shows one of its children at a time.
+ *
+ *
+ *
+ * In contrast to `GtkNotebook`, `GtkStack` does not provide a means
+ * for users to change the visible child. Instead, a separate widget
+ * such as [class@Gtk.StackSwitcher] or [class@Gtk.StackSidebar] can
+ * be used with `GtkStack` to provide this functionality.
+ *
+ * Transitions between pages can be animated as slides or fades. This
+ * can be controlled with [method@Gtk.Stack.set_transition_type].
+ * These animations respect the [property@Gtk.Settings:gtk-enable-animations]
+ * setting.
+ *
+ * `GtkStack` maintains a [class@Gtk.StackPage] object for each added
+ * child, which holds additional per-child properties. You
+ * obtain the `GtkStackPage` for a child with [method@Gtk.Stack.get_page]
+ * and you can obtain a `GtkSelectionModel` containing all the pages
+ * with [method@Gtk.Stack.get_pages].
+ *
+ * # GtkStack as GtkBuildable
+ *
+ * To set child-specific properties in a .ui file, create `GtkStackPage`
+ * objects explicitly, and set the child widget as a property on it:
+ *
+ * ```xml
+ * <object class="GtkStack" id="stack">
+ * <child>
+ * <object class="GtkStackPage">
+ * <property name="name">page1</property>
+ * <property name="title">In the beginning…</property>
+ * <property name="child">
+ * <object class="GtkLabel">
+ * <property name="label">It was dark</property>
+ * </object>
+ * </property>
+ * </object>
+ * </child>
+ * ```
+ *
+ * # CSS nodes
+ *
+ * `GtkStack` has a single CSS node named stack.
+ *
+ * # Accessibility
+ *
+ * `GtkStack` uses the [enum@Gtk.AccessibleRole.tab_panel] role for the stack
+ * pages, which are the accessible parent objects of the child widgets.
+ */
 export class Stack extends Widget {
+    /**
+     * Creates a new `GtkStack`.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -13,6 +66,10 @@ export class Stack extends Widget {
             borrowed: true,
         });
     }
+    /**
+     * Adds a child to @stack.
+     * @param child - the widget to add
+     */
     addChild(child) {
         const ptr = call("libgtk-4.so.1", "gtk_stack_add_child", [
             {
@@ -26,6 +83,13 @@ export class Stack extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, StackPage);
     }
+    /**
+     * Adds a child to @stack.
+     *
+     * The child is identified by the @name.
+     * @param child - the widget to add
+     * @param name - the name for @child
+     */
     addNamed(child, name) {
         const ptr = call("libgtk-4.so.1", "gtk_stack_add_named", [
             {
@@ -44,6 +108,15 @@ export class Stack extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, StackPage);
     }
+    /**
+     * Adds a child to @stack.
+     *
+     * The child is identified by the @name. The `title` will be used by `GtkStackSwitcher` to represent
+     * `child` in a tab bar, so it should be short.
+     * @param child - the widget to add
+     * @param name - the name for @child
+     * @param title - a human-readable title for @child
+     */
     addTitled(child, title, name) {
         const ptr = call("libgtk-4.so.1", "gtk_stack_add_titled", [
             {
@@ -66,6 +139,12 @@ export class Stack extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, StackPage);
     }
+    /**
+     * Finds the child with the name given as the argument.
+     *
+     * Returns %NULL if there is no child with this name.
+     * @param name - the name of the child to find
+     */
     getChildByName(name) {
         const ptr = call("libgtk-4.so.1", "gtk_stack_get_child_by_name", [
             {
@@ -81,6 +160,9 @@ export class Stack extends Widget {
             return null;
         return getObject(ptr, Widget);
     }
+    /**
+     * Gets whether `stack` is horizontally homogeneous.
+     */
     getHhomogeneous() {
         return call("libgtk-4.so.1", "gtk_stack_get_hhomogeneous", [
             {
@@ -89,6 +171,10 @@ export class Stack extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the `GtkStack` is set up to interpolate between
+     * the sizes of children on page switch.
+     */
     getInterpolateSize() {
         return call("libgtk-4.so.1", "gtk_stack_get_interpolate_size", [
             {
@@ -97,6 +183,10 @@ export class Stack extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the `GtkStackPage` object for @child.
+     * @param child - a child of @stack
+     */
     getPage(child) {
         const ptr = call("libgtk-4.so.1", "gtk_stack_get_page", [
             {
@@ -110,6 +200,13 @@ export class Stack extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, StackPage);
     }
+    /**
+     * Returns a `GListModel` that contains the pages of the stack.
+     *
+     * This can be used to keep an up-to-date view. The model also
+     * implements [iface@Gtk.SelectionModel] and can be used to track
+     * and modify the visible page.
+     */
     getPages() {
         const ptr = call("libgtk-4.so.1", "gtk_stack_get_pages", [
             {
@@ -119,6 +216,10 @@ export class Stack extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, SelectionModel);
     }
+    /**
+     * Returns the amount of time (in milliseconds) that
+     * transitions between pages in `stack` will take.
+     */
     getTransitionDuration() {
         return call("libgtk-4.so.1", "gtk_stack_get_transition_duration", [
             {
@@ -127,6 +228,10 @@ export class Stack extends Widget {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Returns whether the `stack` is currently in a transition from one page to
+     * another.
+     */
     getTransitionRunning() {
         return call("libgtk-4.so.1", "gtk_stack_get_transition_running", [
             {
@@ -135,6 +240,10 @@ export class Stack extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the type of animation that will be used
+     * for transitions between pages in @stack.
+     */
     getTransitionType() {
         return call("libgtk-4.so.1", "gtk_stack_get_transition_type", [
             {
@@ -143,6 +252,9 @@ export class Stack extends Widget {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets whether `stack` is vertically homogeneous.
+     */
     getVhomogeneous() {
         return call("libgtk-4.so.1", "gtk_stack_get_vhomogeneous", [
             {
@@ -151,6 +263,11 @@ export class Stack extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the currently visible child of @stack.
+     *
+     * Returns %NULL if there are no visible children.
+     */
     getVisibleChild() {
         const ptr = call("libgtk-4.so.1", "gtk_stack_get_visible_child", [
             {
@@ -162,6 +279,11 @@ export class Stack extends Widget {
             return null;
         return getObject(ptr, Widget);
     }
+    /**
+     * Returns the name of the currently visible child of @stack.
+     *
+     * Returns %NULL if there is no visible child.
+     */
     getVisibleChildName() {
         return call("libgtk-4.so.1", "gtk_stack_get_visible_child_name", [
             {
@@ -170,6 +292,10 @@ export class Stack extends Widget {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Removes a child widget from @stack.
+     * @param child - the child to remove
+     */
     remove(child) {
         call("libgtk-4.so.1", "gtk_stack_remove", [
             {
@@ -182,6 +308,14 @@ export class Stack extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the `GtkStack` to be horizontally homogeneous or not.
+     *
+     * If it is homogeneous, the `GtkStack` will request the same
+     * width for all its children. If it isn't, the stack
+     * may change width when a different child becomes visible.
+     * @param hhomogeneous - %TRUE to make `stack` horizontally homogeneous
+     */
     setHhomogeneous(hhomogeneous) {
         call("libgtk-4.so.1", "gtk_stack_set_hhomogeneous", [
             {
@@ -194,6 +328,16 @@ export class Stack extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether or not `stack` will interpolate its size when
+     * changing the visible child.
+     *
+     * If the [property@Gtk.Stack:interpolate-size] property is set
+     * to %TRUE, `stack` will interpolate its size between the current
+     * one and the one it'll take after changing the visible child,
+     * according to the set transition duration.
+     * @param interpolateSize - the new value
+     */
     setInterpolateSize(interpolateSize) {
         call("libgtk-4.so.1", "gtk_stack_set_interpolate_size", [
             {
@@ -206,6 +350,10 @@ export class Stack extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the duration that transitions between pages in `stack` will take.
+     * @param duration - the new duration, in milliseconds
+     */
     setTransitionDuration(duration) {
         call("libgtk-4.so.1", "gtk_stack_set_transition_duration", [
             {
@@ -218,6 +366,17 @@ export class Stack extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the type of animation that will be used for
+     * transitions between pages in @stack.
+     *
+     * Available types include various kinds of fades and slides.
+     *
+     * The transition type can be changed without problems
+     * at runtime, so it is possible to change the animation
+     * based on the page that is about to become current.
+     * @param transition - the new transition type
+     */
     setTransitionType(transition) {
         call("libgtk-4.so.1", "gtk_stack_set_transition_type", [
             {
@@ -230,6 +389,14 @@ export class Stack extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the `GtkStack` to be vertically homogeneous or not.
+     *
+     * If it is homogeneous, the `GtkStack` will request the same
+     * height for all its children. If it isn't, the stack
+     * may change height when a different child becomes visible.
+     * @param vhomogeneous - %TRUE to make `stack` vertically homogeneous
+     */
     setVhomogeneous(vhomogeneous) {
         call("libgtk-4.so.1", "gtk_stack_set_vhomogeneous", [
             {
@@ -242,6 +409,18 @@ export class Stack extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Makes `child` the visible child of @stack.
+     *
+     * If `child` is different from the currently visible child,
+     * the transition between the two will be animated with the
+     * current transition type of @stack.
+     *
+     * Note that the `child` widget has to be visible itself
+     * (see [method@Gtk.Widget.show]) in order to become the visible
+     * child of @stack.
+     * @param child - a child of @stack
+     */
     setVisibleChild(child) {
         call("libgtk-4.so.1", "gtk_stack_set_visible_child", [
             {
@@ -254,6 +433,15 @@ export class Stack extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Makes the child with the given name visible.
+     *
+     * Note that the child widget has to be visible itself
+     * (see [method@Gtk.Widget.show]) in order to become the visible
+     * child of @stack.
+     * @param name - the name of the child to make visible
+     * @param transition - the transition type to use
+     */
     setVisibleChildFull(name, transition) {
         call("libgtk-4.so.1", "gtk_stack_set_visible_child_full", [
             {
@@ -270,6 +458,18 @@ export class Stack extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Makes the child with the given name visible.
+     *
+     * If `child` is different from the currently visible child,
+     * the transition between the two will be animated with the
+     * current transition type of @stack.
+     *
+     * Note that the child widget has to be visible itself
+     * (see [method@Gtk.Widget.show]) in order to become the visible
+     * child of @stack.
+     * @param name - the name of the child to make visible
+     */
     setVisibleChildName(name) {
         call("libgtk-4.so.1", "gtk_stack_set_visible_child_name", [
             {

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

@@ -1,12 +1,47 @@
 import * as GObject from "../gobject/index.js";
 import { Widget } from "./widget.js";
 export declare class Statusbar extends Widget {
+    /**
+     * Creates a new `GtkStatusbar` ready for messages.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Returns a new context identifier, given a description
+     * of the actual context.
+     *
+     * Note that the description is not shown in the UI.
+     * @param contextDescription - textual description of what context
+     */
     getContextId(contextDescription: string): number;
+    /**
+     * Removes the first message in the `GtkStatusbar`’s stack
+     * with the given context id.
+     *
+     * Note that this may not change the displayed message,
+     * if the message at the top of the stack has a different
+     * context id.
+     * @param contextId - a context identifier
+     */
     pop(contextId: number): void;
+    /**
+     * Pushes a new message onto a statusbar’s stack.
+     * @param contextId - the message’s context id, as returned by
+     * @param text - the message to add to the statusbar
+     */
     push(contextId: number, text: string): number;
+    /**
+     * Forces the removal of a message from a statusbar’s stack.
+     * The exact `context_id` and `message_id` must be specified.
+     * @param contextId - a context identifier
+     * @param messageId - a message identifier, as returned by [method@Gtk.Statusbar.push]
+     */
     remove(contextId: number, messageId: number): void;
+    /**
+     * Forces the removal of all messages from a statusbar's
+     * stack with the exact @context_id.
+     * @param contextId - a context identifier
+     */
     removeAll(contextId: number): void;
     connect(signal: "text-popped", handler: (self: Statusbar, contextId: number, text: string) => void, after?: boolean): number;
     connect(signal: "text-pushed", handler: (self: Statusbar, contextId: number, text: string) => void, after?: boolean): number;