Gtk.FileChooserNative¶

class — extends NativeDialog, FileChooser

:::warning Deprecated since 4.10 This API is deprecated. :::

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 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 FileChooserDialog documentation.

Response Codes¶

GtkFileChooserNative inherits from NativeDialog, which means it will return ResponseType.ACCEPT if the user accepted, and ResponseType.CANCEL if he pressed cancel. It can also return ResponseType.DELETE_EVENT if the window was unexpectedly closed.

Differences from `GtkFileChooserDialog`¶

There are a few things in the 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 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¶

new¶

@classmethod
def new(cls, title: str | None, parent: Window | None, action: FileChooserAction | int, accept_label: str | None = ..., cancel_label: str | None = ...) -> FileChooserNative

:::warning Deprecated since 4.10 This API is deprecated. :::

Creates a new GtkFileChooserNative.

Parameters:

title — Title of the native
parent — Transient parent of the native
action — Open or save mode for the dialog
accept_label — text to go in the accept button, or None for the default
cancel_label — text to go in the cancel button, or None for the default

Methods¶

get_accept_label¶

def get_accept_label(self) -> str | None

:::warning Deprecated since 4.10 This API is deprecated. :::

Retrieves the custom label text for the accept button.

get_cancel_label¶

def get_cancel_label(self) -> str | None

:::warning Deprecated since 4.10 This API is deprecated. :::

Retrieves the custom label text for the cancel button.

set_accept_label¶

def set_accept_label(self, accept_label: str | None = ...) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

accept_label — custom label

set_cancel_label¶

def set_cancel_label(self, cancel_label: str | None = ...) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

cancel_label — custom label

Properties¶

accept_label¶

accept_label: str  # read/write

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

cancel_label¶

cancel_label: str  # read/write

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

Gtk.FileChooserNative¶

Typical usage¶

Response Codes¶

Differences from GtkFileChooserDialog¶

Win32 details¶

Portal details¶

macOS details¶

Constructors¶

new¶

Methods¶

get_accept_label¶

get_cancel_label¶

set_accept_label¶

set_cancel_label¶

Properties¶

accept_label¶

cancel_label¶

Differences from `GtkFileChooserDialog`¶