interface Gtk.FileChooser : GObject.Object
GtkFileChooser is an interface that can be implemented by file
In GTK, the main objects that implement this interface are
You do not need to write an object that implements the
interface unless you are trying to adapt an existing file selector to
expose a standard programming interface.
GtkFileChooser 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
program can get the selected filenames as
You can add extra widgets to a file chooser to provide options
that are not present in the default design, by using
gtk_file_chooser_add_choice(). Each choice has an identifier and
a user visible label; additionally, each choice can have multiple
options. If a choice has no option, it will be rendered as a
check button with the given label; if a choice has options, it will
be rendered as a combo box.
Deprecated since: 4.10
In order to implement FileChooser, your type must inherit from
Adds a ‘choice’ to the file chooser.
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
Gets the current name in the file selector, as entered by the user.
GFile for the currently selected file in
the file selector.
Lists all the selected files and subfolders in the current folder
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_add_choice().
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_add_choice().
Sets whether file chooser will offer to create new folders.
Sets the current folder for
chooser from a
Sets the current name in the file selector, as if entered by the user.
file as the current filename for the file chooser.
Sets the current filter.
Sets whether multiple files can be selected in the file chooser.
The type of operation that the file chooser is performing.
Whether a file chooser not in
will offer the user to create new folders.
The current filter for selecting files that are displayed.
GListModel containing the filters that have been
added with gtk_file_chooser_add_filter().
Whether to allow multiple files to be selected.
GListModel containing the shortcut folders that have been
added with gtk_file_chooser_add_shortcut_folder().