Struct FileChooser 

pub struct FileChooser { /* private fields */ }

FileChooser is an interface that can be implemented by file selection widgets. In GTK+, the main objects that implement this interface are FileChooserWidget, FileChooserDialog, and FileChooserButton. You do not need to write an object that implements the FileChooser interface unless you are trying to adapt an existing file selector to expose a standard programming interface.

FileChooser allows for shortcuts to various places in the filesystem. In the default implementation these are displayed in the left pane. It may be a bit confusing at first that these shortcuts come from various sources and in various flavours, so lets explain the terminology here:

• Bookmarks: are created by the user, by dragging folders from the right pane to the left pane, or by using the “Add”. Bookmarks can be renamed and deleted by the user.

• Shortcuts: can be provided by the application. For example, a Paint program may want to add a shortcut for a Clipart folder. Shortcuts cannot be modified by the user.

• Volumes: are provided by the underlying filesystem abstraction. They are the “roots” of the filesystem.

File Names and Encodings

When the user is finished selecting files in a FileChooser, your program can get the selected names either as filenames or as URIs. For URIs, the normal escaping rules are applied if the URI contains non-ASCII characters. However, filenames are always returned in the character set specified by the G_FILENAME_ENCODING environment variable. Please see the GLib documentation for more details about this variable.

This means that while you can pass the result of FileChooserExt::filename() to g_open() or g_fopen(), you may not be able to directly set it as the text of a Label widget unless you convert it first to UTF-8, which all GTK+ widgets expect. You should use g_filename_to_utf8() to convert filenames into strings that can be passed to GTK+ widgets.

Adding a Preview Widget

You can add a custom preview widget to a file chooser and then get notification about when the preview needs to be updated. To install a preview widget, use FileChooserExt::set_preview_widget(). Then, connect to the update-preview signal to get notified when you need to update the contents of the preview.

Your callback should use FileChooserExt::preview_filename() to see what needs previewing. Once you have generated the preview for the corresponding file, you must call FileChooserExt::set_preview_widget_active() with a boolean flag that indicates whether your callback could successfully generate a preview.

Example: Using a Preview Widget ## {gtkfilechooser-preview}

⚠️ The following code is in C ⚠️

{
  GtkImage *preview;

  ...

  preview = gtk_image_new ();

  gtk_file_chooser_set_preview_widget (my_file_chooser, preview);
  g_signal_connect (my_file_chooser, "update-preview",
            G_CALLBACK (update_preview_cb), preview);
}

static void
update_preview_cb (GtkFileChooser *file_chooser, gpointer data)
{
  GtkWidget *preview;
  char *filename;
  GdkPixbuf *pixbuf;
  gboolean have_preview;

  preview = GTK_WIDGET (data);
  filename = gtk_file_chooser_get_preview_filename (file_chooser);

  pixbuf = gdk_pixbuf_new_from_file_at_size (filename, 128, 128, NULL);
  have_preview = (pixbuf != NULL);
  g_free (filename);

  gtk_image_set_from_pixbuf (GTK_IMAGE (preview), pixbuf);
  if (pixbuf)
    g_object_unref (pixbuf);

  gtk_file_chooser_set_preview_widget_active (file_chooser, have_preview);
}

Adding Extra Widgets

You can add extra widgets to a file chooser to provide options that are not present in the default design. For example, you can add a toggle button to give the user the option to open a file in read-only mode. You can use FileChooserExt::set_extra_widget() to insert additional widgets in a file chooser.

An example for adding extra widgets:

⚠️ The following code is in C ⚠️

  GtkWidget *toggle;

  ...

  toggle = gtk_check_button_new_with_label ("Open file read-only");
  gtk_widget_show (toggle);
  gtk_file_chooser_set_extra_widget (my_file_chooser, toggle);
}

If you want to set more than one extra widget in the file chooser, you can a container such as a Box or a Grid and include your widgets in it. Then, set the container as the whole extra widget.

Properties

action

Readable | Writeable

create-folders

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

Readable | Writeable

do-overwrite-confirmation

Whether a file chooser in FileChooserAction::Save mode will present an overwrite confirmation dialog if the user selects a file name that already exists.

Readable | Writeable

extra-widget

Readable | Writeable

filter

Readable | Writeable

local-only

Readable | Writeable

preview-widget

Readable | Writeable

preview-widget-active

Readable | Writeable

select-multiple

Readable | Writeable

show-hidden

Readable | Writeable

use-preview-label

Readable | Writeable

Signals

confirm-overwrite

This signal gets emitted whenever it is appropriate to present a confirmation dialog when the user has selected a file name that already exists. The signal only gets emitted when the file chooser is in FileChooserAction::Save mode.

