@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtk/alert-dialog.d.ts

@@ -1,22 +1,98 @@
 import { Window } from "./window.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
+/**
+ * Collects the arguments that are needed to present a message to the user.
+ *
+ * The message is shown with the [method@Gtk.AlertDialog.choose]
+ * function.
+ *
+ * If you don't need to wait for a button to be clicked, you can use
+ * [method@Gtk.AlertDialog.show].
+ */
 export declare class AlertDialog extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Promise-based version of choose.
+     * Shows the alert to the user.
+     *
+     * It is ok to pass `NULL` for the callback if the alert
+     */
     choose(parent?: Window, cancellable?: Gio.Cancellable): Promise<number>;
+    /**
+     * Returns the button labels for the alert.
+     */
     getButtons(): string[] | null;
+    /**
+     * Returns the index of the cancel button.
+     */
     getCancelButton(): number;
+    /**
+     * Returns the index of the default button.
+     */
     getDefaultButton(): number;
+    /**
+     * Returns the detail text that will be shown in the alert.
+     */
     getDetail(): string;
+    /**
+     * Returns the message that will be shown in the alert.
+     */
     getMessage(): string;
+    /**
+     * Returns whether the alert blocks interaction
+     * with the parent window while it is presented.
+     */
     getModal(): boolean;
+    /**
+     * Sets the button labels for the alert.
+     * @param labels - the new button labels
+     */
     setButtons(labels: string[]): void;
+    /**
+     * Sets the index of the cancel button.
+     *
+     * See [property@Gtk.AlertDialog:cancel-button] for
+     * details of how this value is used.
+     * @param button - the new cancel button
+     */
     setCancelButton(button: number): void;
+    /**
+     * Sets the index of the default button.
+     *
+     * See [property@Gtk.AlertDialog:default-button] for
+     * details of how this value is used.
+     * @param button - the new default button
+     */
     setDefaultButton(button: number): void;
+    /**
+     * Sets the detail text that will be shown in the alert.
+     * @param detail - the new detail text
+     */
     setDetail(detail: string): void;
+    /**
+     * Sets the message that will be shown in the alert.
+     * @param message - the new message
+     */
     setMessage(message: string): void;
+    /**
+     * Sets whether the alert blocks interaction
+     * with the parent window while it is presented.
+     * @param modal - the new value
+     */
     setModal(modal: boolean): void;
