@gtkx/ffi 0.1.45 → 0.1.46

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

@@ -1,11 +1,76 @@
 import * as GLib from "../glib/index.js";
+/**
+ * Provides a way to associate widgets with actions.
+ *
+ * It primarily consists of two properties: [property@Gtk.Actionable:action-name]
+ * and [property@Gtk.Actionable:action-target]. There are also some convenience
+ * APIs for setting these properties.
+ *
+ * The action will be looked up in action groups that are found among
+ * the widgets ancestors. Most commonly, these will be the actions with
+ * the “win.” or “app.” prefix that are associated with the
+ * `GtkApplicationWindow` or `GtkApplication`, but other action groups that
+ * are added with [method@Gtk.Widget.insert_action_group] will be consulted
+ * as well.
+ */
 export declare class Actionable {
     ptr: unknown;
     protected constructor(ptr: unknown);
     static fromPtr(ptr: unknown): Actionable;
+    /**
+     * Gets the action name for @actionable.
+     */
     getActionName(): string | null;
+    /**
+     * Gets the current target value of @actionable.
+     */
     getActionTargetValue(): GLib.Variant | null;
+    /**
+     * Specifies the name of the action with which this widget should be
+     * associated.
+     *
+     * If `action_name` is %NULL then the widget will be unassociated from
+     * any previous action.
+     *
+     * Usually this function is used when the widget is located (or will be
+     * located) within the hierarchy of a `GtkApplicationWindow`.
+     *
+     * Names are of the form “win.save” or “app.quit” for actions on the
+     * containing [class@ApplicationWindow] or its associated [class@Application],
+     * respectively. This is the same form used for actions in the [class@Gio.Menu]
+     * associated with the window.
+     * @param actionName - an action name
+     */
     setActionName(actionName?: string | null): void;
+    /**
+     * Sets the target value of an actionable widget.
+     *
+     * If `target_value` is %NULL then the target value is unset.
+     *
+     * The target value has two purposes. First, it is used as the parameter
+     * to activation of the action associated with the `GtkActionable` widget.
+     * Second, it is used to determine if the widget should be rendered as
+     * “active” — the widget is active if the state is equal to the given target.
+     *
+     * Consider the example of associating a set of buttons with a [iface@Gio.Action]
+     * with string state in a typical “radio button” situation. Each button
+     * will be associated with the same action, but with a different target
+     * value for that action. Clicking on a particular button will activate
+     * the action with the target of that button, which will typically cause
+     * the action’s state to change to that value. Since the action’s state
+     * is now equal to the target value of the button, the button will now
+     * be rendered as active (and the other buttons, with different targets,
+     * rendered inactive).
+     * @param targetValue - a [struct@GLib.Variant] to set as the target value
+     */
     setActionTargetValue(targetValue?: GLib.Variant | null): void;
+    /**
+     * Sets the action-name and associated string target value of an
+     * actionable widget.
+     *
+     * `detailed_action_name` is a string in the format accepted by
+     * [func@Gio.Action.parse_detailed_name].
+     * @param detailedActionName - the detailed action name
+     */
     setDetailedActionName(detailedActionName: string): void;
 }

package/dist/generated/gtk/actionable.js

