@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtk/file-chooser.d.ts

@@ -1,33 +1,281 @@
 import { FileChooserAction } from "./enums.js";
 import { FileFilter } from "./file-filter.js";
 import * as Gio from "../gio/index.js";
+/**
+ * `GtkFileChooser` is an interface that can be implemented by file
+ * selection widgets.
+ *
+ * In GTK, the main objects that implement this interface are
+ * [class@Gtk.FileChooserWidget] and [class@Gtk.FileChooserDialog].
+ *
+ * You do not need to write an object that implements the `GtkFileChooser`
+ * interface unless you are trying to adapt an existing file selector to
+ * expose a standard programming interface.
+ *
+ * `GtkFileChooser` allows for shortcuts to various places in the filesystem.
+ * In the default implementation these are displayed in the left pane. It
+ * may be a bit confusing at first that these shortcuts come from various
+ * sources and in various flavours, so lets explain the terminology here:
+ *
+ * - Bookmarks: are created by the user, by dragging folders from the
+ * right pane to the left pane, or by using the “Add”. Bookmarks
+ * can be renamed and deleted by the user.
+ *
+ * - Shortcuts: can be provided by the application. For example, a Paint
+ * program may want to add a shortcut for a Clipart folder. Shortcuts
+ * cannot be modified by the user.
+ *
+ * - Volumes: are provided by the underlying filesystem abstraction. They are
+ * the “roots” of the filesystem.
+ *
+ * # File Names and Encodings
+ *
+ * When the user is finished selecting files in a `GtkFileChooser`, your
+ * program can get the selected filenames as `GFile`s.
+ *
+ * # Adding options
+ *
+ * You can add extra widgets to a file chooser to provide options
+ * that are not present in the default design, by using
+ * [method@Gtk.FileChooser.add_choice]. Each choice has an identifier and
+ * a user visible label; additionally, each choice can have multiple
+ * options. If a choice has no option, it will be rendered as a
+ * check button with the given label; if a choice has options, it will
+ * be rendered as a combo box.
+ */
 export declare class FileChooser {
     ptr: unknown;
     protected constructor(ptr: unknown);
     static fromPtr(ptr: unknown): FileChooser;
+    /**
+     * Adds a 'choice' to the file chooser.
+     *
+     * This is typically implemented as a combobox or, for boolean choices,
+     * as a checkbutton. You can select a value using
+     * [method@Gtk.FileChooser.set_choice] before the dialog is shown,
+     * and you can obtain the user-selected value in the
+     * [signal@Gtk.Dialog::response] signal handler using
+     * [method@Gtk.FileChooser.get_choice].
+     * @param id - id for the added choice
+     * @param label - user-visible label for the added choice
+     * @param options - ids for the options of the choice, or %NULL for a boolean choice
+     * @param optionLabels - user-visible labels for the options, must be the same length as @options
+     */
     addChoice(id: string, label: string, options?: string[] | null, optionLabels?: string[] | null): void;
+    /**
+     * Adds `filter` to the list of filters that the user can select between.
+     *
+     * When a filter is selected, only files that are passed by that
+     * filter are displayed.
+     *
+     * Note that the `chooser` takes ownership of the filter if it is floating,
+     * so you have to ref and sink it if you want to keep a reference.
+     * @param filter - a `GtkFileFilter`
+     */
     addFilter(filter: FileFilter): void;
+    /**
+     * Adds a folder to be displayed with the shortcut folders
+     * in a file chooser.
+     * @param folder - a `GFile` for the folder to add
+     */
     addShortcutFolder(folder: Gio.File): boolean;
+    /**
+     * Gets the type of operation that the file chooser is performing.
+     */
     getAction(): FileChooserAction;
+    /**
+     * Gets the currently selected option in the 'choice' with the given ID.
+     * @param id - the ID of the choice to get
+     */
     getChoice(id: string): string | null;
+    /**
+     * Gets whether file chooser will offer to create new folders.
+     */
     getCreateFolders(): boolean;
+    /**
+     * Gets the current folder of `chooser` as `GFile`.
+     */
     getCurrentFolder(): Gio.File | null;
+    /**
+     * Gets the current name in the file selector, as entered by the user.
+     *
+     * This is meant to be used in save dialogs, to get the currently typed
+     * filename when the file itself does not exist yet.
+     */
     getCurrentName(): string | null;
+    /**
+     * Gets the `GFile` for the currently selected file in
+     * the file selector.
+     *
+     * If multiple files are selected, one of the files will be
+     * returned at random.
+     *
+     * If the file chooser is in folder mode, this function returns
+     * the selected folder.
+     */
     getFile(): Gio.File | null;
+    /**
+     * Lists all the selected files and subfolders in the current folder
+     * of `chooser` as `GFile`.
+     */
     getFiles(): Gio.ListModel;
+    /**
+     * Gets the current filter.
+     */
     getFilter(): FileFilter | null;
+    /**
+     * Gets the current set of user-selectable filters, as a list model.
+     *
+     * See [method@Gtk.FileChooser.add_filter] and
+     * [method@Gtk.FileChooser.remove_filter] for changing individual filters.
+     *
+     * You should not modify the returned list model. Future changes to
+     * `chooser` may or may not affect the returned model.
+     */
     getFilters(): Gio.ListModel;
+    /**
+     * Gets whether multiple files can be selected in the file
+     * chooser.
+     */
     getSelectMultiple(): boolean;
+    /**
+     * Queries the list of shortcut folders in the file chooser.
+     *
+     * You should not modify the returned list model. Future changes to
+     * `chooser` may or may not affect the returned model.
+     */
     getShortcutFolders(): Gio.ListModel;
+    /**
+     * Removes a 'choice' that has been added with gtk_file_chooser_add_choice().
+     * @param id - the ID of the choice to remove
+     */
     removeChoice(id: string): void;
+    /**
+     * Removes `filter` from the list of filters that the user can select between.
+     * @param filter - a `GtkFileFilter`
+     */
     removeFilter(filter: FileFilter): void;
+    /**
+     * Removes a folder from the shortcut folders in a file chooser.
+     * @param folder - a `GFile` for the folder to remove
+     */
     removeShortcutFolder(folder: Gio.File): boolean;
+    /**
+     * Sets the type of operation that the chooser is performing.
+     *
+     * The user interface is adapted to suit the selected action.
+     *
+     * For example, an option to create a new folder might be shown
+     * if the action is %GTK_FILE_CHOOSER_ACTION_SAVE but not if the
+     * action is %GTK_FILE_CHOOSER_ACTION_OPEN.
+     * @param action - the action that the file selector is performing
+     */
     setAction(action: FileChooserAction): void;
+    /**
+     * Selects an option in a 'choice' that has been added with
+     * gtk_file_chooser_add_choice().
+     *
+     * For a boolean choice, the possible options are "true" and "false".
+     * @param id - the ID of the choice to set
+     * @param option - the ID of the option to select
+     */
     setChoice(id: string, option: string): void;
+    /**
+     * Sets whether file chooser will offer to create new folders.
+     *
+     * This is only relevant if the action is not set to be
+     * %GTK_FILE_CHOOSER_ACTION_OPEN.
+     * @param createFolders - %TRUE if the Create Folder button should be displayed
+     */
     setCreateFolders(createFolders: boolean): void;
+    /**
+     * Sets the current folder for `chooser` from a `GFile`.
+     * @param file - the `GFile` for the new folder
+     */
     setCurrentFolder(file?: Gio.File | null): boolean;
+    /**
+     * Sets the current name in the file selector, as if entered
+     * by the user.
+     *
+     * Note that the name passed in here is a UTF-8 string rather
+     * than a filename. This function is meant for such uses as a
+     * suggested name in a “Save As...” dialog.  You can pass
+     * “Untitled.doc” or a similarly suitable suggestion for the @name.
+     *
+     * If you want to preselect a particular existing file, you should
+     * use [method@Gtk.FileChooser.set_file] instead.
+     *
+     * Please see the documentation for those functions for an example
+     * of using [method@Gtk.FileChooser.set_current_name] as well.
+     * @param name - the filename to use, as a UTF-8 string
+     */
     setCurrentName(name: string): void;
+    /**
+     * Sets `file` as the current filename for the file chooser.
+     *
+     * This includes changing to the file’s parent folder and actually selecting
+     * the file in list. If the `chooser` is in %GTK_FILE_CHOOSER_ACTION_SAVE mode,
+     * the file’s base name will also appear in the dialog’s file name entry.
+     *
+     * If the file name isn’t in the current folder of @chooser, then the current
+     * folder of `chooser` will be changed to the folder containing @file.
+     *
+     * Note that the file must exist, or nothing will be done except
+     * for the directory change.
+     *
+     * If you are implementing a save dialog, you should use this function if
+     * you already have a file name to which the user may save; for example,
+     * when the user opens an existing file and then does “Save As…”. If you
+     * don’t have a file name already — for example, if the user just created
+     * a new file and is saving it for the first time, do not call this function.
+     *
+     * Instead, use something similar to this:
+     *
+     * ```c
+     * static void
+     * prepare_file_chooser (GtkFileChooser *chooser,
+     * GFile          *existing_file)
+     * {
+     * gboolean document_is_new = (existing_file == NULL);
+     *
+     * if (document_is_new)
+     * {
+     * GFile *default_file_for_saving = g_file_new_for_path ("./out.txt");
+     * // the user just created a new document
+     * gtk_file_chooser_set_current_folder (chooser, default_file_for_saving, NULL);
+     * gtk_file_chooser_set_current_name (chooser, "Untitled document");
+     * g_object_unref (default_file_for_saving);
+     * }
+     * else
+     * {
+     * // the user edited an existing document
+     * gtk_file_chooser_set_file (chooser, existing_file, NULL);
+     * }
+     * }
+     * ```
+     * @param file - the `GFile` to set as current
+     */
     setFile(file: Gio.File): boolean;
+    /**
+     * Sets the current filter.
+     *
+     * Only the files that pass the filter will be displayed.
+     * If the user-selectable list of filters is non-empty, then
+     * the filter should be one of the filters in that list.
+     *
+     * Setting the current filter when the list of filters is
+     * empty is useful if you want to restrict the displayed
+     * set of files without letting the user change it.
+     * @param filter - a `GtkFileFilter`
+     */
     setFilter(filter: FileFilter): void;
+    /**
+     * Sets whether multiple files can be selected in the file chooser.
+     *
+     * This is only relevant if the action is set to be
+     * %GTK_FILE_CHOOSER_ACTION_OPEN or
+     * %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
+     * @param selectMultiple - %TRUE if multiple files can be selected.
+     */
     setSelectMultiple(selectMultiple: boolean): void;
 }

