Creates a new gtk.file_chooser_native.FileChooserNative.
Retrieves the custom label text for the accept button.
Retrieves the custom label text for the cancel button.
Sets the custom label text for the accept button.
Sets the custom label text for the cancel button.
Adds a 'choice' to the file chooser.
Adds filter to the list of filters that the user can select between.
Adds a folder to be displayed with the shortcut folders in a file chooser.
Gets the type of operation that the file chooser is performing.
Gets the currently selected option in the 'choice' with the given ID.
Gets whether file chooser will offer to create new folders.
Gets the current folder of chooser as gio.file.File.
Gets the current name in the file selector, as entered by the user.
Gets the gio.file.File for the currently selected file in the file selector.
Lists all the selected files and subfolders in the current folder of chooser as gio.file.File.
Gets the current filter.
Gets the current set of user-selectable filters, as a list model.
Gets whether multiple files can be selected in the file chooser.
Queries the list of shortcut folders in the file chooser.
Removes a 'choice' that has been added with gtk.file_chooser.FileChooser.addChoice.
Removes filter from the list of filters that the user can select between.
Removes a folder from the shortcut folders in a file chooser.
Sets the type of operation that the chooser is performing.
Selects an option in a 'choice' that has been added with gtk.file_chooser.FileChooser.addChoice.
Sets whether file chooser will offer to create new folders.
Sets the current folder for chooser from a gio.file.File.
Sets the current name in the file selector, as if entered by the user.
Sets file as the current filename for the file chooser.
Sets the current filter.
Sets whether multiple files can be selected in the file chooser.
Destroys a dialog.
Returns whether the dialog is modal.
Gets the title of the gtk.native_dialog.NativeDialog.
Fetches the transient parent for this window.
Determines whether the dialog is visible.
Hides the dialog if it is visible, aborting any interaction.
Sets a dialog modal or non-modal.
Sets the title of the GtkNativeDialog.
Dialog windows should be set transient for the main application window they were spawned from.
Shows the dialog on the display.
Connect to Response signal.
Adds a 'choice' to the file chooser.
Adds filter to the list of filters that the user can select between.
Adds a folder to be displayed with the shortcut folders in a file chooser.
Gets the type of operation that the file chooser is performing.
Gets the currently selected option in the 'choice' with the given ID.
Gets whether file chooser will offer to create new folders.
Gets the current folder of chooser as gio.file.File.
Gets the current name in the file selector, as entered by the user.
Gets the gio.file.File for the currently selected file in the file selector.
Lists all the selected files and subfolders in the current folder of chooser as gio.file.File.
Gets the current filter.
Gets the current set of user-selectable filters, as a list model.
Gets whether multiple files can be selected in the file chooser.
Queries the list of shortcut folders in the file chooser.
Removes a 'choice' that has been added with gtk.file_chooser.FileChooser.addChoice.
Removes filter from the list of filters that the user can select between.
Removes a folder from the shortcut folders in a file chooser.
Sets the type of operation that the chooser is performing.
Selects an option in a 'choice' that has been added with gtk.file_chooser.FileChooser.addChoice.
Sets whether file chooser will offer to create new folders.
Sets the current folder for chooser from a gio.file.File.
Sets the current name in the file selector, as if entered by the user.
Sets file as the current filename for the file chooser.
Sets the current filter.
Sets whether multiple files can be selected in the file chooser.
Deprecated: Use gtk.file_dialog.FileDialog instead
gtk.file_chooser_native.FileChooserNative is an abstraction of a dialog suitable for use with “File Open” or “File Save as” commands.
By default, this just uses a gtk.file_chooser_dialog.FileChooserDialog 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), gtk.file_chooser_native.FileChooserNative may call the proper APIs (portals) to let the user choose a file and make it available to the application.
While the API of gtk.file_chooser_native.FileChooserNative closely mirrors gtk.file_chooser_dialog.FileChooserDialog, the main difference is that there is no access to any gtk.window.Window or gtk.widget.Widget 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 gtk.native_dialog.NativeDialog functions.
Note that unlike gtk.file_chooser_dialog.FileChooserDialog, gtk.file_chooser_native.FileChooserNative 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 gtk.file_chooser_native.FileChooserNative to select a file for opening:
To use a gtk.file_chooser_native.FileChooserNative for saving, you can use this:
For more information on how to best set up a file dialog, see the gtk.file_chooser_dialog.FileChooserDialog documentation.
Response Codes
gtk.file_chooser_native.FileChooserNative inherits from gtk.native_dialog.NativeDialog, which means it will return gtk.types.ResponseType.Accept if the user accepted, and gtk.types.ResponseType.Cancel if he pressed cancel. It can also return gtk.types.ResponseType.DeleteEvent if the window was unexpectedly closed.
Differences from gtk.file_chooser_dialog.FileChooserDialog
There are a few things in the gtk.file_chooser.FileChooser interface that are not possible to use with gtk.file_chooser_native.FileChooserNative, 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 gtk.file_chooser.FileChooser has, but there are some things it does not handle:
If any of these features are used the regular gtk.file_chooser_dialog.FileChooserDialog 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 gtk.file_chooser.FileChooser are not supported: