@gtkx/ffi 0.1.45 → 0.1.47

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

@@ -2,6 +2,60 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as Gdk from "../gdk/index.js";
 import { Window } from "./window.js";
+/**
+ * Displays information about a program.
+ *
+ * The shown information includes the programs' logo, name, copyright,
+ * website and license. It is also possible to give credits to the authors,
+ * documenters, translators and artists who have worked on the program.
+ *
+ * An about dialog is typically opened when the user selects the `About`
+ * option from the `Help` menu. All parts of the dialog are optional.
+ *
+ *
+ *
+ * About dialogs often contain links and email addresses. `GtkAboutDialog`
+ * displays these as clickable links. By default, it calls [method@Gtk.FileLauncher.launch]
+ * when a user clicks one. The behaviour can be overridden with the
+ * [signal@Gtk.AboutDialog::activate-link] signal.
+ *
+ * To specify a person with an email address, use a string like
+ * `Edgar Allan Poe <edgar@poe.com>`. To specify a website with a title,
+ * use a string like `GTK team https://www.gtk.org`.
+ *
+ * To make constructing an about dialog as convenient as possible, you can
+ * use the function [func@Gtk.show_about_dialog] which constructs and shows
+ * a dialog and keeps it around so that it can be shown again.
+ *
+ * Note that GTK sets a default title of `_("About %s")` on the dialog
+ * window (where `%s` is replaced by the name of the application, but in
+ * order to ensure proper translation of the title, applications should
+ * set the title property explicitly when constructing an about dialog,
+ * as shown in the following example:
+ *
+ * ```c
+ * GFile *logo_file = g_file_new_for_path ("./logo.png");
+ * GdkTexture *example_logo = gdk_texture_new_from_file (logo_file, NULL);
+ * g_object_unref (logo_file);
+ *
+ * gtk_show_about_dialog (NULL,
+ * "program-name", "ExampleCode",
+ * "logo", example_logo,
+ * "title", _("About ExampleCode"),
+ * NULL);
+ * ```
+ *
+ * ## Shortcuts and Gestures
+ *
+ * `GtkAboutDialog` supports the following keyboard shortcuts:
+ *
+ * - `Escape` closes the window.
+ *
+ * ## CSS nodes
+ *
+ * `GtkAboutDialog` has a single CSS node with the name `window` and style
+ * class `.aboutdialog`.
+ */
 const SIGNAL_META = {
     "activate-link": {
         params: [{ type: { type: "string", borrowed: false } }],
@@ -17,6 +71,9 @@ const SIGNAL_META = {
     "keys-changed": { params: [], returnType: { type: "undefined" } },
 };
 export class AboutDialog extends Window {
+    /**
+     * Creates a new `GtkAboutDialog`.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -26,6 +83,11 @@ export class AboutDialog extends Window {
             borrowed: true,
         });
     }
+    /**
+     * Creates a new section in the "Credits" page.
+     * @param sectionName - The name of the section
+     * @param people - the people who belong to that section
+     */
     addCreditSection(sectionName, people) {
         call("libgtk-4.so.1", "gtk_about_dialog_add_credit_section", [
             {
@@ -42,6 +104,10 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Returns the names of the artists which are displayed
+     * in the credits page.
+     */
     getArtists() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_artists", [
             {
@@ -50,6 +116,10 @@ export class AboutDialog extends Window {
             },
         ], { type: "array", itemType: { type: "string" } });
     }
+    /**
+     * Returns the names of the authors which are displayed
+     * in the credits page.
+     */
     getAuthors() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_authors", [
             {
@@ -58,6 +128,9 @@ export class AboutDialog extends Window {
             },
         ], { type: "array", itemType: { type: "string" } });
     }
+    /**
+     * Returns the comments string.
+     */
     getComments() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_comments", [
             {
@@ -66,6 +139,9 @@ export class AboutDialog extends Window {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the copyright string.
+     */
     getCopyright() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_copyright", [
             {
@@ -74,6 +150,10 @@ export class AboutDialog extends Window {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the name of the documenters which are displayed
+     * in the credits page.
+     */
     getDocumenters() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_documenters", [
             {
@@ -82,6 +162,9 @@ export class AboutDialog extends Window {
             },
         ], { type: "array", itemType: { type: "string" } });
     }
+    /**
+     * Returns the license information.
+     */
     getLicense() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_license", [
             {
@@ -90,6 +173,9 @@ export class AboutDialog extends Window {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Retrieves the license type.
+     */
     getLicenseType() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_license_type", [
             {
@@ -98,6 +184,9 @@ export class AboutDialog extends Window {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the paintable displayed as logo in the about dialog.
+     */
     getLogo() {
         const ptr = call("libgtk-4.so.1", "gtk_about_dialog_get_logo", [
             {
@@ -109,6 +198,9 @@ export class AboutDialog extends Window {
             return null;
         return getObject(ptr, Gdk.Paintable);
     }
+    /**
+     * Returns the icon name displayed as logo in the about dialog.
+     */
     getLogoIconName() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_logo_icon_name", [
             {
@@ -117,6 +209,9 @@ export class AboutDialog extends Window {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the program name displayed in the about dialog.
+     */
     getProgramName() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_program_name", [
             {
@@ -125,6 +220,9 @@ export class AboutDialog extends Window {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the system information that is shown in the about dialog.
+     */
     getSystemInformation() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_system_information", [
             {
@@ -133,6 +231,10 @@ export class AboutDialog extends Window {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the translator credits string which is displayed
+     * in the credits page.
+     */
     getTranslatorCredits() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_translator_credits", [
             {
@@ -141,6 +243,9 @@ export class AboutDialog extends Window {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the version string.
+     */
     getVersion() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_version", [
             {
@@ -149,6 +254,9 @@ export class AboutDialog extends Window {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the website URL.
+     */
     getWebsite() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_website", [
             {
@@ -157,6 +265,9 @@ export class AboutDialog extends Window {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the label used for the website link.
+     */
     getWebsiteLabel() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_website_label", [
             {
@@ -165,6 +276,10 @@ export class AboutDialog extends Window {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns whether the license text in the about dialog is
+     * automatically wrapped.
+     */
     getWrapLicense() {
         return call("libgtk-4.so.1", "gtk_about_dialog_get_wrap_license", [
             {
@@ -173,6 +288,11 @@ export class AboutDialog extends Window {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets the names of the artists to be displayed
+     * in the "Credits" page.
+     * @param artists - the authors of the artwork
+     */
     setArtists(artists) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_artists", [
             {
@@ -185,6 +305,11 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the names of the authors which are displayed
+     * in the "Credits" page of the about dialog.
+     * @param authors - the authors of the application
+     */
     setAuthors(authors) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_authors", [
             {
@@ -197,6 +322,12 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the comments string to display in the about dialog.
+     *
+     * This should be a short string of one or two lines.
+     * @param comments - a comments string
+     */
     setComments(comments) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_comments", [
             {
@@ -210,6 +341,12 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the copyright string to display in the about dialog.
+     *
+     * This should be a short string of one or two lines.
+     * @param copyright - the copyright string
+     */
     setCopyright(copyright) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_copyright", [
             {
@@ -223,6 +360,11 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the names of the documenters which are displayed
+     * in the "Credits" page.
+     * @param documenters - the authors of the documentation
+     */
     setDocumenters(documenters) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_documenters", [
             {
@@ -235,6 +377,13 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the license information to be displayed in the
+     * about dialog.
+     *
+     * If `license` is `NULL`, the license page is hidden.
+     * @param license - the license information
+     */
     setLicense(license) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_license", [
             {
@@ -248,6 +397,14 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the license of the application showing the about dialog
+     * from a list of known licenses.
+     *
+     * This function overrides the license set using
+     * [method@Gtk.AboutDialog.set_license].
+     * @param licenseType - the type of license
+     */
     setLicenseType(licenseType) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_license_type", [
             {
@@ -260,6 +417,10 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the logo in the about dialog.
+     * @param logo - a `GdkPaintable`
+     */
     setLogo(logo) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_logo", [
             {
@@ -273,6 +434,10 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the icon name to be displayed as logo in the about dialog.
+     * @param iconName - an icon name
+     */
     setLogoIconName(iconName) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_logo_icon_name", [
             {
@@ -286,6 +451,13 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the name to display in the about dialog.
+     *
+     * If `name` is not set, the string returned
+     * by `g_get_application_name()` is used.
+     * @param name - the program name
+     */
     setProgramName(name) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_program_name", [
             {
@@ -299,6 +471,16 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the system information to be displayed in the about
+     * dialog.
+     *
+     * If `system_information` is `NULL`, the system information
+     * page is hidden.
+     *
+     * See [property@Gtk.AboutDialog:system-information].
+     * @param systemInformation - system information
+     */
     setSystemInformation(systemInformation) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_system_information", [
             {
@@ -312,6 +494,27 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the translator credits string which is displayed in
+     * the credits page.
+     *
+     * The intended use for this string is to display the translator
+     * of the language which is currently used in the user interface.
+     * Using `gettext()`, a simple way to achieve that is to mark the
+     * string for translation:
+     *
+     * ```c
+     * GtkWidget *about = gtk_about_dialog_new ();
+     * gtk_about_dialog_set_translator_credits (GTK_ABOUT_DIALOG (about),
+     * _("translator-credits"));
+     * ```
+     *
+     * It is a good idea to use the customary `msgid` “translator-credits”
+     * for this purpose, since translators will already know the purpose of
+     * that `msgid`, and since `GtkAboutDialog` will detect if “translator-credits”
+     * is untranslated and omit translator credits.
+     * @param translatorCredits - the translator credits
+     */
     setTranslatorCredits(translatorCredits) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_translator_credits", [
             {
@@ -325,6 +528,10 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the version string to display in the about dialog.
+     * @param version - the version string
+     */
     setVersion(version) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_version", [
             {
@@ -338,6 +545,10 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the URL to use for the website link.
+     * @param website - a URL string starting with `http://`
+     */
     setWebsite(website) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_website", [
             {
@@ -351,6 +562,10 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the label to be used for the website link.
+     * @param websiteLabel - the label used for the website link
+     */
     setWebsiteLabel(websiteLabel) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_website_label", [
             {
@@ -363,6 +578,11 @@ export class AboutDialog extends Window {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the license text in the about dialog should be
+     * automatically wrapped.
+     * @param wrapLicense - whether to wrap the license
+     */
     setWrapLicense(wrapLicense) {
         call("libgtk-4.so.1", "gtk_about_dialog_set_wrap_license", [
             {

package/dist/generated/gtk/accessible-list.d.ts

@@ -1,8 +1,22 @@
 import { Accessible } from "./accessible.js";
+/** Wraps a list of references to [iface@Gtk.Accessible] objects. */
 export declare class AccessibleList {
     ptr: unknown;
+    /**
+     * Allocates a new list of accessible objects.
+     * @param accessibles - array of accessible objects
+     * @param nAccessibles - length of the `accessibles` array
+     */
     constructor(accessibles: Accessible[], nAccessibles: number);
+    /**
+     * Allocates a new `GtkAccessibleList`, doing a shallow copy
+     * of the passed list of accessible objects
+     * @param list - a list
+     */
     static listNewFromList(list: Accessible[]): AccessibleList;
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Gets the list of objects this boxed type holds.
+     */
     getObjects(): Accessible[];
 }

package/dist/generated/gtk/accessible-list.js

@@ -1,12 +1,23 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Accessible } from "./accessible.js";
+/** Wraps a list of references to [iface@Gtk.Accessible] objects. */
 export class AccessibleList {
     ptr;
+    /**
+     * Allocates a new list of accessible objects.
+     * @param accessibles - array of accessible objects
+     * @param nAccessibles - length of the `accessibles` array
+     */
     constructor(accessibles, nAccessibles) {
         const _args = [accessibles, nAccessibles];
         this.ptr = this.createPtr(_args);
     }
+    /**
+     * Allocates a new `GtkAccessibleList`, doing a shallow copy
+     * of the passed list of accessible objects
+     * @param list - a list
+     */
     static listNewFromList(list) {
         const ptr = call("libgtk-4.so.1", "gtk_accessible_list_new_from_list", [
             {
@@ -33,6 +44,9 @@ export class AccessibleList {
             },
         ], { type: "boxed", borrowed: true, innerType: "GtkAccessibleList" });
     }
+    /**
+     * Gets the list of objects this boxed type holds.
+     */
     getObjects() {
         const ptrs = call("libgtk-4.so.1", "gtk_accessible_list_get_objects", [
             {

package/dist/generated/gtk/accessible-range.d.ts

@@ -1,3 +1,30 @@
+/**
+ * An interface for accessible objects containing a numeric value.
+ *
+ * `GtkAccessibleRange` describes ranged controls for Assistive Technologies.
+ *
+ * Ranged controls have a single value within an allowed range that can
+ * optionally be changed by the user.
+ *
+ * This interface is expected to be implemented by controls using the
+ * following roles:
+ *
+ * - `GTK_ACCESSIBLE_ROLE_METER`
+ * - `GTK_ACCESSIBLE_ROLE_PROGRESS_BAR`
+ * - `GTK_ACCESSIBLE_ROLE_SCROLLBAR`
+ * - `GTK_ACCESSIBLE_ROLE_SLIDER`
+ * - `GTK_ACCESSIBLE_ROLE_SPIN_BUTTON`
+ *
+ * If that is not the case, a warning will be issued at run time.
+ *
+ * In addition to this interface, its implementers are expected to provide the
+ * correct values for the following properties:
+ *
+ * - `GTK_ACCESSIBLE_PROPERTY_VALUE_MAX`
+ * - `GTK_ACCESSIBLE_PROPERTY_VALUE_MIN`
+ * - `GTK_ACCESSIBLE_PROPERTY_VALUE_NOW`
+ * - `GTK_ACCESSIBLE_PROPERTY_VALUE_TEXT`
+ */
 export declare class AccessibleRange {
     ptr: unknown;
     protected constructor(ptr: unknown);

package/dist/generated/gtk/accessible-range.js

@@ -1,3 +1,30 @@
+/**
+ * An interface for accessible objects containing a numeric value.
+ *
+ * `GtkAccessibleRange` describes ranged controls for Assistive Technologies.
+ *
+ * Ranged controls have a single value within an allowed range that can
+ * optionally be changed by the user.
+ *
+ * This interface is expected to be implemented by controls using the
+ * following roles:
+ *
+ * - `GTK_ACCESSIBLE_ROLE_METER`
+ * - `GTK_ACCESSIBLE_ROLE_PROGRESS_BAR`
+ * - `GTK_ACCESSIBLE_ROLE_SCROLLBAR`
+ * - `GTK_ACCESSIBLE_ROLE_SLIDER`
+ * - `GTK_ACCESSIBLE_ROLE_SPIN_BUTTON`
+ *
+ * If that is not the case, a warning will be issued at run time.
+ *
+ * In addition to this interface, its implementers are expected to provide the
+ * correct values for the following properties:
+ *
+ * - `GTK_ACCESSIBLE_PROPERTY_VALUE_MAX`
+ * - `GTK_ACCESSIBLE_PROPERTY_VALUE_MIN`
+ * - `GTK_ACCESSIBLE_PROPERTY_VALUE_NOW`
+ * - `GTK_ACCESSIBLE_PROPERTY_VALUE_TEXT`
+ */
 export class AccessibleRange {
     ptr;
     constructor(ptr) {

package/dist/generated/gtk/accessible-text.d.ts

@@ -1,9 +1,47 @@
 import { AccessibleTextContentChange } from "./enums.js";
+/**
+ * An interface for accessible objects containing formatted text.
+ *
+ * The `GtkAccessibleText` interfaces is meant to be implemented by accessible
+ * objects that have text formatted with attributes, or non-trivial text contents.
+ *
+ * You should use the [enum@Gtk.AccessibleProperty.LABEL] or the
+ * [enum@Gtk.AccessibleProperty.DESCRIPTION] properties for accessible
+ * objects containing simple, unformatted text.
+ */
 export declare class AccessibleText {
     ptr: unknown;
     protected constructor(ptr: unknown);
     static fromPtr(ptr: unknown): AccessibleText;
+    /**
+     * Updates the position of the caret.
+     *
+     * Implementations of the `GtkAccessibleText` interface should call this
+     * function every time the caret has moved, in order to notify assistive
+     * technologies.
+     */
     updateCaretPosition(): void;
+    /**
+     * Notifies assistive technologies of a change in contents.
+     *
+     * Implementations of the `GtkAccessibleText` interface should call this
+     * function every time their contents change as the result of an operation,
+     * like an insertion or a removal.
+     *
+     * Note: If the change is a deletion, this function must be called *before*
+     * removing the contents, if it is an insertion, it must be called *after*
+     * inserting the new contents.
+     * @param change - the type of change in the contents
+     * @param start - the starting offset of the change, in characters
+     * @param end - the end offset of the change, in characters
+     */
     updateContents(change: AccessibleTextContentChange, start: number, end: number): void;
+    /**
+     * Updates the boundary of the selection.
+     *
+     * Implementations of the `GtkAccessibleText` interface should call this
+     * function every time the selection has moved, in order to notify assistive
+     * technologies.
+     */
     updateSelectionBound(): void;
 }

package/dist/generated/gtk/accessible-text.js

@@ -1,4 +1,14 @@
 import { call } from "@gtkx/native";
+/**
+ * An interface for accessible objects containing formatted text.
+ *
+ * The `GtkAccessibleText` interfaces is meant to be implemented by accessible
+ * objects that have text formatted with attributes, or non-trivial text contents.
+ *
+ * You should use the [enum@Gtk.AccessibleProperty.LABEL] or the
+ * [enum@Gtk.AccessibleProperty.DESCRIPTION] properties for accessible
+ * objects containing simple, unformatted text.
+ */
 export class AccessibleText {
     ptr;
     constructor(ptr) {
@@ -7,6 +17,13 @@ export class AccessibleText {
     static fromPtr(ptr) {
         return new AccessibleText(ptr);
     }
+    /**
+     * Updates the position of the caret.
+     *
+     * Implementations of the `GtkAccessibleText` interface should call this
+     * function every time the caret has moved, in order to notify assistive
+     * technologies.
+     */
     updateCaretPosition() {
         call("libgtk-4.so.1", "gtk_accessible_text_update_caret_position", [
             {
@@ -15,6 +32,20 @@ export class AccessibleText {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Notifies assistive technologies of a change in contents.
+     *
+     * Implementations of the `GtkAccessibleText` interface should call this
+     * function every time their contents change as the result of an operation,
+     * like an insertion or a removal.
+     *
+     * Note: If the change is a deletion, this function must be called *before*
+     * removing the contents, if it is an insertion, it must be called *after*
+     * inserting the new contents.
+     * @param change - the type of change in the contents
+     * @param start - the starting offset of the change, in characters
+     * @param end - the end offset of the change, in characters
+     */
     updateContents(change, start, end) {
         call("libgtk-4.so.1", "gtk_accessible_text_update_contents", [
             {
@@ -35,6 +66,13 @@ export class AccessibleText {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Updates the boundary of the selection.
+     *
+     * Implementations of the `GtkAccessibleText` interface should call this
+     * function every time the selection has moved, in order to notify assistive
+     * technologies.
+     */
     updateSelectionBound() {
         call("libgtk-4.so.1", "gtk_accessible_text_update_selection_bound", [
             {