@gtkx/ffi 0.5.2 → 0.6.0

package/dist/generated/adw/action-row.d.ts

@@ -0,0 +1,106 @@
+import * as GObject from "../gobject/index.js";
+import * as Gtk from "../gtk/index.js";
+import { PreferencesRow } from "./preferences-row.js";
+export declare class ActionRow extends PreferencesRow {
+    static readonly glibTypeName: string;
+    /**
+     * Creates a new `AdwActionRow`.
+     */
+    constructor();
+    /**
+     * Activates @self.
+     */
+    activateActionRow(): void;
+    /**
+     * Adds a prefix widget to @self.
+     * @param widget - a widget
+     */
+    addPrefix(widget: Gtk.Widget): void;
+    /**
+     * Adds a suffix widget to @self.
+     * @param widget - a widget
+     */
+    addSuffix(widget: Gtk.Widget): void;
+    /**
+     * Gets the widget activated when `self` is activated.
+     */
+    getActivatableWidget(): Gtk.Widget | null;
+    /**
+     * Gets the icon name for @self.
+     */
+    getIconName(): string | null;
+    /**
+     * Gets the subtitle for @self.
+     */
+    getSubtitle(): string | null;
+    /**
+     * Gets the number of lines at the end of which the subtitle label will be
+     * ellipsized.
+     */
+    getSubtitleLines(): number;
+    /**
+     * Gets whether the user can copy the subtitle from the label
+     */
+    getSubtitleSelectable(): boolean;
+    /**
+     * Gets the number of lines at the end of which the title label will be
+     * ellipsized.
+     */
+    getTitleLines(): number;
+    /**
+     * Removes a child from @self.
+     * @param widget - the child to be removed
+     */
+    remove(widget: Gtk.Widget): void;
+    /**
+     * Sets the widget to activate when `self` is activated.
+     *
+     * The row can be activated either by clicking on it, calling
+     * [method@ActionRow.activate], or via mnemonics in the title.
+     * See the [property@PreferencesRow:use-underline] property to enable mnemonics.
+     *
+     * The target widget will be activated by emitting the
+     * [signal@Gtk.Widget::mnemonic-activate] signal on it.
+     * @param widget - the target widget
+     */
+    setActivatableWidget(widget?: Gtk.Widget | null): void;
+    /**
+     * Sets the icon name for @self.
+     * @param iconName - the icon name
+     */
+    setIconName(iconName?: string | null): void;
+    /**
+     * Sets the subtitle for @self.
+     *
+     * The subtitle is interpreted as Pango markup unless
+     * [property@PreferencesRow:use-markup] is set to `FALSE`.
+     * @param subtitle - the subtitle
+     */
+    setSubtitle(subtitle: string): void;
+    /**
+     * Sets the number of lines at the end of which the subtitle label will be
+     * ellipsized.
+     *
+     * If the value is 0, the number of lines won't be limited.
+     * @param subtitleLines - the number of lines at the end of which the subtitle label will be ellipsized
+     */
+    setSubtitleLines(subtitleLines: number): void;
+    /**
+     * Sets whether the user can copy the subtitle from the label
+     *
+     * See also [property@Gtk.Label:selectable].
+     * @param subtitleSelectable - `TRUE` if the user can copy the subtitle from the label
+     */
+    setSubtitleSelectable(subtitleSelectable: boolean): void;
+    /**
+     * Sets the number of lines at the end of which the title label will be
+     * ellipsized.
+     *
+     * If the value is 0, the number of lines won't be limited.
+     * @param titleLines - the number of lines at the end of which the title label will be ellipsized
+     */
+    setTitleLines(titleLines: number): void;
+    connect(signal: "activated", handler: (self: ActionRow) => void, after?: boolean): number;
+    connect(signal: "notify", handler: (self: ActionRow, pspec: GObject.ParamSpec) => void, after?: boolean): number;
+    connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;
+}

package/dist/generated/adw/action-row.js

