@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtk/mount-operation.js

@@ -3,6 +3,21 @@ import { getObject } from "@gtkx/ffi";
 import { Window } from "./window.js";
 import * as Gdk from "../gdk/index.js";
 import * as Gio from "../gio/index.js";
+/**
+ * Asks the user for passwords and other information required to
+ * mount a volume.
+ *
+ * `GtkMountOperation` is needed when mounting volumes:
+ * It is an implementation of `GMountOperation` that can be used with
+ * GIO functions for mounting volumes such as
+ * [method@Gio.File.mount_enclosing_volume],
+ * [method@Gio.File.mount_mountable],
+ * [method@Gio.Volume.mount],
+ * [method@Gio.Mount.unmount_with_operation] and others.
+ *
+ * When necessary, `GtkMountOperation` shows dialogs to let the user
+ * enter passwords, ask questions or show processes blocking unmount.
+ */
 export class MountOperation extends Gio.MountOperation {
     constructor(...args) {
         super(...args);
@@ -17,6 +32,10 @@ export class MountOperation extends Gio.MountOperation {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Gets the display on which windows of the `GtkMountOperation`
+     * will be shown.
+     */
     getDisplay() {
         const ptr = call("libgtk-4.so.1", "gtk_mount_operation_get_display", [
             {
@@ -26,6 +45,9 @@ export class MountOperation extends Gio.MountOperation {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Gdk.Display);
     }
+    /**
+     * Gets the transient parent used by the `GtkMountOperation`.
+     */
     getParent() {
         const ptr = call("libgtk-4.so.1", "gtk_mount_operation_get_parent", [
             {
@@ -37,6 +59,10 @@ export class MountOperation extends Gio.MountOperation {
             return null;
         return getObject(ptr, Window);
     }
+    /**
+     * Returns whether the `GtkMountOperation` is currently displaying
+     * a window.
+     */
     isShowing() {
         return call("libgtk-4.so.1", "gtk_mount_operation_is_showing", [
             {
@@ -45,6 +71,10 @@ export class MountOperation extends Gio.MountOperation {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets the display to show windows of the `GtkMountOperation` on.
+     * @param display - a `GdkDisplay`
+     */
     setDisplay(display) {
         call("libgtk-4.so.1", "gtk_mount_operation_set_display", [
             {
@@ -57,6 +87,11 @@ export class MountOperation extends Gio.MountOperation {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the transient parent for windows shown by the
+     * `GtkMountOperation`.
+     * @param parent - transient parent of the window
+     */
     setParent(parent) {
         call("libgtk-4.so.1", "gtk_mount_operation_set_parent", [
             {

package/dist/generated/gtk/multi-filter.d.ts

@@ -1,10 +1,28 @@
 import * as GObject from "../gobject/index.js";
 import { Filter } from "./filter.js";
+/** Base class for filters that combine multiple filters. */
 export declare class MultiFilter extends Filter {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Adds a filter.
+     * @param filter - a filter to add
+     */
     append(filter: Filter): void;
+    /**
+     * Removes a filter.
+     *
+     * If `position` is larger than the number of filters,
+     * nothing happens.
+     * @param position - position of filter to remove
+     */
     remove(position: number): void;
+    /**
+     * Gets the ID of the `buildable` object.
+     *
+     * `GtkBuilder` sets the name based on the ID attribute
+     * of the `<object>` tag used to construct the @buildable.
+     */
     getBuildableId(): string | null;
     connect(signal: "notify", handler: (self: MultiFilter, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtk/multi-filter.js

@@ -1,6 +1,7 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Filter } from "./filter.js";
+/** Base class for filters that combine multiple filters. */
 export class MultiFilter extends Filter {
     constructor(...args) {
         super(...args);
@@ -16,6 +17,10 @@ export class MultiFilter extends Filter {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Adds a filter.
+     * @param filter - a filter to add
+     */
     append(filter) {
         call("libgtk-4.so.1", "gtk_multi_filter_append", [
             {
@@ -28,6 +33,13 @@ export class MultiFilter extends Filter {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes a filter.
+     *
+     * If `position` is larger than the number of filters,
+     * nothing happens.
+     * @param position - position of filter to remove
+     */
     remove(position) {
         call("libgtk-4.so.1", "gtk_multi_filter_remove", [
             {
@@ -40,6 +52,12 @@ export class MultiFilter extends Filter {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the ID of the `buildable` object.
+     *
+     * `GtkBuilder` sets the name based on the ID attribute
+     * of the `<object>` tag used to construct the @buildable.
+     */
     getBuildableId() {
         return call("libgtk-4.so.1", "gtk_buildable_get_buildable_id", [
             {

package/dist/generated/gtk/multi-selection.d.ts

@@ -2,24 +2,159 @@ import { Ref } from "@gtkx/native";
 import { Bitset } from "./bitset.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
+/** A selection model that allows selecting multiple elements. */
 export declare class MultiSelection extends GObject.GObject {
+    /**
+     * Creates a new selection to handle @model.
+     * @param model - the `GListModel` to manage
+     */
     constructor(model?: Gio.ListModel | null);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Returns the underlying model of @self.
+     */
     getModel(): Gio.ListModel | null;
+    /**
+     * Sets the model that `self` should wrap.
+     *
+     * If `model` is %NULL, `self` will be empty.
+     * @param model - A `GListModel` to wrap
+     */
     setModel(model?: Gio.ListModel | null): void;
+    /**
+     * Query the section that covers the given position. The number of
+     * items in the section can be computed by `out_end - out_start`.
+     *
+     * If the position is larger than the number of items, a single
+     * range from n_items to G_MAXUINT will be returned.
+     * @param position - the position of the item to query
+     * @param outStart - the position of the first item in the section
+     * @param outEnd - the position of the first item not part of the section
+     */
     getSection(position: number, outStart: Ref<number>, outEnd: Ref<number>): void;
+    /**
+     * This function emits the [signal@Gtk.SectionModel::sections-changed]
+     * signal to notify about changes to sections.
+     *
+     * It must cover all positions that used to be a section start or that
+     * are now a section start. It does not have to cover all positions for
+     * which the section has changed.
+     *
+     * The [signal@Gio.ListModel::items-changed] implies the effect of the
+     * [signal@Gtk.SectionModel::sections-changed] signal for all the items
+     * it covers.
+     *
+     * It is recommended that when changes to the items cause section changes
+     * in a larger range, that the larger range is included in the emission
+     * of the [signal@Gio.ListModel::items-changed] instead of emitting
+     * two signals.
+     * @param position - the first changed item
+     * @param nItems - the number of changed items
+     */
     sectionsChanged(position: number, nItems: number): void;
+    /**
+     * Gets the set containing all currently selected items in the model.
+     *
+     * This function may be slow, so if you are only interested in single item,
+     * consider using [method@Gtk.SelectionModel.is_selected] or if you are only
+     * interested in a few, consider [method@Gtk.SelectionModel.get_selection_in_range].
+     */
     getSelection(): Bitset;
+    /**
+     * Gets the set of selected items in a range.
+     *
+     * This function is an optimization for
+     * [method@Gtk.SelectionModel.get_selection] when you are only
+     * interested in part of the model's selected state. A common use
+     * case is in response to the [signal@Gtk.SelectionModel::selection-changed]
+     * signal.
+     * @param position - start of the queried range
+     * @param nItems - number of items in the queried range
+     */
     getSelectionInRange(position: number, nItems: number): Bitset;
+    /**
+     * Checks if the given item is selected.
+     * @param position - the position of the item to query
+     */
     isSelected(position: number): boolean;
+    /**
+     * Requests to select all items in the model.
+     */
     selectAll(): boolean;
+    /**
+     * Requests to select an item in the model.
+     * @param position - the position of the item to select
+     * @param unselectRest - whether previously selected items should be unselected
+     */
     selectItem(position: number, unselectRest: boolean): boolean;
+    /**
+     * Requests to select a range of items in the model.
+     * @param position - the first item to select
+     * @param nItems - the number of items to select
+     * @param unselectRest - whether previously selected items should be unselected
+     */
     selectRange(position: number, nItems: number, unselectRest: boolean): boolean;
+    /**
+     * Helper function for implementations of `GtkSelectionModel`.
+     *
+     * Call this when the selection changes to emit the
+     * [signal@Gtk.SelectionModel::selection-changed] signal.
+     * @param position - the first changed item
+     * @param nItems - the number of changed items
+     */
     selectionChanged(position: number, nItems: number): void;
+    /**
+     * Make selection changes.
+     *
+     * This is the most advanced selection updating method that allows
+     * the most fine-grained control over selection changes. If you can,
+     * you should try the simpler versions, as implementations are more
+     * likely to implement support for those.
+     *
+     * Requests that the selection state of all positions set in `mask` be updated to the respective value in the `selected` bitmask.
+     *
+     * In pseudocode, it would look something like this:
+     *
+     * ```c
+     * for (i = 0; i < n_items; i++)
+     * {
+     * // don't change values not in the mask
+     * if (!gtk_bitset_contains (mask, i))
+     * continue;
+     *
+     * if (gtk_bitset_contains (selected, i))
+     * select_item (i);
+     * else
+     * unselect_item (i);
+     * }
+     *
+     * gtk_selection_model_selection_changed (model,
+     * first_changed_item,
+     * n_changed_items);
+     * ```
+     *
+     * `mask` and `selected` must not be modified. They may refer to the
+     * same bitset, which would mean that every item in the set should
+     * be selected.
+     * @param selected - bitmask specifying if items should be selected or unselected
+     * @param mask - bitmask specifying which items should be updated
+     */
     setSelection(selected: Bitset, mask: Bitset): boolean;
+    /**
+     * Requests to unselect all items in the model.
+     */
     unselectAll(): boolean;
+    /**
+     * Requests to unselect an item in the model.
+     * @param position - the position of the item to unselect
+     */
     unselectItem(position: number): boolean;
+    /**
+     * Requests to unselect a range of items in the model.
+     * @param position - the first item to unselect
+     * @param nItems - the number of items to unselect
+     */
     unselectRange(position: number, nItems: number): boolean;
     connect(signal: "notify", handler: (self: MultiSelection, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtk/multi-selection.js

@@ -3,6 +3,7 @@ import { getObject } from "@gtkx/ffi";
 import { Bitset } from "./bitset.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
+/** A selection model that allows selecting multiple elements. */
 export class MultiSelection extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -17,6 +18,9 @@ export class MultiSelection extends GObject.GObject {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Returns the underlying model of @self.
+     */
     getModel() {
         const ptr = call("libgtk-4.so.1", "gtk_multi_selection_get_model", [
             {
@@ -28,6 +32,12 @@ export class MultiSelection extends GObject.GObject {
             return null;
         return getObject(ptr, Gio.ListModel);
     }
+    /**
+     * Sets the model that `self` should wrap.
+     *
+     * If `model` is %NULL, `self` will be empty.
+     * @param model - A `GListModel` to wrap
+     */
     setModel(model) {
         call("libgtk-4.so.1", "gtk_multi_selection_set_model", [
             {
@@ -41,6 +51,16 @@ export class MultiSelection extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Query the section that covers the given position. The number of
+     * items in the section can be computed by `out_end - out_start`.
+     *
+     * If the position is larger than the number of items, a single
+     * range from n_items to G_MAXUINT will be returned.
+     * @param position - the position of the item to query
+     * @param outStart - the position of the first item in the section
+     * @param outEnd - the position of the first item not part of the section
+     */
     getSection(position, outStart, outEnd) {
         call("libgtk-4.so.1", "gtk_section_model_get_section", [
             {
@@ -67,6 +87,25 @@ export class MultiSelection extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * This function emits the [signal@Gtk.SectionModel::sections-changed]
+     * signal to notify about changes to sections.
+     *
+     * It must cover all positions that used to be a section start or that
+     * are now a section start. It does not have to cover all positions for
+     * which the section has changed.
+     *
+     * The [signal@Gio.ListModel::items-changed] implies the effect of the
+     * [signal@Gtk.SectionModel::sections-changed] signal for all the items
+     * it covers.
+     *
+     * It is recommended that when changes to the items cause section changes
+     * in a larger range, that the larger range is included in the emission
+     * of the [signal@Gio.ListModel::items-changed] instead of emitting
+     * two signals.
+     * @param position - the first changed item
+     * @param nItems - the number of changed items
+     */
     sectionsChanged(position, nItems) {
         call("libgtk-4.so.1", "gtk_section_model_sections_changed", [
             {
@@ -83,6 +122,13 @@ export class MultiSelection extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the set containing all currently selected items in the model.
+     *
+     * This function may be slow, so if you are only interested in single item,
+     * consider using [method@Gtk.SelectionModel.is_selected] or if you are only
+     * interested in a few, consider [method@Gtk.SelectionModel.get_selection_in_range].
+     */
     getSelection() {
         const ptr = call("libgtk-4.so.1", "gtk_selection_model_get_selection", [
             {
@@ -97,6 +143,17 @@ export class MultiSelection extends GObject.GObject {
         });
         return getObject(ptr, Bitset);
     }
+    /**
+     * Gets the set of selected items in a range.
+     *
+     * This function is an optimization for
+     * [method@Gtk.SelectionModel.get_selection] when you are only
+     * interested in part of the model's selected state. A common use
+     * case is in response to the [signal@Gtk.SelectionModel::selection-changed]
+     * signal.
+     * @param position - start of the queried range
+     * @param nItems - number of items in the queried range
+     */
     getSelectionInRange(position, nItems) {
         const ptr = call("libgtk-4.so.1", "gtk_selection_model_get_selection_in_range", [
             {
@@ -119,6 +176,10 @@ export class MultiSelection extends GObject.GObject {
         });
         return getObject(ptr, Bitset);
     }
+    /**
+     * Checks if the given item is selected.
+     * @param position - the position of the item to query
+     */
     isSelected(position) {
         return call("libgtk-4.so.1", "gtk_selection_model_is_selected", [
             {
@@ -131,6 +192,9 @@ export class MultiSelection extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Requests to select all items in the model.
+     */
     selectAll() {
         return call("libgtk-4.so.1", "gtk_selection_model_select_all", [
             {
@@ -139,6 +203,11 @@ export class MultiSelection extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Requests to select an item in the model.
+     * @param position - the position of the item to select
+     * @param unselectRest - whether previously selected items should be unselected
+     */
     selectItem(position, unselectRest) {
         return call("libgtk-4.so.1", "gtk_selection_model_select_item", [
             {
@@ -155,6 +224,12 @@ export class MultiSelection extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Requests to select a range of items in the model.
+     * @param position - the first item to select
+     * @param nItems - the number of items to select
+     * @param unselectRest - whether previously selected items should be unselected
+     */
     selectRange(position, nItems, unselectRest) {
         return call("libgtk-4.so.1", "gtk_selection_model_select_range", [
             {
@@ -175,6 +250,14 @@ export class MultiSelection extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Helper function for implementations of `GtkSelectionModel`.
+     *
+     * Call this when the selection changes to emit the
+     * [signal@Gtk.SelectionModel::selection-changed] signal.
+     * @param position - the first changed item
+     * @param nItems - the number of changed items
+     */
     selectionChanged(position, nItems) {
         call("libgtk-4.so.1", "gtk_selection_model_selection_changed", [
             {
@@ -191,6 +274,42 @@ export class MultiSelection extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Make selection changes.
+     *
+     * This is the most advanced selection updating method that allows
+     * the most fine-grained control over selection changes. If you can,
+     * you should try the simpler versions, as implementations are more
+     * likely to implement support for those.
+     *
+     * Requests that the selection state of all positions set in `mask` be updated to the respective value in the `selected` bitmask.
+     *
+     * In pseudocode, it would look something like this:
+     *
+     * ```c
+     * for (i = 0; i < n_items; i++)
+     * {
+     * // don't change values not in the mask
+     * if (!gtk_bitset_contains (mask, i))
+     * continue;
+     *
+     * if (gtk_bitset_contains (selected, i))
+     * select_item (i);
+     * else
+     * unselect_item (i);
+     * }
+     *
+     * gtk_selection_model_selection_changed (model,
+     * first_changed_item,
+     * n_changed_items);
+     * ```
+     *
+     * `mask` and `selected` must not be modified. They may refer to the
+     * same bitset, which would mean that every item in the set should
+     * be selected.
+     * @param selected - bitmask specifying if items should be selected or unselected
+     * @param mask - bitmask specifying which items should be updated
+     */
     setSelection(selected, mask) {
         return call("libgtk-4.so.1", "gtk_selection_model_set_selection", [
             {
@@ -217,6 +336,9 @@ export class MultiSelection extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Requests to unselect all items in the model.
+     */
     unselectAll() {
         return call("libgtk-4.so.1", "gtk_selection_model_unselect_all", [
             {
@@ -225,6 +347,10 @@ export class MultiSelection extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Requests to unselect an item in the model.
+     * @param position - the position of the item to unselect
+     */
     unselectItem(position) {
         return call("libgtk-4.so.1", "gtk_selection_model_unselect_item", [
             {
@@ -237,6 +363,11 @@ export class MultiSelection extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Requests to unselect a range of items in the model.
+     * @param position - the first item to unselect
+     * @param nItems - the number of items to unselect
+     */
     unselectRange(position, nItems) {
         return call("libgtk-4.so.1", "gtk_selection_model_unselect_range", [
             {

package/dist/generated/gtk/multi-sorter.d.ts

@@ -1,10 +1,44 @@
 import * as GObject from "../gobject/index.js";
 import { Sorter } from "./sorter.js";
+/**
+ * Combines multiple sorters by trying them in turn.
+ *
+ * If the first sorter compares two items as equal,
+ * the second is tried next, and so on.
+ */
 export declare class MultiSorter extends Sorter {
+    /**
+     * Creates a new multi sorter.
+     *
+     * This sorter compares items by trying each of the sorters
+     * in turn, until one returns non-zero. In particular, if
+     * no sorter has been added to it, it will always compare
+     * items as equal.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Add `sorter` to `self` to use for sorting at the end.
+     *
+     * `self` will consult all existing sorters before it will
+     * sort with the given @sorter.
+     * @param sorter - a sorter to add
+     */
     append(sorter: Sorter): void;
+    /**
+     * Removes the sorter at the given `position` from the list of sorter
+     * used by @self.
+     *
+     * If `position` is larger than the number of sorters, nothing happens.
+     * @param position - position of sorter to remove
+     */
     remove(position: number): void;
+    /**
+     * Gets the ID of the `buildable` object.
+     *
+     * `GtkBuilder` sets the name based on the ID attribute
+     * of the `<object>` tag used to construct the @buildable.
+     */
     getBuildableId(): string | null;
     connect(signal: "notify", handler: (self: MultiSorter, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtk/multi-sorter.js

@@ -1,7 +1,21 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Sorter } from "./sorter.js";
+/**
+ * Combines multiple sorters by trying them in turn.
+ *
+ * If the first sorter compares two items as equal,
+ * the second is tried next, and so on.
+ */
 export class MultiSorter extends Sorter {
+    /**
+     * Creates a new multi sorter.
+     *
+     * This sorter compares items by trying each of the sorters
+     * in turn, until one returns non-zero. In particular, if
+     * no sorter has been added to it, it will always compare
+     * items as equal.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -11,6 +25,13 @@ export class MultiSorter extends Sorter {
             borrowed: false,
         });
     }
+    /**
+     * Add `sorter` to `self` to use for sorting at the end.
+     *
+     * `self` will consult all existing sorters before it will
+     * sort with the given @sorter.
+     * @param sorter - a sorter to add
+     */
     append(sorter) {
         call("libgtk-4.so.1", "gtk_multi_sorter_append", [
             {
@@ -23,6 +44,13 @@ export class MultiSorter extends Sorter {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes the sorter at the given `position` from the list of sorter
+     * used by @self.
+     *
+     * If `position` is larger than the number of sorters, nothing happens.
+     * @param position - position of sorter to remove
+     */
     remove(position) {
         call("libgtk-4.so.1", "gtk_multi_sorter_remove", [
             {
@@ -35,6 +63,12 @@ export class MultiSorter extends Sorter {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the ID of the `buildable` object.
+     *
+     * `GtkBuilder` sets the name based on the ID attribute
+     * of the `<object>` tag used to construct the @buildable.
+     */
     getBuildableId() {
         return call("libgtk-4.so.1", "gtk_buildable_get_buildable_id", [
             {

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

@@ -1,7 +1,27 @@
 import { ShortcutAction } from "./shortcut-action.js";
+/**
+ * Activates a named action.
+ *
+ * See [method@Gtk.WidgetClass.install_action] and
+ * [method@Gtk.Widget.insert_action_group] for ways
+ * to associate named actions with widgets.
+ */
 export declare class NamedAction extends ShortcutAction {
+    /**
+     * Creates an action that when activated, activates
+     * the named action on the widget.
+     *
+     * It also passes the given arguments to it.
+     *
+     * See [method@Gtk.Widget.insert_action_group] for
+     * how to add actions to widgets.
+     * @param name - the detailed name of the action
+     */
     constructor(name: string);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Returns the name of the action that will be activated.
+     */
     getActionName(): string;
 }