+    /**
+     * Shows the alert to the user.
+     *
+     * This function is a simpler version of [method@Gtk.AlertDialog.choose]
+     * intended for dialogs with a single button.
+     *
+     * If you want to cancel the dialog or if the alert has more than one
+     * button, you should use that function instead and provide it with a
+     * [class@Gio.Cancellable] and callback respectively.
+     * @param parent - the parent window
+     */
     show(parent?: Window | null): void;
     connect(signal: "notify", handler: (self: AlertDialog, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtk/alert-dialog.js

@@ -1,6 +1,15 @@
 import { call } from "@gtkx/native";
 import { NativeError, getObject } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
+/**
+ * Collects the arguments that are needed to present a message to the user.
+ *
+ * The message is shown with the [method@Gtk.AlertDialog.choose]
+ * function.
+ *
+ * If you don't need to wait for a button to be clicked, you can use
+ * [method@Gtk.AlertDialog.show].
+ */
 export class AlertDialog extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -16,6 +25,12 @@ export class AlertDialog extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Promise-based version of choose.
+     * Shows the alert to the user.
+     *
+     * It is ok to pass `NULL` for the callback if the alert
+     */
     choose(parent, cancellable) {
         return new Promise((resolve, reject) => {
             const callback = (_source, asyncResult) => {
@@ -67,6 +82,9 @@ export class AlertDialog extends GObject.GObject {
             ], { type: "undefined" });
         });
     }
+    /**
+     * Returns the button labels for the alert.
+     */
     getButtons() {
         return call("libgtk-4.so.1", "gtk_alert_dialog_get_buttons", [
             {
@@ -75,6 +93,9 @@ export class AlertDialog extends GObject.GObject {
             },
         ], { type: "array", itemType: { type: "string" } });
     }
+    /**
+     * Returns the index of the cancel button.
+     */
     getCancelButton() {
         return call("libgtk-4.so.1", "gtk_alert_dialog_get_cancel_button", [
             {
@@ -83,6 +104,9 @@ export class AlertDialog extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the index of the default button.
+     */
     getDefaultButton() {
         return call("libgtk-4.so.1", "gtk_alert_dialog_get_default_button", [
             {
@@ -91,6 +115,9 @@ export class AlertDialog extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the detail text that will be shown in the alert.
+     */
     getDetail() {
         return call("libgtk-4.so.1", "gtk_alert_dialog_get_detail", [
             {
@@ -99,6 +126,9 @@ export class AlertDialog extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the message that will be shown in the alert.
+     */
     getMessage() {
         return call("libgtk-4.so.1", "gtk_alert_dialog_get_message", [
             {
@@ -107,6 +137,10 @@ export class AlertDialog extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns whether the alert blocks interaction
+     * with the parent window while it is presented.
+     */
     getModal() {
         return call("libgtk-4.so.1", "gtk_alert_dialog_get_modal", [
             {
@@ -115,6 +149,10 @@ export class AlertDialog extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets the button labels for the alert.
+     * @param labels - the new button labels
+     */
     setButtons(labels) {
         call("libgtk-4.so.1", "gtk_alert_dialog_set_buttons", [
             {
@@ -127,6 +165,13 @@ export class AlertDialog extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the index of the cancel button.
+     *
+     * See [property@Gtk.AlertDialog:cancel-button] for
+     * details of how this value is used.
+     * @param button - the new cancel button
+     */
     setCancelButton(button) {
         call("libgtk-4.so.1", "gtk_alert_dialog_set_cancel_button", [
             {
@@ -139,6 +184,13 @@ export class AlertDialog extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the index of the default button.
+     *
+     * See [property@Gtk.AlertDialog:default-button] for
+     * details of how this value is used.
+     * @param button - the new default button
+     */
     setDefaultButton(button) {
         call("libgtk-4.so.1", "gtk_alert_dialog_set_default_button", [
             {
@@ -151,6 +203,10 @@ export class AlertDialog extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the detail text that will be shown in the alert.
+     * @param detail - the new detail text
+     */
     setDetail(detail) {
         call("libgtk-4.so.1", "gtk_alert_dialog_set_detail", [
             {
@@ -163,6 +219,10 @@ export class AlertDialog extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the message that will be shown in the alert.
+     * @param message - the new message
+     */
     setMessage(message) {
         call("libgtk-4.so.1", "gtk_alert_dialog_set_message", [
             {
@@ -175,6 +235,11 @@ export class AlertDialog extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the alert blocks interaction
+     * with the parent window while it is presented.
+     * @param modal - the new value
+     */
     setModal(modal) {
         call("libgtk-4.so.1", "gtk_alert_dialog_set_modal", [
             {
@@ -187,6 +252,17 @@ export class AlertDialog extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Shows the alert to the user.
+     *
+     * This function is a simpler version of [method@Gtk.AlertDialog.choose]
+     * intended for dialogs with a single button.
+     *
+     * If you want to cancel the dialog or if the alert has more than one
+     * button, you should use that function instead and provide it with a
+     * [class@Gio.Cancellable] and callback respectively.
+     * @param parent - the parent window
+     */
     show(parent) {
         call("libgtk-4.so.1", "gtk_alert_dialog_show", [
             {

package/dist/generated/gtk/alternative-trigger.d.ts

@@ -1,8 +1,38 @@
 import { ShortcutTrigger } from "./shortcut-trigger.js";
+/**
+ * Combines two shortcut triggers.
+ *
+ * The `GtkAlternativeTrigger` triggers when either of the two trigger.
+ *
+ * This can be cascaded to combine more than two triggers.
+ */
 export declare class AlternativeTrigger extends ShortcutTrigger {
+    /**
+     * Creates a `GtkShortcutTrigger` that will trigger whenever
+     * either of the two given triggers gets triggered.
+     *
+     * Note that nesting is allowed, so if you want more than two
+     * alternative, create a new alternative trigger for each option.
+     * @param first - The first trigger that may trigger
+     * @param second - The second trigger that may trigger
+     */
     constructor(first: ShortcutTrigger, second: ShortcutTrigger);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Gets the first of the two alternative triggers that may
+     * trigger @self.
+     *
+     * [method@Gtk.AlternativeTrigger.get_second] will return
+     * the other one.
+     */
     getFirst(): ShortcutTrigger;
+    /**
+     * Gets the second of the two alternative triggers that may
+     * trigger @self.
+     *
+     * [method@Gtk.AlternativeTrigger.get_first] will return
+     * the other one.
+     */
     getSecond(): ShortcutTrigger;
 }

package/dist/generated/gtk/alternative-trigger.js

@@ -1,6 +1,13 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { ShortcutTrigger } from "./shortcut-trigger.js";
+/**
+ * Combines two shortcut triggers.
+ *
+ * The `GtkAlternativeTrigger` triggers when either of the two trigger.
+ *
+ * This can be cascaded to combine more than two triggers.
+ */
 export class AlternativeTrigger extends ShortcutTrigger {
     constructor(...args) {
         super(...args);
@@ -18,6 +25,13 @@ export class AlternativeTrigger extends ShortcutTrigger {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Gets the first of the two alternative triggers that may
+     * trigger @self.
+     *
+     * [method@Gtk.AlternativeTrigger.get_second] will return
+     * the other one.
+     */
     getFirst() {
         const ptr = call("libgtk-4.so.1", "gtk_alternative_trigger_get_first", [
             {
@@ -27,6 +41,13 @@ export class AlternativeTrigger extends ShortcutTrigger {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, ShortcutTrigger);
     }
+    /**
+     * Gets the second of the two alternative triggers that may
+     * trigger @self.
+     *
+     * [method@Gtk.AlternativeTrigger.get_first] will return
+     * the other one.
+     */
     getSecond() {
         const ptr = call("libgtk-4.so.1", "gtk_alternative_trigger_get_second", [
             {

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

@@ -1,6 +1,20 @@
 import * as GObject from "../gobject/index.js";
 import { MultiFilter } from "./multi-filter.js";
+/**
+ * Matches an item when at least one of its filters matches.
+ *
+ * To add filters to a `GtkAnyFilter`, use [method@Gtk.MultiFilter.append].
+ */
 export declare class AnyFilter extends MultiFilter {
+    /**
+     * Creates a new empty "any" filter.
+     *
+     * Use [method@Gtk.MultiFilter.append] to add filters to it.
+     *
+     * This filter matches an item if any of the filters added to it
+     * matches the item. In particular, this means that if no filter
+     * has been added to it, the filter matches no item.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     connect(signal: "notify", handler: (self: AnyFilter, pspec: GObject.ParamSpec) => void, after?: boolean): number;

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

@@ -1,7 +1,21 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { MultiFilter } from "./multi-filter.js";
+/**
+ * Matches an item when at least one of its filters matches.
+ *
+ * To add filters to a `GtkAnyFilter`, use [method@Gtk.MultiFilter.append].
+ */
 export class AnyFilter extends MultiFilter {
+    /**
+     * Creates a new empty "any" filter.
+     *
+     * Use [method@Gtk.MultiFilter.append] to add filters to it.
+     *
+     * This filter matches an item if any of the filters added to it
+     * matches the item. In particular, this means that if no filter
+     * has been added to it, the filter matches no item.
+     */
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gtk/app-chooser-button.d.ts

@@ -2,22 +2,98 @@ import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
 import { Widget } from "./widget.js";
 export declare class AppChooserButton extends Widget {
+    /**
+     * Creates a new `GtkAppChooserButton` for applications
+     * that can handle content of the given type.
+     * @param contentType - the content type to show applications for
+     */
     constructor(contentType: string);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Appends a custom item to the list of applications that is shown
+     * in the popup.
+     *
+     * The item name must be unique per-widget. Clients can use the
+     * provided name as a detail for the
+     * [signal@Gtk.AppChooserButton::custom-item-activated] signal, to add a
+     * callback for the activation of a particular custom item in the list.
+     *
+     * See also [method@Gtk.AppChooserButton.append_separator].
+     * @param name - the name of the custom item
+     * @param label - the label for the custom item
+     * @param icon - the icon for the custom item
+     */
     appendCustomItem(name: string, label: string, icon: Gio.Icon): void;
+    /**
+     * Appends a separator to the list of applications that is shown
+     * in the popup.
+     */
     appendSeparator(): void;
+    /**
+     * Returns the text to display at the top of the dialog.
+     */
     getHeading(): string | null;
+    /**
+     * Gets whether the dialog is modal.
+     */
     getModal(): boolean;
+    /**
+     * Returns whether the dropdown menu should show the default
+     * application at the top.
+     */
     getShowDefaultItem(): boolean;
+    /**
+     * Returns whether the dropdown menu shows an item
+     * for a `GtkAppChooserDialog`.
+     */
     getShowDialogItem(): boolean;
+    /**
+     * Selects a custom item.
+     *
+     * See [method@Gtk.AppChooserButton.append_custom_item].
+     *
+     * Use [method@Gtk.AppChooser.refresh] to bring the selection
+     * to its initial state.
+     * @param name - the name of the custom item
+     */
     setActiveCustomItem(name: string): void;
+    /**
+     * Sets the text to display at the top of the dialog.
+     *
+     * If the heading is not set, the dialog displays a default text.
+     * @param heading - a string containing Pango markup
+     */
     setHeading(heading: string): void;
+    /**
+     * Sets whether the dialog should be modal.
+     * @param modal - %TRUE to make the dialog modal
+     */
     setModal(modal: boolean): void;
+    /**
+     * Sets whether the dropdown menu of this button should show the
+     * default application for the given content type at top.
+     * @param setting - the new value for [property@Gtk.AppChooserButton:show-default-item]
+     */
     setShowDefaultItem(setting: boolean): void;
+    /**
+     * Sets whether the dropdown menu of this button should show an
+     * entry to trigger a `GtkAppChooserDialog`.
+     * @param setting - the new value for [property@Gtk.AppChooserButton:show-dialog-item]
+     */
     setShowDialogItem(setting: boolean): void;
+    /**
+     * Returns the currently selected application.
+     */
     getAppInfo(): Gio.AppInfo | null;
+    /**
+     * Returns the content type for which the `GtkAppChooser`
+     * shows applications.
+     */
     getContentType(): string;
+    /**
+     * Reloads the list of applications.
+     */
     refresh(): void;
     connect(signal: "activate", handler: (self: AppChooserButton) => void, after?: boolean): number;
     connect(signal: "changed", handler: (self: AppChooserButton) => void, after?: boolean): number;

package/dist/generated/gtk/app-chooser-button.js

@@ -2,6 +2,35 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as Gio from "../gio/index.js";
 import { Widget } from "./widget.js";
+/**
+ * The `GtkAppChooserButton` lets the user select an application.
+ *
+ *
+ *
+ * Initially, a `GtkAppChooserButton` selects the first application
+ * in its list, which will either be the most-recently used application
+ * or, if [property@Gtk.AppChooserButton:show-default-item] is %TRUE, the
+ * default application.
+ *
+ * The list of applications shown in a `GtkAppChooserButton` includes
+ * the recommended applications for the given content type. When
+ * [property@Gtk.AppChooserButton:show-default-item] is set, the default
+ * application is also included. To let the user chooser other applications,
+ * you can set the [property@Gtk.AppChooserButton:show-dialog-item] property,
+ * which allows to open a full [class@Gtk.AppChooserDialog].
+ *
+ * It is possible to add custom items to the list, using
+ * [method@Gtk.AppChooserButton.append_custom_item]. These items cause
+ * the [signal@Gtk.AppChooserButton::custom-item-activated] signal to be
+ * emitted when they are selected.
+ *
+ * To track changes in the selected application, use the
+ * [signal@Gtk.AppChooserButton::changed] signal.
+ *
+ * ## CSS nodes
+ *
+ * `GtkAppChooserButton` has a single CSS node with the name “appchooserbutton”.
+ */
 const SIGNAL_META = {
     activate: { params: [], returnType: { type: "undefined" } },
     changed: { params: [], returnType: { type: "undefined" } },
@@ -23,6 +52,20 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Appends a custom item to the list of applications that is shown
+     * in the popup.
+     *
+     * The item name must be unique per-widget. Clients can use the
+     * provided name as a detail for the
+     * [signal@Gtk.AppChooserButton::custom-item-activated] signal, to add a
+     * callback for the activation of a particular custom item in the list.
+     *
+     * See also [method@Gtk.AppChooserButton.append_separator].
+     * @param name - the name of the custom item
+     * @param label - the label for the custom item
+     * @param icon - the icon for the custom item
+     */
     appendCustomItem(name, label, icon) {
         call("libgtk-4.so.1", "gtk_app_chooser_button_append_custom_item", [
             {
@@ -43,6 +86,10 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Appends a separator to the list of applications that is shown
+     * in the popup.
+     */
     appendSeparator() {
         call("libgtk-4.so.1", "gtk_app_chooser_button_append_separator", [
             {
@@ -51,6 +98,9 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Returns the text to display at the top of the dialog.
+     */
     getHeading() {
         return call("libgtk-4.so.1", "gtk_app_chooser_button_get_heading", [
             {
@@ -59,6 +109,9 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets whether the dialog is modal.
+     */
     getModal() {
         return call("libgtk-4.so.1", "gtk_app_chooser_button_get_modal", [
             {
@@ -67,6 +120,10 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the dropdown menu should show the default
+     * application at the top.
+     */
     getShowDefaultItem() {
         return call("libgtk-4.so.1", "gtk_app_chooser_button_get_show_default_item", [
             {
@@ -75,6 +132,10 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the dropdown menu shows an item
+     * for a `GtkAppChooserDialog`.
+     */
     getShowDialogItem() {
         return call("libgtk-4.so.1", "gtk_app_chooser_button_get_show_dialog_item", [
             {
@@ -83,6 +144,15 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Selects a custom item.
+     *
+     * See [method@Gtk.AppChooserButton.append_custom_item].
+     *
+     * Use [method@Gtk.AppChooser.refresh] to bring the selection
+     * to its initial state.
+     * @param name - the name of the custom item
+     */
     setActiveCustomItem(name) {
         call("libgtk-4.so.1", "gtk_app_chooser_button_set_active_custom_item", [
             {
@@ -95,6 +165,12 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the text to display at the top of the dialog.
+     *
+     * If the heading is not set, the dialog displays a default text.
+     * @param heading - a string containing Pango markup
+     */
     setHeading(heading) {
         call("libgtk-4.so.1", "gtk_app_chooser_button_set_heading", [
             {
@@ -107,6 +183,10 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the dialog should be modal.
+     * @param modal - %TRUE to make the dialog modal
+     */
     setModal(modal) {
         call("libgtk-4.so.1", "gtk_app_chooser_button_set_modal", [
             {
@@ -119,6 +199,11 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the dropdown menu of this button should show the
+     * default application for the given content type at top.
+     * @param setting - the new value for [property@Gtk.AppChooserButton:show-default-item]
+     */
     setShowDefaultItem(setting) {
         call("libgtk-4.so.1", "gtk_app_chooser_button_set_show_default_item", [
             {
@@ -131,6 +216,11 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the dropdown menu of this button should show an
+     * entry to trigger a `GtkAppChooserDialog`.
+     * @param setting - the new value for [property@Gtk.AppChooserButton:show-dialog-item]
+     */
     setShowDialogItem(setting) {
         call("libgtk-4.so.1", "gtk_app_chooser_button_set_show_dialog_item", [
             {
@@ -143,6 +233,9 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Returns the currently selected application.
+     */
     getAppInfo() {
         const ptr = call("libgtk-4.so.1", "gtk_app_chooser_get_app_info", [
             {
@@ -154,6 +247,10 @@ export class AppChooserButton extends Widget {
             return null;
         return getObject(ptr, Gio.AppInfo);
     }
+    /**
+     * Returns the content type for which the `GtkAppChooser`
+     * shows applications.
+     */
     getContentType() {
         return call("libgtk-4.so.1", "gtk_app_chooser_get_content_type", [
             {
@@ -162,6 +259,9 @@ export class AppChooserButton extends Widget {
             },
         ], { type: "string" });
     }
+    /**
+     * Reloads the list of applications.
+     */
     refresh() {
         call("libgtk-4.so.1", "gtk_app_chooser_refresh", [
             {