FileChooserNative

open class FileChooserNative(pointer: <Error class: unknown class><<Error class: unknown class>>) : NativeDialog, FileChooser

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:

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:

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.

Constructors

Link copied to clipboard
constructor(title: String? = null, parent: Window? = null, action: FileChooserAction, acceptLabel: String? = null, cancelLabel: String? = null)

Creates a new GtkFileChooserNative.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open var acceptLabel: String?

The text used for the label on the accept button in the dialog, or null to use the default text.

Link copied to clipboard

The type of operation that the file chooser is performing.

Link copied to clipboard
open var cancelLabel: String?

The text used for the label on the cancel button in the dialog, or null to use the default text.

Link copied to clipboard

Whether a file chooser not in %GTK_FILE_CHOOSER_ACTION_OPEN mode will offer the user to create new folders.

Link copied to clipboard
open val filters: <Error class: unknown class>

A GListModel containing the filters that have been added with gtk_file_chooser_add_filter().

Link copied to clipboard
val gtkFileChooserNativePointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val gtkFileChooserPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gtkNativeDialogPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open var modal: Boolean

Whether the window should be modal with respect to its transient parent.

Link copied to clipboard

Whether to allow multiple files to be selected.

Link copied to clipboard
open val shortcutFolders: <Error class: unknown class>

A GListModel containing the shortcut folders that have been added with gtk_file_chooser_add_shortcut_folder().

Link copied to clipboard
open var transientFor: Window?

The transient parent of the dialog, or null for none.

Link copied to clipboard
open val visible: Boolean

Whether the window is currently visible.

Functions

Link copied to clipboard
open fun addChoice(id: String, label: String, options: List<String>? = null, optionLabels: List<String>? = null)

Adds a 'choice' to the file chooser.

Link copied to clipboard
open fun addFilter(filter: FileFilter)

Adds @filter to the list of filters that the user can select between.

Link copied to clipboard
open fun addShortcutFolder(folder: <Error class: unknown class>): <Error class: unknown class><Boolean>

Adds a folder to be displayed with the shortcut folders in a file chooser.

Link copied to clipboard
fun connectResponse(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>) -> Unit): <Error class: unknown class>

Emitted when the user responds to the dialog.

Link copied to clipboard
open fun destroy()

Destroys a dialog.

Link copied to clipboard

Gets the type of operation that the file chooser is performing.

Link copied to clipboard
open fun getChoice(id: String): String?

Gets the currently selected option in the 'choice' with the given ID.

Link copied to clipboard

Gets whether file chooser will offer to create new folders.

Link copied to clipboard
open fun getCurrentFolder(): <Error class: unknown class>?

Gets the current folder of @chooser as GFile.

Link copied to clipboard
open fun getCurrentName(): String?

Gets the current name in the file selector, as entered by the user.

Link copied to clipboard
open fun getFile(): <Error class: unknown class>?

Gets the GFile for the currently selected file in the file selector.

Link copied to clipboard
open fun getFiles(): <Error class: unknown class>

Lists all the selected files and subfolders in the current folder of @chooser as GFile.

Link copied to clipboard
open fun getFilter(): FileFilter?

Gets the current filter.

Link copied to clipboard
open fun getFilters(): <Error class: unknown class>

Gets the current set of user-selectable filters, as a list model.

Link copied to clipboard

Gets whether multiple files can be selected in the file chooser.

Link copied to clipboard
open fun getShortcutFolders(): <Error class: unknown class>

Queries the list of shortcut folders in the file chooser.

Link copied to clipboard
open fun getTitle(): String?

Gets the title of the GtkNativeDialog.

Link copied to clipboard
open fun hide()

Hides the dialog if it is visible, aborting any interaction.

Link copied to clipboard
open fun removeChoice(id: String)

Removes a 'choice' that has been added with gtk_file_chooser_add_choice().

Link copied to clipboard
open fun removeFilter(filter: FileFilter)

Removes @filter from the list of filters that the user can select between.

Link copied to clipboard
open fun removeShortcutFolder(folder: <Error class: unknown class>): <Error class: unknown class><Boolean>

Removes a folder from the shortcut folders in a file chooser.

Link copied to clipboard
open fun setAction(action: FileChooserAction)

Sets the type of operation that the chooser is performing.

Link copied to clipboard
open fun setChoice(id: String, option: String)

Selects an option in a 'choice' that has been added with gtk_file_chooser_add_choice().

Link copied to clipboard
open fun setCreateFolders(createFolders: Boolean)

Sets whether file chooser will offer to create new folders.

Link copied to clipboard
open fun setCurrentFolder(file: <Error class: unknown class>? = null): <Error class: unknown class><Boolean>

Sets the current folder for @chooser from a GFile.

Link copied to clipboard
open fun setCurrentName(name: String)

Sets the current name in the file selector, as if entered by the user.

Link copied to clipboard
open fun setFile(file: <Error class: unknown class>): <Error class: unknown class><Boolean>

Sets @file as the current filename for the file chooser.

Link copied to clipboard
open fun setFilter(filter: FileFilter)

Sets the current filter.

Link copied to clipboard
open fun setSelectMultiple(selectMultiple: Boolean)

Sets whether multiple files can be selected in the file chooser.

Link copied to clipboard
open fun setTitle(title: String)

Sets the title of the GtkNativeDialog.

Link copied to clipboard
open fun show()

Shows the dialog on the display.