@@ -1,6 +1,20 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as GLib from "../glib/index.js";
+/**
+ * Provides a way to associate widgets with actions.
+ *
+ * It primarily consists of two properties: [property@Gtk.Actionable:action-name]
+ * and [property@Gtk.Actionable:action-target]. There are also some convenience
+ * APIs for setting these properties.
+ *
+ * The action will be looked up in action groups that are found among
+ * the widgets ancestors. Most commonly, these will be the actions with
+ * the “win.” or “app.” prefix that are associated with the
+ * `GtkApplicationWindow` or `GtkApplication`, but other action groups that
+ * are added with [method@Gtk.Widget.insert_action_group] will be consulted
+ * as well.
+ */
 export class Actionable {
     ptr;
     constructor(ptr) {
@@ -9,6 +23,9 @@ export class Actionable {
     static fromPtr(ptr) {
         return new Actionable(ptr);
     }
+    /**
+     * Gets the action name for @actionable.
+     */
     getActionName() {
         return call("libgtk-4.so.1", "gtk_actionable_get_action_name", [
             {
@@ -17,6 +34,9 @@ export class Actionable {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets the current target value of @actionable.
+     */
     getActionTargetValue() {
         const ptr = call("libgtk-4.so.1", "gtk_actionable_get_action_target_value", [
             {
@@ -33,6 +53,22 @@ export class Actionable {
             return null;
         return getObject(ptr, GLib.Variant);
     }
+    /**
+     * Specifies the name of the action with which this widget should be
+     * associated.
+     *
+     * If `action_name` is %NULL then the widget will be unassociated from
+     * any previous action.
+     *
+     * Usually this function is used when the widget is located (or will be
+     * located) within the hierarchy of a `GtkApplicationWindow`.
+     *
+     * Names are of the form “win.save” or “app.quit” for actions on the
+     * containing [class@ApplicationWindow] or its associated [class@Application],
+     * respectively. This is the same form used for actions in the [class@Gio.Menu]
+     * associated with the window.
+     * @param actionName - an action name
+     */
     setActionName(actionName) {
         call("libgtk-4.so.1", "gtk_actionable_set_action_name", [
             {
@@ -46,6 +82,27 @@ export class Actionable {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the target value of an actionable widget.
+     *
+     * If `target_value` is %NULL then the target value is unset.
+     *
+     * The target value has two purposes. First, it is used as the parameter
+     * to activation of the action associated with the `GtkActionable` widget.
+     * Second, it is used to determine if the widget should be rendered as
+     * “active” — the widget is active if the state is equal to the given target.
+     *
+     * Consider the example of associating a set of buttons with a [iface@Gio.Action]
+     * with string state in a typical “radio button” situation. Each button
+     * will be associated with the same action, but with a different target
+     * value for that action. Clicking on a particular button will activate
+     * the action with the target of that button, which will typically cause
+     * the action’s state to change to that value. Since the action’s state
+     * is now equal to the target value of the button, the button will now
+     * be rendered as active (and the other buttons, with different targets,
+     * rendered inactive).
+     * @param targetValue - a [struct@GLib.Variant] to set as the target value
+     */
     setActionTargetValue(targetValue) {
         call("libgtk-4.so.1", "gtk_actionable_set_action_target_value", [
             {
@@ -64,6 +121,14 @@ export class Actionable {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the action-name and associated string target value of an
+     * actionable widget.
+     *
+     * `detailed_action_name` is a string in the format accepted by
+     * [func@Gio.Action.parse_detailed_name].
+     * @param detailedActionName - the detailed action name
+     */
     setDetailedActionName(detailedActionName) {
         call("libgtk-4.so.1", "gtk_actionable_set_detailed_action_name", [
             {

package/dist/generated/gtk/activate-action.d.ts

@@ -1,6 +1,17 @@
 import { ShortcutAction } from "./shortcut-action.js";
+/**
+ * Activates a widget.
+ *
+ * Widgets are activated by calling [method@Gtk.Widget.activate].
+ */
 export declare class ActivateAction extends ShortcutAction {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Gets the activate action.
+     *
+     * This is an action that calls gtk_widget_activate()
+     * on the given widget upon activation.
+     */
     static get(): ActivateAction;
 }

package/dist/generated/gtk/activate-action.js

@@ -1,6 +1,11 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { ShortcutAction } from "./shortcut-action.js";
+/**
+ * Activates a widget.
+ *
+ * Widgets are activated by calling [method@Gtk.Widget.activate].
+ */
 export class ActivateAction extends ShortcutAction {
     constructor(...args) {
         super(...args);
@@ -16,6 +21,12 @@ export class ActivateAction extends ShortcutAction {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Gets the activate action.
+     *
+     * This is an action that calls gtk_widget_activate()
+     * on the given widget upon activation.
+     */
     static get() {
         const ptr = call("libgtk-4.so.1", "gtk_activate_action_get", [], {
             type: "gobject",

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

@@ -1,22 +1,143 @@
 import * as GObject from "../gobject/index.js";
 export declare class Adjustment extends GObject.InitiallyUnowned {
+    /**
+     * Creates a new `GtkAdjustment`.
+     * @param value - the initial value
+     * @param lower - the minimum value
+     * @param upper - the maximum value
+     * @param stepIncrement - the step increment
+     * @param pageIncrement - the page increment
+     * @param pageSize - the page size
+     */
     constructor(value: number, lower: number, upper: number, stepIncrement: number, pageIncrement: number, pageSize: number);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Updates the value of the adjustment to ensure that the
+     * given range is contained in the current page.
+     *
+     * The current page goes from `value` to `value` + `page-size`.
+     * If the range is larger than the page size, then only the
+     * start of it will be in the current page.
+     *
+     * A [signal@Gtk.Adjustment::value-changed] signal will be emitted
+     * if the value is changed.
+     * @param lower - the lower value
+     * @param upper - the upper value
+     */
     clampPage(lower: number, upper: number): void;
+    /**
+     * Sets all properties of the adjustment at once.
+     *
+     * Use this function to avoid multiple emissions of the
+     * [signal@Gtk.Adjustment::changed] signal. See
+     * [method@Gtk.Adjustment.set_lower] for an alternative
+     * way of compressing multiple emissions of
+     * [signal@Gtk.Adjustment::changed] into one.
+     * @param value - the new value
+     * @param lower - the new minimum value
+     * @param upper - the new maximum value
+     * @param stepIncrement - the new step increment
+     * @param pageIncrement - the new page increment
+     * @param pageSize - the new page size
+     */
     configure(value: number, lower: number, upper: number, stepIncrement: number, pageIncrement: number, pageSize: number): void;
+    /**
+     * Retrieves the minimum value of the adjustment.
+     */
     getLower(): number;
+    /**
+     * Gets the smaller of step increment and page increment.
+     */
     getMinimumIncrement(): number;
+    /**
+     * Retrieves the page increment of the adjustment.
+     */
     getPageIncrement(): number;
+    /**
+     * Retrieves the page size of the adjustment.
+     */
     getPageSize(): number;
+    /**
+     * Retrieves the step increment of the adjustment.
+     */
     getStepIncrement(): number;
+    /**
+     * Retrieves the maximum value of the adjustment.
+     */
     getUpper(): number;
+    /**
+     * Gets the current value of the adjustment.
+     */
     getValue(): number;
+    /**
+     * Sets the minimum value of the adjustment.
+     *
+     * When setting multiple adjustment properties via their individual
+     * setters, multiple [signal@Gtk.Adjustment::changed] signals will
+     * be emitted. However, since the emission of the
+     * [signal@Gtk.Adjustment::changed] signal is tied to the emission
+     * of the ::notify signals of the changed properties, it’s possible
+     * to compress the [signal@Gtk.Adjustment::changed] signals into one
+     * by calling g_object_freeze_notify() and g_object_thaw_notify()
+     * around the calls to the individual setters.
+     *
+     * Alternatively, using a single g_object_set() for all the properties
+     * to change, or using [method@Gtk.Adjustment.configure] has the same effect.
+     * @param lower - the new minimum value
+     */
     setLower(lower: number): void;
+    /**
+     * Sets the page increment of the adjustment.
+     *
+     * See [method@Gtk.Adjustment.set_lower] about how to compress
+     * multiple emissions of the [signal@Gtk.Adjustment::changed]
+     * signal when setting multiple adjustment properties.
+     * @param pageIncrement - the new page increment
+     */
     setPageIncrement(pageIncrement: number): void;
+    /**
+     * Sets the page size of the adjustment.
+     *
+     * See [method@Gtk.Adjustment.set_lower] about how to compress
+     * multiple emissions of the [signal@Gtk.Adjustment::changed]
+     * signal when setting multiple adjustment properties.
+     * @param pageSize - the new page size
+     */
     setPageSize(pageSize: number): void;
+    /**
+     * Sets the step increment of the adjustment.
+     *
+     * See [method@Gtk.Adjustment.set_lower] about how to compress
+     * multiple emissions of the [signal@Gtk.Adjustment::changed]
+     * signal when setting multiple adjustment properties.
+     * @param stepIncrement - the new step increment
+     */
     setStepIncrement(stepIncrement: number): void;
+    /**
+     * Sets the maximum value of the adjustment.
+     *
+     * Note that values will be restricted by `upper - page-size`
+     * if the page-size property is nonzero.
+     *
+     * See [method@Gtk.Adjustment.set_lower] about how to compress
+     * multiple emissions of the [signal@Gtk.Adjustment::changed]
+     * signal when setting multiple adjustment properties.
+     * @param upper - the new maximum value
+     */
     setUpper(upper: number): void;
+    /**
+     * Sets the `GtkAdjustment` value.
+     *
+     * The value is clamped to lie between [property@Gtk.Adjustment:lower]
+     * and [property@Gtk.Adjustment:upper].
+     *
+     * Note that for adjustments which are used in a `GtkScrollbar`,
+     * the effective range of allowed values goes from
+     * [property@Gtk.Adjustment:lower] to
+     * [property@Gtk.Adjustment:upper] - [property@Gtk.Adjustment:page-size].
+     * @param value - the new value
+     */
     setValue(value: number): void;
     connect(signal: "changed", handler: (self: Adjustment) => void, after?: boolean): number;
     connect(signal: "value-changed", handler: (self: Adjustment) => void, after?: boolean): number;

package/dist/generated/gtk/adjustment.js

@@ -1,6 +1,19 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
+/**
+ * A model for a numeric value.
+ *
+ * The `GtkAdjustment` has an associated lower and upper bound.
+ * It also contains step and page increments, and a page size.
+ *
+ * Adjustments are used within several GTK widgets, including
+ * [class@Gtk.SpinButton], [class@Gtk.Viewport], [class@Gtk.Scrollbar]
+ * and [class@Gtk.Scale].
+ *
+ * The `GtkAdjustment` object does not update the value itself. Instead
+ * it is left up to the owner of the `GtkAdjustment` to control the value.
+ */
 const SIGNAL_META = {
     changed: { params: [], returnType: { type: "undefined" } },
     "value-changed": { params: [], returnType: { type: "undefined" } },
@@ -38,6 +51,19 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Updates the value of the adjustment to ensure that the
+     * given range is contained in the current page.
+     *
+     * The current page goes from `value` to `value` + `page-size`.
+     * If the range is larger than the page size, then only the
+     * start of it will be in the current page.
+     *
+     * A [signal@Gtk.Adjustment::value-changed] signal will be emitted
+     * if the value is changed.
+     * @param lower - the lower value
+     * @param upper - the upper value
+     */
     clampPage(lower, upper) {
         call("libgtk-4.so.1", "gtk_adjustment_clamp_page", [
             {
@@ -54,6 +80,21 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets all properties of the adjustment at once.
+     *
+     * Use this function to avoid multiple emissions of the
+     * [signal@Gtk.Adjustment::changed] signal. See
+     * [method@Gtk.Adjustment.set_lower] for an alternative
+     * way of compressing multiple emissions of
+     * [signal@Gtk.Adjustment::changed] into one.
+     * @param value - the new value
+     * @param lower - the new minimum value
+     * @param upper - the new maximum value
+     * @param stepIncrement - the new step increment
+     * @param pageIncrement - the new page increment
+     * @param pageSize - the new page size
+     */
     configure(value, lower, upper, stepIncrement, pageIncrement, pageSize) {
         call("libgtk-4.so.1", "gtk_adjustment_configure", [
             {
@@ -86,6 +127,9 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the minimum value of the adjustment.
+     */
     getLower() {
         return call("libgtk-4.so.1", "gtk_adjustment_get_lower", [
             {
@@ -94,6 +138,9 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Gets the smaller of step increment and page increment.
+     */
     getMinimumIncrement() {
         return call("libgtk-4.so.1", "gtk_adjustment_get_minimum_increment", [
             {
@@ -102,6 +149,9 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Retrieves the page increment of the adjustment.
+     */
     getPageIncrement() {
         return call("libgtk-4.so.1", "gtk_adjustment_get_page_increment", [
             {
@@ -110,6 +160,9 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Retrieves the page size of the adjustment.
+     */
     getPageSize() {
         return call("libgtk-4.so.1", "gtk_adjustment_get_page_size", [
             {
@@ -118,6 +171,9 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Retrieves the step increment of the adjustment.
+     */
     getStepIncrement() {
         return call("libgtk-4.so.1", "gtk_adjustment_get_step_increment", [
             {
@@ -126,6 +182,9 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Retrieves the maximum value of the adjustment.
+     */
     getUpper() {
         return call("libgtk-4.so.1", "gtk_adjustment_get_upper", [
             {
@@ -134,6 +193,9 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Gets the current value of the adjustment.
+     */
     getValue() {
         return call("libgtk-4.so.1", "gtk_adjustment_get_value", [
             {
@@ -142,6 +204,22 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Sets the minimum value of the adjustment.
+     *
+     * When setting multiple adjustment properties via their individual
+     * setters, multiple [signal@Gtk.Adjustment::changed] signals will
+     * be emitted. However, since the emission of the
+     * [signal@Gtk.Adjustment::changed] signal is tied to the emission
+     * of the ::notify signals of the changed properties, it’s possible
+     * to compress the [signal@Gtk.Adjustment::changed] signals into one
+     * by calling g_object_freeze_notify() and g_object_thaw_notify()
+     * around the calls to the individual setters.
+     *
+     * Alternatively, using a single g_object_set() for all the properties
+     * to change, or using [method@Gtk.Adjustment.configure] has the same effect.
+     * @param lower - the new minimum value
+     */
     setLower(lower) {
         call("libgtk-4.so.1", "gtk_adjustment_set_lower", [
             {
@@ -154,6 +232,14 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the page increment of the adjustment.
+     *
+     * See [method@Gtk.Adjustment.set_lower] about how to compress
+     * multiple emissions of the [signal@Gtk.Adjustment::changed]
+     * signal when setting multiple adjustment properties.
+     * @param pageIncrement - the new page increment
+     */
     setPageIncrement(pageIncrement) {
         call("libgtk-4.so.1", "gtk_adjustment_set_page_increment", [
             {
@@ -166,6 +252,14 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the page size of the adjustment.
+     *
+     * See [method@Gtk.Adjustment.set_lower] about how to compress
+     * multiple emissions of the [signal@Gtk.Adjustment::changed]
+     * signal when setting multiple adjustment properties.
+     * @param pageSize - the new page size
+     */
     setPageSize(pageSize) {
         call("libgtk-4.so.1", "gtk_adjustment_set_page_size", [
             {
@@ -178,6 +272,14 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the step increment of the adjustment.
+     *
+     * See [method@Gtk.Adjustment.set_lower] about how to compress
+     * multiple emissions of the [signal@Gtk.Adjustment::changed]
+     * signal when setting multiple adjustment properties.
+     * @param stepIncrement - the new step increment
+     */
     setStepIncrement(stepIncrement) {
         call("libgtk-4.so.1", "gtk_adjustment_set_step_increment", [
             {
@@ -190,6 +292,17 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the maximum value of the adjustment.
+     *
+     * Note that values will be restricted by `upper - page-size`
+     * if the page-size property is nonzero.
+     *
+     * See [method@Gtk.Adjustment.set_lower] about how to compress
+     * multiple emissions of the [signal@Gtk.Adjustment::changed]
+     * signal when setting multiple adjustment properties.
+     * @param upper - the new maximum value
+     */
     setUpper(upper) {
         call("libgtk-4.so.1", "gtk_adjustment_set_upper", [
             {
@@ -202,6 +315,18 @@ export class Adjustment extends GObject.InitiallyUnowned {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the `GtkAdjustment` value.
+     *
+     * The value is clamped to lie between [property@Gtk.Adjustment:lower]
+     * and [property@Gtk.Adjustment:upper].
+     *
+     * Note that for adjustments which are used in a `GtkScrollbar`,
+     * the effective range of allowed values goes from
+     * [property@Gtk.Adjustment:lower] to
+     * [property@Gtk.Adjustment:upper] - [property@Gtk.Adjustment:page-size].
+     * @param value - the new value
+     */
     setValue(value) {
         call("libgtk-4.so.1", "gtk_adjustment_set_value", [
             {