Most applications just need to turn on the do-overwrite-confirmation property (or call the FileChooserExt::set_do_overwrite_confirmation() function), and they will automatically get a stock confirmation dialog. Applications which need to customize this behavior should do that, and also connect to the confirm-overwrite signal.

A signal handler for this signal must return a FileChooserConfirmation value, which indicates the action to take. If the handler determines that the user wants to select a different filename, it should return FileChooserConfirmation::SelectAgain. If it determines that the user is satisfied with his choice of file name, it should return FileChooserConfirmation::AcceptFilename. On the other hand, if it determines that the stock confirmation dialog should be used, it should return FileChooserConfirmation::Confirm. The following example illustrates this.

Custom confirmation ## {gtkfilechooser-confirmation}

⚠️ The following code is in C ⚠️

static GtkFileChooserConfirmation
confirm_overwrite_callback (GtkFileChooser *chooser, gpointer data)
{
  char *uri;

  uri = gtk_file_chooser_get_uri (chooser);

  if (is_uri_read_only (uri))
    {
      if (user_wants_to_replace_read_only_file (uri))
        return GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME;
      else
        return GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN;
    } else
      return GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM; // fall back to the default dialog
}

...

chooser = gtk_file_chooser_dialog_new (...);

gtk_file_chooser_set_do_overwrite_confirmation (GTK_FILE_CHOOSER (dialog), TRUE);
g_signal_connect (chooser, "confirm-overwrite",
                  G_CALLBACK (confirm_overwrite_callback), NULL);

if (gtk_dialog_run (chooser) == GTK_RESPONSE_ACCEPT)
        save_to_file (gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (chooser));

gtk_widget_destroy (chooser);

current-folder-changed

This signal is emitted when the current folder in a FileChooser changes. This can happen due to the user performing some action that changes folders, such as selecting a bookmark or visiting a folder on the file list. It can also happen as a result of calling a function to explicitly change the current folder in a file chooser.

Normally you do not need to connect to this signal, unless you need to keep track of which folder a file chooser is showing.

See also: FileChooserExt::set_current_folder(), FileChooserExt::current_folder(), FileChooserExt::set_current_folder_uri(), FileChooserExt::current_folder_uri().

file-activated

This signal is emitted when the user “activates” a file in the file chooser. This can happen by double-clicking on a file in the file list, or by pressing Enter.

Normally you do not need to connect to this signal. It is used internally by FileChooserDialog to know when to activate the default button in the dialog.

See also: FileChooserExt::filename(), FileChooserExt::filenames(), FileChooserExt::uri(), FileChooserExt::uris().

selection-changed

This signal is emitted when there is a change in the set of selected files in a FileChooser. This can happen when the user modifies the selection with the mouse or the keyboard, or when explicitly calling functions to change the selection.

Normally you do not need to connect to this signal, as it is easier to wait for the file chooser to finish running, and then to get the list of selected files using the functions mentioned below.

See also: FileChooserExt::select_filename(), FileChooserExt::unselect_filename(), FileChooserExt::filename(), FileChooserExt::filenames(), FileChooserExt::select_uri(), FileChooserExt::unselect_uri(), FileChooserExt::uri(), FileChooserExt::uris().

update-preview

This signal is emitted when the preview in a file chooser should be regenerated. For example, this can happen when the currently selected file changes. You should use this signal if you want your file chooser to have a preview widget.

Once you have installed a preview widget with FileChooserExt::set_preview_widget(), you should update it when this signal is emitted. You can use the functions FileChooserExt::preview_filename() or FileChooserExt::preview_uri() to get the name of the file to preview. Your widget may not be able to preview all kinds of files; your callback must call FileChooserExt::set_preview_widget_active() to inform the file chooser about whether the preview was generated successfully or not.

Please see the example code in [Using a Preview Widget][gtkfilechooser-preview].

See also: FileChooserExt::set_preview_widget(), FileChooserExt::set_preview_widget_active(), FileChooserExt::set_use_preview_label(), FileChooserExt::preview_filename(), FileChooserExt::preview_uri().

Implements

FileChooserExt, FileChooserExtManual

Implementations

impl FileChooser

pub const NONE: Option<&'static FileChooser> = None

Trait Implementations

impl Clone for FileChooser

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileChooser

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

Formats the value using the given formatter.

impl Display for FileChooser

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

Formats the value using the given formatter.

impl Eq for FileChooser

impl HasParamSpec for FileChooser

type ParamSpec = ParamSpecObject

type SetValue = FileChooser

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FileChooser

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 IsA<FileChooser> for FileChooserButton

impl IsA<FileChooser> for FileChooserDialog

impl IsA<FileChooser> for FileChooserNative

impl IsA<FileChooser> for FileChooserWidget

impl Ord for FileChooser

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

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

Equality operator ==.

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

Inequality operator !=.

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for FileChooser

fn static_type() -> Type

Returns the type identifier of Self.