Gtk.FileChooser¶

Example¶

Implementations:: Gtk.FileChooserDialog, Gtk.FileChooserNative, Gtk.FileChooserWidget

Methods¶

	`add_choice` (id, label, options, option_labels)
	`add_filter` (filter)
	`add_shortcut_folder` (folder)
	`get_action` ()
	`get_choice` (id)
	`get_create_folders` ()
	`get_current_folder` ()
	`get_current_name` ()
	`get_file` ()
	`get_files` ()
	`get_filter` ()
	`get_filters` ()
	`get_select_multiple` ()
	`get_shortcut_folders` ()
	`remove_choice` (id)
	`remove_filter` (filter)
	`remove_shortcut_folder` (folder)
	`set_action` (action)
	`set_choice` (id, option)
	`set_create_folders` (create_folders)
	`set_current_folder` (file)
	`set_current_name` (name)
	`set_file` (file)
	`set_filter` (filter)
	`set_select_multiple` (select_multiple)

Virtual Methods¶

None

Properties¶

Name	Type	Flags	Short Description
`action`	`Gtk.FileChooserAction`	r/w	`deprecated`
`create-folders`	`bool`	r/w	`deprecated`
`filter`	`Gtk.FileFilter`	r/w	`deprecated`
`filters`	`Gio.ListModel`	r	`deprecated`
`select-multiple`	`bool`	r/w	`deprecated`
`shortcut-folders`	`Gio.ListModel`	r	`deprecated`

Signals¶

None

Fields¶

None

Class Details¶

class Gtk.FileChooser¶

Bases:: GObject.GInterface

GtkFileChooser is an interface that can be implemented by file selection widgets.

In GTK, the main objects that implement this interface are [class`Gtk`.FileChooserWidget] and [class`Gtk`.FileChooserDialog].

You do not need to write an object that implements the GtkFileChooser 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 GtkFileChooser, your program can get the selected filenames as ``GFile``s.

Adding options

