@gtkx/ffi 0.1.45 → 0.1.46

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

@@ -3,6 +3,154 @@ import { NativeError, getObject } from "@gtkx/ffi";
 import { FileFilter } from "./file-filter.js";
 import * as Gio from "../gio/index.js";
 import { NativeDialog } from "./native-dialog.js";
+/**
+ * `GtkFileChooserNative` is an abstraction of a dialog suitable
+ * for use with “File Open” or “File Save as” commands.
+ *
+ * By default, this just uses a `GtkFileChooserDialog` to implement
+ * the actual dialog. However, on some platforms, such as Windows and
+ * macOS, the native platform file chooser is used instead. When the
+ * application is running in a sandboxed environment without direct
+ * filesystem access (such as Flatpak), `GtkFileChooserNative` may call
+ * the proper APIs (portals) to let the user choose a file and make it
+ * available to the application.
+ *
+ * While the API of `GtkFileChooserNative` closely mirrors `GtkFileChooserDialog`,
+ * the main difference is that there is no access to any `GtkWindow` or `GtkWidget`
+ * for the dialog. This is required, as there may not be one in the case of a
+ * platform native dialog.
+ *
+ * Showing, hiding and running the dialog is handled by the
+ * [class@Gtk.NativeDialog] functions.
+ *
+ * Note that unlike `GtkFileChooserDialog`, `GtkFileChooserNative` objects
+ * are not toplevel widgets, and GTK does not keep them alive. It is your
+ * responsibility to keep a reference until you are done with the
+ * object.
+ *
+ * ## Typical usage
+ *
+ * In the simplest of cases, you can the following code to use
+ * `GtkFileChooserNative` to select a file for opening:
+ *
+ * ```c
+ * static void
+ * on_response (GtkNativeDialog *native,
+ * int              response)
+ * {
+ * if (response == GTK_RESPONSE_ACCEPT)
+ * {
+ * GtkFileChooser *chooser = GTK_FILE_CHOOSER (native);
+ * GFile *file = gtk_file_chooser_get_file (chooser);
+ *
+ * open_file (file);
+ *
+ * g_object_unref (file);
+ * }
+ *
+ * g_object_unref (native);
+ * }
+ *
+ * // ...
+ * GtkFileChooserNative *native;
+ * GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN;
+ *
+ * native = gtk_file_chooser_native_new ("Open File",
+ * parent_window,
+ * action,
+ * "_Open",
+ * "_Cancel");
+ *
+ * g_signal_connect (native, "response", G_CALLBACK (on_response), NULL);
+ * gtk_native_dialog_show (GTK_NATIVE_DIALOG (native));
+ * ```
+ *
+ * To use a `GtkFileChooserNative` for saving, you can use this:
+ *
+ * ```c
+ * static void
+ * on_response (GtkNativeDialog *native,
+ * int              response)
+ * {
+ * if (response == GTK_RESPONSE_ACCEPT)
+ * {
+ * GtkFileChooser *chooser = GTK_FILE_CHOOSER (native);
+ * GFile *file = gtk_file_chooser_get_file (chooser);
+ *
+ * save_to_file (file);
+ *
+ * g_object_unref (file);
+ * }
+ *
+ * g_object_unref (native);
+ * }
+ *
+ * // ...
+ * GtkFileChooserNative *native;
+ * GtkFileChooser *chooser;
+ * GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_SAVE;
+ *
+ * native = gtk_file_chooser_native_new ("Save File",
+ * parent_window,
+ * action,
+ * "_Save",
+ * "_Cancel");
+ * chooser = GTK_FILE_CHOOSER (native);
+ *
+ * if (user_edited_a_new_document)
+ * gtk_file_chooser_set_current_name (chooser, _("Untitled document"));
+ * else
+ * gtk_file_chooser_set_file (chooser, existing_file, NULL);
+ *
+ * g_signal_connect (native, "response", G_CALLBACK (on_response), NULL);
+ * gtk_native_dialog_show (GTK_NATIVE_DIALOG (native));
+ * ```
+ *
+ * For more information on how to best set up a file dialog,
+ * see the [class@Gtk.FileChooserDialog] documentation.
+ *
+ * ## Response Codes
+ *
+ * `GtkFileChooserNative` inherits from [class@Gtk.NativeDialog],
+ * which means it will return %GTK_RESPONSE_ACCEPT if the user accepted,
+ * and %GTK_RESPONSE_CANCEL if he pressed cancel. It can also return
+ * %GTK_RESPONSE_DELETE_EVENT if the window was unexpectedly closed.
+ *
+ * ## Differences from `GtkFileChooserDialog`
+ *
+ * There are a few things in the [iface@Gtk.FileChooser] interface that
+ * are not possible to use with `GtkFileChooserNative`, as such use would
+ * prohibit the use of a native dialog.
+ *
+ * No operations that change the dialog work while the dialog is visible.
+ * Set all the properties that are required before showing the dialog.
+ *
+ * ## Win32 details
+ *
+ * On windows the `IFileDialog` implementation (added in Windows Vista) is
+ * used. It supports many of the features that `GtkFileChooser` has, but
+ * there are some things it does not handle:
+ *
+ * * Any [class@Gtk.FileFilter] added using a mimetype
+ *
+ * If any of these features are used the regular `GtkFileChooserDialog`
+ * will be used in place of the native one.
+ *
+ * ## Portal details
+ *
+ * When the `org.freedesktop.portal.FileChooser` portal is available on
+ * the session bus, it is used to bring up an out-of-process file chooser.
+ * Depending on the kind of session the application is running in, this may
+ * or may not be a GTK file chooser.
+ *
+ * ## macOS details
+ *
+ * On macOS the `NSSavePanel` and `NSOpenPanel` classes are used to provide
+ * native file chooser dialogs. Some features provided by `GtkFileChooser`
+ * are not supported:
+ *
+ * * Shortcut folders.
+ */
 export class FileChooserNative extends NativeDialog {
     constructor(...args) {
         super(...args);
@@ -36,6 +184,9 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Retrieves the custom label text for the accept button.
+     */
     getAcceptLabel() {
         return call("libgtk-4.so.1", "gtk_file_chooser_native_get_accept_label", [
             {
@@ -44,6 +195,9 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Retrieves the custom label text for the cancel button.
+     */
     getCancelLabel() {
         return call("libgtk-4.so.1", "gtk_file_chooser_native_get_cancel_label", [
             {
@@ -52,6 +206,17 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Sets the custom label text for the accept button.
+     *
+     * If characters in `label` are preceded by an underscore, they are
+     * underlined. If you need a literal underscore character in a label,
+     * use “__” (two underscores). The first underlined character represents
+     * a keyboard accelerator called a mnemonic.
+     *
+     * Pressing Alt and that key should activate the button.
+     * @param acceptLabel - custom label
+     */
     setAcceptLabel(acceptLabel) {
         call("libgtk-4.so.1", "gtk_file_chooser_native_set_accept_label", [
             {
@@ -65,6 +230,17 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the custom label text for the cancel button.
+     *
+     * If characters in `label` are preceded by an underscore, they are
+     * underlined. If you need a literal underscore character in a label,
+     * use “__” (two underscores). The first underlined character represents
+     * a keyboard accelerator called a mnemonic.
+     *
+     * Pressing Alt and that key should activate the button.
+     * @param cancelLabel - custom label
+     */
     setCancelLabel(cancelLabel) {
         call("libgtk-4.so.1", "gtk_file_chooser_native_set_cancel_label", [
             {
@@ -78,6 +254,20 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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", [
             {
@@ -104,6 +294,16 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
             {
@@ -116,6 +316,11 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
@@ -144,6 +349,9 @@ export class FileChooserNative extends NativeDialog {
         }
         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", [
             {
@@ -152,6 +360,10 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
             {
@@ -164,6 +376,9 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
             {
@@ -172,6 +387,9 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the current folder of `chooser` as `GFile`.
+     */
     getCurrentFolder() {
         const ptr = call("libgtk-4.so.1", "gtk_file_chooser_get_current_folder", [
             {
@@ -183,6 +401,12 @@ export class FileChooserNative extends NativeDialog {
             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", [
             {
@@ -191,6 +415,16 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
             {
@@ -202,6 +436,10 @@ export class FileChooserNative extends NativeDialog {
             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", [
             {
@@ -211,6 +449,9 @@ export class FileChooserNative extends NativeDialog {
         ], { 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", [
             {
@@ -222,6 +463,15 @@ export class FileChooserNative extends NativeDialog {
             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", [
             {
@@ -231,6 +481,10 @@ export class FileChooserNative extends NativeDialog {
         ], { 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", [
             {
@@ -239,6 +493,12 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
             {
@@ -248,6 +508,10 @@ export class FileChooserNative extends NativeDialog {
         ], { 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", [
             {
@@ -260,6 +524,10 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
             {
@@ -272,6 +540,10 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
@@ -300,6 +572,16 @@ export class FileChooserNative extends NativeDialog {
         }
         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", [
             {
@@ -312,6 +594,14 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
             {
@@ -328,6 +618,13 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
             {
@@ -340,6 +637,10 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
@@ -369,6 +670,22 @@ export class FileChooserNative extends NativeDialog {
         }
         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", [
             {
@@ -381,6 +698,51 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
@@ -409,6 +771,18 @@ export class FileChooserNative extends NativeDialog {
         }
         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", [
             {
@@ -421,6 +795,14 @@ export class FileChooserNative extends NativeDialog {
             },
         ], { 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", [
             {