Trait gtk4::prelude::FileChooserExt

pub trait FileChooserExt: 'static {
    // Required methods
    fn add_filter(&self, filter: &FileFilter);
    fn add_shortcut_folder(&self, folder: &impl IsA<File>) -> Result<(), Error>;
    fn action(&self) -> FileChooserAction;
    fn choice(&self, id: &str) -> Option<GString>;
    fn creates_folders(&self) -> bool;
    fn current_folder(&self) -> Option<File>;
    fn current_name(&self) -> Option<GString>;
    fn file(&self) -> Option<File>;
    fn files(&self) -> ListModel;
    fn filter(&self) -> Option<FileFilter>;
    fn filters(&self) -> ListModel;
    fn selects_multiple(&self) -> bool;
    fn shortcut_folders(&self) -> ListModel;
    fn remove_choice(&self, id: &str);
    fn remove_filter(&self, filter: &FileFilter);
    fn remove_shortcut_folder(
        &self,
        folder: &impl IsA<File>
    ) -> Result<(), Error>;
    fn set_action(&self, action: FileChooserAction);
    fn set_choice(&self, id: &str, option: &str);
    fn set_create_folders(&self, create_folders: bool);
    fn set_current_folder(
        &self,
        file: Option<&impl IsA<File>>
    ) -> Result<(), Error>;
    fn set_current_name(&self, name: &str);
    fn set_file(&self, file: &impl IsA<File>) -> Result<(), Error>;
    fn set_filter(&self, filter: &FileFilter);
    fn set_select_multiple(&self, select_multiple: bool);
    fn connect_action_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
    fn connect_create_folders_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
    fn connect_filter_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
    fn connect_filters_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
    fn connect_select_multiple_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
    fn connect_shortcut_folders_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
}

Trait containing all FileChooser methods.

Implementors

FileChooserDialog, FileChooserNative, FileChooserWidget, FileChooser

Required Methods

fn add_filter(&self, filter: &FileFilter)

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 @self takes ownership of the filter if it is floating, so you have to ref and sink it if you want to keep a reference.

filter

a FileFilter

fn add_shortcut_folder(&self, folder: &impl IsA<File>) -> Result<(), Error>

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

folder

a GFile for the folder to add

Returns

true if the folder could be added successfully, false otherwise.

fn action(&self) -> FileChooserAction

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

Returns

the action that the file selector is performing

fn choice(&self, id: &str) -> Option<GString>

Gets the currently selected option in the ‘choice’ with the given ID.

id

the ID of the choice to get

Returns

the ID of the currently selected option

fn creates_folders(&self) -> bool

Gets whether file chooser will offer to create new folders.

Returns

true if the Create Folder button should be displayed.

fn current_folder(&self) -> Option<File>

Gets the current folder of @self as GFile.

Returns

the GFile for the current folder.

fn current_name(&self) -> Option<GString>

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.

Returns

The raw text from the file chooser’s “Name” entry. Free with g_free(). Note that this string is not a full pathname or URI; it is whatever the contents of the entry are. Note also that this string is in UTF-8 encoding, which is not necessarily the system’s encoding for filenames.

fn file(&self) -> Option<File>

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.

Returns

a selected GFile. You own the returned file; use g_object_unref() to release it.

fn files(&self) -> ListModel

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

Returns

a list model containing a GFile for each selected file and subfolder in the current folder. Free the returned list with g_object_unref().

fn filter(&self) -> Option<FileFilter>

Gets the current filter.

Returns

the current filter

fn filters(&self) -> ListModel

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

See add_filter() and remove_filter() for changing individual filters.

You should not modify the returned list model. Future changes to @self may or may not affect the returned model.

Returns

a GListModel containing the current set of user-selectable filters.

fn selects_multiple(&self) -> bool

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

Returns

true if multiple files can be selected.

fn shortcut_folders(&self) -> ListModel

Queries the list of shortcut folders in the file chooser.

You should not modify the returned list model. Future changes to @self may or may not affect the returned model.

Returns

A list model of GFiles

fn remove_choice(&self, id: &str)

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

id

the ID of the choice to remove

fn remove_filter(&self, filter: &FileFilter)

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

filter

a FileFilter

fn remove_shortcut_folder(&self, folder: &impl IsA<File>) -> Result<(), Error>

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

folder

a GFile for the folder to remove

Returns

true if the folder could be removed successfully, false otherwise.

fn set_action(&self, action: FileChooserAction)

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 FileChooserAction::Save but not if the action is FileChooserAction::Open.

action

the action that the file selector is performing

fn set_choice(&self, id: &str, option: &str)

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”.

id

the ID of the choice to set

option

the ID of the option to select

fn set_create_folders(&self, create_folders: bool)

Sets whether file chooser will offer to create new folders.

This is only relevant if the action is not set to be FileChooserAction::Open.

create_folders

true if the Create Folder button should be displayed

fn set_current_folder(&self, file: Option<&impl IsA<File>>) -> Result<(), Error>

Sets the current folder for @self from a GFile.

file

the GFile for the new folder

Returns

true if the folder could be changed successfully, false otherwise.

fn set_current_name(&self, name: &str)

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 set_file() instead.

Please see the documentation for those functions for an example of using set_current_name() as well.

name

the filename to use, as a UTF-8 string

fn set_file(&self, file: &impl IsA<File>) -> Result<(), Error>

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 @self is in FileChooserAction::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 @self, then the current folder of @self 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:

⚠️ The following code is in 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);
    }
}

file

the GFile to set as current

Returns

Not useful

fn set_filter(&self, filter: &FileFilter)

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.

filter

a FileFilter

fn set_select_multiple(&self, select_multiple: bool)

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

This is only relevant if the action is set to be FileChooserAction::Open or FileChooserAction::SelectFolder.

select_multiple

true if multiple files can be selected.

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

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

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

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

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

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

Implementors

impl<O: IsA<FileChooser>> FileChooserExt for O