Struct gtk4::FileChooserNative

#[repr(transparent)]
pub struct FileChooserNative { /* private fields */ }

Use FileDialog instead FileChooserNative is an abstraction of a dialog suitable for use with “File Open” or “File Save as” commands.

By default, this just uses a 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), 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 FileChooserNative closely mirrors FileChooserDialog, the main difference is that there is no access to any Window or 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 NativeDialog functions.

Note that unlike FileChooserDialog, 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 FileChooserNative to select a file for opening:

⚠️ The following code is in 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 FileChooserNative for saving, you can use this:

⚠️ The following code is in 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 FileChooserDialog documentation.

Response Codes

FileChooserNative 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::DeleteEvent if the window was unexpectedly closed.

Differences from FileChooserDialog

There are a few things in the FileChooser interface that are not possible to use with 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 FileChooser 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 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 FileChooser are not supported:

• Shortcut folders.

Properties

accept-label

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

Readable | Writeable

cancel-label

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

Readable | Writeable

NativeDialog

modal

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

Readable | Writeable

title

The title of the dialog window

Readable | Writeable

transient-for

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

Readable | Writeable | Construct

visible

Whether the window is currently visible.

Readable | Writeable

FileChooser

action

The type of operation that the file chooser is performing.

Readable | Writeable

create-folders

Whether a file chooser not in FileChooserAction::Open mode will offer the user to create new folders.

Readable | Writeable

filter

The current filter for selecting files that are displayed.

Readable | Writeable

filters

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

The returned object should not be modified. It may or may not be updated for later changes.

Readable

select-multiple

Whether to allow multiple files to be selected.

Readable | Writeable

shortcut-folders

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

The returned object should not be modified. It may or may not be updated for later changes.

Readable

Implements

NativeDialogExt, glib::ObjectExt, FileChooserExt, NativeDialogExtManual, FileChooserExtManual

Implementations

impl FileChooserNative

pub fn new( title: Option<&str>, parent: Option<&impl IsA<Window>>, action: FileChooserAction, accept_label: Option<&str>, cancel_label: Option<&str> ) -> FileChooserNative

Creates a new FileChooserNative.

Deprecated since 4.10

Use FileDialog instead

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

Returns

a new FileChooserNative

pub fn builder() -> FileChooserNativeBuilder

Creates a new builder-pattern struct instance to construct FileChooserNative objects.

This method returns an instance of FileChooserNativeBuilder which can be used to create FileChooserNative objects.

pub fn accept_label(&self) -> Option<GString>

Retrieves the custom label text for the accept button.

Deprecated since 4.10

Use FileDialog instead

Returns

The custom label

pub fn cancel_label(&self) -> Option<GString>

Retrieves the custom label text for the cancel button.

Deprecated since 4.10

Use FileDialog instead

Returns

The custom label

pub fn set_accept_label(&self, accept_label: Option<&str>)

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.

Deprecated since 4.10

Use FileDialog instead

accept_label

custom label

pub fn set_cancel_label(&self, cancel_label: Option<&str>)

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.

Deprecated since 4.10

Use FileDialog instead

cancel_label

custom label

pub fn connect_accept_label_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_cancel_label_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for FileChooserNative

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileChooserNative

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FileChooserNative

fn default() -> Self

Returns the “default value” for a type.

impl Display for FileChooserNative

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for FileChooserNative

type ParamSpec = ParamSpecObject

type SetValue = FileChooserNative

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, FileChooserNative>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FileChooserNative

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FileChooserNative

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for FileChooserNative

type Parent = NativeDialog

impl<OT: ObjectType> PartialEq<OT> for FileChooserNative

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for FileChooserNative

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FileChooserNative

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FileChooserNative

impl IsA<FileChooser> for FileChooserNative

impl IsA<NativeDialog> for FileChooserNative