package/dist/generated/gtk/file-chooser.js

@@ -2,6 +2,48 @@ import { call } from "@gtkx/native";
 import { NativeError, getObject } from "@gtkx/ffi";
 import { FileFilter } from "./file-filter.js";
 import * as Gio from "../gio/index.js";
+/**
+ * `GtkFileChooser` is an interface that can be implemented by file
+ * selection widgets.
+ *
+ * In GTK, the main objects that implement this interface are
+ * [class@Gtk.FileChooserWidget] and [class@Gtk.FileChooserDialog].
+ *
+ * You do not need to write an object that implements the `GtkFileChooser`
+ * interface unless you are trying to adapt an existing file selector to
+ * expose a standard programming interface.
+ *
+ * `GtkFileChooser` allows for shortcuts to various places in the filesystem.
+ * In the default implementation these are displayed in the left pane. It
+ * may be a bit confusing at first that these shortcuts come from various
+ * sources and in various flavours, so lets explain the terminology here:
+ *
+ * - Bookmarks: are created by the user, by dragging folders from the
+ * right pane to the left pane, or by using the “Add”. Bookmarks
+ * can be renamed and deleted by the user.
+ *
+ * - Shortcuts: can be provided by the application. For example, a Paint
+ * program may want to add a shortcut for a Clipart folder. Shortcuts
+ * cannot be modified by the user.
+ *
+ * - Volumes: are provided by the underlying filesystem abstraction. They are
+ * the “roots” of the filesystem.
+ *
+ * # File Names and Encodings
+ *
+ * When the user is finished selecting files in a `GtkFileChooser`, your
+ * program can get the selected filenames as `GFile`s.
+ *
+ * # Adding options
+ *
+ * You can add extra widgets to a file chooser to provide options
+ * that are not present in the default design, by using
+ * [method@Gtk.FileChooser.add_choice]. Each choice has an identifier and
+ * a user visible label; additionally, each choice can have multiple
+ * options. If a choice has no option, it will be rendered as a
+ * check button with the given label; if a choice has options, it will
+ * be rendered as a combo box.
+ */
 export class FileChooser {
     ptr;
     constructor(ptr) {
@@ -10,6 +52,20 @@ export class FileChooser {
     static fromPtr(ptr) {
         return new FileChooser(ptr);
     }
+    /**
+     * Adds a 'choice' to the file chooser.
+     *
+     * This is typically implemented as a combobox or, for boolean choices,
+     * as a checkbutton. You can select a value using
+     * [method@Gtk.FileChooser.set_choice] before the dialog is shown,
+     * and you can obtain the user-selected value in the
+     * [signal@Gtk.Dialog::response] signal handler using
+     * [method@Gtk.FileChooser.get_choice].
+     * @param id - id for the added choice
+     * @param label - user-visible label for the added choice
+     * @param options - ids for the options of the choice, or %NULL for a boolean choice
+     * @param optionLabels - user-visible labels for the options, must be the same length as @options
+     */
     addChoice(id, label, options, optionLabels) {
         call("libgtk-4.so.1", "gtk_file_chooser_add_choice", [
             {
@@ -36,6 +92,16 @@ export class FileChooser {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Adds `filter` to the list of filters that the user can select between.
+     *
+     * When a filter is selected, only files that are passed by that
+     * filter are displayed.
+     *
+     * Note that the `chooser` takes ownership of the filter if it is floating,
+     * so you have to ref and sink it if you want to keep a reference.
+     * @param filter - a `GtkFileFilter`
+     */
     addFilter(filter) {
         call("libgtk-4.so.1", "gtk_file_chooser_add_filter", [
             {
@@ -48,6 +114,11 @@ export class FileChooser {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Adds a folder to be displayed with the shortcut folders
+     * in a file chooser.
+     * @param folder - a `GFile` for the folder to add
+     */
     addShortcutFolder(folder) {
         const error = { value: null };
         const result = call("libgtk-4.so.1", "gtk_file_chooser_add_shortcut_folder", [
@@ -76,6 +147,9 @@ export class FileChooser {
         }
         return result;
     }
+    /**
+     * Gets the type of operation that the file chooser is performing.
+     */
     getAction() {
         return call("libgtk-4.so.1", "gtk_file_chooser_get_action", [
             {
@@ -84,6 +158,10 @@ export class FileChooser {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the currently selected option in the 'choice' with the given ID.
+     * @param id - the ID of the choice to get
+     */
     getChoice(id) {
         return call("libgtk-4.so.1", "gtk_file_chooser_get_choice", [
             {
@@ -96,6 +174,9 @@ export class FileChooser {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets whether file chooser will offer to create new folders.
+     */
     getCreateFolders() {
         return call("libgtk-4.so.1", "gtk_file_chooser_get_create_folders", [
             {
@@ -104,6 +185,9 @@ export class FileChooser {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the current folder of `chooser` as `GFile`.
+     */
     getCurrentFolder() {
         const ptr = call("libgtk-4.so.1", "gtk_file_chooser_get_current_folder", [
             {
@@ -115,6 +199,12 @@ export class FileChooser {
             return null;
         return getObject(ptr, Gio.File);
     }
+    /**
+     * Gets the current name in the file selector, as entered by the user.
+     *
+     * This is meant to be used in save dialogs, to get the currently typed
+     * filename when the file itself does not exist yet.
+     */
     getCurrentName() {
         return call("libgtk-4.so.1", "gtk_file_chooser_get_current_name", [
             {
@@ -123,6 +213,16 @@ export class FileChooser {
             },
         ], { type: "string" });
     }
+    /**
+     * Gets the `GFile` for the currently selected file in
+     * the file selector.
+     *
+     * If multiple files are selected, one of the files will be
+     * returned at random.
+     *
+     * If the file chooser is in folder mode, this function returns
+     * the selected folder.
+     */
     getFile() {
         const ptr = call("libgtk-4.so.1", "gtk_file_chooser_get_file", [
             {
@@ -134,6 +234,10 @@ export class FileChooser {
             return null;
         return getObject(ptr, Gio.File);
     }
+    /**
+     * Lists all the selected files and subfolders in the current folder
+     * of `chooser` as `GFile`.
+     */
     getFiles() {
         const ptr = call("libgtk-4.so.1", "gtk_file_chooser_get_files", [
             {
@@ -143,6 +247,9 @@ export class FileChooser {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Gio.ListModel);
     }
+    /**
+     * Gets the current filter.
+     */
     getFilter() {
         const ptr = call("libgtk-4.so.1", "gtk_file_chooser_get_filter", [
             {
@@ -154,6 +261,15 @@ export class FileChooser {
             return null;
         return getObject(ptr, FileFilter);
     }
+    /**
+     * Gets the current set of user-selectable filters, as a list model.
+     *
+     * See [method@Gtk.FileChooser.add_filter] and
+     * [method@Gtk.FileChooser.remove_filter] for changing individual filters.
+     *
+     * You should not modify the returned list model. Future changes to
+     * `chooser` may or may not affect the returned model.
+     */
     getFilters() {
         const ptr = call("libgtk-4.so.1", "gtk_file_chooser_get_filters", [
             {
@@ -163,6 +279,10 @@ export class FileChooser {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Gio.ListModel);
     }
+    /**
+     * Gets whether multiple files can be selected in the file
+     * chooser.
+     */
     getSelectMultiple() {
         return call("libgtk-4.so.1", "gtk_file_chooser_get_select_multiple", [
             {
@@ -171,6 +291,12 @@ export class FileChooser {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Queries the list of shortcut folders in the file chooser.
+     *
+     * You should not modify the returned list model. Future changes to
+     * `chooser` may or may not affect the returned model.
+     */
     getShortcutFolders() {
         const ptr = call("libgtk-4.so.1", "gtk_file_chooser_get_shortcut_folders", [
             {
@@ -180,6 +306,10 @@ export class FileChooser {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Gio.ListModel);
     }
+    /**
+     * Removes a 'choice' that has been added with gtk_file_chooser_add_choice().
+     * @param id - the ID of the choice to remove
+     */
     removeChoice(id) {
         call("libgtk-4.so.1", "gtk_file_chooser_remove_choice", [
             {
@@ -192,6 +322,10 @@ export class FileChooser {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes `filter` from the list of filters that the user can select between.
+     * @param filter - a `GtkFileFilter`
+     */
     removeFilter(filter) {
         call("libgtk-4.so.1", "gtk_file_chooser_remove_filter", [
             {
@@ -204,6 +338,10 @@ export class FileChooser {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes a folder from the shortcut folders in a file chooser.
+     * @param folder - a `GFile` for the folder to remove
+     */
     removeShortcutFolder(folder) {
         const error = { value: null };
         const result = call("libgtk-4.so.1", "gtk_file_chooser_remove_shortcut_folder", [
@@ -232,6 +370,16 @@ export class FileChooser {
         }
         return result;
     }
+    /**
+     * Sets the type of operation that the chooser is performing.
+     *
+     * The user interface is adapted to suit the selected action.
+     *
+     * For example, an option to create a new folder might be shown
+     * if the action is %GTK_FILE_CHOOSER_ACTION_SAVE but not if the
+     * action is %GTK_FILE_CHOOSER_ACTION_OPEN.
+     * @param action - the action that the file selector is performing
+     */
     setAction(action) {
         call("libgtk-4.so.1", "gtk_file_chooser_set_action", [
             {
@@ -244,6 +392,14 @@ export class FileChooser {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Selects an option in a 'choice' that has been added with
+     * gtk_file_chooser_add_choice().
+     *
+     * For a boolean choice, the possible options are "true" and "false".
+     * @param id - the ID of the choice to set
+     * @param option - the ID of the option to select
+     */
     setChoice(id, option) {
         call("libgtk-4.so.1", "gtk_file_chooser_set_choice", [
             {
@@ -260,6 +416,13 @@ export class FileChooser {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether file chooser will offer to create new folders.
+     *
+     * This is only relevant if the action is not set to be
+     * %GTK_FILE_CHOOSER_ACTION_OPEN.
+     * @param createFolders - %TRUE if the Create Folder button should be displayed
+     */
     setCreateFolders(createFolders) {
         call("libgtk-4.so.1", "gtk_file_chooser_set_create_folders", [
             {
@@ -272,6 +435,10 @@ export class FileChooser {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the current folder for `chooser` from a `GFile`.
+     * @param file - the `GFile` for the new folder
+     */
     setCurrentFolder(file) {
         const error = { value: null };
         const result = call("libgtk-4.so.1", "gtk_file_chooser_set_current_folder", [
@@ -301,6 +468,22 @@ export class FileChooser {
         }
         return result;
     }
+    /**
+     * Sets the current name in the file selector, as if entered
+     * by the user.
+     *
+     * Note that the name passed in here is a UTF-8 string rather
+     * than a filename. This function is meant for such uses as a
+     * suggested name in a “Save As...” dialog.  You can pass
+     * “Untitled.doc” or a similarly suitable suggestion for the @name.
+     *
+     * If you want to preselect a particular existing file, you should
+     * use [method@Gtk.FileChooser.set_file] instead.
+     *
+     * Please see the documentation for those functions for an example
+     * of using [method@Gtk.FileChooser.set_current_name] as well.
+     * @param name - the filename to use, as a UTF-8 string
+     */
     setCurrentName(name) {
         call("libgtk-4.so.1", "gtk_file_chooser_set_current_name", [
             {
@@ -313,6 +496,51 @@ export class FileChooser {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets `file` as the current filename for the file chooser.
+     *
+     * This includes changing to the file’s parent folder and actually selecting
+     * the file in list. If the `chooser` is in %GTK_FILE_CHOOSER_ACTION_SAVE mode,
+     * the file’s base name will also appear in the dialog’s file name entry.
+     *
+     * If the file name isn’t in the current folder of @chooser, then the current
+     * folder of `chooser` will be changed to the folder containing @file.
+     *
+     * Note that the file must exist, or nothing will be done except
+     * for the directory change.
+     *
+     * If you are implementing a save dialog, you should use this function if
+     * you already have a file name to which the user may save; for example,
+     * when the user opens an existing file and then does “Save As…”. If you
+     * don’t have a file name already — for example, if the user just created
+     * a new file and is saving it for the first time, do not call this function.
+     *
+     * Instead, use something similar to this:
+     *
+     * ```c
+     * static void
+     * prepare_file_chooser (GtkFileChooser *chooser,
+     * GFile          *existing_file)
+     * {
+     * gboolean document_is_new = (existing_file == NULL);
+     *
+     * if (document_is_new)
+     * {
+     * GFile *default_file_for_saving = g_file_new_for_path ("./out.txt");
+     * // the user just created a new document
+     * gtk_file_chooser_set_current_folder (chooser, default_file_for_saving, NULL);
+     * gtk_file_chooser_set_current_name (chooser, "Untitled document");
+     * g_object_unref (default_file_for_saving);
+     * }
+     * else
+     * {
+     * // the user edited an existing document
+     * gtk_file_chooser_set_file (chooser, existing_file, NULL);
+     * }
+     * }
+     * ```
+     * @param file - the `GFile` to set as current
+     */
     setFile(file) {
         const error = { value: null };
         const result = call("libgtk-4.so.1", "gtk_file_chooser_set_file", [
@@ -341,6 +569,18 @@ export class FileChooser {
         }
         return result;
     }
+    /**
+     * Sets the current filter.
+     *
+     * Only the files that pass the filter will be displayed.
+     * If the user-selectable list of filters is non-empty, then
+     * the filter should be one of the filters in that list.
+     *
+     * Setting the current filter when the list of filters is
+     * empty is useful if you want to restrict the displayed
+     * set of files without letting the user change it.
+     * @param filter - a `GtkFileFilter`
+     */
     setFilter(filter) {
         call("libgtk-4.so.1", "gtk_file_chooser_set_filter", [
             {
@@ -353,6 +593,14 @@ export class FileChooser {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether multiple files can be selected in the file chooser.
+     *
+     * This is only relevant if the action is set to be
+     * %GTK_FILE_CHOOSER_ACTION_OPEN or
+     * %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
+     * @param selectMultiple - %TRUE if multiple files can be selected.
+     */
     setSelectMultiple(selectMultiple) {
         call("libgtk-4.so.1", "gtk_file_chooser_set_select_multiple", [
             {