FileChooserWidget

Deprecated since version 4.10: Direct use of GtkFileChooserWidget is deprecated

class FileChooserWidget(**properties: Any)

Superclasses: Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, Buildable, ConstraintTarget, FileChooser

GtkFileChooserWidget is a widget for choosing files.

It exposes the FileChooser interface, and you should use the methods of this interface to interact with the widget.

CSS nodes

GtkFileChooserWidget has a single CSS node with name filechooser.

Constructors

class FileChooserWidget

classmethod new(action: FileChooserAction) → Widget

Creates a new GtkFileChooserWidget.

This is a file chooser widget that can be embedded in custom windows, and it is the same widget that is used by GtkFileChooserDialog.

Deprecated since version 4.10: Direct use of GtkFileChooserWidget is deprecated

Parameters:: action – Open or save mode for the widget

Properties

class FileChooserWidget

props.search_mode: bool

props.show_time: bool: Whether to show the time.

Added in version 4.10.

props.subtitle: str

Signals

class FileChooserWidget.signals

desktop_folder() → None

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser show the user’s Desktop folder in the file list.

The default binding for this signal is Alt-D.

down_folder() → None

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser go to a child of the current folder in the file hierarchy. The subfolder that will be used is displayed in the path bar widget of the file chooser. For example, if the path bar is showing “/foo/bar/baz”, with bar currently displayed, then this will cause the file chooser to switch to the “baz” subfolder.

The default binding for this signal is Alt-Down.

home_folder() → None

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser show the user’s home folder in the file list.

The default binding for this signal is Alt-Home.

location_popup(path: str) → None

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser show a “Location” prompt which the user can use to manually type the name of the file he wishes to select.

The default bindings for this signal are Control-L with a path string of “” (the empty string). It is also bound to <kbd>/</kbd> with a path string of “/” (a slash): this lets you type / and immediately type a path name. On Unix systems, this is bound to <kbd>~</kbd> (tilde) with a path string of “~” itself for access to home directories.

Parameters:: path – a string that gets put in the text entry for the file name

location_popup_on_paste() → None

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser show a “Location” prompt when the user pastes into a GtkFileChooserWidget.

The default binding for this signal is Control-V.

location_toggle_popup() → None

Emitted when the user asks for it.

This is a keybinding signal.

This is used to toggle the visibility of a “Location” prompt which the user can use to manually type the name of the file he wishes to select.

The default binding for this signal is Control-L.

places_shortcut() → None

Emitted when the user asks for it.

This is a keybinding signal.

This is used to move the focus to the places sidebar.

The default binding for this signal is Alt-P.

quick_bookmark(bookmark_index: int) → None

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser switch to the bookmark specified in the bookmark_index parameter. For example, if you have three bookmarks, you can pass 0, 1, 2 to this signal to switch to each of them, respectively.

The default binding for this signal is Alt-1, Alt-2, etc. until Alt-0. Note that in the default binding, that Alt-1 is actually defined to switch to the bookmark at index 0, and so on successively.

Parameters:: bookmark_index – the number of the bookmark to switch to

recent_shortcut() → None

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser show the Recent location.

The default binding for this signal is Alt-R.

search_shortcut() → None

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser show the search entry.

The default binding for this signal is Alt-S.

show_hidden() → None

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser display hidden files.

The default binding for this signal is Control-H.

up_folder() → None

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser go to the parent of the current folder in the file hierarchy.

The default binding for this signal is Alt-Up.