You can add extra widgets to a file chooser to provide options that are not present in the default design, by using [method`Gtk`.FileChooser.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 version 4.10: Use [class`Gtk`.FileDialog] instead

add_choice(id, label, options, option_labels)[source]¶

Parameters:

id (str) – id for the added choice
label (str) – user-visible label for the added choice
options ([str] or None) – ids for the options of the choice, or None for a boolean choice
option_labels ([str] or None) – user-visible labels for the options, must be the same length as options

Adds a ‘choice’ to the file chooser.

This is typically implemented as a combobox or, for boolean choices, as a checkbutton. You can select a value using [method`Gtk`.FileChooser.set_choice] before the dialog is shown, and you can obtain the user-selected value in the [signal`Gtk`.Dialog::response] signal handler using [method`Gtk`.FileChooser.get_choice].

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

add_filter(filter)[source]¶

Parameters:: filter (Gtk.FileFilter) – a GtkFileFilter

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.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

add_shortcut_folder(folder)[source]¶

Parameters:: folder (Gio.File) – a GFile for the folder to add
Raises:: GLib.Error
Returns:: True if the folder could be added successfully, False otherwise.
Return type:: bool

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

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

get_action()[source]¶

Returns:: the action that the file selector is performing
Return type:: Gtk.FileChooserAction

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

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

get_choice(id)[source]¶

Parameters:: id (str) – the ID of the choice to get
Returns:: the ID of the currently selected option
Return type:: str or None

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

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

get_create_folders()[source]¶

Returns:: True if the Create Folder button should be displayed.
Return type:: bool

Gets whether file chooser will offer to create new folders.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

get_current_folder()[source]¶

Returns:: the GFile for the current folder.
Return type:: Gio.File or None

Gets the current folder of self as GFile.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

get_current_name()[source]¶

Returns:: The raw text from the file chooser’s “Name” entry. Free with GLib.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.
Return type:: str or None

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.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

get_file()[source]¶

Returns:: a selected GFile. You own the returned file; use GObject.Object.unref() to release it.
Return type:: Gio.File or None

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.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

get_files()[source]¶

Returns:: a list model containing a GFile for each selected file and subfolder in the current folder. Free the returned list with GObject.Object.unref().
Return type:: Gio.ListModel

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

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

get_filter()[source]¶

Returns:: the current filter
Return type:: Gtk.FileFilter or None

Gets the current filter.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

get_filters()[source]¶

Returns:: a GListModel containing the current set of user-selectable filters.
Return type:: Gio.ListModel

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

See [method`Gtk`.FileChooser.add_filter] and [method`Gtk`.FileChooser.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.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

get_select_multiple()[source]¶

Returns:: True if multiple files can be selected.
Return type:: bool

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

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

get_shortcut_folders()[source]¶

Returns:: A list model of ``GFile``s
Return type:: Gio.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.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

remove_choice(id)[source]¶

Parameters:: id (str) – the ID of the choice to remove

Removes a ‘choice’ that has been added with Gtk.FileChooser.add_choice().

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

remove_filter(filter)[source]¶

Parameters:: filter (Gtk.FileFilter) – a GtkFileFilter

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

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

remove_shortcut_folder(folder)[source]¶

Parameters:: folder (Gio.File) – a GFile for the folder to remove
Raises:: GLib.Error
Returns:: True if the folder could be removed successfully, False otherwise.
Return type:: bool

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

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

set_action(action)[source]¶

Parameters:: action (Gtk.FileChooserAction) – the action that the file selector is performing

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 Gtk.FileChooserAction.SAVE but not if the action is Gtk.FileChooserAction.OPEN.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

set_choice(id, option)[source]¶

Parameters:

id (str) – the ID of the choice to set
option (str) – the ID of the option to select

Selects an option in a ‘choice’ that has been added with Gtk.FileChooser.add_choice().

For a boolean choice, the possible options are “true” and “false”.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

set_create_folders(create_folders)[source]¶

Parameters:: create_folders (bool) – True if the Create Folder button should be displayed

Sets whether file chooser will offer to create new folders.

This is only relevant if the action is not set to be Gtk.FileChooserAction.OPEN.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

set_current_folder(file)[source]¶

Parameters:: file (Gio.File or None) – the GFile for the new folder
Raises:: GLib.Error
Returns:: True if the folder could be changed successfully, False otherwise.
Return type:: bool

Sets the current folder for self from a GFile.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

set_current_name(name)[source]¶

Parameters:: name (str) – the filename to use, as a UTF-8 string

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 [method`Gtk`.FileChooser.set_file] instead.

Please see the documentation for those functions for an example of using [method`Gtk`.FileChooser.set_current_name] as well.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

set_file(file)[source]¶

Parameters:: file (Gio.File) – the GFile to set as current
Raises:: GLib.Error
Returns:: Not useful
Return type:: bool

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 Gtk.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:

```c static void prepare_file_chooser (Gtk.FileChooser *chooser, Gio.File *existing_file) { bool document_is_new = (existing_file == None);

if (document_is_new) { Gio.File *default_file_for_saving = Gio.File.new_for_path (“./out.txt”); // the user just created a new document Gtk.FileChooser.set_current_folder (chooser, default_file_for_saving, None); Gtk.FileChooser.set_current_name (chooser, “Untitled document”); GObject.Object.unref (default_file_for_saving); } else { // the user edited an existing document Gtk.FileChooser.set_file (chooser, existing_file, None); } } ```

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

set_filter(filter)[source]¶

Parameters:: filter (Gtk.FileFilter) – a GtkFileFilter

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.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

set_select_multiple(select_multiple)[source]¶

Parameters:: select_multiple (bool) – True if multiple files can be selected.

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

This is only relevant if the action is set to be Gtk.FileChooserAction.OPEN or Gtk.FileChooserAction.SELECT_FOLDER.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

Property Details¶

Gtk.FileChooser.props.action¶

Name:: action
Type:: Gtk.FileChooserAction
Default Value:: Gtk.FileChooserAction.OPEN
Flags:: READABLE, WRITABLE

The type of operation that the file chooser is performing.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

Gtk.FileChooser.props.create_folders¶

Name:: create-folders
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE

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

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

Gtk.FileChooser.props.filter¶

Name:: filter
Type:: Gtk.FileFilter
Default Value:: None
Flags:: READABLE, WRITABLE

The current filter for selecting files that are displayed.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

Gtk.FileChooser.props.filters¶

Name:: filters
Type:: Gio.ListModel
Default Value:: None
Flags:: READABLE

A GListModel containing the filters that have been added with Gtk.FileChooser.add_filter().

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

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

Gtk.FileChooser.props.select_multiple¶

Name:: select-multiple
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether to allow multiple files to be selected.

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead

Gtk.FileChooser.props.shortcut_folders¶

Name:: shortcut-folders
Type:: Gio.ListModel
Default Value:: None
Flags:: READABLE

A GListModel containing the shortcut folders that have been added with Gtk.FileChooser.add_shortcut_folder().

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

Deprecated since version 4.10: Use [class`Gtk`.FileDialog] instead