@gtkx/ffi 0.1.45 → 0.1.46

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

@@ -3,6 +3,180 @@ import { NativeError, getObject } from "@gtkx/ffi";
 import { FileFilter } from "./file-filter.js";
 import * as Gio from "../gio/index.js";
 import { Dialog } from "./dialog.js";
+/**
+ * `GtkFileChooserDialog` is a dialog suitable for use with
+ * “File Open” or “File Save” commands.
+ *
+ *
+ *
+ * This widget works by putting a [class@Gtk.FileChooserWidget]
+ * inside a [class@Gtk.Dialog]. It exposes the [iface@Gtk.FileChooser]
+ * interface, so you can use all of the [iface@Gtk.FileChooser] functions
+ * on the file chooser dialog as well as those for [class@Gtk.Dialog].
+ *
+ * Note that `GtkFileChooserDialog` does not have any methods of its
+ * own. Instead, you should use the functions that work on a
+ * [iface@Gtk.FileChooser].
+ *
+ * If you want to integrate well with the platform you should use the
+ * [class@Gtk.FileChooserNative] API, which will use a platform-specific
+ * dialog if available and fall back to `GtkFileChooserDialog`
+ * otherwise.
+ *
+ * ## Typical usage
+ *
+ * In the simplest of cases, you can the following code to use
+ * `GtkFileChooserDialog` to select a file for opening:
+ *
+ * ```c
+ * static void
+ * on_open_response (GtkDialog *dialog,
+ * int        response)
+ * {
+ * if (response == GTK_RESPONSE_ACCEPT)
+ * {
+ * GtkFileChooser *chooser = GTK_FILE_CHOOSER (dialog);
+ *
+ * g_autoptr(GFile) file = gtk_file_chooser_get_file (chooser);
+ *
+ * open_file (file);
+ * }
+ *
+ * gtk_window_destroy (GTK_WINDOW (dialog));
+ * }
+ *
+ * // ...
+ * GtkWidget *dialog;
+ * GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN;
+ *
+ * dialog = gtk_file_chooser_dialog_new ("Open File",
+ * parent_window,
+ * action,
+ * _("_Cancel"),
+ * GTK_RESPONSE_CANCEL,
+ * _("_Open"),
+ * GTK_RESPONSE_ACCEPT,
+ * NULL);
+ *
+ * gtk_window_present (GTK_WINDOW (dialog));
+ *
+ * g_signal_connect (dialog, "response",
+ * G_CALLBACK (on_open_response),
+ * NULL);
+ * ```
+ *
+ * To use a dialog for saving, you can use this:
+ *
+ * ```c
+ * static void
+ * on_save_response (GtkDialog *dialog,
+ * int        response)
+ * {
+ * if (response == GTK_RESPONSE_ACCEPT)
+ * {
+ * GtkFileChooser *chooser = GTK_FILE_CHOOSER (dialog);
+ *
+ * g_autoptr(GFile) file = gtk_file_chooser_get_file (chooser);
+ *
+ * save_to_file (file);
+ * }
+ *
+ * gtk_window_destroy (GTK_WINDOW (dialog));
+ * }
+ *
+ * // ...
+ * GtkWidget *dialog;
+ * GtkFileChooser *chooser;
+ * GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_SAVE;
+ *
+ * dialog = gtk_file_chooser_dialog_new ("Save File",
+ * parent_window,
+ * action,
+ * _("_Cancel"),
+ * GTK_RESPONSE_CANCEL,
+ * _("_Save"),
+ * GTK_RESPONSE_ACCEPT,
+ * NULL);
+ * chooser = GTK_FILE_CHOOSER (dialog);
+ *
+ * if (user_edited_a_new_document)
+ * gtk_file_chooser_set_current_name (chooser, _("Untitled document"));
+ * else
+ * gtk_file_chooser_set_file (chooser, existing_filename);
+ *
+ * gtk_window_present (GTK_WINDOW (dialog));
+ *
+ * g_signal_connect (dialog, "response",
+ * G_CALLBACK (on_save_response),
+ * NULL);
+ * ```
+ *
+ * ## Setting up a file chooser dialog
+ *
+ * There are various cases in which you may need to use a `GtkFileChooserDialog`:
+ *
+ * - To select a file for opening, use %GTK_FILE_CHOOSER_ACTION_OPEN.
+ *
+ * - To save a file for the first time, use %GTK_FILE_CHOOSER_ACTION_SAVE,
+ * and suggest a name such as “Untitled” with
+ * [method@Gtk.FileChooser.set_current_name].
+ *
+ * - To save a file under a different name, use %GTK_FILE_CHOOSER_ACTION_SAVE,
+ * and set the existing file with [method@Gtk.FileChooser.set_file].
+ *
+ * - To choose a folder instead of a file, use %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
+ *
+ * In general, you should only cause the file chooser to show a specific
+ * folder when it is appropriate to use [method@Gtk.FileChooser.set_file],
+ * i.e. when you are doing a “Save As” command and you already have a file
+ * saved somewhere.
+ *
+ * ## Response Codes
+ *
+ * `GtkFileChooserDialog` inherits from [class@Gtk.Dialog], so buttons that
+ * go in its action area have response codes such as %GTK_RESPONSE_ACCEPT and
+ * %GTK_RESPONSE_CANCEL. For example, you could call
+ * [ctor@Gtk.FileChooserDialog.new] as follows:
+ *
+ * ```c
+ * GtkWidget *dialog;
+ * GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN;
+ *
+ * dialog = gtk_file_chooser_dialog_new ("Open File",
+ * parent_window,
+ * action,
+ * _("_Cancel"),
+ * GTK_RESPONSE_CANCEL,
+ * _("_Open"),
+ * GTK_RESPONSE_ACCEPT,
+ * NULL);
+ * ```
+ *
+ * This will create buttons for “Cancel” and “Open” that use predefined
+ * response identifiers from [enum@Gtk.ResponseType].  For most dialog
+ * boxes you can use your own custom response codes rather than the
+ * ones in [enum@Gtk.ResponseType], but `GtkFileChooserDialog` assumes that
+ * its “accept”-type action, e.g. an “Open” or “Save” button,
+ * will have one of the following response codes:
+ *
+ * - %GTK_RESPONSE_ACCEPT
+ * - %GTK_RESPONSE_OK
+ * - %GTK_RESPONSE_YES
+ * - %GTK_RESPONSE_APPLY
+ *
+ * This is because `GtkFileChooserDialog` must intercept responses and switch
+ * to folders if appropriate, rather than letting the dialog terminate — the
+ * implementation uses these known response codes to know which responses can
+ * be blocked if appropriate.
+ *
+ * To summarize, make sure you use a predefined response code
+ * when you use `GtkFileChooserDialog` to ensure proper operation.
+ *
+ * ## CSS nodes
+ *
+ * `GtkFileChooserDialog` has a single CSS node with the name `window` and style
+ * class `.filechooser`.
+ */
 const SIGNAL_META = {
     close: { params: [], returnType: { type: "undefined" } },
     response: {
@@ -29,6 +203,20 @@ export class FileChooserDialog extends Dialog {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * 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", [
             {
@@ -55,6 +243,16 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
             {
@@ -67,6 +265,11 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
@@ -95,6 +298,9 @@ export class FileChooserDialog extends Dialog {
         }
         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", [
             {
@@ -103,6 +309,10 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
             {
@@ -115,6 +325,9 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
             {
@@ -123,6 +336,9 @@ export class FileChooserDialog extends Dialog {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the current folder of `chooser` as `GFile`.
+     */
     getCurrentFolder() {
         const ptr = call("libgtk-4.so.1", "gtk_file_chooser_get_current_folder", [
             {
@@ -134,6 +350,12 @@ export class FileChooserDialog extends Dialog {
             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", [
             {
@@ -142,6 +364,16 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
             {
@@ -153,6 +385,10 @@ export class FileChooserDialog extends Dialog {
             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", [
             {
@@ -162,6 +398,9 @@ export class FileChooserDialog extends Dialog {
         ], { 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", [
             {
@@ -173,6 +412,15 @@ export class FileChooserDialog extends Dialog {
             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", [
             {
@@ -182,6 +430,10 @@ export class FileChooserDialog extends Dialog {
         ], { 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", [
             {
@@ -190,6 +442,12 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
             {
@@ -199,6 +457,10 @@ export class FileChooserDialog extends Dialog {
         ], { 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", [
             {
@@ -211,6 +473,10 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
             {
@@ -223,6 +489,10 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
@@ -251,6 +521,16 @@ export class FileChooserDialog extends Dialog {
         }
         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", [
             {
@@ -263,6 +543,14 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
             {
@@ -279,6 +567,13 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
             {
@@ -291,6 +586,10 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
@@ -320,6 +619,22 @@ export class FileChooserDialog extends Dialog {
         }
         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", [
             {
@@ -332,6 +647,51 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
@@ -360,6 +720,18 @@ export class FileChooserDialog extends Dialog {
         }
         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", [
             {
@@ -372,6 +744,14 @@ export class FileChooserDialog extends Dialog {
             },
         ], { 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", [
             {