Gtk.FileChooserWidget

g Atk.ImplementorIface Atk.ImplementorIface Gtk.Widget Gtk.Widget Atk.ImplementorIface->Gtk.Widget GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable Gtk.FileChooser Gtk.FileChooser GObject.GInterface->Gtk.FileChooser Gtk.Orientable Gtk.Orientable GObject.GInterface->Gtk.Orientable GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Gtk.Widget GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.Box Gtk.Box Gtk.FileChooserWidget Gtk.FileChooserWidget Gtk.Box->Gtk.FileChooserWidget Gtk.Buildable->Gtk.Widget Gtk.Container Gtk.Container Gtk.Container->Gtk.Box Gtk.FileChooser->Gtk.FileChooserWidget Gtk.Orientable->Gtk.Box Gtk.Widget->Gtk.Container

Subclasses:None

Properties

Inherited:Gtk.Box (3), Gtk.Container (3), Gtk.Widget (39), Gtk.Orientable (1), Gtk.FileChooser (11)
Name Type Flags Short Description
search-mode bool r/w Search mode
subtitle str r Subtitle

Child Properties

Inherited:Gtk.Box (5)

Style Properties

Inherited:Gtk.Widget (17)

Signals

Inherited:Gtk.Container (4), Gtk.Widget (69), GObject.Object (1), Gtk.FileChooser (5)
Name Short Description
desktop-folder The ::desktop-folder signal is a keybinding signal which gets emitted when the user asks for it.
down-folder The ::down-folder signal is a keybinding signal which gets emitted when the user asks for it.
home-folder The ::home-folder signal is a keybinding signal which gets emitted when the user asks for it.
location-popup The ::location-popup signal is a keybinding signal which gets emitted when the user asks for it.
location-popup-on-paste The ::location-popup-on-paste signal is a keybinding signal which gets emitted when the user asks for it.
location-toggle-popup The ::location-toggle-popup signal is a keybinding signal which gets emitted when the user asks for it.
places-shortcut The ::places-shortcut signal is a keybinding signal which gets emitted when the user asks for it.
quick-bookmark The ::quick-bookmark signal is a keybinding signal which gets emitted when the user asks for it.
recent-shortcut The ::recent-shortcut signal is a keybinding signal which gets emitted when the user asks for it.
search-shortcut The ::search-shortcut signal is a keybinding signal which gets emitted when the user asks for it.
show-hidden The ::show-hidden signal is a keybinding signal which gets emitted when the user asks for it.
up-folder The ::up-folder signal is a keybinding signal which gets emitted when the user asks for it.

Fields

Inherited:Gtk.Container (4), Gtk.Widget (69), GObject.Object (1), Gtk.FileChooser (5)
Name Type Access Description
parent_instance Gtk.Box r  

Class Details

class Gtk.FileChooserWidget(*args, **kwargs)
Bases:Gtk.Box, Gtk.FileChooser
Abstract:No
Structure:Gtk.FileChooserWidgetClass

Gtk.FileChooserWidget is a widget for choosing files. It exposes the Gtk.FileChooser interface, and you should use the methods of this interface to interact with the widget.

CSS nodes

Gtk.FileChooserWidget has a single CSS node with name filechooser.

classmethod new(action)[source]
Parameters:action (Gtk.FileChooserAction) – Open or save mode for the widget
Returns:a new Gtk.FileChooserWidget
Return type:Gtk.Widget

Creates a new Gtk.FileChooserWidget. This is a file chooser widget that can be embedded in custom windows, and it is the same widget that is used by Gtk.FileChooserDialog.

New in version 2.4.

Signal Details

Gtk.FileChooserWidget.signals.desktop_folder(file_chooser_widget)
Signal Name:desktop-folder
Flags:RUN_FIRST, ACTION
Parameters:file_chooser_widget (Gtk.FileChooserWidget) – The object which received the signal

The ::desktop-folder signal is a keybinding signal which gets emitted when the user asks for it.

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.

Gtk.FileChooserWidget.signals.down_folder(file_chooser_widget)
Signal Name:down-folder
Flags:RUN_FIRST, ACTION
Parameters:file_chooser_widget (Gtk.FileChooserWidget) – The object which received the signal

The ::down-folder signal is a keybinding signal which gets emitted when the user asks for it.

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.