@@ -0,0 +1,348 @@
+import { call, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import { PreferencesRow } from "./preferences-row.js";
+/**
+ * A [class@Gtk.ListBoxRow] used to present actions.
+ *
+ *
+ *
+ * The `AdwActionRow` widget can have a title, a subtitle and an icon. The row
+ * can receive additional widgets at its end, or prefix widgets at its start.
+ *
+ * It is convenient to present a preference and its related actions.
+ *
+ * `AdwActionRow` is unactivatable by default, giving it an activatable widget
+ * will automatically make it activatable, but unsetting it won't change the
+ * row's activatability.
+ *
+ * ## AdwActionRow as GtkBuildable
+ *
+ * The `AdwActionRow` implementation of the [iface@Gtk.Buildable] interface
+ * supports adding a child at its end by specifying “suffix” or omitting the
+ * “type” attribute of a <child> element.
+ *
+ * It also supports adding a child as a prefix widget by specifying “prefix” as
+ * the “type” attribute of a <child> element.
+ *
+ * ## CSS nodes
+ *
+ * `AdwActionRow` has a main CSS node with name `row`.
+ *
+ * It contains the subnode `box.header` for its main horizontal box, and
+ * `box.title` for the vertical box containing the title and subtitle labels.
+ *
+ * It contains subnodes `label.title` and `label.subtitle` representing
+ * respectively the title label and subtitle label.
+ *
+ * ## Style classes
+ *
+ * `AdwActionRow` can use the `.property`
+ * style class to emphasize the row subtitle instead of the row title, which is
+ * useful for displaying read-only properties.
+ *
+ *
+ *
+ * When used together with the `.monospace` style class, only the subtitle
+ * becomes monospace, not the title or any extra widgets.
+ */
+const SIGNAL_META = {
+    activated: { params: [], returnType: { type: "undefined" } },
+};
+export class ActionRow extends PreferencesRow {
+    static glibTypeName = "AdwActionRow";
+    /**
+     * Creates a new `AdwActionRow`.
+     */
+    constructor() {
+        if (!isInstantiating) {
+            setInstantiating(true);
+            // @ts-ignore
+            super();
+            setInstantiating(false);
+            this.id = call("libadwaita-1.so.0", "adw_action_row_new", [], {
+                type: "gobject",
+                borrowed: true,
+            });
+        }
+        else {
+            // @ts-ignore
+            super();
+        }
+    }
+    /**
+     * Activates @self.
+     */
+    activateActionRow() {
+        call("libadwaita-1.so.0", "adw_action_row_activate", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Adds a prefix widget to @self.
+     * @param widget - a widget
+     */
+    addPrefix(widget) {
+        call("libadwaita-1.so.0", "adw_action_row_add_prefix", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "gobject", borrowed: true },
+                value: widget?.id ?? widget,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Adds a suffix widget to @self.
+     * @param widget - a widget
+     */
+    addSuffix(widget) {
+        call("libadwaita-1.so.0", "adw_action_row_add_suffix", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "gobject", borrowed: true },
+                value: widget?.id ?? widget,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Gets the widget activated when `self` is activated.
+     */
+    getActivatableWidget() {
+        const ptr = call("libadwaita-1.so.0", "adw_action_row_get_activatable_widget", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "gobject", borrowed: true });
+        if (ptr === null)
+            return null;
+        return getObject(ptr);
+    }
+    /**
+     * Gets the icon name for @self.
+     */
+    getIconName() {
+        return call("libadwaita-1.so.0", "adw_action_row_get_icon_name", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "string", borrowed: true });
+    }
+    /**
+     * Gets the subtitle for @self.
+     */
+    getSubtitle() {
+        return call("libadwaita-1.so.0", "adw_action_row_get_subtitle", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "string", borrowed: true });
+    }
+    /**
+     * Gets the number of lines at the end of which the subtitle label will be
+     * ellipsized.
+     */
+    getSubtitleLines() {
+        return call("libadwaita-1.so.0", "adw_action_row_get_subtitle_lines", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "int", size: 32, unsigned: false });
+    }
+    /**
+     * Gets whether the user can copy the subtitle from the label
+     */
+    getSubtitleSelectable() {
+        return call("libadwaita-1.so.0", "adw_action_row_get_subtitle_selectable", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "boolean" });
+    }
+    /**
+     * Gets the number of lines at the end of which the title label will be
+     * ellipsized.
+     */
+    getTitleLines() {
+        return call("libadwaita-1.so.0", "adw_action_row_get_title_lines", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "int", size: 32, unsigned: false });
+    }
+    /**
+     * Removes a child from @self.
+     * @param widget - the child to be removed
+     */
+    remove(widget) {
+        call("libadwaita-1.so.0", "adw_action_row_remove", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "gobject", borrowed: true },
+                value: widget?.id ?? widget,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Sets the widget to activate when `self` is activated.
+     *
+     * The row can be activated either by clicking on it, calling
+     * [method@ActionRow.activate], or via mnemonics in the title.
+     * See the [property@PreferencesRow:use-underline] property to enable mnemonics.
+     *
+     * The target widget will be activated by emitting the
+     * [signal@Gtk.Widget::mnemonic-activate] signal on it.
+     * @param widget - the target widget
+     */
+    setActivatableWidget(widget) {
+        call("libadwaita-1.so.0", "adw_action_row_set_activatable_widget", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "gobject", borrowed: true },
+                value: widget?.id ?? widget,
+                optional: true,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Sets the icon name for @self.
+     * @param iconName - the icon name
+     */
+    setIconName(iconName) {
+        call("libadwaita-1.so.0", "adw_action_row_set_icon_name", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "string" },
+                value: iconName,
+                optional: true,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Sets the subtitle for @self.
+     *
+     * The subtitle is interpreted as Pango markup unless
+     * [property@PreferencesRow:use-markup] is set to `FALSE`.
+     * @param subtitle - the subtitle
+     */
+    setSubtitle(subtitle) {
+        call("libadwaita-1.so.0", "adw_action_row_set_subtitle", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "string" },
+                value: subtitle,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Sets the number of lines at the end of which the subtitle label will be
+     * ellipsized.
+     *
+     * If the value is 0, the number of lines won't be limited.
+     * @param subtitleLines - the number of lines at the end of which the subtitle label will be ellipsized
+     */
+    setSubtitleLines(subtitleLines) {
+        call("libadwaita-1.so.0", "adw_action_row_set_subtitle_lines", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "int", size: 32, unsigned: false },
+                value: subtitleLines,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Sets whether the user can copy the subtitle from the label
+     *
+     * See also [property@Gtk.Label:selectable].
+     * @param subtitleSelectable - `TRUE` if the user can copy the subtitle from the label
+     */
+    setSubtitleSelectable(subtitleSelectable) {
+        call("libadwaita-1.so.0", "adw_action_row_set_subtitle_selectable", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "boolean" },
+                value: subtitleSelectable,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Sets the number of lines at the end of which the title label will be
+     * ellipsized.
+     *
+     * If the value is 0, the number of lines won't be limited.
+     * @param titleLines - the number of lines at the end of which the title label will be ellipsized
+     */
+    setTitleLines(titleLines) {
+        call("libadwaita-1.so.0", "adw_action_row_set_title_lines", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "int", size: 32, unsigned: false },
+                value: titleLines,
+            },
+        ], { type: "undefined" });
+    }
+    connect(signal, handler, after = false) {
+        const meta = SIGNAL_META[signal];
+        const selfType = { type: "gobject", borrowed: true };
+        const argTypes = meta
+            ? [selfType, ...meta.params.map((m) => m.type)]
+            : [selfType];
+        const returnType = meta?.returnType;
+        const wrappedHandler = (...args) => {
+            const self = getObject(args[0]);
+            const signalArgs = args.slice(1);
+            if (!meta)
+                return handler(self, ...signalArgs);
+            const wrapped = meta.params.map((m, i) => {
+                if (m.getCls && signalArgs[i] != null) {
+                    return getObject(signalArgs[i]);
+                }
+                return signalArgs[i];
+            });
+            return handler(self, ...wrapped);
+        };
+        return call("libadwaita-1.so.0", "g_signal_connect_closure", [
+            { type: { type: "gobject" }, value: this.id },
+            { type: { type: "string" }, value: signal },
+            {
+                type: { type: "callback", argTypes, returnType },
+                value: wrappedHandler,
+            },
+            { type: { type: "boolean" }, value: after },
+        ], { type: "int", size: 64, unsigned: true });
+    }
+}
+registerType(ActionRow);

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

@@ -0,0 +1,229 @@
+import { ResponseAppearance } from "./enums.js";
+import * as GObject from "../gobject/index.js";
+import * as Gio from "../gio/index.js";
+import * as Gtk from "../gtk/index.js";
+import { Dialog } from "./dialog.js";
+export declare class AlertDialog extends Dialog {
+    static readonly glibTypeName: string;
+    /**
+     * Creates a new `AdwAlertDialog`.
+     *
+     * `heading` and `body` can be set to `NULL`. This can be useful if they need to
+     * be formatted or use markup. In that case, set them to `NULL` and call
+     * [method@AlertDialog.format_body] or similar methods afterwards:
+     *
+     * ```c
+     * AdwDialog *dialog;
+     *
+     * dialog = adw_alert_dialog_new (_("Replace File?"), NULL);
+     * adw_alert_dialog_format_body (ADW_ALERT_DIALOG (dialog),
+     * _("A file named “%s” already exists.  Do you want to replace it?"),
+     * filename);
+     * ```
+     * @param heading - the heading
+     * @param body - the body text
+     */
+    constructor(heading?: string | null, body?: string | null);
+    /**
+     * Adds a response with `id` and `label` to @self.
+     *
+     * Responses are represented as buttons in the dialog.
+     *
+     * Response ID must be unique. It will be used in [signal@AlertDialog::response]
+     * to tell which response had been activated, as well as to inspect and modify
+     * the response later.
+     *
+     * An embedded underline in `label` indicates a mnemonic.
+     *
+     * [method@AlertDialog.set_response_label] can be used to change the response
+     * label after it had been added.
+     *
+     * [method@AlertDialog.set_response_enabled] and
+     * [method@AlertDialog.set_response_appearance] can be used to customize the
+     * responses further.
+     * @param id - the response ID
+     * @param label - the response label
+     */
+    addResponse(id: string, label: string): void;
+    /**
+     * Promise-based version of choose.
+     * This function shows `self` to the user.
+     *
+     * If the window is an [class@Window] or [class@ApplicationWindow], the dialog
+     */
+    choose(parent?: Gtk.Widget, cancellable?: Gio.Cancellable): Promise<string>;
+    /**
+     * Gets the body text of @self.
+     */
+    getBody(): string;
+    /**
+     * Gets whether the body text of `self` includes Pango markup.
+     */
+    getBodyUseMarkup(): boolean;
+    /**
+     * Gets the ID of the close response of @self.
+     */
+    getCloseResponse(): string;
+    /**
+     * Gets the ID of the default response of @self.
+     */
+    getDefaultResponse(): string | null;
+    /**
+     * Gets the child widget of @self.
+     */
+    getExtraChild(): Gtk.Widget | null;
+    /**
+     * Gets the heading of @self.
+     */
+    getHeading(): string | null;
+    /**
+     * Gets whether the heading of `self` includes Pango markup.
+     */
+    getHeadingUseMarkup(): boolean;
+    /**
+     * Gets whether `self` prefers wide layout.
+     */
+    getPreferWideLayout(): boolean;
+    /**
+     * Gets the appearance of @response.
+     *
+     * See [method@AlertDialog.set_response_appearance].
+     * @param response - a response ID
+     */
+    getResponseAppearance(response: string): ResponseAppearance;
+    /**
+     * Gets whether `response` is enabled.
+     *
+     * See [method@AlertDialog.set_response_enabled].
+     * @param response - a response ID
+     */
+    getResponseEnabled(response: string): boolean;
+    /**
+     * Gets the label of @response.
+     *
+     * See [method@AlertDialog.set_response_label].
+     * @param response - a response ID
+     */
+    getResponseLabel(response: string): string;
+    /**
+     * Gets whether `self` has a response with the ID @response.
+     * @param response - response ID
+     */
+    hasResponse(response: string): boolean;
+    /**
+     * Removes a response from @self.
+     * @param id - the response ID
+     */
+    removeResponse(id: string): void;
+    /**
+     * Sets the body text of @self.
+     * @param body - the body of @self
+     */
+    setBody(body: string): void;
+    /**
+     * Sets whether the body text of `self` includes Pango markup.
+     *
+     * See [func@Pango.parse_markup].
+     * @param useMarkup - whether to use markup for body text
+     */
+    setBodyUseMarkup(useMarkup: boolean): void;
+    /**
+     * Sets the ID of the close response of @self.
+     *
+     * It will be passed to [signal@AlertDialog::response] if the dialog is closed
+     * by pressing `Escape` or with a system action.
+     *
+     * It doesn't have to correspond to any of the responses in the dialog.
+     *
+     * The default close response is `close`.
+     * @param response - the close response ID
+     */
+    setCloseResponse(response: string): void;
+    /**
+     * Sets the ID of the default response of @self.
+     *
+     * The button corresponding to this response will be set as the default widget
+     * of @self.
+     *
+     * If not set, the default widget will not be set, and the last added response
+     * will be focused by default.
+     *
+     * See [property@Dialog:default-widget].
+     * @param response - the default response ID
+     */
+    setDefaultResponse(response?: string | null): void;
+    /**
+     * Sets the child widget of @self.
+     *
+     * The child widget is displayed below the heading and body.
+     * @param child - the child widget
+     */
+    setExtraChild(child?: Gtk.Widget | null): void;
+    /**
+     * Sets the heading of @self.
+     * @param heading - the heading of @self
+     */
+    setHeading(heading?: string | null): void;
+    /**
+     * Sets whether the heading of `self` includes Pango markup.
+     *
+     * See [func@Pango.parse_markup].
+     * @param useMarkup - whether to use markup for heading
+     */
+    setHeadingUseMarkup(useMarkup: boolean): void;
+    /**
+     * Sets whether `self` prefers wide layout.
+     *
+     * Prefer horizontal button layout when possible, and wider dialog width
+     * otherwise.
+     * @param preferWideLayout - whether to prefer wide layout
+     */
+    setPreferWideLayout(preferWideLayout: boolean): void;
+    /**
+     * Sets the appearance for @response.
+     *
+     *
+     *
+     * Use `ADW_RESPONSE_SUGGESTED` to mark important responses such as the
+     * affirmative action, like the Save button in the example.
+     *
+     * Use `ADW_RESPONSE_DESTRUCTIVE` to draw attention to the potentially damaging
+     * consequences of using @response. This appearance acts as a warning to the
+     * user. The Discard button in the example is using this appearance.
+     *
+     * The default appearance is `ADW_RESPONSE_DEFAULT`.
+     *
+     * Negative responses like Cancel or Close should use the default appearance.
+     * @param response - a response ID
+     * @param appearance - appearance for @response
+     */
+    setResponseAppearance(response: string, appearance: ResponseAppearance): void;
+    /**
+     * Sets whether `response` is enabled.
+     *
+     * If `response` is not enabled, the corresponding button will have
+     * [property@Gtk.Widget:sensitive] set to `FALSE` and it can't be activated as
+     * a default response.
+     *
+     * `response` can still be used as [property@AlertDialog:close-response] while
+     * it's not enabled.
+     *
+     * Responses are enabled by default.
+     * @param response - a response ID
+     * @param enabled - whether to enable @response
+     */
+    setResponseEnabled(response: string, enabled: boolean): void;
+    /**
+     * Sets the label of `response` to @label.
+     *
+     * Labels are displayed on the dialog buttons. An embedded underline in `label` indicates a mnemonic.
+     * @param response - a response ID
+     * @param label - the label of @response
+     */
+    setResponseLabel(response: string, label: string): void;
+    connect(signal: "response", handler: (self: AlertDialog, response: string) => void, after?: boolean): number;
+    connect(signal: "close-attempt", handler: (self: AlertDialog) => void, after?: boolean): number;
+    connect(signal: "closed", handler: (self: AlertDialog) => void, after?: boolean): number;
+    connect(signal: "notify", handler: (self: AlertDialog, pspec: GObject.ParamSpec) => void, after?: boolean): number;
+    connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;
+}