Gtk.FileChooserWidget.signals.home_folder(file_chooser_widget)
Signal Name:home-folder
Flags:RUN_FIRST, ACTION
Parameters:file_chooser_widget (Gtk.FileChooserWidget) – The object which received the signal

The ::home-folder signal is a keybinding signal which gets emitted when the user asks for it.

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.

Gtk.FileChooserWidget.signals.location_popup(file_chooser_widget, path)
Signal Name:

location-popup
Flags:

RUN_FIRST, ACTION
Parameters:
  • file_chooser_widget (Gtk.FileChooserWidget) – The object which received the signal
  • path (str) – a string that gets put in the text entry for the file name

The ::location-popup signal is a keybinding signal which gets emitted when the user asks for it.

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 / with a path string of “/” (a slash): this lets you type / and immediately type a path name. On Unix systems, this is bound to ~ (tilde) with a path string of “~” itself for access to home directories.

Gtk.FileChooserWidget.signals.location_popup_on_paste(file_chooser_widget)
Signal Name:location-popup-on-paste
Flags:RUN_FIRST, ACTION
Parameters:file_chooser_widget (Gtk.FileChooserWidget) – The object which received the signal

The ::location-popup-on-paste signal is a keybinding signal which gets emitted when the user asks for it.

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

The default binding for this signal is Control + V.

Gtk.FileChooserWidget.signals.location_toggle_popup(file_chooser_widget)
Signal Name:location-toggle-popup
Flags:RUN_FIRST, ACTION
Parameters:file_chooser_widget (Gtk.FileChooserWidget) – The object which received the signal

The ::location-toggle-popup signal is a keybinding signal which gets emitted when the user asks for it.

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.

Gtk.FileChooserWidget.signals.places_shortcut(file_chooser_widget)
Signal Name:places-shortcut
Flags:RUN_FIRST, ACTION
Parameters:file_chooser_widget (Gtk.FileChooserWidget) – The object which received the signal

The ::places-shortcut signal is a keybinding signal which gets emitted when the user asks for it.

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

The default binding for this signal is Alt + P.

Gtk.FileChooserWidget.signals.quick_bookmark(file_chooser_widget, bookmark_index)
Signal Name:

quick-bookmark
Flags:

RUN_FIRST, ACTION
Parameters:
  • file_chooser_widget (Gtk.FileChooserWidget) – The object which received the signal
  • bookmark_index (int) – the number of the bookmark to switch to

The ::quick-bookmark signal is a keybinding signal which gets emitted when the user asks for it.

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; Alt + 0 is defined to switch to the bookmark at index 10.

Gtk.FileChooserWidget.signals.recent_shortcut(file_chooser_widget)
Signal Name:recent-shortcut
Flags:RUN_FIRST, ACTION
Parameters:file_chooser_widget (Gtk.FileChooserWidget) – The object which received the signal

The ::recent-shortcut signal is a keybinding signal which gets emitted when the user asks for it.

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

The default binding for this signal is Alt + R.

Gtk.FileChooserWidget.signals.search_shortcut(file_chooser_widget)
Signal Name:search-shortcut
Flags:RUN_FIRST, ACTION
Parameters:file_chooser_widget (Gtk.FileChooserWidget) – The object which received the signal

The ::search-shortcut signal is a keybinding signal which gets emitted when the user asks for it.

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

The default binding for this signal is Alt + S.

Gtk.FileChooserWidget.signals.show_hidden(file_chooser_widget)
Signal Name:show-hidden
Flags:RUN_FIRST, ACTION
Parameters:file_chooser_widget (Gtk.FileChooserWidget) – The object which received the signal

The ::show-hidden signal is a keybinding signal which gets emitted when the user asks for it.

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

The default binding for this signal is Control + H.

Gtk.FileChooserWidget.signals.up_folder(file_chooser_widget)
Signal Name:up-folder
Flags:RUN_FIRST, ACTION
Parameters:file_chooser_widget (Gtk.FileChooserWidget) – The object which received the signal

The ::up-folder signal is a keybinding signal which gets emitted when the user asks for it.

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.

Property Details

Gtk.FileChooserWidget.props.search_mode
Name:search-mode
Type:bool
Default Value:False
Flags:READABLE, WRITABLE

Search mode

Gtk.FileChooserWidget.props.subtitle
Name:subtitle
Type:str
Default Value:''
Flags:READABLE

Subtitle